| <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="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.connections.html">connections</a> . <a href="connectors_v1.projects.locations.connections.eventSubscriptions.html">eventSubscriptions</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, eventSubscriptionId=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a new EventSubscription in a given project,location and connection.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes a single EventSubscription.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets details of a single EventSubscription.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">List EventSubscriptions in a given project,location and connection.</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">Updates the parameters of a single EventSubscription.</p> | |
| <p class="toc_element"> | |
| <code><a href="#retry">retry(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">RetryEventSubscription retries the registration of Subscription.</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, eventSubscriptionId=None, x__xgafv=None)</code> | |
| <pre>Creates a new EventSubscription in a given project,location and connection. | |
| Args: | |
| parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # represents the Connector's EventSubscription resource | |
| "createTime": "A String", # Output only. Created time. | |
| "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event | |
| "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event. | |
| "endpointUri": "A String", # The URI of the Endpoint. | |
| "headers": [ # List of Header to be added to the Endpoint. | |
| { # Header details for a given header to be added to Endpoint. | |
| "key": "A String", # Key of Header. | |
| "value": "A String", # Value of Header. | |
| }, | |
| ], | |
| }, | |
| "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow. | |
| "type": "A String", # type of the destination | |
| }, | |
| "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription. | |
| "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} | |
| "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource | |
| "description": "A String", # Output only. Description of the state. | |
| "state": "A String", # Output only. State of Event Subscription resource. | |
| }, | |
| "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription. | |
| "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription. | |
| "updateTime": "A String", # Output only. Updated time. | |
| } | |
| eventSubscriptionId: string, Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> | |
| <pre>Deletes a single EventSubscription. | |
| Args: | |
| name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*` (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(name, x__xgafv=None)</code> | |
| <pre>Gets details of a single EventSubscription. | |
| Args: | |
| name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # represents the Connector's EventSubscription resource | |
| "createTime": "A String", # Output only. Created time. | |
| "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event | |
| "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event. | |
| "endpointUri": "A String", # The URI of the Endpoint. | |
| "headers": [ # List of Header to be added to the Endpoint. | |
| { # Header details for a given header to be added to Endpoint. | |
| "key": "A String", # Key of Header. | |
| "value": "A String", # Value of Header. | |
| }, | |
| ], | |
| }, | |
| "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow. | |
| "type": "A String", # type of the destination | |
| }, | |
| "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription. | |
| "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} | |
| "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource | |
| "description": "A String", # Output only. Description of the state. | |
| "state": "A String", # Output only. State of Event Subscription resource. | |
| }, | |
| "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription. | |
| "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription. | |
| "updateTime": "A String", # Output only. Updated time. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>List EventSubscriptions in a given project,location and connection. | |
| Args: | |
| parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required) | |
| filter: string, Filter. https://g3doc.corp.google.com/cloud/control2/g3doc/dev/apihosting/list_filtering.md#filtering. | |
| orderBy: string, Order by parameters. | |
| pageSize: integer, Page size. | |
| pageToken: string, Page token. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response message for ConnectorsService.ListEventSubscriptions | |
| "eventSubscriptions": [ # Subscriptions. | |
| { # represents the Connector's EventSubscription resource | |
| "createTime": "A String", # Output only. Created time. | |
| "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event | |
| "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event. | |
| "endpointUri": "A String", # The URI of the Endpoint. | |
| "headers": [ # List of Header to be added to the Endpoint. | |
| { # Header details for a given header to be added to Endpoint. | |
| "key": "A String", # Key of Header. | |
| "value": "A String", # Value of Header. | |
| }, | |
| ], | |
| }, | |
| "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow. | |
| "type": "A String", # type of the destination | |
| }, | |
| "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription. | |
| "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} | |
| "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource | |
| "description": "A String", # Output only. Description of the state. | |
| "state": "A String", # Output only. State of Event Subscription resource. | |
| }, | |
| "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription. | |
| "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription. | |
| "updateTime": "A String", # Output only. Updated time. | |
| }, | |
| ], | |
| "nextPageToken": "A String", # Next page token. | |
| "unreachable": [ # Locations that could not be reached. | |
| "A String", | |
| ], | |
| }</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>Updates the parameters of a single EventSubscription. | |
| Args: | |
| name: string, Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # represents the Connector's EventSubscription resource | |
| "createTime": "A String", # Output only. Created time. | |
| "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event | |
| "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event. | |
| "endpointUri": "A String", # The URI of the Endpoint. | |
| "headers": [ # List of Header to be added to the Endpoint. | |
| { # Header details for a given header to be added to Endpoint. | |
| "key": "A String", # Key of Header. | |
| "value": "A String", # Value of Header. | |
| }, | |
| ], | |
| }, | |
| "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow. | |
| "type": "A String", # type of the destination | |
| }, | |
| "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription. | |
| "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} | |
| "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource | |
| "description": "A String", # Output only. Description of the state. | |
| "state": "A String", # Output only. State of Event Subscription resource. | |
| }, | |
| "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription. | |
| "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription. | |
| "updateTime": "A String", # Output only. Updated time. | |
| } | |
| updateMask: string, Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount` | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="retry">retry(name, body=None, x__xgafv=None)</code> | |
| <pre>RetryEventSubscription retries the registration of Subscription. | |
| Args: | |
| name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Request message for ConnectorsService.RefreshEventSubscription | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # This resource represents a long-running operation that is the result of a network API call. | |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. | |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. | |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. | |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. | |
| { | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| ], | |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. | |
| }, | |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | |
| "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | |
| "a_key": "", # Properties of the object. Contains field @type with type URL. | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |