| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="apihub_v1.html">API hub API</a> . <a href="apihub_v1.projects.html">projects</a> . <a href="apihub_v1.projects.locations.html">locations</a> . <a href="apihub_v1.projects.locations.deployments.html">deployments</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, deploymentId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a deployment resource in the API hub.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get details about a deployment and the API versions linked to it.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List deployment resources in the API hub.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">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 * source_project * source_environment * management_url * source_uri The update_mask should be used to specify the fields being updated.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, deploymentId=None, x__xgafv=None)</code> |
| <pre>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", |
| ], |
| }, |
| }, |
| "managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 that uniquely identfies the deployment within a particular gateway. For example, if the runtime resource is of type APIGEE_PROXY, then this field will be a combination of org, proxy name and environment. |
| "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", |
| ], |
| }, |
| }, |
| "sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. |
| "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. |
| }, |
| ], |
| "sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. |
| "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 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", |
| ], |
| }, |
| }, |
| "managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 that uniquely identfies the deployment within a particular gateway. For example, if the runtime resource is of type APIGEE_PROXY, then this field will be a combination of org, proxy name and environment. |
| "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", |
| ], |
| }, |
| }, |
| "sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. |
| "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. |
| }, |
| ], |
| "sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. |
| "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 deployment was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>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", |
| ], |
| }, |
| }, |
| "managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 that uniquely identfies the deployment within a particular gateway. For example, if the runtime resource is of type APIGEE_PROXY, then this field will be a combination of org, proxy name and environment. |
| "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", |
| ], |
| }, |
| }, |
| "sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. |
| "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. |
| }, |
| ], |
| "sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. |
| "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 deployment was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>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. A filter function is also supported in the filter string. The filter function is `id(name)`. The `id(name)` function returns the id of the resource name. For example, `id(name) = \"deployment-1\"` is equivalent to `name = \"projects/test-project-id/locations/test-location-id/deployments/deployment-1\"` provided the parent is `projects/test-project-id/locations/test-location-id`. 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", |
| ], |
| }, |
| }, |
| "managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 that uniquely identfies the deployment within a particular gateway. For example, if the runtime resource is of type APIGEE_PROXY, then this field will be a combination of org, proxy name and environment. |
| "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", |
| ], |
| }, |
| }, |
| "sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. |
| "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. |
| }, |
| ], |
| "sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. |
| "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>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 * source_project * source_environment * management_url * source_uri 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", |
| ], |
| }, |
| }, |
| "managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 that uniquely identfies the deployment within a particular gateway. For example, if the runtime resource is of type APIGEE_PROXY, then this field will be a combination of org, proxy name and environment. |
| "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", |
| ], |
| }, |
| }, |
| "sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. |
| "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. |
| }, |
| ], |
| "sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. |
| "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 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", |
| ], |
| }, |
| }, |
| "managementUrl": { # The attribute values associated with resource. # Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 that uniquely identfies the deployment within a particular gateway. For example, if the runtime resource is of type APIGEE_PROXY, then this field will be a combination of org, proxy name and environment. |
| "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", |
| ], |
| }, |
| }, |
| "sourceEnvironment": "A String", # Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. |
| "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. |
| }, |
| ], |
| "sourceProject": "A String", # Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. |
| "sourceUri": { # The attribute values associated with resource. # Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. |
| "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 deployment was last updated. |
| }</pre> |
| </div> |
| |
| </body></html> |
