Updates a reasoning engine.
Args:
- name: string, Identifier. The resource name of the ReasoningEngine. (required)
+ name: string, Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
body: object, The request body.
The object takes the form of:
@@ -372,7 +372,7 @@ Method Details
"description": "A String", # Optional. The description of the ReasoningEngine.
"displayName": "A String", # Required. The display name of the ReasoningEngine.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- "name": "A String", # Identifier. The resource name of the ReasoningEngine.
+ "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine
"agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
"classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.html b/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.html
index 2cb0e9a381..e4be7a21db 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.trainingPipelines.html
@@ -353,6 +353,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -752,6 +753,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -1193,6 +1195,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -1606,6 +1609,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html
index 6c06847357..f1349851a6 100644
--- a/docs/dyn/aiplatform_v1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.publishers.models.html
@@ -312,6 +312,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -466,6 +467,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
@@ -649,6 +652,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -824,6 +828,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
@@ -1781,6 +1787,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -1956,6 +1963,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html
index 97691b95fd..99d4a15bc8 100644
--- a/docs/dyn/aiplatform_v1beta1.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.endpoints.html
@@ -323,6 +323,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -480,6 +481,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -675,6 +678,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -853,6 +857,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1277,6 +1283,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -1455,6 +1462,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
index d359d25161..251106ea65 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
@@ -160,6 +160,9 @@ Method Details
],
"createTime": "A String", # Output only. Creation time of the cache entry.
"displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content.
+ "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key.
+ "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+ },
"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.
"model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}
"name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
@@ -326,6 +329,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -433,6 +438,9 @@ Method Details
],
"createTime": "A String", # Output only. Creation time of the cache entry.
"displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content.
+ "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key.
+ "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+ },
"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.
"model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}
"name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
@@ -599,6 +607,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -731,6 +741,9 @@ Method Details
],
"createTime": "A String", # Output only. Creation time of the cache entry.
"displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content.
+ "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key.
+ "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+ },
"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.
"model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}
"name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
@@ -897,6 +910,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1015,6 +1030,9 @@ Method Details
],
"createTime": "A String", # Output only. Creation time of the cache entry.
"displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content.
+ "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key.
+ "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+ },
"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.
"model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}
"name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
@@ -1181,6 +1199,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1307,6 +1327,9 @@ Method Details
],
"createTime": "A String", # Output only. Creation time of the cache entry.
"displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content.
+ "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key.
+ "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+ },
"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.
"model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}
"name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
@@ -1473,6 +1496,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1581,6 +1606,9 @@ Method Details
],
"createTime": "A String", # Output only. Creation time of the cache entry.
"displayName": "A String", # Optional. Immutable. The user-generated meaningful display name of the cached content.
+ "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key.
+ "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+ },
"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.
"model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}
"name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}
@@ -1747,6 +1775,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
index 109adaebcc..178b0510a0 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
@@ -281,6 +281,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -460,6 +461,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -631,6 +634,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -810,6 +814,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1030,6 +1036,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -1209,6 +1216,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1380,6 +1389,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -1559,6 +1569,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html
index 58e154f517..55825ff22b 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html
@@ -449,6 +449,7 @@ Method Details
{ # Response message for QueryDeployedModels method.
"deployedModelRefs": [ # References to the DeployedModels that share the specified deploymentResourcePool.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index b2070c25a6..f97c6b8d60 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -391,6 +391,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -548,6 +549,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1823,6 +1826,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -2001,6 +2005,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -4063,6 +4069,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -4241,6 +4248,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html
index 3a548dd372..f0ac261b10 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html
@@ -235,11 +235,10 @@ Method Details
{ # Response message for ExampleStoreService.FetchExamples.
"examples": [ # The examples in the Example Store that satisfy the metadata filters.
- { # A single example to upload or read from the Example Store.
+ {
"createTime": "A String", # Output only. Timestamp when this Example was created.
"displayName": "A String", # Optional. The display name for Example.
"exampleId": "A String", # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
- "name": "A String", # Identifier. The resource name of the Example. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/examples/{example}`
"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
"contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
"contents": [ # Required. The content of the conversation with the model that resulted in the expected output.
@@ -616,11 +615,10 @@ Method Details
{ # Response message for ExampleStoreService.SearchExamples.
"results": [ # The results of searching for similar examples.
{ # The result of the similar example.
- "example": { # A single example to upload or read from the Example Store. # The example that is similar to the searched query.
+ "example": { # The example that is similar to the searched query.
"createTime": "A String", # Output only. Timestamp when this Example was created.
"displayName": "A String", # Optional. The display name for Example.
"exampleId": "A String", # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
- "name": "A String", # Identifier. The resource name of the Example. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/examples/{example}`
"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
"contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
"contents": [ # Required. The content of the conversation with the model that resulted in the expected output.
@@ -744,11 +742,10 @@ Method Details
{ # Request message for ExampleStoreService.UpsertExamples.
"examples": [ # Required. A list of examples to be created/updated.
- { # A single example to upload or read from the Example Store.
+ {
"createTime": "A String", # Output only. Timestamp when this Example was created.
"displayName": "A String", # Optional. The display name for Example.
"exampleId": "A String", # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
- "name": "A String", # Identifier. The resource name of the Example. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/examples/{example}`
"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
"contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
"contents": [ # Required. The content of the conversation with the model that resulted in the expected output.
@@ -870,11 +867,10 @@ Method Details
{ # Response message for ExampleStoreService.UpsertExamples.
"results": [ # A list of results for creating/updating. It's either a successfully created/updated example or a status with an error message.
{ # The result for creating/updating a single example.
- "example": { # A single example to upload or read from the Example Store. # The example created/updated successfully.
+ "example": { # The example created/updated successfully.
"createTime": "A String", # Output only. Timestamp when this Example was created.
"displayName": "A String", # Optional. The display name for Example.
"exampleId": "A String", # Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.
- "name": "A String", # Identifier. The resource name of the Example. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/examples/{example}`
"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent.
"contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent.
"contents": [ # Required. The content of the conversation with the model that resulted in the expected output.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.models.html
index 46e4848063..952b5df4fb 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.models.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.models.html
@@ -476,6 +476,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -852,6 +853,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -1239,6 +1241,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -1614,6 +1617,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -1944,6 +1948,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -2273,6 +2278,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -2746,6 +2752,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
index 07581ea598..70754ac56f 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
@@ -345,6 +345,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -502,6 +503,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -811,6 +814,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -989,6 +993,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -1773,6 +1779,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -1951,6 +1958,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
index 880c276203..211895e8bc 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the operations Resource.
+
+Returns the sandboxEnvironments Resource.
+
@@ -131,7 +136,7 @@ Method Details
"description": "A String", # Optional. The description of the ReasoningEngine.
"displayName": "A String", # Required. The display name of the ReasoningEngine.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- "name": "A String", # Identifier. The resource name of the ReasoningEngine.
+ "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine
"agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
"classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
@@ -250,7 +255,7 @@ Method Details
"description": "A String", # Optional. The description of the ReasoningEngine.
"displayName": "A String", # Required. The display name of the ReasoningEngine.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- "name": "A String", # Identifier. The resource name of the ReasoningEngine.
+ "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine
"agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
"classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
@@ -311,7 +316,7 @@ Method Details
"description": "A String", # Optional. The description of the ReasoningEngine.
"displayName": "A String", # Required. The display name of the ReasoningEngine.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- "name": "A String", # Identifier. The resource name of the ReasoningEngine.
+ "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine
"agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
"classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
@@ -368,7 +373,7 @@ Method Details
Updates a reasoning engine.
Args:
- name: string, Identifier. The resource name of the ReasoningEngine. (required)
+ name: string, Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
body: object, The request body.
The object takes the form of:
@@ -377,7 +382,7 @@ Method Details
"description": "A String", # Optional. The description of the ReasoningEngine.
"displayName": "A String", # Required. The display name of the ReasoningEngine.
"etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- "name": "A String", # Identifier. The resource name of the ReasoningEngine.
+ "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
"spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine
"agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
"classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html
new file mode 100644
index 0000000000..d1b0b979a7
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html
@@ -0,0 +1,91 @@
+
+
+
+Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironments
+Instance Methods
+
+ operations()
+
+Returns the operations Resource.
+
+
+ close()
+Close httplib2 connections.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html
new file mode 100644
index 0000000000..2effd706de
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.operations.html
@@ -0,0 +1,268 @@
+
+
+
+Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironments . operations
+Instance Methods
+
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
+Close httplib2 connections.
+
+Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Retrieves the next page of results.
+
+ wait(name, timeout=None, x__xgafv=None)
+Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+Method Details
+
+ cancel(name, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ wait(name, timeout=None, x__xgafv=None)
+ Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html
index 5d7a234796..5b131a1ce4 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.trainingPipelines.html
@@ -345,6 +345,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -740,6 +741,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -1177,6 +1179,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
@@ -1586,6 +1589,7 @@ Method Details
"defaultCheckpointId": "A String", # The default checkpoint id of a model version.
"deployedModels": [ # Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
{ # Points to a DeployedModel.
+ "checkpointId": "A String", # Immutable. The ID of the Checkpoint deployed in the DeployedModel.
"deployedModelId": "A String", # Immutable. An ID of a DeployedModel in the above Endpoint.
"endpoint": "A String", # Immutable. A resource name of an Endpoint.
},
diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html
index c81a2580c8..34f69d96c2 100644
--- a/docs/dyn/aiplatform_v1beta1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html
@@ -327,6 +327,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -484,6 +485,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -679,6 +682,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -857,6 +861,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
@@ -2428,6 +2434,7 @@ Method Details
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
+ "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
"thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.
},
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
@@ -2606,6 +2613,8 @@ Method Details
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
"engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. Filter strings to be passed to the search API.
+ "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.html b/docs/dyn/alloydb_v1.projects.locations.clusters.html
index 227bfca0ab..fe05085ce8 100644
--- a/docs/dyn/alloydb_v1.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1.projects.locations.clusters.html
@@ -196,7 +196,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -204,7 +204,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -402,7 +402,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -410,7 +410,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -716,7 +716,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -724,7 +724,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -957,7 +957,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -965,7 +965,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1152,7 +1152,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1160,7 +1160,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1408,7 +1408,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1416,7 +1416,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1625,7 +1625,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1633,7 +1633,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html
index c454cbf525..0cacd7bd76 100644
--- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html
+++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html
@@ -157,6 +157,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -304,6 +305,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -542,6 +544,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -736,6 +739,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -872,6 +876,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
index 323c621b9f..72993ebd81 100644
--- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
@@ -196,7 +196,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -204,7 +204,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -406,7 +406,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -414,7 +414,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -724,7 +724,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -732,7 +732,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -969,7 +969,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -977,7 +977,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1168,7 +1168,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1176,7 +1176,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1428,7 +1428,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1436,7 +1436,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1649,7 +1649,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1657,7 +1657,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html
index 51e06b60b1..25ad882f79 100644
--- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html
+++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html
@@ -183,6 +183,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -361,6 +362,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -630,6 +632,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -859,6 +862,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -1026,6 +1030,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
index d725373cf8..2a50c45d80 100644
--- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
@@ -196,7 +196,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -204,7 +204,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -405,7 +405,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -413,7 +413,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -722,7 +722,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -730,7 +730,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -966,7 +966,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -974,7 +974,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1164,7 +1164,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1172,7 +1172,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1423,7 +1423,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1431,7 +1431,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
@@ -1643,7 +1643,7 @@ Method Details
"recoveryWindowDays": 42, # The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.
},
"continuousBackupInfo": { # ContinuousBackupInfo describes the continuous backup properties of a cluster. # Output only. Continuous backup properties for this cluster.
- "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. Output only field.
+ "earliestRestorableTime": "A String", # Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
"enabledTime": "A String", # Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.
"encryptionInfo": { # EncryptionInfo describes the encryption information of a cluster or a backup. # Output only. The encryption information for the WALs and backups required for ContinuousBackup.
"encryptionType": "A String", # Output only. Type of encryption.
@@ -1651,7 +1651,7 @@ Method Details
"A String",
],
},
- "schedule": [ # Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
+ "schedule": [ # Output only. Days of the week on which a continuous backup is taken.
"A String",
],
},
diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html
index 2fe378f722..6a317c0baa 100644
--- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html
+++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html
@@ -183,6 +183,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -360,6 +361,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -628,6 +630,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -856,6 +859,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
@@ -1022,6 +1026,7 @@ Method Details
},
"name": "A String", # Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
+ "allocatedIpRangeOverride": "A String", # Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
diff --git a/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html
index a46a632edd..76c8e2e67d 100644
--- a/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html
+++ b/docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html
@@ -94,7 +94,7 @@ Method Details
Lists all data exchanges from projects in a given organization and location.
Args:
- organization: string, Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`. (required)
+ organization: string, Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`. (required)
pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
@@ -115,7 +115,7 @@ Method Details
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html
index 7f4d79427f..768f690272 100644
--- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html
+++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html
@@ -114,7 +114,7 @@ Instance Methods
Sets the IAM policy.
subscribe(name, body=None, x__xgafv=None)
-Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.
+Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.
testIamPermissions(resource, body=None, x__xgafv=None)
Returns the permissions that a caller has.
@@ -129,7 +129,7 @@ Method Details
Creates a new data exchange.
Args:
- parent: string, Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`. (required)
+ parent: string, Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`. (required)
body: object, The request body.
The object takes the form of:
@@ -141,7 +141,7 @@ Method Details
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
@@ -170,7 +170,7 @@ Method Details
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
@@ -188,7 +188,7 @@ Method Details
Deletes an existing data exchange.
Args:
- name: string, Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`. (required)
+ name: string, Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/us/dataExchanges/123`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -206,7 +206,7 @@ Method Details
Gets the details of a data exchange.
Args:
- name: string, Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ name: string, Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -223,7 +223,7 @@ Method Details
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
@@ -297,7 +297,7 @@ Method Details
Lists all data exchanges in a given project and location.
Args:
- parent: string, Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`. (required)
+ parent: string, Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`. (required)
pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
@@ -318,7 +318,7 @@ Method Details
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
@@ -339,7 +339,7 @@ Method Details
Lists all subscriptions on a given Data Exchange or Listing.
Args:
- resource: string, Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789 (required)
+ resource: string, Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/us/dataExchanges/456 OR e.g. projects/123/locations/us/dataExchanges/456/listings/789 (required)
includeDeletedSubscriptions: boolean, If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
pageSize: integer, The maximum number of results to return in a single response page.
pageToken: string, Page token, returned by a previous call.
@@ -361,9 +361,21 @@ Method Details
},
},
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
- "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
+ "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
+ "destinationDataset": { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
+ "datasetReference": { # Required. A reference that identifies the destination dataset.
+ "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "projectId": "A String", # Required. The ID of the project containing this dataset.
+ },
+ "description": "A String", # Optional. A user-friendly description of the dataset.
+ "friendlyName": "A String", # Optional. A descriptive name for the dataset.
+ "labels": { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
+ "a_key": "A String",
+ },
+ "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
+ },
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
- "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
+ "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
"a_key": { # Reference to a linked resource tracked by this Subscription.
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
"linkedPubsubSubscription": "A String", # Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
@@ -377,9 +389,9 @@ Method Details
"listing": "A String", # Output only. Listing for which linked resource is created.
},
],
- "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
+ "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
"logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
+ "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
"resourceType": "A String", # Output only. Listing shared asset type.
@@ -423,7 +435,7 @@ Method Details
Updates an existing data exchange.
Args:
- name: string, Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ name: string, Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
body: object, The request body.
The object takes the form of:
@@ -435,7 +447,7 @@ Method Details
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
@@ -464,7 +476,7 @@ Method Details
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the DataExchange has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Optional. Configurable data sharing environment option for a data exchange.
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
@@ -564,15 +576,15 @@ Method Details
subscribe(name, body=None, x__xgafv=None)
- Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.
+ Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.
Args:
- name: string, Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123` (required)
+ name: string, Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/us/dataExchanges/123` (required)
body: object, The request body.
The object takes the form of:
{ # Message for subscribing to a Data Exchange.
- "destination": "A String", # Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/US`
+ "destination": "A String", # Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/us`
"destinationDataset": { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
"datasetReference": { # Required. A reference that identifies the destination dataset.
"datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
@@ -584,9 +596,6 @@ Method Details
"a_key": "A String",
},
"location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- "A String",
- ],
},
"subscriberContact": "A String", # Email of the subscriber.
"subscription": "A String", # Required. Name of the subscription to create. e.g. `subscription1`
diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
index 7a9eeba371..da2fe3910f 100644
--- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
+++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
@@ -124,7 +124,7 @@ Method Details
Creates a new listing.
Args:
- parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
body: object, The request body.
The object takes the form of:
@@ -163,7 +163,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -229,7 +229,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -257,7 +257,7 @@ Method Details
Deletes a listing.
Args:
- name: string, Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+ name: string, Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. (required)
deleteCommercial: boolean, Optional. If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.
x__xgafv: string, V1 error format.
Allowed values
@@ -276,7 +276,7 @@ Method Details
Gets the details of a listing.
Args:
- name: string, Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+ name: string, Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -320,7 +320,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -404,7 +404,7 @@ Method Details
Lists all listings in a given project and location.
Args:
- parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
@@ -452,7 +452,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -483,7 +483,7 @@ Method Details
Lists all subscriptions on a given Data Exchange or Listing.
Args:
- resource: string, Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789 (required)
+ resource: string, Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/us/dataExchanges/456 OR e.g. projects/123/locations/us/dataExchanges/456/listings/789 (required)
includeDeletedSubscriptions: boolean, If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
pageSize: integer, The maximum number of results to return in a single response page.
pageToken: string, Page token, returned by a previous call.
@@ -505,9 +505,21 @@ Method Details
},
},
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
- "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
+ "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
+ "destinationDataset": { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
+ "datasetReference": { # Required. A reference that identifies the destination dataset.
+ "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "projectId": "A String", # Required. The ID of the project containing this dataset.
+ },
+ "description": "A String", # Optional. A user-friendly description of the dataset.
+ "friendlyName": "A String", # Optional. A descriptive name for the dataset.
+ "labels": { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
+ "a_key": "A String",
+ },
+ "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
+ },
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
- "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
+ "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
"a_key": { # Reference to a linked resource tracked by this Subscription.
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
"linkedPubsubSubscription": "A String", # Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
@@ -521,9 +533,9 @@ Method Details
"listing": "A String", # Output only. Listing for which linked resource is created.
},
],
- "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
+ "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
"logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
+ "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
"resourceType": "A String", # Output only. Listing shared asset type.
@@ -567,7 +579,7 @@ Method Details
Updates an existing listing.
Args:
- name: string, Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` (required)
+ name: string, Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456` (required)
body: object, The request body.
The object takes the form of:
@@ -606,7 +618,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -672,7 +684,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"logLinkedDatasetQueryUserEmail": True or False, # Optional. By default, false. If true, the Listing has an email sharing mandate enabled.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -785,7 +797,7 @@ Method Details
Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
Args:
- name: string, Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+ name: string, Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. (required)
body: object, The request body.
The object takes the form of:
@@ -801,9 +813,6 @@ Method Details
"a_key": "A String",
},
"location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- "replicaLocations": [ # Optional. The geographic locations where the dataset should be replicated. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- "A String",
- ],
},
"destinationPubsubSubscription": { # Defines the destination Pub/Sub subscription. # Input only. Destination Pub/Sub subscription to create for the subscriber.
"pubsubSubscription": { # Defines the destination Pub/Sub subscription. If none of `push_config`, `bigquery_config`, `cloud_storage_config`, `pubsub_export_config`, or `pubsublite_export_config` is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set. # Required. Destination Pub/Sub subscription resource.
@@ -898,9 +907,21 @@ Method Details
},
},
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
- "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
+ "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
+ "destinationDataset": { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
+ "datasetReference": { # Required. A reference that identifies the destination dataset.
+ "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "projectId": "A String", # Required. The ID of the project containing this dataset.
+ },
+ "description": "A String", # Optional. A user-friendly description of the dataset.
+ "friendlyName": "A String", # Optional. A descriptive name for the dataset.
+ "labels": { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
+ "a_key": "A String",
+ },
+ "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
+ },
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
- "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
+ "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
"a_key": { # Reference to a linked resource tracked by this Subscription.
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
"linkedPubsubSubscription": "A String", # Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
@@ -914,9 +935,9 @@ Method Details
"listing": "A String", # Output only. Listing for which linked resource is created.
},
],
- "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
+ "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
"logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
+ "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
"resourceType": "A String", # Output only. Listing shared asset type.
diff --git a/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html b/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html
index dd014f07a6..8d41798fdd 100644
--- a/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html
+++ b/docs/dyn/analyticshub_v1.projects.locations.subscriptions.html
@@ -112,7 +112,7 @@ Method Details
Deletes a subscription.
Args:
- name: string, Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456 (required)
+ name: string, Required. Resource name of the subscription to delete. e.g. projects/123/locations/us/subscriptions/456 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -147,7 +147,7 @@ Method Details
Gets the details of a Subscription.
Args:
- name: string, Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456 (required)
+ name: string, Required. Resource name of the subscription. e.g. projects/123/locations/us/subscriptions/456 (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -163,9 +163,21 @@ Method Details
},
},
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
- "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
+ "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
+ "destinationDataset": { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
+ "datasetReference": { # Required. A reference that identifies the destination dataset.
+ "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "projectId": "A String", # Required. The ID of the project containing this dataset.
+ },
+ "description": "A String", # Optional. A user-friendly description of the dataset.
+ "friendlyName": "A String", # Optional. A descriptive name for the dataset.
+ "labels": { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
+ "a_key": "A String",
+ },
+ "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
+ },
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
- "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
+ "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
"a_key": { # Reference to a linked resource tracked by this Subscription.
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
"linkedPubsubSubscription": "A String", # Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
@@ -179,9 +191,9 @@ Method Details
"listing": "A String", # Output only. Listing for which linked resource is created.
},
],
- "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
+ "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
"logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
+ "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
"resourceType": "A String", # Output only. Listing shared asset type.
@@ -251,7 +263,7 @@ Method Details
Lists all subscriptions in a given project and location.
Args:
- parent: string, Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US (required)
+ parent: string, Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us (required)
filter: string, An expression for filtering the results of the request. Eligible fields for filtering are: + `listing` + `data_exchange` Alternatively, a literal wrapped in double quotes may be provided. This will be checked for an exact match against both fields above. In all cases, the full Data Exchange or Listing resource name must be provided. Some example of using filters: + data_exchange="projects/myproject/locations/us/dataExchanges/123" + listing="projects/123/locations/us/dataExchanges/456/listings/789" + "projects/myproject/locations/us/dataExchanges/123"
pageSize: integer, The maximum number of results to return in a single response page.
pageToken: string, Page token, returned by a previous call.
@@ -273,9 +285,21 @@ Method Details
},
},
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
- "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
+ "dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/us/dataExchanges/456
+ "destinationDataset": { # Defines the destination bigquery dataset. # Optional. BigQuery destination dataset to create for the subscriber.
+ "datasetReference": { # Required. A reference that identifies the destination dataset.
+ "datasetId": "A String", # Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
+ "projectId": "A String", # Required. The ID of the project containing this dataset.
+ },
+ "description": "A String", # Optional. A user-friendly description of the dataset.
+ "friendlyName": "A String", # Optional. A descriptive name for the dataset.
+ "labels": { # Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.
+ "a_key": "A String",
+ },
+ "location": "A String", # Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
+ },
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
- "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
+ "linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/us/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
"a_key": { # Reference to a linked resource tracked by this Subscription.
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
"linkedPubsubSubscription": "A String", # Output only. Name of the Pub/Sub subscription, e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
@@ -289,9 +313,9 @@ Method Details
"listing": "A String", # Output only. Listing for which linked resource is created.
},
],
- "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
+ "listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/us/dataExchanges/456/listings/789
"logLinkedDatasetQueryUserEmail": True or False, # Output only. By default, false. If true, the Subscriber agreed to the email sharing mandate that is enabled for DataExchange/Listing.
- "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
+ "name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/us/subscriptions/123`.
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
"resourceType": "A String", # Output only. Listing shared asset type.
@@ -321,7 +345,7 @@ Method Details
Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.
Args:
- name: string, Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123` (required)
+ name: string, Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/us/subscriptions/123` (required)
body: object, The request body.
The object takes the form of:
@@ -362,7 +386,7 @@ Method Details
Revokes a given subscription.
Args:
- name: string, Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456 (required)
+ name: string, Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456 (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/analyticshub_v1beta1.organizations.locations.dataExchanges.html b/docs/dyn/analyticshub_v1beta1.organizations.locations.dataExchanges.html
index 63ef285470..fdcf5dd59a 100644
--- a/docs/dyn/analyticshub_v1beta1.organizations.locations.dataExchanges.html
+++ b/docs/dyn/analyticshub_v1beta1.organizations.locations.dataExchanges.html
@@ -94,7 +94,7 @@ Method Details
Lists all data exchanges from projects in a given organization and location.
Args:
- organization: string, Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`. (required)
+ organization: string, Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`. (required)
pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
@@ -113,7 +113,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the data exchange.
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
},
],
diff --git a/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.html b/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.html
index 7ea887131d..caf8846f7a 100644
--- a/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.html
+++ b/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.html
@@ -120,7 +120,7 @@ Method Details
Creates a new data exchange.
Args:
- parent: string, Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`. (required)
+ parent: string, Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`. (required)
body: object, The request body.
The object takes the form of:
@@ -130,7 +130,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the data exchange.
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
}
@@ -149,7 +149,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the data exchange.
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
}
@@ -159,7 +159,7 @@ Method Details
Deletes an existing data exchange.
Args:
- name: string, Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`. (required)
+ name: string, Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/us/dataExchanges/123`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -177,7 +177,7 @@ Method Details
Gets the details of a data exchange.
Args:
- name: string, Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ name: string, Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -192,7 +192,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the data exchange.
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
}
@@ -258,7 +258,7 @@ Method Details
Lists all data exchanges in a given project and location.
Args:
- parent: string, Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`. (required)
+ parent: string, Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`. (required)
pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
@@ -277,7 +277,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the data exchange.
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
},
],
@@ -304,7 +304,7 @@ Method Details
Updates an existing data exchange.
Args:
- name: string, Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ name: string, Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
body: object, The request body.
The object takes the form of:
@@ -314,7 +314,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the data exchange.
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
}
@@ -333,7 +333,7 @@ Method Details
"documentation": "A String", # Optional. Documentation describing the data exchange.
"icon": "A String", # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
- "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
+ "name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
}
diff --git a/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html
index 6525fae672..ecea55eee7 100644
--- a/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html
+++ b/docs/dyn/analyticshub_v1beta1.projects.locations.dataExchanges.listings.html
@@ -118,7 +118,7 @@ Method Details
Creates a new listing.
Args:
- parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
body: object, The request body.
The object takes the form of:
@@ -138,7 +138,7 @@ Method Details
"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -178,7 +178,7 @@ Method Details
"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -199,7 +199,7 @@ Method Details
Deletes a listing.
Args:
- name: string, Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+ name: string, Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -217,7 +217,7 @@ Method Details
Gets the details of a listing.
Args:
- name: string, Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+ name: string, Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -242,7 +242,7 @@ Method Details
"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -319,7 +319,7 @@ Method Details
Lists all listings in a given project and location.
Args:
- parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`. (required)
+ parent: string, Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`. (required)
pageSize: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call, to request the next page of results.
x__xgafv: string, V1 error format.
@@ -348,7 +348,7 @@ Method Details
"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -386,7 +386,7 @@ Method Details
Updates an existing listing.
Args:
- name: string, Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` (required)
+ name: string, Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456` (required)
body: object, The request body.
The object takes the form of:
@@ -406,7 +406,7 @@ Method Details
"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -446,7 +446,7 @@ Method Details
"displayName": "A String", # Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.
"documentation": "A String", # Optional. Documentation describing the listing.
"icon": "A String", # Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.
- "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
+ "name": "A String", # Output only. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
"publisher": { # Contains details of the listing publisher. # Optional. Details of the publisher who owns the listing and who can share the source data.
"name": "A String", # Optional. Name of the listing publisher.
@@ -552,7 +552,7 @@ Method Details
Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.
Args:
- name: string, Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`. (required)
+ name: string, Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html
index 587ddcbc21..3d9df17fbd 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.devices.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html
@@ -84,7 +84,7 @@ Instance Methods
Close httplib2 connections.
delete(name, wipeDataFlags=None, wipeReasonMessage=None, x__xgafv=None)
-Deletes a device. This operation wipes the device. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.
+Deletes a device. This operation attempts to wipe the device but this is not guaranteed to succeed if the device is offline for an extended period. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.
Gets a device. Deleted devices will respond with a 404 error.
@@ -108,7 +108,7 @@ Method Details
delete(name, wipeDataFlags=None, wipeReasonMessage=None, x__xgafv=None)
- Deletes a device. This operation wipes the device. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.
+ Deletes a device. This operation attempts to wipe the device but this is not guaranteed to succeed if the device is offline for an extended period. Deleted devices do not show up in enterprises.devices.list calls and a 404 is returned from enterprises.devices.get.
Args:
name: string, The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}. (required)
diff --git a/docs/dyn/androidpublisher_v3.monetization.html b/docs/dyn/androidpublisher_v3.monetization.html
index d15891b564..41bbfb5883 100644
--- a/docs/dyn/androidpublisher_v3.monetization.html
+++ b/docs/dyn/androidpublisher_v3.monetization.html
@@ -145,7 +145,7 @@ Method Details
},
},
"regionVersion": { # The version of the available regions being used for the specified resource. # The region version at which the prices were generated.
- "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
}
diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html
index 4e0d0b7f0e..5af7396e62 100644
--- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html
+++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html
@@ -242,7 +242,7 @@ Method Details
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the regional_price_migrations.
- "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
},
],
@@ -555,7 +555,7 @@ Method Details
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the regional_price_migrations.
- "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
}
diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html
index a242073f53..fb122531e8 100644
--- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html
+++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html
@@ -386,7 +386,7 @@ Method Details
"allowMissing": True or False, # Optional. If set to true, and the subscription offer with the given package_name, product_id, base_plan_id and offer_id doesn't exist, an offer will be created. If a new offer is created, update_mask is ignored.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the subscription_offer.
- "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"subscriptionOffer": { # A single, temporary offer # Required. The subscription offer to update.
"basePlanId": "A String", # Required. Immutable. The ID of the base plan to which this offer is an extension.
@@ -855,7 +855,7 @@ Method Details
}
offerId: string, Required. The ID to use for the offer. For the requirements on this format, see the documentation of the offer_id field on the SubscriptionOffer resource.
- regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1469,7 +1469,7 @@ Method Details
PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
- regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
updateMask: string, Required. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html
index d36ad777df..3b00bc153d 100644
--- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html
+++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html
@@ -345,7 +345,7 @@ Method Details
"allowMissing": True or False, # Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the subscription.
- "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
},
"subscription": { # A single subscription for an app. # Required. The subscription to update.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
@@ -646,7 +646,7 @@ Method Details
}
productId: string, Required. The ID to use for the subscription. For the requirements on this format, see the documentation of the product_id field on the Subscription resource.
- regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1095,7 +1095,7 @@ Method Details
PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
- regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
+ regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. The latest supported version is available in this article. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
updateMask: string, Required. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/androidpublisher_v3.orders.html b/docs/dyn/androidpublisher_v3.orders.html
index 7852b4bf53..972b76882b 100644
--- a/docs/dyn/androidpublisher_v3.orders.html
+++ b/docs/dyn/androidpublisher_v3.orders.html
@@ -74,18 +74,296 @@
Google Play Android Developer API . orders
Instance Methods
+
+ batchget(packageName, orderIds=None, x__xgafv=None)
+Get order details for a list of orders.
Close httplib2 connections.
+
+ get(packageName, orderId, x__xgafv=None)
+Get order details for a single order.
refund(packageName, orderId, revoke=None, x__xgafv=None)
Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.
Method Details
+
+ batchget(packageName, orderIds=None, x__xgafv=None)
+ Get order details for a list of orders.
+
+Args:
+ packageName: string, Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). (required)
+ orderIds: string, Required. The list of order IDs to retrieve order details for. There must be between 1 and 1000 (inclusive) order IDs per request. If any order ID is not found or does not match the provided package, the entire request will fail with an error. The order IDs must be distinct. (repeated)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for the orders.batchGet API.
+ "orders": [ # Details for the requested order IDs.
+ { # Details of an order.
+ "buyerAddress": { # Address information for the customer, for use in tax computation. # Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown.
+ "buyerCountry": "A String", # Two letter country code based on ISO-3166-1 Alpha-2 (UN country codes).
+ "buyerPostcode": "A String", # Postal code of an address. When Google is the Merchant of Record for the order, this information is not included.
+ "buyerState": "A String", # Top-level administrative subdivision of the buyer address country. When Google is the Merchant of Record for the order, this information is not included.
+ },
+ "createTime": "A String", # The time when the order was created.
+ "developerRevenueInBuyerCurrency": { # Represents an amount of money with its currency type. # Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "lastEventTime": "A String", # The time of the last event that occurred on the order.
+ "lineItems": [ # The individual line items making up this order.
+ { # Details of a line item.
+ "listingPrice": { # Represents an amount of money with its currency type. # Item's listed price on Play Store, this may or may not include tax. Excludes any discounts or promotions.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "oneTimePurchaseDetails": { # Details of a one-time purchase. # Details of a one-time purchase.
+ "offerId": "A String", # The offer ID of the one-time purchase offer.
+ "quantity": 42, # The number of items purchased (for multi-quantity item purchases).
+ },
+ "paidAppDetails": { # Details of a paid app purchase. # Details of a paid app purchase.
+ },
+ "productId": "A String", # The purchased product ID or in-app SKU (for example, 'monthly001' or 'com.some.thing.inapp1').
+ "productTitle": "A String", # Developer-specified name of the product. Displayed in buyer's locale. Example: coins, monthly subscription, etc.
+ "subscriptionDetails": { # Details of a subscription purchase. # Details of a subscription purchase.
+ "basePlanId": "A String", # The base plan ID of the subscription.
+ "offerId": "A String", # The offer ID for the current subscription offer.
+ "offerPhase": "A String", # The pricing phase for the billing period funded by this order.
+ "servicePeriodEndTime": "A String", # The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get.
+ "servicePeriodStartTime": "A String", # The start of the billing period funded by this order. This is a snapshot of the billing/service period start time at the moment the order was processed, and should be used only for accounting.
+ },
+ "tax": { # Represents an amount of money with its currency type. # The tax paid for this line item.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The total amount paid by the user for this line item, taking into account discounts and tax.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ ],
+ "orderDetails": { # Detailed information about the order at creation time. # Detailed information about the order at creation time.
+ "taxInclusive": True or False, # Indicates whether the listed price was tax inclusive or not.
+ },
+ "orderHistory": { # Details about events which modified the order. # Details about events which modified the order.
+ "cancellationEvent": { # Details of when the order was canceled. # Details of when the order was canceled.
+ "eventTime": "A String", # The time when the order was canceled.
+ },
+ "partialRefundEvents": [ # Details of the partial refund events for this order.
+ { # Details of the partial refund events for this order.
+ "createTime": "A String", # The time when the partial refund was created.
+ "processTime": "A String", # The time when the partial refund was processed.
+ "refundDetails": { # Details for a partial or full refund. # Details for the partial refund.
+ "tax": { # Represents an amount of money with its currency type. # The amount of tax refunded.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The total amount refunded, including tax.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "state": "A String", # The state of the partial refund.
+ },
+ ],
+ "processedEvent": { # Details of when the order was processed. # Details of when the order was processed.
+ "eventTime": "A String", # The time when the order was processed.
+ },
+ "refundEvent": { # Details of when the order was fully refunded. # Details of when the order was fully refunded.
+ "eventTime": "A String", # The time when the order was fully refunded.
+ "refundDetails": { # Details for a partial or full refund. # Details for the full refund.
+ "tax": { # Represents an amount of money with its currency type. # The amount of tax refunded.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The total amount refunded, including tax.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "refundReason": "A String", # The reason the order was refunded.
+ },
+ },
+ "orderId": "A String", # The order ID.
+ "pointsDetails": { # Details relating to any Play Points applied to an order. # Play points applied to the order, including offer information, discount rate and point values.
+ "pointsCouponValue": { # Represents an amount of money with its currency type. # The monetary value of a Play Points coupon. This is the discount the coupon provides, which may not be the total amount. Only set when Play Points coupons have been used. E.g. for a 100 points for $2 coupon, this is $2.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "pointsDiscountRateMicros": "A String", # The percentage rate which the Play Points promotion reduces the cost by. E.g. for a 100 points for $2 coupon, this is 500,000. Since $2 has an estimate of 200 points, but the actual Points required, 100, is 50% of this, and 50% in micros is 500,000. Between 0 and 1,000,000.
+ "pointsOfferId": "A String", # ID unique to the play points offer in use for this order.
+ "pointsSpent": "A String", # The number of Play Points applied in this order. E.g. for a 100 points for $2 coupon, this is 100. For coupon stacked with base offer, this is the total points spent across both.
+ },
+ "purchaseToken": "A String", # The token provided to the user's device when the subscription or item was purchased.
+ "state": "A String", # The state of the order.
+ "tax": { # Represents an amount of money with its currency type. # The total tax paid as a part of this order.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The final amount paid by the customer, taking into account discounts and taxes.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ ],
+}
+
+
close()
Close httplib2 connections.
+
+ get(packageName, orderId, x__xgafv=None)
+ Get order details for a single order.
+
+Args:
+ packageName: string, Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). (required)
+ orderId: string, Required. The order ID provided to the user when the subscription or in-app order was purchased. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Details of an order.
+ "buyerAddress": { # Address information for the customer, for use in tax computation. # Address information for the customer, for use in tax computation. When Google is the Merchant of Record for the order, only country is shown.
+ "buyerCountry": "A String", # Two letter country code based on ISO-3166-1 Alpha-2 (UN country codes).
+ "buyerPostcode": "A String", # Postal code of an address. When Google is the Merchant of Record for the order, this information is not included.
+ "buyerState": "A String", # Top-level administrative subdivision of the buyer address country. When Google is the Merchant of Record for the order, this information is not included.
+ },
+ "createTime": "A String", # The time when the order was created.
+ "developerRevenueInBuyerCurrency": { # Represents an amount of money with its currency type. # Your revenue for this order in the buyer's currency, including deductions of partial refunds, taxes and fees. Google deducts standard transaction and third party fees from each sale, including VAT in some regions.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "lastEventTime": "A String", # The time of the last event that occurred on the order.
+ "lineItems": [ # The individual line items making up this order.
+ { # Details of a line item.
+ "listingPrice": { # Represents an amount of money with its currency type. # Item's listed price on Play Store, this may or may not include tax. Excludes any discounts or promotions.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "oneTimePurchaseDetails": { # Details of a one-time purchase. # Details of a one-time purchase.
+ "offerId": "A String", # The offer ID of the one-time purchase offer.
+ "quantity": 42, # The number of items purchased (for multi-quantity item purchases).
+ },
+ "paidAppDetails": { # Details of a paid app purchase. # Details of a paid app purchase.
+ },
+ "productId": "A String", # The purchased product ID or in-app SKU (for example, 'monthly001' or 'com.some.thing.inapp1').
+ "productTitle": "A String", # Developer-specified name of the product. Displayed in buyer's locale. Example: coins, monthly subscription, etc.
+ "subscriptionDetails": { # Details of a subscription purchase. # Details of a subscription purchase.
+ "basePlanId": "A String", # The base plan ID of the subscription.
+ "offerId": "A String", # The offer ID for the current subscription offer.
+ "offerPhase": "A String", # The pricing phase for the billing period funded by this order.
+ "servicePeriodEndTime": "A String", # The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get.
+ "servicePeriodStartTime": "A String", # The start of the billing period funded by this order. This is a snapshot of the billing/service period start time at the moment the order was processed, and should be used only for accounting.
+ },
+ "tax": { # Represents an amount of money with its currency type. # The tax paid for this line item.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The total amount paid by the user for this line item, taking into account discounts and tax.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ ],
+ "orderDetails": { # Detailed information about the order at creation time. # Detailed information about the order at creation time.
+ "taxInclusive": True or False, # Indicates whether the listed price was tax inclusive or not.
+ },
+ "orderHistory": { # Details about events which modified the order. # Details about events which modified the order.
+ "cancellationEvent": { # Details of when the order was canceled. # Details of when the order was canceled.
+ "eventTime": "A String", # The time when the order was canceled.
+ },
+ "partialRefundEvents": [ # Details of the partial refund events for this order.
+ { # Details of the partial refund events for this order.
+ "createTime": "A String", # The time when the partial refund was created.
+ "processTime": "A String", # The time when the partial refund was processed.
+ "refundDetails": { # Details for a partial or full refund. # Details for the partial refund.
+ "tax": { # Represents an amount of money with its currency type. # The amount of tax refunded.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The total amount refunded, including tax.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "state": "A String", # The state of the partial refund.
+ },
+ ],
+ "processedEvent": { # Details of when the order was processed. # Details of when the order was processed.
+ "eventTime": "A String", # The time when the order was processed.
+ },
+ "refundEvent": { # Details of when the order was fully refunded. # Details of when the order was fully refunded.
+ "eventTime": "A String", # The time when the order was fully refunded.
+ "refundDetails": { # Details for a partial or full refund. # Details for the full refund.
+ "tax": { # Represents an amount of money with its currency type. # The amount of tax refunded.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The total amount refunded, including tax.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "refundReason": "A String", # The reason the order was refunded.
+ },
+ },
+ "orderId": "A String", # The order ID.
+ "pointsDetails": { # Details relating to any Play Points applied to an order. # Play points applied to the order, including offer information, discount rate and point values.
+ "pointsCouponValue": { # Represents an amount of money with its currency type. # The monetary value of a Play Points coupon. This is the discount the coupon provides, which may not be the total amount. Only set when Play Points coupons have been used. E.g. for a 100 points for $2 coupon, this is $2.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "pointsDiscountRateMicros": "A String", # The percentage rate which the Play Points promotion reduces the cost by. E.g. for a 100 points for $2 coupon, this is 500,000. Since $2 has an estimate of 200 points, but the actual Points required, 100, is 50% of this, and 50% in micros is 500,000. Between 0 and 1,000,000.
+ "pointsOfferId": "A String", # ID unique to the play points offer in use for this order.
+ "pointsSpent": "A String", # The number of Play Points applied in this order. E.g. for a 100 points for $2 coupon, this is 100. For coupon stacked with base offer, this is the total points spent across both.
+ },
+ "purchaseToken": "A String", # The token provided to the user's device when the subscription or item was purchased.
+ "state": "A String", # The state of the order.
+ "tax": { # Represents an amount of money with its currency type. # The total tax paid as a part of this order.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "total": { # Represents an amount of money with its currency type. # The final amount paid by the customer, taking into account discounts and taxes.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+}
+
+
refund(packageName, orderId, revoke=None, x__xgafv=None)
Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.
diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html
index 3ef5c15310..79439a930f 100644
--- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html
+++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html
@@ -212,6 +212,9 @@ Method Details
"revocationContext": { # Revocation context of the purchases.subscriptionsv2.revoke API. # Required. Additional details around the subscription revocation.
"fullRefund": { # Used to determine if the refund type in the RevocationContext is a full refund. # Optional. Used when users should be refunded the full amount of the latest order of the subscription.
},
+ "itemBasedRefund": { # Used to determine what specific item to revoke in a subscription with multiple items. # Optional. Used when a specific item should be refunded in a subscription with multiple items.
+ "productId": "A String", # Required. If the subscription is a subscription bundle, the product id of the subscription to revoke.
+ },
"proratedRefund": { # Used to determine if the refund type in the RevocationContext is a prorated refund. # Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription.
},
},
diff --git a/docs/dyn/apihub_v1.html b/docs/dyn/apihub_v1.html
new file mode 100644
index 0000000000..91014d65f0
--- /dev/null
+++ b/docs/dyn/apihub_v1.html
@@ -0,0 +1,111 @@
+
+
+
+API hub API
+Instance Methods
+
+ projects()
+
+Returns the projects Resource.
+
+
+ close()
+Close httplib2 connections.
+
+Create a BatchHttpRequest object based on the discovery document.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.html b/docs/dyn/apihub_v1.projects.html
new file mode 100644
index 0000000000..06929e4bb5
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.html
@@ -0,0 +1,91 @@
+
+
+
+API hub API . projects
+Instance Methods
+
+ locations()
+
+Returns the locations Resource.
+
+
+ close()
+Close httplib2 connections.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.apiHubInstances.html b/docs/dyn/apihub_v1.projects.locations.apiHubInstances.html
new file mode 100644
index 0000000000..918a0b2894
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.apiHubInstances.html
@@ -0,0 +1,258 @@
+
+
+
+API hub API . projects . locations . apiHubInstances
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, apiHubInstanceId=None, body=None, x__xgafv=None)
+Provisions instance resources for the API Hub.
+
+Deletes the API hub instance.
+
+Gets details of a single API Hub instance.
+
+ lookup(parent, x__xgafv=None)
+Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, apiHubInstanceId=None, body=None, x__xgafv=None)
+ Provisions instance resources for the API Hub.
+
+Args:
+ parent: string, Required. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
+ "config": { # Available configurations to provision an ApiHub Instance. # Required. Config of the ApiHub instance.
+ "cmekKeyName": "A String", # Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.
+ "disableSearch": True or False, # Optional. If true, the search will be disabled for the instance. The default value is false.
+ "encryptionType": "A String", # Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used.
+ "vertexLocation": "A String", # Optional. The name of the Vertex AI location where the data store is stored.
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the ApiHub instance.
+ "labels": { # Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
+ "state": "A String", # Output only. The current state of the ApiHub instance.
+ "stateMessage": "A String", # Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.
+ "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+ apiHubInstanceId: string, Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are `/a-z[0-9]-_/`.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes the API hub instance.
+
+Args:
+ name: string, Required. The name of the Api Hub instance to delete. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets details of a single API Hub instance.
+
+Args:
+ name: string, Required. The name of the Api Hub instance to retrieve. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
+ "config": { # Available configurations to provision an ApiHub Instance. # Required. Config of the ApiHub instance.
+ "cmekKeyName": "A String", # Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.
+ "disableSearch": True or False, # Optional. If true, the search will be disabled for the instance. The default value is false.
+ "encryptionType": "A String", # Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used.
+ "vertexLocation": "A String", # Optional. The name of the Vertex AI location where the data store is stored.
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the ApiHub instance.
+ "labels": { # Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
+ "state": "A String", # Output only. The current state of the ApiHub instance.
+ "stateMessage": "A String", # Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.
+ "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+
+
+ lookup(parent, x__xgafv=None)
+ Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.
+
+Args:
+ parent: string, Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The LookupApiHubInstance method's response.`
+ "apiHubInstance": { # An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project. # API Hub instance for a project if it exists, empty otherwise.
+ "config": { # Available configurations to provision an ApiHub Instance. # Required. Config of the ApiHub instance.
+ "cmekKeyName": "A String", # Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.
+ "disableSearch": True or False, # Optional. If true, the search will be disabled for the instance. The default value is false.
+ "encryptionType": "A String", # Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used.
+ "vertexLocation": "A String", # Optional. The name of the Vertex AI location where the data store is stored.
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the ApiHub instance.
+ "labels": { # Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
+ "state": "A String", # Output only. The current state of the ApiHub instance.
+ "stateMessage": "A String", # Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.
+ "updateTime": "A String", # Output only. Last update timestamp.
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.apis.html b/docs/dyn/apihub_v1.projects.locations.apis.html
new file mode 100644
index 0000000000..626ec23778
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.apis.html
@@ -0,0 +1,1934 @@
+
+
+
+API hub API . projects . locations . apis
+Instance Methods
+
+ versions()
+
+Returns the versions Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ create(parent, apiId=None, body=None, x__xgafv=None)
+Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
+
+ delete(name, force=None, x__xgafv=None)
+Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
+
+Get API resource details including the API versions contained in it.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List API resources in the API hub.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, apiId=None, body=None, x__xgafv=None)
+ Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
+
+Args:
+ parent: string, Required. The parent resource for the API resource. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An API resource in the API Hub.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+}
+
+ apiId: string, Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An API resource in the API Hub.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+}
+
+
+
+ delete(name, force=None, x__xgafv=None)
+ Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
+
+Args:
+ name: string, Required. The name of the API resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}` (required)
+ force: boolean, Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get API resource details including the API versions contained in it.
+
+Args:
+ name: string, Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An API resource in the API Hub.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List API resources in the API hub.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of API resources. Format: `projects/{project}/locations/{location}` (required)
+ filter: string, Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `ApiResource` are eligible for filtering: * `owner.email` - The email of the team which owns the ApiResource. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the ApiResource. Allowed comparison operators: `=`. * `target_user.enum_values.values.id` - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `target_user.enum_values.values.display_name` - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.id` - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.display_name` - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.id` - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.display_name` - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.id` - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.display_name` - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.id` - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.display_name` - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `owner.email = \"apihub@google.com\"` - - The owner team email is _apihub@google.com_. * `owner.email = \"apihub@google.com\" AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The owner team email is _apihub@google.com_ and the api was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `owner.email = \"apihub@google.com\" OR team.enum_values.values.id: apihub-team-id` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is _apihub-team-id_. * `owner.email = \"apihub@google.com\" OR team.enum_values.values.display_name: ApiHub Team` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is `ApiHub Team`. * `owner.email = \"apihub@google.com\" AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test_enum_id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values: test_string_value` - The filter string specifies the APIs where the owner team email is _apihub@google.com_ and the id of the allowed value associated with the user defined attribute of type enum is _test_enum_id_ and the value of the user defined attribute of type string is _test_..
+ pageSize: integer, Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApis` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListApis method's response.
+ "apis": [ # The API resources present in the API hub.
+ { # An API resource in the API Hub.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.
+
+Args:
+ name: string, Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An API resource in the API Hub.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An API resource in the API Hub.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.apis.versions.definitions.html b/docs/dyn/apihub_v1.projects.locations.apis.versions.definitions.html
new file mode 100644
index 0000000000..8983379e50
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.apis.versions.definitions.html
@@ -0,0 +1,146 @@
+
+
+
+API hub API . projects . locations . apis . versions . definitions
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+Get details about a definition in an API version.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Get details about a definition in an API version.
+
+Args:
+ name: string, Required. The name of the definition to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported.
+ "attributes": { # Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the definition was created.
+ "name": "A String", # Identifier. The name of the definition. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "schema": { # The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the `definitions` section for OpenAPI 2.0 version and in `components.schemas` section for OpenAPI 3.0 and 3.1 version. # Output only. The value of a schema definition.
+ "displayName": "A String", # Output only. The display name of the schema. This will map to the name of the schema in the spec.
+ "rawValue": "A String", # Output only. The raw value of the schema definition corresponding to the schema name in the spec.
+ },
+ "spec": "A String", # Output only. The name of the spec from where the definition was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "type": "A String", # Output only. The type of the definition.
+ "updateTime": "A String", # Output only. The time at which the definition was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.apis.versions.html b/docs/dyn/apihub_v1.projects.locations.apis.versions.html
new file mode 100644
index 0000000000..64beb75415
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.apis.versions.html
@@ -0,0 +1,1128 @@
+
+
+
+API hub API . projects . locations . apis . versions
+Instance Methods
+
+ definitions()
+
+Returns the definitions Resource.
+
+
+ operations()
+
+Returns the operations Resource.
+
+
+ specs()
+
+Returns the specs Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, versionId=None, x__xgafv=None)
+Create an API version for an API resource in the API hub.
+
+ delete(name, force=None, x__xgafv=None)
+Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
+
+Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List API versions of an API resource in the API hub.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update API version. The following fields in the version can be updated currently: * display_name * description * documentation * deployments * lifecycle * compliance * accreditation * attributes The update_mask should be used to specify the fields being updated.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, versionId=None, x__xgafv=None)
+ Create an API version for an API resource in the API hub.
+
+Args:
+ parent: string, Required. The parent resource for API version. Format: `projects/{project}/locations/{location}/apis/{api}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a version of the API resource in API hub. This is also referred to as the API version.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+}
+
+ versionId: string, Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}`, its length is limited to 700 characters and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a version of the API resource in API hub. This is also referred to as the API version.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+}
+
+
+
+ delete(name, force=None, x__xgafv=None)
+ Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
+
+Args:
+ name: string, Required. The name of the version to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
+ force: boolean, Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
+
+Args:
+ name: string, Required. The name of the API version to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a version of the API resource in API hub. This is also referred to as the API version.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List API versions of an API resource in the API hub.
+
+Args:
+ parent: string, Required. The parent which owns this collection of API versions i.e., the API resource Format: `projects/{project}/locations/{location}/apis/{api}` (required)
+ filter: string, Optional. An expression that filters the list of Versions. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Version` are eligible for filtering: * `display_name` - The display name of the Version. Allowed comparison operators: `=`. * `create_time` - The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `lifecycle.enum_values.values.id` - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `lifecycle.enum_values.values.display_name` - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.id` - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `compliance.enum_values.values.display_name` - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.id` - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `accreditation.enum_values.values.display_name` - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `lifecycle.enum_values.values.id: preview-id` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_. * `lifecycle.enum_values.values.display_name: \"Preview Display Name\"` - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is `Preview Display Name`. * `lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and it was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id` - The id of the allowed value associated with the compliance attribute is _gdpr-id_ or _pci-dss-id_. * `lifecycle.enum_values.values.id: preview-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is _preview-id_ and the value of the user defined attribute of type string is _test_.
+ pageSize: integer, Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListVersions` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListVersions method's response.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "versions": [ # The versions corresponding to an API.
+ { # Represents a version of the API resource in API hub. This is also referred to as the API version.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update API version. The following fields in the version can be updated currently: * display_name * description * documentation * deployments * lifecycle * compliance * accreditation * attributes The update_mask should be used to specify the fields being updated.
+
+Args:
+ name: string, Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a version of the API resource in API hub. This is also referred to as the API version.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a version of the API resource in API hub. This is also referred to as the API version.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html b/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html
new file mode 100644
index 0000000000..57c2e4d090
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html
@@ -0,0 +1,590 @@
+
+
+
+API hub API . projects . locations . apis . versions . operations
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, apiOperationId=None, body=None, x__xgafv=None)
+Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec.
+
+Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec.
+
+Get details about a particular operation in API version.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List operations in an API version.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, apiOperationId=None, body=None, x__xgafv=None)
+ Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec.
+
+Args:
+ parent: string, Required. The parent resource for the operation resource. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
+ "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the operation was created.
+ "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
+ "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
+ "documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "httpOperation": { # The HTTP Operation. # The HTTP Operation.
+ "method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "description": "A String", # Optional. A short description for the path applicable to all operations.
+ "path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ },
+ },
+ },
+ "name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
+ "updateTime": "A String", # Output only. The time at which the operation was last updated.
+}
+
+ apiOperationId: string, Optional. The ID to use for the operation resource, which will become the final component of the operation's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another operation resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`, its length is limited to 700 characters, and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
+ "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the operation was created.
+ "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
+ "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
+ "documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "httpOperation": { # The HTTP Operation. # The HTTP Operation.
+ "method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "description": "A String", # Optional. A short description for the path applicable to all operations.
+ "path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ },
+ },
+ },
+ "name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
+ "updateTime": "A String", # Output only. The time at which the operation was last updated.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec.
+
+Args:
+ name: string, Required. The name of the operation resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get details about a particular operation in API version.
+
+Args:
+ name: string, Required. The name of the operation to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
+ "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the operation was created.
+ "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
+ "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
+ "documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "httpOperation": { # The HTTP Operation. # The HTTP Operation.
+ "method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "description": "A String", # Optional. A short description for the path applicable to all operations.
+ "path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ },
+ },
+ },
+ "name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
+ "updateTime": "A String", # Output only. The time at which the operation was last updated.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List operations in an API version.
+
+Args:
+ parent: string, Required. The parent which owns this collection of operations i.e., the API version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
+ filter: string, Optional. An expression that filters the list of ApiOperations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `ApiOperation` are eligible for filtering: * `name` - The ApiOperation resource name. Allowed comparison operators: `=`. * `details.http_operation.path.path` - The http operation's complete path relative to server endpoint. Allowed comparison operators: `=`. * `details.http_operation.method` - The http operation method type. Allowed comparison operators: `=`. * `details.deprecated` - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `details.deprecated = True` - The ApiOperation is deprecated. * `details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The method of the http operation of the ApiOperation is _GET_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `details.http_operation.method = GET OR details.http_operation.method = POST`. - The http operation of the method of ApiOperation is _GET_ or _POST_. * `details.deprecated = True AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the ApiOperation is deprecated and the value of the user defined attribute of type string is _test_.
+ pageSize: integer, Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApiOperations` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListApiOperations method's response.
+ "apiOperations": [ # The operations corresponding to an API version.
+ { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
+ "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the operation was created.
+ "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
+ "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
+ "documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "httpOperation": { # The HTTP Operation. # The HTTP Operation.
+ "method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "description": "A String", # Optional. A short description for the path applicable to all operations.
+ "path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ },
+ },
+ },
+ "name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
+ "updateTime": "A String", # Output only. The time at which the operation was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.
+
+Args:
+ name: string, Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
+ "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the operation was created.
+ "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
+ "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
+ "documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "httpOperation": { # The HTTP Operation. # The HTTP Operation.
+ "method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "description": "A String", # Optional. A short description for the path applicable to all operations.
+ "path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ },
+ },
+ },
+ "name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
+ "updateTime": "A String", # Output only. The time at which the operation was last updated.
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
+ "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the operation was created.
+ "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
+ "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
+ "documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "httpOperation": { # The HTTP Operation. # The HTTP Operation.
+ "method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "description": "A String", # Optional. A short description for the path applicable to all operations.
+ "path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ },
+ },
+ },
+ "name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
+ "updateTime": "A String", # Output only. The time at which the operation was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.apis.versions.specs.html b/docs/dyn/apihub_v1.projects.locations.apis.versions.specs.html
new file mode 100644
index 0000000000..0dec86150e
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.apis.versions.specs.html
@@ -0,0 +1,1036 @@
+
+
+
+API hub API . projects . locations . apis . versions . specs
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, specId=None, x__xgafv=None)
+Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.
+
+Delete a spec. Deleting a spec will also delete the associated operations from the version.
+
+Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.
+
+ getContents(name, x__xgafv=None)
+Get spec contents.
+
+ lint(name, body=None, x__xgafv=None)
+Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List specs corresponding to a particular API resource.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, specId=None, x__xgafv=None)
+ Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.
+
+Args:
+ parent: string, Required. The parent resource for Spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+}
+
+ specId: string, Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete a spec. Deleting a spec will also delete the associated operations from the version.
+
+Args:
+ name: string, Required. The name of the spec to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.
+
+Args:
+ name: string, Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+}
+
+
+
+ getContents(name, x__xgafv=None)
+ Get spec contents.
+
+Args:
+ name: string, Required. The name of the spec whose contents need to be retrieved. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The spec contents.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+}
+
+
+
+ lint(name, body=None, x__xgafv=None)
+ Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.
+
+Args:
+ name: string, Required. The name of the spec to be linted. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The LintSpec method's request.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List specs corresponding to a particular API resource.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of specs. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
+ filter: string, Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `Spec` are eligible for filtering: * `display_name` - The display name of the Spec. Allowed comparison operators: `=`. * `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`. * `mime_type` - The MIME type of the Spec. Allowed comparison operators: `=`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_. * `spec_type.enum_values.values.display_name: \"Rest Display Name\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`. * `spec_type.enum_values.values.id: grpc-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the spec_type attribute is _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id` - The id of the allowed value associated with the spec_type attribute is _rest-id_ or _grpc-id_. * `spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_ and the id of the allowed value associated with the user defined attribute of type enum is _test_.
+ pageSize: integer, Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSpecs` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListSpecs method's response.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "specs": [ # The specs corresponding to an API Version.
+ { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.
+
+Args:
+ name: string, Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.attributes.html b/docs/dyn/apihub_v1.projects.locations.attributes.html
new file mode 100644
index 0000000000..fd80df4ed8
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.attributes.html
@@ -0,0 +1,338 @@
+
+
+
+API hub API . projects . locations . attributes
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, attributeId=None, body=None, x__xgafv=None)
+Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as `SYSTEM_DEFINED` and can be listed via ListAttributes method. Allowed values for the same can be updated via UpdateAttribute method.
+
+Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
+
+Get details about the attribute.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List all attributes.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update the attribute. The following fields in the Attribute resource can be updated: * display_name The display name can be updated for user defined attributes only. * description The description can be updated for user defined attributes only. * allowed_values To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * cardinality The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The update_mask should be used to specify the fields being updated.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, attributeId=None, body=None, x__xgafv=None)
+ Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as `SYSTEM_DEFINED` and can be listed via ListAttributes method. Allowed values for the same can be updated via UpdateAttribute method.
+
+Args:
+ parent: string, Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
+ "allowedValues": [ # Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ "cardinality": 42, # Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
+ "createTime": "A String", # Output only. The time at which the attribute was created.
+ "dataType": "A String", # Required. The type of the data of the attribute.
+ "definitionType": "A String", # Output only. The definition type of the attribute.
+ "description": "A String", # Optional. The description of the attribute.
+ "displayName": "A String", # Required. The display name of the attribute.
+ "mandatory": True or False, # Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
+ "name": "A String", # Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
+ "scope": "A String", # Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
+ "updateTime": "A String", # Output only. The time at which the attribute was last updated.
+}
+
+ attributeId: string, Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another attribute resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
+ "allowedValues": [ # Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ "cardinality": 42, # Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
+ "createTime": "A String", # Output only. The time at which the attribute was created.
+ "dataType": "A String", # Required. The type of the data of the attribute.
+ "definitionType": "A String", # Output only. The definition type of the attribute.
+ "description": "A String", # Optional. The description of the attribute.
+ "displayName": "A String", # Required. The display name of the attribute.
+ "mandatory": True or False, # Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
+ "name": "A String", # Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
+ "scope": "A String", # Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
+ "updateTime": "A String", # Output only. The time at which the attribute was last updated.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
+
+Args:
+ name: string, Required. The name of the attribute to delete. Format: `projects/{project}/locations/{location}/attributes/{attribute}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get details about the attribute.
+
+Args:
+ name: string, Required. The name of the attribute to retrieve. Format: `projects/{project}/locations/{location}/attributes/{attribute}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
+ "allowedValues": [ # Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ "cardinality": 42, # Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
+ "createTime": "A String", # Output only. The time at which the attribute was created.
+ "dataType": "A String", # Required. The type of the data of the attribute.
+ "definitionType": "A String", # Output only. The definition type of the attribute.
+ "description": "A String", # Optional. The description of the attribute.
+ "displayName": "A String", # Required. The display name of the attribute.
+ "mandatory": True or False, # Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
+ "name": "A String", # Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
+ "scope": "A String", # Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
+ "updateTime": "A String", # Output only. The time at which the attribute was last updated.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List all attributes.
+
+Args:
+ parent: string, Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}` (required)
+ filter: string, Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Attribute` are eligible for filtering: * `display_name` - The display name of the Attribute. Allowed comparison operators: `=`. * `definition_type` - The definition type of the attribute. Allowed comparison operators: `=`. * `scope` - The scope of the attribute. Allowed comparison operators: `=`. * `data_type` - The type of the data of the attribute. Allowed comparison operators: `=`. * `mandatory` - Denotes whether the attribute is mandatory or not. Allowed comparison operators: `=`. * `create_time` - The time at which the Attribute was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `display_name = production` - - The display name of the attribute is _production_. * `(display_name = production) AND (create_time < \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\")` - The display name of the attribute is _production_ and the attribute was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `display_name = production OR scope = api` - The attribute where the display name is _production_ or the scope is _api_.
+ pageSize: integer, Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListAttributes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAttributes` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListAttributes method's response.
+ "attributes": [ # The list of all attributes.
+ { # An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
+ "allowedValues": [ # Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ "cardinality": 42, # Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
+ "createTime": "A String", # Output only. The time at which the attribute was created.
+ "dataType": "A String", # Required. The type of the data of the attribute.
+ "definitionType": "A String", # Output only. The definition type of the attribute.
+ "description": "A String", # Optional. The description of the attribute.
+ "displayName": "A String", # Required. The display name of the attribute.
+ "mandatory": True or False, # Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
+ "name": "A String", # Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
+ "scope": "A String", # Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
+ "updateTime": "A String", # Output only. The time at which the attribute was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update the attribute. The following fields in the Attribute resource can be updated: * display_name The display name can be updated for user defined attributes only. * description The description can be updated for user defined attributes only. * allowed_values To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * cardinality The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The update_mask should be used to specify the fields being updated.
+
+Args:
+ name: string, Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
+ "allowedValues": [ # Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ "cardinality": 42, # Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
+ "createTime": "A String", # Output only. The time at which the attribute was created.
+ "dataType": "A String", # Required. The type of the data of the attribute.
+ "definitionType": "A String", # Output only. The definition type of the attribute.
+ "description": "A String", # Optional. The description of the attribute.
+ "displayName": "A String", # Required. The display name of the attribute.
+ "mandatory": True or False, # Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
+ "name": "A String", # Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
+ "scope": "A String", # Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
+ "updateTime": "A String", # Output only. The time at which the attribute was last updated.
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
+ "allowedValues": [ # Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ "cardinality": 42, # Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
+ "createTime": "A String", # Output only. The time at which the attribute was created.
+ "dataType": "A String", # Required. The type of the data of the attribute.
+ "definitionType": "A String", # Output only. The definition type of the attribute.
+ "description": "A String", # Optional. The description of the attribute.
+ "displayName": "A String", # Required. The display name of the attribute.
+ "mandatory": True or False, # Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
+ "name": "A String", # Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
+ "scope": "A String", # Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
+ "updateTime": "A String", # Output only. The time at which the attribute was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.curations.html b/docs/dyn/apihub_v1.projects.locations.curations.html
new file mode 100644
index 0000000000..026881166d
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.curations.html
@@ -0,0 +1,350 @@
+
+
+
+API hub API . projects . locations . curations
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, curationId=None, x__xgafv=None)
+Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.
+
+Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.
+
+Get curation resource details.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List curation resources in the API hub.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, curationId=None, x__xgafv=None)
+ Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.
+
+Args:
+ parent: string, Required. The parent resource for the curation resource. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A curation resource in the API Hub.
+ "createTime": "A String", # Output only. The time at which the curation was created.
+ "description": "A String", # Optional. The description of the curation.
+ "displayName": "A String", # Required. The display name of the curation.
+ "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation.
+ "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation.
+ "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow.
+ "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute`
+ },
+ },
+ "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
+ "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation.
+ "lastExecutionState": "A String", # Output only. The last execution state of the curation.
+ "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
+ "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
+ { # The plugin instance and associated action that is using the curation.
+ "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
+ "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the curation was last updated.
+}
+
+ curationId: string, Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub. * If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A curation resource in the API Hub.
+ "createTime": "A String", # Output only. The time at which the curation was created.
+ "description": "A String", # Optional. The description of the curation.
+ "displayName": "A String", # Required. The display name of the curation.
+ "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation.
+ "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation.
+ "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow.
+ "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute`
+ },
+ },
+ "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
+ "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation.
+ "lastExecutionState": "A String", # Output only. The last execution state of the curation.
+ "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
+ "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
+ { # The plugin instance and associated action that is using the curation.
+ "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
+ "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the curation was last updated.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.
+
+Args:
+ name: string, Required. The name of the curation resource to delete. Format: `projects/{project}/locations/{location}/curations/{curation}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get curation resource details.
+
+Args:
+ name: string, Required. The name of the curation resource to retrieve. Format: `projects/{project}/locations/{location}/curations/{curation}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A curation resource in the API Hub.
+ "createTime": "A String", # Output only. The time at which the curation was created.
+ "description": "A String", # Optional. The description of the curation.
+ "displayName": "A String", # Required. The display name of the curation.
+ "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation.
+ "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation.
+ "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow.
+ "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute`
+ },
+ },
+ "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
+ "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation.
+ "lastExecutionState": "A String", # Output only. The last execution state of the curation.
+ "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
+ "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
+ { # The plugin instance and associated action that is using the curation.
+ "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
+ "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the curation was last updated.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List curation resources in the API hub.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of curation resources. Format: `projects/{project}/locations/{location}` (required)
+ filter: string, Optional. An expression that filters the list of curation resources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are case insensitive. The following fields in the `curation resource` are eligible for filtering: * `create_time` - The time at which the curation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the curation. Allowed comparison operators: `=`. * `state` - The state of the curation. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The curation resource was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_.
+ pageSize: integer, Optional. The maximum number of curation resources to return. The service may return fewer than this value. If unspecified, at most 50 curations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListCurations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListCurations` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListCurations method's response.
+ "curations": [ # The curation resources present in the API hub.
+ { # A curation resource in the API Hub.
+ "createTime": "A String", # Output only. The time at which the curation was created.
+ "description": "A String", # Optional. The description of the curation.
+ "displayName": "A String", # Required. The display name of the curation.
+ "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation.
+ "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation.
+ "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow.
+ "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute`
+ },
+ },
+ "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
+ "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation.
+ "lastExecutionState": "A String", # Output only. The last execution state of the curation.
+ "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
+ "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
+ { # The plugin instance and associated action that is using the curation.
+ "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
+ "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the curation was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated.
+
+Args:
+ name: string, Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A curation resource in the API Hub.
+ "createTime": "A String", # Output only. The time at which the curation was created.
+ "description": "A String", # Optional. The description of the curation.
+ "displayName": "A String", # Required. The display name of the curation.
+ "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation.
+ "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation.
+ "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow.
+ "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute`
+ },
+ },
+ "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
+ "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation.
+ "lastExecutionState": "A String", # Output only. The last execution state of the curation.
+ "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
+ "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
+ { # The plugin instance and associated action that is using the curation.
+ "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
+ "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the curation was last updated.
+}
+
+ updateMask: string, Optional. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A curation resource in the API Hub.
+ "createTime": "A String", # Output only. The time at which the curation was created.
+ "description": "A String", # Optional. The description of the curation.
+ "displayName": "A String", # Required. The display name of the curation.
+ "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation.
+ "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation.
+ "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow.
+ "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute`
+ },
+ },
+ "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed.
+ "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation.
+ "lastExecutionState": "A String", # Output only. The last execution state of the curation.
+ "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
+ "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance.
+ { # The plugin instance and associated action that is using the curation.
+ "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin.
+ "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the curation was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.dependencies.html b/docs/dyn/apihub_v1.projects.locations.dependencies.html
new file mode 100644
index 0000000000..444aaa6acc
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.dependencies.html
@@ -0,0 +1,530 @@
+
+
+
+API hub API . projects . locations . dependencies
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, dependencyId=None, x__xgafv=None)
+Create a dependency between two entities in the API hub.
+
+Delete the dependency resource.
+
+Get details about a dependency resource in the API hub.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List dependencies based on the provided filter and pagination parameters.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, dependencyId=None, x__xgafv=None)
+ Create a dependency between two entities in the API hub.
+
+Args:
+ parent: string, Required. The parent resource for the dependency resource. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
+ "attributes": { # Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "consumer": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the consumer in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "createTime": "A String", # Output only. The time at which the dependency was created.
+ "description": "A String", # Optional. Human readable description corresponding of the dependency.
+ "discoveryMode": "A String", # Output only. Discovery mode of the dependency.
+ "errorDetail": { # Details describing error condition of a dependency. # Output only. Error details of a dependency if the system has detected it internally.
+ "error": "A String", # Optional. Error in the dependency.
+ "errorTime": "A String", # Optional. Timestamp at which the error was found.
+ },
+ "name": "A String", # Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
+ "state": "A String", # Output only. State of the dependency.
+ "supplier": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the supplier in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "updateTime": "A String", # Output only. The time at which the dependency was last updated.
+}
+
+ dependencyId: string, Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are `a-z[0-9]-_`.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
+ "attributes": { # Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "consumer": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the consumer in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "createTime": "A String", # Output only. The time at which the dependency was created.
+ "description": "A String", # Optional. Human readable description corresponding of the dependency.
+ "discoveryMode": "A String", # Output only. Discovery mode of the dependency.
+ "errorDetail": { # Details describing error condition of a dependency. # Output only. Error details of a dependency if the system has detected it internally.
+ "error": "A String", # Optional. Error in the dependency.
+ "errorTime": "A String", # Optional. Timestamp at which the error was found.
+ },
+ "name": "A String", # Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
+ "state": "A String", # Output only. State of the dependency.
+ "supplier": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the supplier in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "updateTime": "A String", # Output only. The time at which the dependency was last updated.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete the dependency resource.
+
+Args:
+ name: string, Required. The name of the dependency resource to delete. Format: `projects/{project}/locations/{location}/dependencies/{dependency}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get details about a dependency resource in the API hub.
+
+Args:
+ name: string, Required. The name of the dependency resource to retrieve. Format: `projects/{project}/locations/{location}/dependencies/{dependency}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
+ "attributes": { # Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "consumer": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the consumer in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "createTime": "A String", # Output only. The time at which the dependency was created.
+ "description": "A String", # Optional. Human readable description corresponding of the dependency.
+ "discoveryMode": "A String", # Output only. Discovery mode of the dependency.
+ "errorDetail": { # Details describing error condition of a dependency. # Output only. Error details of a dependency if the system has detected it internally.
+ "error": "A String", # Optional. Error in the dependency.
+ "errorTime": "A String", # Optional. Timestamp at which the error was found.
+ },
+ "name": "A String", # Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
+ "state": "A String", # Output only. State of the dependency.
+ "supplier": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the supplier in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "updateTime": "A String", # Output only. The time at which the dependency was last updated.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List dependencies based on the provided filter and pagination parameters.
+
+Args:
+ parent: string, Required. The parent which owns this collection of dependency resources. Format: `projects/{project}/locations/{location}` (required)
+ filter: string, Optional. An expression that filters the list of Dependencies. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is `=`. Filters are not case sensitive. The following fields in the `Dependency` are eligible for filtering: * `consumer.operation_resource_name` - The operation resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `consumer.external_api_resource_name` - The external api resource name for the consumer entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.operation_resource_name` - The operation resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. * `supplier.external_api_resource_name` - The external api resource name for the supplier entity involved in a dependency. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. For example, `consumer.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR supplier.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\"` - The dependencies with either consumer or supplier operation resource name as _projects/p1/locations/global/apis/a1/versions/v1/operations/o1_.
+ pageSize: integer, Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListDependencies` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDependencies` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListDependencies method's response.
+ "dependencies": [ # The dependency resources present in the API hub.
+ { # A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
+ "attributes": { # Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "consumer": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the consumer in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "createTime": "A String", # Output only. The time at which the dependency was created.
+ "description": "A String", # Optional. Human readable description corresponding of the dependency.
+ "discoveryMode": "A String", # Output only. Discovery mode of the dependency.
+ "errorDetail": { # Details describing error condition of a dependency. # Output only. Error details of a dependency if the system has detected it internally.
+ "error": "A String", # Optional. Error in the dependency.
+ "errorTime": "A String", # Optional. Timestamp at which the error was found.
+ },
+ "name": "A String", # Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
+ "state": "A String", # Output only. State of the dependency.
+ "supplier": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the supplier in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "updateTime": "A String", # Output only. The time at which the dependency was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update a dependency based on the update_mask provided in the request. The following fields in the dependency can be updated: * description
+
+Args:
+ name: string, Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
+ "attributes": { # Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "consumer": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the consumer in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "createTime": "A String", # Output only. The time at which the dependency was created.
+ "description": "A String", # Optional. Human readable description corresponding of the dependency.
+ "discoveryMode": "A String", # Output only. Discovery mode of the dependency.
+ "errorDetail": { # Details describing error condition of a dependency. # Output only. Error details of a dependency if the system has detected it internally.
+ "error": "A String", # Optional. Error in the dependency.
+ "errorTime": "A String", # Optional. Timestamp at which the error was found.
+ },
+ "name": "A String", # Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
+ "state": "A String", # Output only. State of the dependency.
+ "supplier": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the supplier in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "updateTime": "A String", # Output only. The time at which the dependency was last updated.
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
+ "attributes": { # Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "consumer": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the consumer in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "createTime": "A String", # Output only. The time at which the dependency was created.
+ "description": "A String", # Optional. Human readable description corresponding of the dependency.
+ "discoveryMode": "A String", # Output only. Discovery mode of the dependency.
+ "errorDetail": { # Details describing error condition of a dependency. # Output only. Error details of a dependency if the system has detected it internally.
+ "error": "A String", # Optional. Error in the dependency.
+ "errorTime": "A String", # Optional. Timestamp at which the error was found.
+ },
+ "name": "A String", # Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
+ "state": "A String", # Output only. State of the dependency.
+ "supplier": { # Reference to an entity participating in a dependency. # Required. Immutable. The entity acting as the supplier in the dependency.
+ "displayName": "A String", # Output only. Display name of the entity.
+ "externalApiResourceName": "A String", # The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
+ "operationResourceName": "A String", # The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ },
+ "updateTime": "A String", # Output only. The time at which the dependency was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.deployments.html b/docs/dyn/apihub_v1.projects.locations.deployments.html
new file mode 100644
index 0000000000..35df955740
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.deployments.html
@@ -0,0 +1,1076 @@
+
+
+
+API hub API . projects . locations . deployments
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, deploymentId=None, x__xgafv=None)
+Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
+
+Delete a deployment resource in the API hub.
+
+Get details about a deployment and the API versions linked to it.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List deployment resources in the API hub.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment * attributes The update_mask should be used to specify the fields being updated.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, deploymentId=None, x__xgafv=None)
+ Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
+
+Args:
+ parent: string, Required. The parent resource for the deployment resource. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+}
+
+ deploymentId: string, Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another deployment resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete a deployment resource in the API hub.
+
+Args:
+ name: string, Required. The name of the deployment resource to delete. Format: `projects/{project}/locations/{location}/deployments/{deployment}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get details about a deployment and the API versions linked to it.
+
+Args:
+ name: string, Required. The name of the deployment resource to retrieve. Format: `projects/{project}/locations/{location}/deployments/{deployment}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List deployment resources in the API hub.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of deployment resources. Format: `projects/{project}/locations/{location}` (required)
+ filter: string, Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Deployments` are eligible for filtering: * `display_name` - The display name of the Deployment. Allowed comparison operators: `=`. * `create_time` - The time at which the Deployment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `resource_uri` - A URI to the deployment resource. Allowed comparison operators: `=`. * `api_versions` - The API versions linked to this deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.id` - The allowed value id of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `deployment_type.enum_values.values.display_name` - The allowed value display name of the deployment_type attribute associated with the Deployment. Allowed comparison operators: `:`. * `slo.string_values.values` -The allowed string value of the slo attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.id` - The allowed value id of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `environment.enum_values.values.display_name` - The allowed value display name of the environment attribute associated with the deployment. Allowed comparison operators: `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `environment.enum_values.values.id: staging-id` - The allowed value id of the environment attribute associated with the Deployment is _staging-id_. * `environment.enum_values.values.display_name: \"Staging Deployment\"` - The allowed value display name of the environment attribute associated with the Deployment is `Staging Deployment`. * `environment.enum_values.values.id: production-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The allowed value id of the environment attribute associated with the Deployment is _production-id_ and Deployment was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `environment.enum_values.values.id: production-id OR slo.string_values.values: \"99.99%\"` - The allowed value id of the environment attribute Deployment is _production-id_ or string value of the slo attribute is _99.99%_. * `environment.enum_values.values.id: staging-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test` - The filter string specifies that the allowed value id of the environment attribute associated with the Deployment is _staging-id_ and the value of the user defined attribute of type string is _test_.
+ pageSize: integer, Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListDeployments` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListDeployments method's response.
+ "deployments": [ # The deployment resources present in the API hub.
+ { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment * attributes The update_mask should be used to specify the fields being updated.
+
+Args:
+ name: string, Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.externalApis.html b/docs/dyn/apihub_v1.projects.locations.externalApis.html
new file mode 100644
index 0000000000..ee89681153
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.externalApis.html
@@ -0,0 +1,493 @@
+
+
+
+API hub API . projects . locations . externalApis
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, externalApiId=None, x__xgafv=None)
+Create an External API resource in the API hub.
+
+Delete an External API resource in the API hub.
+
+Get details about an External API resource in the API hub.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+List External API resources in the API hub.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Update an External API resource in the API hub. The following fields can be updated: * display_name * description * documentation * endpoints * paths The update_mask should be used to specify the fields being updated.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, externalApiId=None, x__xgafv=None)
+ Create an External API resource in the API hub.
+
+Args:
+ parent: string, Required. The parent resource for the External API resource. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
+ "displayName": "A String", # Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
+ "documentation": { # Documentation details. # Optional. Documentation of the external API.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Optional. List of endpoints on which this API is accessible.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
+ "paths": [ # Optional. List of paths served by this API.
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+ externalApiId: string, Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
+ "displayName": "A String", # Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
+ "documentation": { # Documentation details. # Optional. Documentation of the external API.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Optional. List of endpoints on which this API is accessible.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
+ "paths": [ # Optional. List of paths served by this API.
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete an External API resource in the API hub.
+
+Args:
+ name: string, Required. The name of the External API resource to delete. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get details about an External API resource in the API hub.
+
+Args:
+ name: string, Required. The name of the External API resource to retrieve. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
+ "displayName": "A String", # Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
+ "documentation": { # Documentation details. # Optional. Documentation of the external API.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Optional. List of endpoints on which this API is accessible.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
+ "paths": [ # Optional. List of paths served by this API.
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ List External API resources in the API hub.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of External API resources. Format: `projects/{project}/locations/{location}` (required)
+ pageSize: integer, Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListExternalApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListExternalApis` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListExternalApis method's response.
+ "externalApis": [ # The External API resources present in the API hub.
+ { # An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
+ "displayName": "A String", # Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
+ "documentation": { # Documentation details. # Optional. Documentation of the external API.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Optional. List of endpoints on which this API is accessible.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
+ "paths": [ # Optional. List of paths served by this API.
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. Last update timestamp.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update an External API resource in the API hub. The following fields can be updated: * display_name * description * documentation * endpoints * paths The update_mask should be used to specify the fields being updated.
+
+Args:
+ name: string, Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
+ "displayName": "A String", # Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
+ "documentation": { # Documentation details. # Optional. Documentation of the external API.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Optional. List of endpoints on which this API is accessible.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
+ "paths": [ # Optional. List of paths served by this API.
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+ updateMask: string, Required. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. Creation timestamp.
+ "description": "A String", # Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
+ "displayName": "A String", # Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
+ "documentation": { # Documentation details. # Optional. Documentation of the external API.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Optional. List of endpoints on which this API is accessible.
+ "A String",
+ ],
+ "name": "A String", # Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
+ "paths": [ # Optional. List of paths served by this API.
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. Last update timestamp.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.hostProjectRegistrations.html b/docs/dyn/apihub_v1.projects.locations.hostProjectRegistrations.html
new file mode 100644
index 0000000000..98517b3af8
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.hostProjectRegistrations.html
@@ -0,0 +1,194 @@
+
+
+
+API hub API . projects . locations . hostProjectRegistrations
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, hostProjectRegistrationId=None, x__xgafv=None)
+Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.
+
+Get a host project registration.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists host project registrations.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, hostProjectRegistrationId=None, x__xgafv=None)
+ Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.
+
+Args:
+ parent: string, Required. The parent resource for the host project. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.
+ "createTime": "A String", # Output only. The time at which the host project registration was created.
+ "gcpProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+ "name": "A String", # Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
+}
+
+ hostProjectRegistrationId: string, Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.
+ "createTime": "A String", # Output only. The time at which the host project registration was created.
+ "gcpProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+ "name": "A String", # Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get a host project registration.
+
+Args:
+ name: string, Required. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.
+ "createTime": "A String", # Output only. The time at which the host project registration was created.
+ "gcpProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+ "name": "A String", # Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists host project registrations.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of host projects. Format: `projects/*/locations/*` (required)
+ filter: string, Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `HostProjectRegistration` are eligible for filtering: * `name` - The name of the HostProjectRegistration. * `create_time` - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `gcp_project` - The Google cloud project associated with the HostProjectRegistration.
+ orderBy: string, Optional. Hint for how to order the results.
+ pageSize: integer, Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListHostProjectRegistrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListHostProjectRegistrations` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListHostProjectRegistrations method's response.
+ "hostProjectRegistrations": [ # The list of host project registrations.
+ { # Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.
+ "createTime": "A String", # Output only. The time at which the host project registration was created.
+ "gcpProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+ "name": "A String", # Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html
new file mode 100644
index 0000000000..28e37ddf0e
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.html
@@ -0,0 +1,1900 @@
+
+
+
+API hub API . projects . locations
+Instance Methods
+
+Returns the apiHubInstances Resource.
+
+
+ apis()
+
+Returns the apis Resource.
+
+
+ attributes()
+
+Returns the attributes Resource.
+
+
+ curations()
+
+Returns the curations Resource.
+
+
+ dependencies()
+
+Returns the dependencies Resource.
+
+
+ deployments()
+
+Returns the deployments Resource.
+
+
+ externalApis()
+
+Returns the externalApis Resource.
+
+
+ hostProjectRegistrations()
+
+Returns the hostProjectRegistrations Resource.
+
+
+ operations()
+
+Returns the operations Resource.
+
+
+ plugins()
+
+Returns the plugins Resource.
+
+
+ runtimeProjectAttachments()
+
+Returns the runtimeProjectAttachments Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ collectApiData(location, body=None, x__xgafv=None)
+Collect API data from a source and push it to Hub's collect layer.
+
+Gets information about a location.
+
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists information about the supported locations for this service.
+
+Retrieves the next page of results.
+
+ lookupRuntimeProjectAttachment(name, x__xgafv=None)
+Look up a runtime project attachment. This API can be called in the context of any project.
+
+ searchResources(location, body=None, x__xgafv=None)
+Search across API-Hub resources.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ collectApiData(location, body=None, x__xgafv=None)
+ Collect API data from a source and push it to Hub's collect layer.
+
+Args:
+ location: string, Required. The regional location of the API hub instance and its resources. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The CollectApiData method's request.
+ "actionId": "A String", # Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin.
+ "apiData": { # The API data to be collected. # Required. The API data to be collected.
+ "apiMetadataList": { # The message to hold repeated API metadata. # Optional. The list of API metadata.
+ "apiMetadata": [ # Required. The list of API metadata.
+ { # The API metadata.
+ "api": { # An API resource in the API Hub. # Required. The API resource to be pushed to Hub's collect layer. The ID of the API resource will be generated by Hub to ensure uniqueness across all APIs across systems.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+ },
+ "originalCreateTime": "A String", # Optional. Timestamp indicating when the API was created at the source.
+ "originalId": "A String", # Optional. The unique identifier of the API in the system where it was originally created.
+ "originalUpdateTime": "A String", # Required. Timestamp indicating when the API was last updated at the source.
+ "versions": [ # Optional. The list of versions present in an API resource.
+ { # The metadata associated with a version of the API resource.
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc.)
+ { # The metadata associated with a deployment.
+ "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+ },
+ "originalCreateTime": "A String", # Optional. Timestamp indicating when the deployment was created at the source.
+ "originalId": "A String", # Optional. The unique identifier of the deployment in the system where it was originally created.
+ "originalUpdateTime": "A String", # Required. Timestamp indicating when the deployment was last updated at the source.
+ },
+ ],
+ "originalCreateTime": "A String", # Optional. Timestamp indicating when the version was created at the source.
+ "originalId": "A String", # Optional. The unique identifier of the version in the system where it was originally created.
+ "originalUpdateTime": "A String", # Required. Timestamp indicating when the version was last updated at the source.
+ "specs": [ # Optional. The specs associated with this version. Note that an API version can be associated with multiple specs.
+ { # The metadata associated with a spec of the API version.
+ "originalCreateTime": "A String", # Optional. Timestamp indicating when the spec was created at the source.
+ "originalId": "A String", # Optional. The unique identifier of the spec in the system where it was originally created.
+ "originalUpdateTime": "A String", # Required. Timestamp indicating when the spec was last updated at the source.
+ "spec": { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. # Required. The spec resource to be pushed to Hub's collect layer. The ID of the spec will be generated by Hub.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+ },
+ },
+ ],
+ "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # Required. Represents a version of the API resource in API hub. The ID of the version will be generated by Hub.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+ },
+ },
+ ],
+ },
+ ],
+ },
+ },
+ "collectionType": "A String", # Required. The type of collection. Applies to all entries in api_data.
+ "pluginInstance": "A String", # Required. The plugin instance collecting the API data. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets information about a location.
+
+Args:
+ name: string, Resource name for the location. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A resource that represents a Google Cloud location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+
+
+ list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists information about the supported locations for this service.
+
+Args:
+ name: string, The resource that owns the locations collection, if applicable. (required)
+ extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
+ filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+ pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Locations.ListLocations.
+ "locations": [ # A list of locations that matches the specified filter in the request.
+ { # A resource that represents a Google Cloud location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ lookupRuntimeProjectAttachment(name, x__xgafv=None)
+ Look up a runtime project attachment. This API can be called in the context of any project.
+
+Args:
+ name: string, Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: `projects/{project}/locations/{location}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListRuntimeProjectAttachments method's response.
+ "runtimeProjectAttachment": { # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments. # Runtime project attachment for a project if exists, empty otherwise.
+ "createTime": "A String", # Output only. Create time.
+ "name": "A String", # Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
+ "runtimeProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+ },
+}
+
+
+
+ searchResources(location, body=None, x__xgafv=None)
+ Search across API-Hub resources.
+
+Args:
+ location: string, Required. The resource name of the location which will be of the type `projects/{project_id}/locations/{location_id}`. This field is used to identify the instance of API-Hub in which resources should be searched. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SearchResources method's request.
+ "filter": "A String", # Optional. An expression that filters the list of search results. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`. Filters are not case sensitive. The following field names are eligible for filtering: * `resource_type` - The type of resource in the search results. Must be one of the following: `Api`, `ApiOperation`, `Deployment`, `Definition`, `Spec` or `Version`. This field can only be specified once in the filter. Here are is an example: * `resource_type = Api` - The resource_type is _Api_.
+ "pageSize": 42, # Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then `INVALID_ARGUMENT` error is returned. The maximum value is 25; values above 25 will be coerced to 25. While paginating, you can specify a new page size parameter for each page of search results to be listed.
+ "pageToken": "A String", # Optional. A page token, received from a previous SearchResources call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the `page_token` parameter and all the other parameters except page_size should be specified with the same value which was used in the previous call. If the other fields are set with a different value than the previous call then `INVALID_ARGUMENT` error is returned.
+ "query": "A String", # Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for the SearchResources method.
+ "nextPageToken": "A String", # Pass this token in the SearchResourcesRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.
+ "searchResults": [ # List of search results according to the filter and search query specified. The order of search results represents the ranking.
+ { # Represents the search results.
+ "resource": { # ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub. # This represents the ApiHubResource. Note: Only selected fields of the resources are populated in response.
+ "api": { # An API resource in the API Hub. # This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results.
+ "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the API resource was created.
+ "description": "A String", # Optional. The description of the API resource.
+ "displayName": "A String", # Required. The display name of the API resource.
+ "documentation": { # Documentation details. # Optional. The documentation for the API resource.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+ "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
+ "owner": { # Owner details. # Optional. Owner details for the API resource.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the API resource was last updated.
+ "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "A String",
+ ],
+ },
+ "definition": { # Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only `schema` object is supported. # This represents Definition resource in search results. Only name field is populated in search results.
+ "attributes": { # Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the definition was created.
+ "name": "A String", # Identifier. The name of the definition. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "schema": { # The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the `definitions` section for OpenAPI 2.0 version and in `components.schemas` section for OpenAPI 3.0 and 3.1 version. # Output only. The value of a schema definition.
+ "displayName": "A String", # Output only. The display name of the schema. This will map to the name of the schema in the spec.
+ "rawValue": "A String", # Output only. The raw value of the schema definition corresponding to the schema name in the spec.
+ },
+ "spec": "A String", # Output only. The name of the spec from where the definition was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "type": "A String", # Output only. The type of the definition.
+ "updateTime": "A String", # Output only. The time at which the definition was last updated.
+ },
+ "deployment": { # Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. # This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results.
+ "apiVersions": [ # Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the deployment was created.
+ "deploymentType": { # The attribute values associated with resource. # Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "description": "A String", # Optional. The description of the deployment.
+ "displayName": "A String", # Required. The display name of the deployment.
+ "documentation": { # Documentation details. # Optional. The documentation of the deployment.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "endpoints": [ # Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
+ "A String",
+ ],
+ "environment": { # The attribute values associated with resource. # Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
+ "resourceUri": "A String", # Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
+ "slo": { # The attribute values associated with resource. # Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the deployment.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "updateTime": "A String", # Output only. The time at which the deployment was last updated.
+ },
+ "operation": { # Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API. # This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results.
+ "attributes": { # Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the operation was created.
+ "details": { # The operation details parsed from the spec. # Optional. Operation details. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "deprecated": True or False, # Optional. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
+ "description": "A String", # Optional. Description of the operation behavior. For OpenAPI spec, this will map to `operation.description` in the spec, in case description is empty, `operation.summary` will be used.
+ "documentation": { # Documentation details. # Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "httpOperation": { # The HTTP Operation. # The HTTP Operation.
+ "method": "A String", # Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "path": { # The path details derived from the spec. # Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ "description": "A String", # Optional. A short description for the path applicable to all operations.
+ "path": "A String", # Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.
+ },
+ },
+ },
+ "name": "A String", # Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API operation.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "spec": "A String", # Output only. The name of the spec will be of the format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` Note:The name of the spec will be empty if the operation is created via CreateApiOperation API.
+ "updateTime": "A String", # Output only. The time at which the operation was last updated.
+ },
+ "spec": { # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. # This represents Spec resource in search results. Only name, display_name, description, spec_type and documentation fields are populated in search results.
+ "attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
+ "contents": "A String", # Required. The contents of the spec.
+ "mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
+ },
+ "createTime": "A String", # Output only. The time at which the spec was created.
+ "details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
+ "description": "A String", # Output only. The description of the spec.
+ "openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
+ "format": "A String", # Output only. The format of the spec.
+ "owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
+ "displayName": "A String", # Optional. The name of the owner.
+ "email": "A String", # Required. The email of the owner.
+ },
+ "version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
+ },
+ },
+ "displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
+ "documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
+ "createTime": "A String", # Required. Timestamp when the linting response was generated.
+ "issues": [ # Optional. Array of issues found in the analyzed document.
+ { # Issue contains the details of a single issue found by the linter.
+ "code": "A String", # Required. Rule code unique to each rule defined in linter.
+ "message": "A String", # Required. Human-readable message describing the issue found by the linter.
+ "path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
+ "A String",
+ ],
+ "range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
+ "end": { # Point within the file (line and character). # Required. End of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ "start": { # Point within the file (line and character). # Required. Start of the issue.
+ "character": 42, # Required. Character position within the line (zero-indexed).
+ "line": 42, # Required. Line number (zero-indexed).
+ },
+ },
+ "severity": "A String", # Required. Severity level of the rule violation.
+ },
+ ],
+ "linter": "A String", # Required. Name of the linter used.
+ "source": "A String", # Required. Name of the linting application.
+ "state": "A String", # Required. Lint state represents success or failure for linting.
+ "summary": [ # Optional. Summary of all issue types and counts for each severity level.
+ { # Count of issues with a given severity.
+ "count": 42, # Required. Count of issues with the given severity.
+ "severity": "A String", # Required. Severity of the issue.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
+ "specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time at which the spec was last updated.
+ },
+ "version": { # Represents a version of the API resource in API hub. This is also referred to as the API version. # This represents Version resource in search results. Only name, display_name, description, lifecycle, compliance and accreditation fields are populated in search results.
+ "accreditation": { # The attribute values associated with resource. # Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "apiOperations": [ # Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
+ "A String",
+ ],
+ "attributes": { # Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
+ "a_key": { # The attribute values associated with resource.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ },
+ "compliance": { # The attribute values associated with resource. # Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "definitions": [ # Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
+ "A String",
+ ],
+ "deployments": [ # Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "A String",
+ ],
+ "description": "A String", # Optional. The description of the version.
+ "displayName": "A String", # Required. The display name of the version.
+ "documentation": { # Documentation details. # Optional. The documentation of the version.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "lifecycle": { # The attribute values associated with resource. # Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
+ "selectedDeployment": "A String", # Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`
+ "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the version.
+ { # SourceMetadata represents the metadata for a resource at the source.
+ "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
+ "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
+ "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
+ "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
+ "actionId": "A String", # Output only. The id of the plugin instance action.
+ "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ },
+ "sourceType": "A String", # Output only. The type of the source.
+ },
+ ],
+ "specs": [ # Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
+ "A String",
+ ],
+ "updateTime": "A String", # Output only. The time at which the version was last updated.
+ },
+ },
+ },
+ ],
+}
+
+
+
+ searchResources_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.operations.html b/docs/dyn/apihub_v1.projects.locations.operations.html
new file mode 100644
index 0000000000..7dc75fe371
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.operations.html
@@ -0,0 +1,235 @@
+
+
+
+API hub API . projects . locations . operations
+Instance Methods
+
+ cancel(name, body=None, x__xgafv=None)
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+ close()
+Close httplib2 connections.
+
+Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Retrieves the next page of results.
+Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.plugins.html b/docs/dyn/apihub_v1.projects.locations.plugins.html
new file mode 100644
index 0000000000..fa6e70c7f9
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.plugins.html
@@ -0,0 +1,848 @@
+
+
+
+API hub API . projects . locations . plugins
+Instance Methods
+
+ instances()
+
+Returns the instances Resource.
+
+
+ styleGuide()
+
+Returns the styleGuide Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, pluginId=None, x__xgafv=None)
+Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
+
+Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
+
+ disable(name, body=None, x__xgafv=None)
+Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
+
+ enable(name, body=None, x__xgafv=None)
+Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
+
+Get an API Hub plugin.
+
+ getStyleGuide(name, x__xgafv=None)
+Get the style guide being used for linting.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List all the plugins in a given project and location.
+
+Retrieves the next page of results.
+
+ updateStyleGuide(name, body=None, updateMask=None, x__xgafv=None)
+Update the styleGuide to be used for liniting in by API hub.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, pluginId=None, x__xgafv=None)
+ Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
+
+Args:
+ parent: string, Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A plugin resource in the API Hub.
+ "actionsConfig": [ # Optional. The configuration of actions supported by the plugin.
+ { # PluginActionConfig represents the configuration of an action supported by a plugin.
+ "description": "A String", # Required. The description of the operation performed by the action.
+ "displayName": "A String", # Required. The display name of the action.
+ "id": "A String", # Required. The id of the action.
+ "triggerMode": "A String", # Required. The trigger mode supported by the action.
+ },
+ ],
+ "configTemplate": { # ConfigTemplate represents the configuration template for a plugin. # Optional. The configuration template for the plugin.
+ "additionalConfigTemplate": [ # Optional. The list of additional configuration variables for the plugin's configuration.
+ { # ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
+ "description": "A String", # Optional. Description.
+ "enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "id": "A String", # Required. ID of the config variable. Must be unique within the configuration.
+ "multiSelectOptions": [ # Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
+ "validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Required. Type of the parameter: string, int, bool etc.
+ },
+ ],
+ "authConfigTemplate": { # AuthConfigTemplate represents the authentication template for a plugin. # Optional. The authentication template for the plugin.
+ "serviceAccount": { # Config for Google service account authentication. # Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "supportedAuthTypes": [ # Required. The list of authentication types supported by the plugin.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin was created.
+ "description": "A String", # Optional. The plugin description. Max length is 2000 characters (Unicode code points).
+ "displayName": "A String", # Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
+ "documentation": { # Documentation details. # Optional. The documentation of the plugin, that explains how to set up and use the plugin.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "hostingService": { # The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. # Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.
+ "serviceUri": "A String", # Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins.
+ },
+ "name": "A String", # Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
+ "ownershipType": "A String", # Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
+ "pluginCategory": "A String", # Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
+ "state": "A String", # Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.
+ "type": { # The attribute values associated with resource. # Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin was last updated.
+}
+
+ pluginId: string, Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/plugins/{plugin}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A plugin resource in the API Hub.
+ "actionsConfig": [ # Optional. The configuration of actions supported by the plugin.
+ { # PluginActionConfig represents the configuration of an action supported by a plugin.
+ "description": "A String", # Required. The description of the operation performed by the action.
+ "displayName": "A String", # Required. The display name of the action.
+ "id": "A String", # Required. The id of the action.
+ "triggerMode": "A String", # Required. The trigger mode supported by the action.
+ },
+ ],
+ "configTemplate": { # ConfigTemplate represents the configuration template for a plugin. # Optional. The configuration template for the plugin.
+ "additionalConfigTemplate": [ # Optional. The list of additional configuration variables for the plugin's configuration.
+ { # ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
+ "description": "A String", # Optional. Description.
+ "enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "id": "A String", # Required. ID of the config variable. Must be unique within the configuration.
+ "multiSelectOptions": [ # Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
+ "validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Required. Type of the parameter: string, int, bool etc.
+ },
+ ],
+ "authConfigTemplate": { # AuthConfigTemplate represents the authentication template for a plugin. # Optional. The authentication template for the plugin.
+ "serviceAccount": { # Config for Google service account authentication. # Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "supportedAuthTypes": [ # Required. The list of authentication types supported by the plugin.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin was created.
+ "description": "A String", # Optional. The plugin description. Max length is 2000 characters (Unicode code points).
+ "displayName": "A String", # Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
+ "documentation": { # Documentation details. # Optional. The documentation of the plugin, that explains how to set up and use the plugin.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "hostingService": { # The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. # Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.
+ "serviceUri": "A String", # Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins.
+ },
+ "name": "A String", # Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
+ "ownershipType": "A String", # Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
+ "pluginCategory": "A String", # Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
+ "state": "A String", # Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.
+ "type": { # The attribute values associated with resource. # Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin was last updated.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
+
+Args:
+ name: string, Required. The name of the Plugin resource to delete. Format: `projects/{project}/locations/{location}/plugins/{plugin}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ disable(name, body=None, x__xgafv=None)
+ Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
+
+Args:
+ name: string, Required. The name of the plugin to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The DisablePlugin method's request.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A plugin resource in the API Hub.
+ "actionsConfig": [ # Optional. The configuration of actions supported by the plugin.
+ { # PluginActionConfig represents the configuration of an action supported by a plugin.
+ "description": "A String", # Required. The description of the operation performed by the action.
+ "displayName": "A String", # Required. The display name of the action.
+ "id": "A String", # Required. The id of the action.
+ "triggerMode": "A String", # Required. The trigger mode supported by the action.
+ },
+ ],
+ "configTemplate": { # ConfigTemplate represents the configuration template for a plugin. # Optional. The configuration template for the plugin.
+ "additionalConfigTemplate": [ # Optional. The list of additional configuration variables for the plugin's configuration.
+ { # ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
+ "description": "A String", # Optional. Description.
+ "enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "id": "A String", # Required. ID of the config variable. Must be unique within the configuration.
+ "multiSelectOptions": [ # Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
+ "validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Required. Type of the parameter: string, int, bool etc.
+ },
+ ],
+ "authConfigTemplate": { # AuthConfigTemplate represents the authentication template for a plugin. # Optional. The authentication template for the plugin.
+ "serviceAccount": { # Config for Google service account authentication. # Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "supportedAuthTypes": [ # Required. The list of authentication types supported by the plugin.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin was created.
+ "description": "A String", # Optional. The plugin description. Max length is 2000 characters (Unicode code points).
+ "displayName": "A String", # Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
+ "documentation": { # Documentation details. # Optional. The documentation of the plugin, that explains how to set up and use the plugin.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "hostingService": { # The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. # Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.
+ "serviceUri": "A String", # Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins.
+ },
+ "name": "A String", # Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
+ "ownershipType": "A String", # Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
+ "pluginCategory": "A String", # Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
+ "state": "A String", # Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.
+ "type": { # The attribute values associated with resource. # Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin was last updated.
+}
+
+
+
+ enable(name, body=None, x__xgafv=None)
+ Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
+
+Args:
+ name: string, Required. The name of the plugin to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The EnablePlugin method's request.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A plugin resource in the API Hub.
+ "actionsConfig": [ # Optional. The configuration of actions supported by the plugin.
+ { # PluginActionConfig represents the configuration of an action supported by a plugin.
+ "description": "A String", # Required. The description of the operation performed by the action.
+ "displayName": "A String", # Required. The display name of the action.
+ "id": "A String", # Required. The id of the action.
+ "triggerMode": "A String", # Required. The trigger mode supported by the action.
+ },
+ ],
+ "configTemplate": { # ConfigTemplate represents the configuration template for a plugin. # Optional. The configuration template for the plugin.
+ "additionalConfigTemplate": [ # Optional. The list of additional configuration variables for the plugin's configuration.
+ { # ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
+ "description": "A String", # Optional. Description.
+ "enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "id": "A String", # Required. ID of the config variable. Must be unique within the configuration.
+ "multiSelectOptions": [ # Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
+ "validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Required. Type of the parameter: string, int, bool etc.
+ },
+ ],
+ "authConfigTemplate": { # AuthConfigTemplate represents the authentication template for a plugin. # Optional. The authentication template for the plugin.
+ "serviceAccount": { # Config for Google service account authentication. # Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "supportedAuthTypes": [ # Required. The list of authentication types supported by the plugin.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin was created.
+ "description": "A String", # Optional. The plugin description. Max length is 2000 characters (Unicode code points).
+ "displayName": "A String", # Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
+ "documentation": { # Documentation details. # Optional. The documentation of the plugin, that explains how to set up and use the plugin.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "hostingService": { # The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. # Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.
+ "serviceUri": "A String", # Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins.
+ },
+ "name": "A String", # Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
+ "ownershipType": "A String", # Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
+ "pluginCategory": "A String", # Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
+ "state": "A String", # Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.
+ "type": { # The attribute values associated with resource. # Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin was last updated.
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get an API Hub plugin.
+
+Args:
+ name: string, Required. The name of the plugin to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A plugin resource in the API Hub.
+ "actionsConfig": [ # Optional. The configuration of actions supported by the plugin.
+ { # PluginActionConfig represents the configuration of an action supported by a plugin.
+ "description": "A String", # Required. The description of the operation performed by the action.
+ "displayName": "A String", # Required. The display name of the action.
+ "id": "A String", # Required. The id of the action.
+ "triggerMode": "A String", # Required. The trigger mode supported by the action.
+ },
+ ],
+ "configTemplate": { # ConfigTemplate represents the configuration template for a plugin. # Optional. The configuration template for the plugin.
+ "additionalConfigTemplate": [ # Optional. The list of additional configuration variables for the plugin's configuration.
+ { # ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
+ "description": "A String", # Optional. Description.
+ "enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "id": "A String", # Required. ID of the config variable. Must be unique within the configuration.
+ "multiSelectOptions": [ # Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
+ "validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Required. Type of the parameter: string, int, bool etc.
+ },
+ ],
+ "authConfigTemplate": { # AuthConfigTemplate represents the authentication template for a plugin. # Optional. The authentication template for the plugin.
+ "serviceAccount": { # Config for Google service account authentication. # Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "supportedAuthTypes": [ # Required. The list of authentication types supported by the plugin.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin was created.
+ "description": "A String", # Optional. The plugin description. Max length is 2000 characters (Unicode code points).
+ "displayName": "A String", # Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
+ "documentation": { # Documentation details. # Optional. The documentation of the plugin, that explains how to set up and use the plugin.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "hostingService": { # The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. # Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.
+ "serviceUri": "A String", # Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins.
+ },
+ "name": "A String", # Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
+ "ownershipType": "A String", # Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
+ "pluginCategory": "A String", # Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
+ "state": "A String", # Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.
+ "type": { # The attribute values associated with resource. # Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin was last updated.
+}
+
+
+
+ getStyleGuide(name, x__xgafv=None)
+ Get the style guide being used for linting.
+
+Args:
+ name: string, Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a singleton style guide resource to be used for linting Open API specs.
+ "contents": { # The style guide contents. # Required. Input only. The contents of the uploaded style guide.
+ "contents": "A String", # Required. The contents of the style guide.
+ "mimeType": "A String", # Required. The mime type of the content.
+ },
+ "linter": "A String", # Required. Target linter for the style guide.
+ "name": "A String", # Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List all the plugins in a given project and location.
+
+Args:
+ parent: string, Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}`. (required)
+ filter: string, Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `Plugins` are eligible for filtering: * `plugin_category` - The category of the Plugin. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `plugin_category = ON_RAMP` - The plugin is of category on ramp.
+ pageSize: integer, Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListPlugins` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListPlugins` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListPlugins method's response.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "plugins": [ # The plugins from the specified parent resource.
+ { # A plugin resource in the API Hub.
+ "actionsConfig": [ # Optional. The configuration of actions supported by the plugin.
+ { # PluginActionConfig represents the configuration of an action supported by a plugin.
+ "description": "A String", # Required. The description of the operation performed by the action.
+ "displayName": "A String", # Required. The display name of the action.
+ "id": "A String", # Required. The id of the action.
+ "triggerMode": "A String", # Required. The trigger mode supported by the action.
+ },
+ ],
+ "configTemplate": { # ConfigTemplate represents the configuration template for a plugin. # Optional. The configuration template for the plugin.
+ "additionalConfigTemplate": [ # Optional. The list of additional configuration variables for the plugin's configuration.
+ { # ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
+ "description": "A String", # Optional. Description.
+ "enumOptions": [ # Optional. Enum options. To be populated if `ValueType` is `ENUM`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "id": "A String", # Required. ID of the config variable. Must be unique within the configuration.
+ "multiSelectOptions": [ # Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT`.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ "required": True or False, # Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
+ "validationRegex": "A String", # Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
+ "valueType": "A String", # Required. Type of the parameter: string, int, bool etc.
+ },
+ ],
+ "authConfigTemplate": { # AuthConfigTemplate represents the authentication template for a plugin. # Optional. The authentication template for the plugin.
+ "serviceAccount": { # Config for Google service account authentication. # Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "supportedAuthTypes": [ # Required. The list of authentication types supported by the plugin.
+ "A String",
+ ],
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin was created.
+ "description": "A String", # Optional. The plugin description. Max length is 2000 characters (Unicode code points).
+ "displayName": "A String", # Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
+ "documentation": { # Documentation details. # Optional. The documentation of the plugin, that explains how to set up and use the plugin.
+ "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
+ },
+ "hostingService": { # The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality. # Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI.
+ "serviceUri": "A String", # Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins.
+ },
+ "name": "A String", # Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
+ "ownershipType": "A String", # Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
+ "pluginCategory": "A String", # Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
+ "state": "A String", # Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.
+ "type": { # The attribute values associated with resource. # Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework.
+ "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
+ "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
+ "values": [ # Required. The attribute values in case attribute data type is enum.
+ { # The value that can be assigned to the attribute when the data type is enum.
+ "description": "A String", # Optional. The detailed description of the allowed value.
+ "displayName": "A String", # Required. The display name of the allowed value.
+ "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
+ "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
+ },
+ ],
+ },
+ "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
+ "values": [ # Required. The attribute values in case attribute data type is string or JSON.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin was last updated.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ updateStyleGuide(name, body=None, updateMask=None, x__xgafv=None)
+ Update the styleGuide to be used for liniting in by API hub.
+
+Args:
+ name: string, Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a singleton style guide resource to be used for linting Open API specs.
+ "contents": { # The style guide contents. # Required. Input only. The contents of the uploaded style guide.
+ "contents": "A String", # Required. The contents of the style guide.
+ "mimeType": "A String", # Required. The mime type of the content.
+ },
+ "linter": "A String", # Required. Target linter for the style guide.
+ "name": "A String", # Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`
+}
+
+ updateMask: string, Optional. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a singleton style guide resource to be used for linting Open API specs.
+ "contents": { # The style guide contents. # Required. Input only. The contents of the uploaded style guide.
+ "contents": "A String", # Required. The contents of the style guide.
+ "mimeType": "A String", # Required. The mime type of the content.
+ },
+ "linter": "A String", # Required. Target linter for the style guide.
+ "name": "A String", # Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.plugins.instances.html b/docs/dyn/apihub_v1.projects.locations.plugins.instances.html
new file mode 100644
index 0000000000..265dd74b59
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.plugins.instances.html
@@ -0,0 +1,640 @@
+
+
+
+API hub API . projects . locations . plugins . instances
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, pluginInstanceId=None, x__xgafv=None)
+Creates a Plugin instance in the API hub.
+
+Deletes a plugin instance in the API hub.
+
+ disableAction(name, body=None, x__xgafv=None)
+Disables a plugin instance in the API hub.
+
+ enableAction(name, body=None, x__xgafv=None)
+Enables a plugin instance in the API hub.
+
+ executeAction(name, body=None, x__xgafv=None)
+Executes a plugin instance in the API hub.
+
+Get an API Hub plugin instance.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+List all the plugins in a given project and location. `-` can be used as wildcard value for {plugin_id}
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, pluginInstanceId=None, x__xgafv=None)
+ Creates a Plugin instance in the API hub.
+
+Args:
+ parent: string, Required. The parent of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
+ "actions": [ # Required. The action status for the plugin instance.
+ { # PluginInstanceAction represents an action which can be executed in the plugin instance.
+ "actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
+ "curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
+ "curationType": "A String", # Required. The curation type for this plugin instance.
+ "customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
+ "curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
+ },
+ },
+ "hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
+ "currentExecutionState": "A String", # Output only. The current state of the execution.
+ "lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
+ "endTime": "A String", # Output only. The last execution end time of the plugin instance.
+ "errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
+ "result": "A String", # Output only. The result of the last execution of the plugin instance.
+ "startTime": "A String", # Output only. The last execution start time of the plugin instance.
+ },
+ },
+ "scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
+ "scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
+ "state": "A String", # Output only. The current state of the plugin action in the plugin instance.
+ },
+ ],
+ "additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
+ "a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
+ "boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
+ "enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ "intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
+ "key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
+ "multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
+ "values": [ # Optional. The config variable value of data type multi int.
+ 42,
+ ],
+ },
+ "multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
+ "values": [ # Optional. The config variable value of data type multi select.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ },
+ "multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
+ "values": [ # Optional. The config variable value of data type multi string.
+ "A String",
+ ],
+ },
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
+ },
+ },
+ "authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
+ "apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
+ "apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
+ "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+ },
+ "authType": "A String", # Required. The authentication type.
+ "googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
+ "clientId": "A String", # Required. The client identifier.
+ "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ },
+ "userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
+ "password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "username": "A String", # Required. Username.
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
+ "displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
+ "errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
+ "name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ "state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
+}
+
+ pluginInstanceId: string, Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes a plugin instance in the API hub.
+
+Args:
+ name: string, Required. The name of the plugin instance to delete. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ disableAction(name, body=None, x__xgafv=None)
+ Disables a plugin instance in the API hub.
+
+Args:
+ name: string, Required. The name of the plugin instance to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The DisablePluginInstanceAction method's request.
+ "actionId": "A String", # Required. The action id to disable.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ enableAction(name, body=None, x__xgafv=None)
+ Enables a plugin instance in the API hub.
+
+Args:
+ name: string, Required. The name of the plugin instance to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The EnablePluginInstanceAction method's request.
+ "actionId": "A String", # Required. The action id to enable.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ executeAction(name, body=None, x__xgafv=None)
+ Executes a plugin instance in the API hub.
+
+Args:
+ name: string, Required. The name of the plugin instance to execute. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The ExecutePluginInstanceAction method's request.
+ "actionExecutionDetail": { # The details for the action to execute. # Required. The execution details for the action to execute.
+ "actionId": "A String", # Required. The action id of the plugin to execute.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
+
+ get(name, x__xgafv=None)
+ Get an API Hub plugin instance.
+
+Args:
+ name: string, Required. The name of the plugin instance to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
+ "actions": [ # Required. The action status for the plugin instance.
+ { # PluginInstanceAction represents an action which can be executed in the plugin instance.
+ "actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
+ "curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
+ "curationType": "A String", # Required. The curation type for this plugin instance.
+ "customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
+ "curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
+ },
+ },
+ "hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
+ "currentExecutionState": "A String", # Output only. The current state of the execution.
+ "lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
+ "endTime": "A String", # Output only. The last execution end time of the plugin instance.
+ "errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
+ "result": "A String", # Output only. The result of the last execution of the plugin instance.
+ "startTime": "A String", # Output only. The last execution start time of the plugin instance.
+ },
+ },
+ "scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
+ "scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
+ "state": "A String", # Output only. The current state of the plugin action in the plugin instance.
+ },
+ ],
+ "additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
+ "a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
+ "boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
+ "enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ "intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
+ "key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
+ "multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
+ "values": [ # Optional. The config variable value of data type multi int.
+ 42,
+ ],
+ },
+ "multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
+ "values": [ # Optional. The config variable value of data type multi select.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ },
+ "multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
+ "values": [ # Optional. The config variable value of data type multi string.
+ "A String",
+ ],
+ },
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
+ },
+ },
+ "authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
+ "apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
+ "apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
+ "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+ },
+ "authType": "A String", # Required. The authentication type.
+ "googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
+ "clientId": "A String", # Required. The client identifier.
+ "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ },
+ "userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
+ "password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "username": "A String", # Required. Username.
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
+ "displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
+ "errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
+ "name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ "state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List all the plugins in a given project and location. `-` can be used as wildcard value for {plugin_id}
+
+Args:
+ parent: string, Required. The parent resource where this plugin will be created. Format: `projects/{project}/locations/{location}/plugins/{plugin}`. To list plugin instances for multiple plugins, use the - character instead of the plugin ID. (required)
+ filter: string, Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `PluginInstances` are eligible for filtering: * `state` - The state of the Plugin Instance. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `state = ENABLED` - The plugin instance is in enabled state.
+ pageSize: integer, Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListPluginInstances` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluginInstances` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListPluginInstances method's response.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "pluginInstances": [ # The plugin instances from the specified parent resource.
+ { # Represents a plugin instance resource in the API Hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
+ "actions": [ # Required. The action status for the plugin instance.
+ { # PluginInstanceAction represents an action which can be executed in the plugin instance.
+ "actionId": "A String", # Required. This should map to one of the action id specified in actions_config in the plugin.
+ "curationConfig": { # The curation information for this plugin instance. # Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
+ "curationType": "A String", # Required. The curation type for this plugin instance.
+ "customCuration": { # Custom curation information for this plugin instance. # Optional. Custom curation information for this plugin instance.
+ "curation": "A String", # Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`
+ },
+ },
+ "hubInstanceAction": { # The execution status for the plugin instance. # Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
+ "currentExecutionState": "A String", # Output only. The current state of the execution.
+ "lastExecution": { # The result of the last execution of the plugin instance. # Output only. The last execution of the plugin instance.
+ "endTime": "A String", # Output only. The last execution end time of the plugin instance.
+ "errorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution.
+ "result": "A String", # Output only. The result of the last execution of the plugin instance.
+ "startTime": "A String", # Output only. The last execution start time of the plugin instance.
+ },
+ },
+ "scheduleCronExpression": "A String", # Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
+ "scheduleTimeZone": "A String", # Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
+ "state": "A String", # Output only. The current state of the plugin action in the plugin instance.
+ },
+ ],
+ "additionalConfig": { # Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.
+ "a_key": { # ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
+ "boolValue": True or False, # Optional. The config variable value in case of config variable of type boolean.
+ "enumValue": { # ConfigValueOption represents an option for a config variable of type enum or multi select. # Optional. The config variable value in case of config variable of type enum.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ "intValue": "A String", # Optional. The config variable value in case of config variable of type integer.
+ "key": "A String", # Output only. Key will be the id to uniquely identify the config variable.
+ "multiIntValues": { # The config variable value of data type multi int. # Optional. The config variable value in case of config variable of type multi integer.
+ "values": [ # Optional. The config variable value of data type multi int.
+ 42,
+ ],
+ },
+ "multiSelectValues": { # The config variable value of data type multi select. # Optional. The config variable value in case of config variable of type multi select.
+ "values": [ # Optional. The config variable value of data type multi select.
+ { # ConfigValueOption represents an option for a config variable of type enum or multi select.
+ "description": "A String", # Optional. Description of the option.
+ "displayName": "A String", # Required. Display name of the option.
+ "id": "A String", # Required. Id of the option.
+ },
+ ],
+ },
+ "multiStringValues": { # The config variable value of data type multi string. # Optional. The config variable value in case of config variable of type multi string.
+ "values": [ # Optional. The config variable value of data type multi string.
+ "A String",
+ ],
+ },
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. The config variable value in case of config variable of type secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "stringValue": "A String", # Optional. The config variable value in case of config variable of type string.
+ },
+ },
+ "authConfig": { # AuthConfig represents the authentication information. # Optional. The authentication information for this plugin instance.
+ "apiKeyConfig": { # Config for authentication with API key. # Api Key Config.
+ "apiKey": { # Secret provides a reference to entries in Secret Manager. # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "httpElementLocation": "A String", # Required. The location of the API key. The default value is QUERY.
+ "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+ },
+ "authType": "A String", # Required. The authentication type.
+ "googleServiceAccountConfig": { # Config for Google service account authentication. # Google Service Account.
+ "serviceAccount": "A String", # Required. The service account to be used for authenticating request. The `iam.serviceAccounts.getAccessToken` permission should be granted on this service account to the impersonator service account.
+ },
+ "oauth2ClientCredentialsConfig": { # Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2.0 Client Credentials.
+ "clientId": "A String", # Required. The client identifier.
+ "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ },
+ "userPasswordConfig": { # Parameters to support Username and Password Authentication. # User Password.
+ "password": { # Secret provides a reference to entries in Secret Manager. # Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.
+ "secretVersion": "A String", # Required. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "username": "A String", # Required. Username.
+ },
+ },
+ "createTime": "A String", # Output only. Timestamp indicating when the plugin instance was created.
+ "displayName": "A String", # Required. The display name for this plugin instance. Max length is 255 characters.
+ "errorMessage": "A String", # Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.
+ "name": "A String", # Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
+ "state": "A String", # Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
+ "updateTime": "A String", # Output only. Timestamp indicating when the plugin instance was last updated.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.plugins.styleGuide.html b/docs/dyn/apihub_v1.projects.locations.plugins.styleGuide.html
new file mode 100644
index 0000000000..30896bb4a4
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.plugins.styleGuide.html
@@ -0,0 +1,109 @@
+
+
+
+API hub API . projects . locations . plugins . styleGuide
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ getContents(name, x__xgafv=None)
+Get the contents of the style guide.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ getContents(name, x__xgafv=None)
+ Get the contents of the style guide.
+
+Args:
+ name: string, Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The style guide contents.
+ "contents": "A String", # Required. The contents of the style guide.
+ "mimeType": "A String", # Required. The mime type of the content.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/apihub_v1.projects.locations.runtimeProjectAttachments.html b/docs/dyn/apihub_v1.projects.locations.runtimeProjectAttachments.html
new file mode 100644
index 0000000000..cc1457d085
--- /dev/null
+++ b/docs/dyn/apihub_v1.projects.locations.runtimeProjectAttachments.html
@@ -0,0 +1,215 @@
+
+
+
+API hub API . projects . locations . runtimeProjectAttachments
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, runtimeProjectAttachmentId=None, x__xgafv=None)
+Attaches a runtime project to the host project.
+
+Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.
+
+Gets a runtime project attachment.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+List runtime projects attached to the host project.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, runtimeProjectAttachmentId=None, x__xgafv=None)
+ Attaches a runtime project to the host project.
+
+Args:
+ parent: string, Required. The parent resource for the Runtime Project Attachment. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
+ "createTime": "A String", # Output only. Create time.
+ "name": "A String", # Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
+ "runtimeProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+}
+
+ runtimeProjectAttachmentId: string, Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
+ "createTime": "A String", # Output only. Create time.
+ "name": "A String", # Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
+ "runtimeProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.
+
+Args:
+ name: string, Required. The name of the Runtime Project Attachment to delete. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a runtime project attachment.
+
+Args:
+ name: string, Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
+ "createTime": "A String", # Output only. Create time.
+ "name": "A String", # Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
+ "runtimeProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List runtime projects attached to the host project.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of runtime project attachments. Format: `projects/{project}/locations/{location}` (required)
+ filter: string, Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `RuntimeProjectAttachment` are eligible for filtering: * `name` - The name of the RuntimeProjectAttachment. * `create_time` - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. * `runtime_project` - The Google cloud project associated with the RuntimeProjectAttachment.
+ orderBy: string, Optional. Hint for how to order the results.
+ pageSize: integer, Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListRuntimeProjectAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListRuntimeProjectAttachments` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The ListRuntimeProjectAttachments method's response.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "runtimeProjectAttachments": [ # List of runtime project attachments.
+ { # Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
+ "createTime": "A String", # Output only. Create time.
+ "name": "A String", # Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
+ "runtimeProject": "A String", # Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1.projects.locations.applications.domainMappings.html b/docs/dyn/appengine_v1.projects.locations.applications.domainMappings.html
new file mode 100644
index 0000000000..b8b26cf40e
--- /dev/null
+++ b/docs/dyn/appengine_v1.projects.locations.applications.domainMappings.html
@@ -0,0 +1,124 @@
+
+
+
+App Engine Admin API . projects . locations . applications . domainMappings
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)
+Gets the specified domain mapping.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(projectsId, locationsId, applicationsId, domainMappingsId, x__xgafv=None)
+ Gets the specified domain mapping.
+
+Args:
+ projectsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. (required)
+ locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ domainMappingsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A domain serving an App Engine application.
+ "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+ "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+ { # A DNS resource record.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+ "type": "A String", # Resource record type. Example: AAAA.
+ },
+ ],
+ "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+ "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
+ "pendingManagedCertificateId": "A String", # ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly
+ "sslManagementType": "A String", # SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1.projects.locations.applications.html b/docs/dyn/appengine_v1.projects.locations.applications.html
index 4745db824d..2635e648eb 100644
--- a/docs/dyn/appengine_v1.projects.locations.applications.html
+++ b/docs/dyn/appengine_v1.projects.locations.applications.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the authorizedDomains Resource.
+
+ domainMappings()
+
+Returns the domainMappings Resource.
+
diff --git a/docs/dyn/appengine_v1.projects.locations.applications.services.html b/docs/dyn/appengine_v1.projects.locations.applications.services.html
index 57fe9d4a23..150da95c79 100644
--- a/docs/dyn/appengine_v1.projects.locations.applications.services.html
+++ b/docs/dyn/appengine_v1.projects.locations.applications.services.html
@@ -85,6 +85,9 @@ Instance Methods
delete(projectsId, locationsId, applicationsId, servicesId, x__xgafv=None)
Deletes the specified service and all enclosed versions.
+
+Updates the configuration of the specified service.
Method Details
close()
@@ -129,4 +132,67 @@ Method Details
}
+
+ patch(projectsId, locationsId, applicationsId, servicesId, body=None, migrateTraffic=None, updateMask=None, x__xgafv=None)
+ Updates the configuration of the specified service.
+
+Args:
+ projectsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default. (required)
+ locationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ applicationsId: string, Part of `name`. See documentation of `projectsId`. (required)
+ servicesId: string, Part of `name`. See documentation of `projectsId`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
+ "generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly
+ "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
+ "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
+ "ingressTrafficAllowed": "A String", # The ingress settings for version or service.
+ },
+ "split": { # Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the service.
+ "allocations": { # Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
+ "a_key": 3.14,
+ },
+ "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
+ },
+}
+
+ migrateTraffic: boolean, Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
+ updateMask: string, Required. Standard field mask for the set of fields to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+ "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+