support_event_subscriptions

Creates, updates, deletes, gets or lists a support_event_subscriptions resource.

Overview

Name	support_event_subscriptions
Type	Resource
Id	google.cloudsupport.support_event_subscriptions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the support event subscription.
createTime	string (google-datetime)	Output only. The time at which the subscription was created.
deleteTime	string (google-datetime)	Output only. The time at which the subscription was deleted.
failureReason	string	Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. (FAILURE_REASON_UNSPECIFIED, PERMISSION_DENIED, TOPIC_NOT_FOUND, OTHER)
pubSubTopic	string	Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
purgeTime	string (google-datetime)	Output only. The time at which the subscription will be purged.
state	string	Output only. The state of the subscription. (STATE_UNSPECIFIED, WORKING, FAILING, DELETED)
updateTime	string (google-datetime)	Output only. The time at which the subscription was last updated.

list

Name	Datatype	Description
name	string	Identifier. The resource name of the support event subscription.
createTime	string (google-datetime)	Output only. The time at which the subscription was created.
deleteTime	string (google-datetime)	Output only. The time at which the subscription was deleted.
failureReason	string	Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value. (FAILURE_REASON_UNSPECIFIED, PERMISSION_DENIED, TOPIC_NOT_FOUND, OTHER)
pubSubTopic	string	Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}
purgeTime	string (google-datetime)	Output only. The time at which the subscription will be purged.
state	string	Output only. The state of the subscription. (STATE_UNSPECIFIED, WORKING, FAILING, DELETED)
updateTime	string (google-datetime)	Output only. The time at which the subscription was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	organizationsId, supportEventSubscriptionsId		Gets a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())
list	select	organizationsId	filter, pageSize, showDeleted, pageToken	Lists support event subscriptions. EXAMPLES: cURL: shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute())
create	insert	organizationsId		Creates a support event subscription for an organization. EXAMPLES: cURL: shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute())
patch	update	organizationsId, supportEventSubscriptionsId	updateMask	Updates a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute())
delete	delete	organizationsId, supportEventSubscriptionsId		Soft deletes a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())
undelete	exec	organizationsId, supportEventSubscriptionsId		Undeletes a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())
expunge	exec	organizationsId, supportEventSubscriptionsId		Expunges a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:expunge" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().expunge( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
organizationsId	string
supportEventSubscriptionsId	string
filter	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())

SELECT
name,
createTime,
deleteTime,
failureReason,
pubSubTopic,
purgeTime,
state,
updateTime
FROM google.cloudsupport.support_event_subscriptions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND supportEventSubscriptionsId = '{{ supportEventSubscriptionsId }}' -- required
;

list

Lists support event subscriptions. EXAMPLES: cURL: shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute())

SELECT
name,
createTime,
deleteTime,
failureReason,
pubSubTopic,
purgeTime,
state,
updateTime
FROM google.cloudsupport.support_event_subscriptions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND showDeleted = '{{ showDeleted }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a support event subscription for an organization. EXAMPLES: cURL: shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute())

INSERT INTO google.cloudsupport.support_event_subscriptions (
data__name,
data__pubSubTopic,
organizationsId
)
SELECT 
'{{ name }}',
'{{ pubSubTopic }}',
'{{ organizationsId }}'
RETURNING
name,
createTime,
deleteTime,
failureReason,
pubSubTopic,
purgeTime,
state,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: support_event_subscriptions
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the support_event_subscriptions resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The resource name of the support event subscription.
  - name: pubSubTopic
    value: "{{ pubSubTopic }}"
    description: |
      Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}

UPDATE examples

patch

Updates a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute())

UPDATE google.cloudsupport.support_event_subscriptions
SET 
data__name = '{{ name }}',
data__pubSubTopic = '{{ pubSubTopic }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND supportEventSubscriptionsId = '{{ supportEventSubscriptionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
deleteTime,
failureReason,
pubSubTopic,
purgeTime,
state,
updateTime;

DELETE examples

delete

Soft deletes a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())

DELETE FROM google.cloudsupport.support_event_subscriptions
WHERE organizationsId = '{{ organizationsId }}' --required
AND supportEventSubscriptionsId = '{{ supportEventSubscriptionsId }}' --required
;

Lifecycle Methods

undelete

Undeletes a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())

EXEC google.cloudsupport.support_event_subscriptions.undelete 
@organizationsId='{{ organizationsId }}' --required, 
@supportEventSubscriptionsId='{{ supportEventSubscriptionsId }}' --required
;

expunge

Expunges a support event subscription. EXAMPLES: cURL: shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:expunge" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().expunge( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute())

EXEC google.cloudsupport.support_event_subscriptions.expunge 
@organizationsId='{{ organizationsId }}' --required, 
@supportEventSubscriptionsId='{{ supportEventSubscriptionsId }}' --required
;