| <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="cloudsupport_v2.html">Google Cloud Support API</a> . <a href="cloudsupport_v2.supportEventSubscriptions.html">supportEventSubscriptions</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, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a support event subscription for an organization.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Soft deletes a support event subscription.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a support event subscription.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists support event subscriptions.</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 a support event subscription.</p> |
| <p class="toc_element"> |
| <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Undeletes a support event 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, x__xgafv=None)</code> |
| <pre>Creates a support event subscription for an organization. |
| |
| Args: |
| parent: string, Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Soft deletes a support event subscription. |
| |
| Args: |
| name: string, Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a support event subscription. |
| |
| Args: |
| name: string, Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code> |
| <pre>Lists support event subscriptions. |
| |
| Args: |
| parent: string, Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id} (required) |
| filter: string, Optional. Filter expression based on AIP-160. Supported fields: - pub_sub_topic - state Examples: - `pub_sub_topic="projects/example-project/topics/example-topic"` - `state=WORKING` - `pub_sub_topic="projects/example-project/topics/example-topic" AND state=WORKING` |
| pageSize: integer, Optional. The maximum number of support event subscriptions to return. |
| pageToken: string, Optional. A token identifying the page of results to return. If unspecified, the first page is retrieved. When paginating, all other parameters provided to `ListSupportEventSubscriptions` must match the call that provided the page token. |
| showDeleted: boolean, Optional. Whether to show deleted subscriptions. By default, deleted subscriptions are not returned. |
| 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 ListSupportEventSubscriptions. |
| "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. |
| "supportEventSubscriptions": [ # The support event subscriptions. |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| }, |
| ], |
| }</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 a support event subscription. |
| |
| Args: |
| name: string, Identifier. The resource name of the support event subscription. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| } |
| |
| updateMask: string, Optional. The list of fields to update. The only supported value is pub_sub_topic. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code> |
| <pre>Undeletes a support event subscription. |
| |
| Args: |
| name: string, Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for UndeleteSupportEventSubscription. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A support event subscription. |
| "createTime": "A String", # Output only. The time at which the subscription was created. |
| "deleteTime": "A String", # Output only. The time at which the subscription was deleted. |
| "failureReason": "A String", # Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. |
| "name": "A String", # Identifier. The resource name of the support event subscription. |
| "pubSubTopic": "A String", # Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic} |
| "purgeTime": "A String", # Output only. The time at which the subscription will be purged. |
| "state": "A String", # Output only. The state of the subscription. |
| "updateTime": "A String", # Output only. The time at which the subscription was last updated. |
| }</pre> |
| </div> |
| |
| </body></html> |
