| <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.apis.html">apis</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="apihub_v1.projects.locations.apis.versions.html">versions()</a></code> |
| </p> |
| <p class="firstline">Returns the versions Resource.</p> |
| |
| <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, apiId=None, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create an API resource in the API hub. Once an API resource is created, versions can be added to it.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get API resource details including the API versions contained in 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 API 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 an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.</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, apiId=None, body=None, x__xgafv=None)</code> |
| <pre>Create an API resource in the API hub. Once an API resource is created, versions can be added to it. |
| |
| Args: |
| parent: string, Required. The parent resource for the API resource. Format: `projects/{project}/locations/{location}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # An API resource in the API Hub. |
| "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which the API resource was created. |
| "description": "A String", # Optional. The description of the API resource. |
| "displayName": "A String", # Required. The display name of the API resource. |
| "documentation": { # Documentation details. # Optional. The documentation for the API resource. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "fingerprint": "A String", # Optional. Fingerprint of the API resource. |
| "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` |
| "owner": { # Owner details. # Optional. Owner details for the API resource. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the API resource was last updated. |
| "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "A String", |
| ], |
| } |
| |
| apiId: string, Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An API resource in the API Hub. |
| "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which the API resource was created. |
| "description": "A String", # Optional. The description of the API resource. |
| "displayName": "A String", # Required. The display name of the API resource. |
| "documentation": { # Documentation details. # Optional. The documentation for the API resource. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "fingerprint": "A String", # Optional. Fingerprint of the API resource. |
| "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` |
| "owner": { # Owner details. # Optional. Owner details for the API resource. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the API resource was last updated. |
| "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> |
| <pre>Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted. |
| |
| Args: |
| name: string, Required. The name of the API resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}` (required) |
| force: boolean, Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get API resource details including the API versions contained in it. |
| |
| Args: |
| name: string, Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An API resource in the API Hub. |
| "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which the API resource was created. |
| "description": "A String", # Optional. The description of the API resource. |
| "displayName": "A String", # Required. The display name of the API resource. |
| "documentation": { # Documentation details. # Optional. The documentation for the API resource. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "fingerprint": "A String", # Optional. Fingerprint of the API resource. |
| "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` |
| "owner": { # Owner details. # Optional. Owner details for the API resource. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the API resource was last updated. |
| "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List API resources in the API hub. |
| |
| Args: |
| parent: string, Required. The parent, which owns this collection of API resources. Format: `projects/{project}/locations/{location}` (required) |
| filter: string, Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `ApiResource` are eligible for filtering: * `owner.email` - The email of the team which owns the ApiResource. Allowed comparison operators: `=`. * `create_time` - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the ApiResource. Allowed comparison operators: `=`. * `target_user.enum_values.values.id` - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `target_user.enum_values.values.display_name` - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.id` - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `team.enum_values.values.display_name` - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.id` - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `business_unit.enum_values.values.display_name` - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.id` - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `maturity_level.enum_values.values.display_name` - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.id` - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `api_style.enum_values.values.display_name` - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is `:`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. 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) = \"api-1\"` is equivalent to `name = \"projects/test-project-id/locations/test-location-id/apis/api-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: * `owner.email = \"[email protected]\"` - - The owner team email is [email protected]_. * `owner.email = \"[email protected]\" AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The owner team email is [email protected]_ and the api was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `owner.email = \"[email protected]\" OR team.enum_values.values.id: apihub-team-id` - The filter string specifies the APIs where the owner team email is [email protected]_ or the id of the allowed value associated with the team attribute is _apihub-team-id_. * `owner.email = \"[email protected]\" OR team.enum_values.values.display_name: ApiHub Team` - The filter string specifies the APIs where the owner team email is [email protected]_ or the display name of the allowed value associated with the team attribute is `ApiHub Team`. * `owner.email = \"[email protected]\" AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test_enum_id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values: test_string_value` - The filter string specifies the APIs where the owner team email is [email protected]_ and the id of the allowed value associated with the user defined attribute of type enum is _test_enum_id_ and the value of the user defined attribute of type string is _test_.. |
| pageSize: integer, Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| pageToken: string, Optional. A page token, received from a previous `ListApis` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListApis` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The ListApis method's response. |
| "apis": [ # The API resources present in the API hub. |
| { # An API resource in the API Hub. |
| "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which the API resource was created. |
| "description": "A String", # Optional. The description of the API resource. |
| "displayName": "A String", # Required. The display name of the API resource. |
| "documentation": { # Documentation details. # Optional. The documentation for the API resource. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "fingerprint": "A String", # Optional. Fingerprint of the API resource. |
| "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` |
| "owner": { # Owner details. # Optional. Owner details for the API resource. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the API resource was last updated. |
| "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "A String", |
| ], |
| }, |
| ], |
| "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| }</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 an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields. |
| |
| Args: |
| name: string, Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # An API resource in the API Hub. |
| "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which the API resource was created. |
| "description": "A String", # Optional. The description of the API resource. |
| "displayName": "A String", # Required. The display name of the API resource. |
| "documentation": { # Documentation details. # Optional. The documentation for the API resource. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "fingerprint": "A String", # Optional. Fingerprint of the API resource. |
| "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` |
| "owner": { # Owner details. # Optional. Owner details for the API resource. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the API resource was last updated. |
| "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "A String", |
| ], |
| } |
| |
| updateMask: string, Required. The list of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An API resource in the API Hub. |
| "apiFunctionalRequirements": { # The attribute values associated with resource. # Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-functional-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiRequirements": { # The attribute values associated with resource. # Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiStyle": { # The attribute values associated with resource. # Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "apiTechnicalRequirements": { # The attribute values associated with resource. # Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-technical-requirements` attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "attributes": { # Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. |
| "a_key": { # The attribute values associated with resource. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| }, |
| "businessUnit": { # The attribute values associated with resource. # Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "createTime": "A String", # Output only. The time at which the API resource was created. |
| "description": "A String", # Optional. The description of the API resource. |
| "displayName": "A String", # Required. The display name of the API resource. |
| "documentation": { # Documentation details. # Optional. The documentation for the API resource. |
| "externalUri": "A String", # Optional. The uri of the externally hosted documentation. |
| }, |
| "fingerprint": "A String", # Optional. Fingerprint of the API resource. |
| "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "name": "A String", # Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` |
| "owner": { # Owner details. # Optional. Owner details for the API resource. |
| "displayName": "A String", # Optional. The name of the owner. |
| "email": "A String", # Required. The email of the owner. |
| }, |
| "selectedVersion": "A String", # Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the API resource. |
| { # SourceMetadata represents the metadata for a resource at the source. |
| "originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source. |
| "originalResourceId": "A String", # Output only. The unique identifier of the resource at the source. |
| "originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source. |
| "pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action. |
| "actionId": "A String", # Output only. The id of the plugin instance action. |
| "pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| "sourceType": "A String", # Output only. The type of the source. |
| }, |
| ], |
| "targetUser": { # The attribute values associated with resource. # Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "team": { # The attribute values associated with resource. # Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. |
| "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
| "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. |
| "values": [ # Required. The attribute values in case attribute data type is enum. |
| { # The value that can be assigned to the attribute when the data type is enum. |
| "description": "A String", # Optional. The detailed description of the allowed value. |
| "displayName": "A String", # Required. The display name of the allowed value. |
| "id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/. |
| "immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
| }, |
| ], |
| }, |
| "jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| "uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
| "values": [ # Required. The attribute values in case attribute data type is string or JSON. |
| "A String", |
| ], |
| }, |
| }, |
| "updateTime": "A String", # Output only. The time at which the API resource was last updated. |
| "versions": [ # Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}` |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
