| <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.curations.html">curations</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, curationId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get curation resource details.</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 curation resources in the API hub.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, curationId=None, x__xgafv=None)</code> |
| <pre>Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it. |
| |
| Args: |
| parent: string, Required. The parent resource for the curation resource. Format: `projects/{project}/locations/{location}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A curation resource in the API Hub. |
| "createTime": "A String", # Output only. The time at which the curation was created. |
| "description": "A String", # Optional. The description of the curation. |
| "displayName": "A String", # Required. The display name of the curation. |
| "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation. |
| "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation. |
| "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow. |
| "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` |
| }, |
| }, |
| "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
| "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation. |
| "lastExecutionState": "A String", # Output only. The last execution state of the curation. |
| "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` |
| "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
| { # The plugin instance and associated action that is using the curation. |
| "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. |
| "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time at which the curation was last updated. |
| } |
| |
| curationId: string, Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub. * If not provided, a system generated ID will be used. This value should be 4-500 characters, and valid characters are /a-z[0-9]-_/. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A curation resource in the API Hub. |
| "createTime": "A String", # Output only. The time at which the curation was created. |
| "description": "A String", # Optional. The description of the curation. |
| "displayName": "A String", # Required. The display name of the curation. |
| "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation. |
| "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation. |
| "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow. |
| "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` |
| }, |
| }, |
| "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
| "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation. |
| "lastExecutionState": "A String", # Output only. The last execution state of the curation. |
| "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` |
| "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
| { # The plugin instance and associated action that is using the curation. |
| "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. |
| "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time at which the curation was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance. |
| |
| Args: |
| name: string, Required. The name of the curation resource to delete. Format: `projects/{project}/locations/{location}/curations/{curation}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get curation resource details. |
| |
| Args: |
| name: string, Required. The name of the curation resource to retrieve. Format: `projects/{project}/locations/{location}/curations/{curation}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A curation resource in the API Hub. |
| "createTime": "A String", # Output only. The time at which the curation was created. |
| "description": "A String", # Optional. The description of the curation. |
| "displayName": "A String", # Required. The display name of the curation. |
| "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation. |
| "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation. |
| "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow. |
| "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` |
| }, |
| }, |
| "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
| "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation. |
| "lastExecutionState": "A String", # Output only. The last execution state of the curation. |
| "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` |
| "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
| { # The plugin instance and associated action that is using the curation. |
| "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. |
| "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time at which the curation was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List curation resources in the API hub. |
| |
| Args: |
| parent: string, Required. The parent, which owns this collection of curation resources. Format: `projects/{project}/locations/{location}` (required) |
| filter: string, Optional. An expression that filters the list of curation resources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are case insensitive. The following fields in the `curation resource` are eligible for filtering: * `create_time` - The time at which the curation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `display_name` - The display name of the curation. Allowed comparison operators: `=`. * `state` - The state of the curation. Allowed comparison operators: `=`. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The curation resource was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. |
| pageSize: integer, Optional. The maximum number of curation resources to return. The service may return fewer than this value. If unspecified, at most 50 curations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| pageToken: string, Optional. A page token, received from a previous `ListCurations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListCurations` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The ListCurations method's response. |
| "curations": [ # The curation resources present in the API hub. |
| { # A curation resource in the API Hub. |
| "createTime": "A String", # Output only. The time at which the curation was created. |
| "description": "A String", # Optional. The description of the curation. |
| "displayName": "A String", # Required. The display name of the curation. |
| "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation. |
| "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation. |
| "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow. |
| "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` |
| }, |
| }, |
| "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
| "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation. |
| "lastExecutionState": "A String", # Output only. The last execution state of the curation. |
| "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` |
| "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
| { # The plugin instance and associated action that is using the curation. |
| "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. |
| "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time at which the curation was last updated. |
| }, |
| ], |
| "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update a curation resource in the API hub. The following fields in the curation can be updated: * display_name * description The update_mask should be used to specify the fields being updated. |
| |
| Args: |
| name: string, Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A curation resource in the API Hub. |
| "createTime": "A String", # Output only. The time at which the curation was created. |
| "description": "A String", # Optional. The description of the curation. |
| "displayName": "A String", # Required. The display name of the curation. |
| "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation. |
| "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation. |
| "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow. |
| "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` |
| }, |
| }, |
| "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
| "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation. |
| "lastExecutionState": "A String", # Output only. The last execution state of the curation. |
| "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` |
| "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
| { # The plugin instance and associated action that is using the curation. |
| "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. |
| "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time at which the curation was last updated. |
| } |
| |
| updateMask: string, Optional. The list of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A curation resource in the API Hub. |
| "createTime": "A String", # Output only. The time at which the curation was created. |
| "description": "A String", # Optional. The description of the curation. |
| "displayName": "A String", # Required. The display name of the curation. |
| "endpoint": { # The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing ApiMetadata. Response should contain curated data in the form of ApiMetadata. # Required. The endpoint to be triggered for curation. |
| "applicationIntegrationEndpointDetails": { # The details of the Application Integration endpoint to be triggered for curation. # Required. The details of the Application Integration endpoint to be triggered for curation. |
| "triggerId": "A String", # Required. The API trigger ID of the Application Integration workflow. |
| "uri": "A String", # Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: `https://integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` or `https://{location}-integrations.googleapis.com/v1/{name=projects/*/locations/*/integrations/*}:execute` |
| }, |
| }, |
| "lastExecutionErrorCode": "A String", # Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
| "lastExecutionErrorMessage": "A String", # Output only. Error message describing the failure, if any, during the last execution of the curation. |
| "lastExecutionState": "A String", # Output only. The last execution state of the curation. |
| "name": "A String", # Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}` |
| "pluginInstanceActions": [ # Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
| { # The plugin instance and associated action that is using the curation. |
| "actionId": "A String", # Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. |
| "pluginInstance": "A String", # Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` |
| }, |
| ], |
| "updateTime": "A String", # Output only. The time at which the curation was last updated. |
| }</pre> |
| </div> |
| |
| </body></html> |
