Google Cloud Support API (cloudsupport:v2)

▼ ▲ cloudsupport.organizations.supportEventSubscriptions.expunge

Parameters :

name

Pattern : ^organizations/[^/]+/supportEventSubscriptions/[^/]+$

Required : Yes

Description : Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

Location : path

Type : string

Flat Path : v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge

Scopes : https://www.googleapis.com/auth/cloud-platform

Path : v2/{+name}:expunge

HTTP Method : POST

Description : 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()) ```

Parameter Order : name

▼ ▲ cloudsupport.organizations.supportEventSubscriptions.undelete

Path : v2/{+name}:undelete

HTTP Method : POST

Description : 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()) ```

Parameter Order : name

Parameters :

name

Description : Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

Location : path

Type : string

Pattern : ^organizations/[^/]+/supportEventSubscriptions/[^/]+$

Required : Yes

Flat Path : v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete

Scopes : https://www.googleapis.com/auth/cloud-platform

▼ ▲ cloudsupport.organizations.supportEventSubscriptions.create

Flat Path : v2/organizations/{organizationsId}/supportEventSubscriptions

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

parent

Location : path

Type : string

Description : Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id}

Pattern : ^organizations/[^/]+$

Required : Yes

Description : 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()) ```

Parameter Order : parent

HTTP Method : POST

Path : v2/{+parent}/supportEventSubscriptions

▼ ▲ cloudsupport.organizations.supportEventSubscriptions.get

Flat Path : v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

name

Pattern : ^organizations/[^/]+/supportEventSubscriptions/[^/]+$

Required : Yes

Location : path

Type : string

Description : Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

Parameter Order : name

Description : 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()) ```

Path : v2/{+name}

HTTP Method : GET

▼ ▲ cloudsupport.organizations.supportEventSubscriptions.list

Parameters :

parent

Description : Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id}

Location : path

Type : string

Pattern : ^organizations/[^/]+$

Required : Yes

filter

Description : 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`

Location : query

Type : string

pageSize

Location : query

Type : integer

Description : Optional. The maximum number of support event subscriptions to return.

Format : int32

showDeleted

Location : query

Type : boolean

Description : Optional. Whether to show deleted subscriptions. By default, deleted subscriptions are not returned.

pageToken

Location : query

Type : string

Description : 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.

Flat Path : v2/organizations/{organizationsId}/supportEventSubscriptions

Scopes : https://www.googleapis.com/auth/cloud-platform

HTTP Method : GET

Path : v2/{+parent}/supportEventSubscriptions

Parameter Order : parent

Description : 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()) ```

▼ ▲ cloudsupport.organizations.supportEventSubscriptions.patch

HTTP Method : PATCH

Path : v2/{+name}

Description : 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()) ```

Parameter Order : name

Parameters :

name

Description : Identifier. The resource name of the support event subscription.

Location : path

Type : string

Pattern : ^organizations/[^/]+/supportEventSubscriptions/[^/]+$

Required : Yes

updateMask

Location : query

Type : string

Description : Optional. The list of fields to update. The only supported value is pub_sub_topic.

Format : google-fieldmask

Flat Path : v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}

Scopes : https://www.googleapis.com/auth/cloud-platform

▼ ▲ cloudsupport.organizations.supportEventSubscriptions.delete

Parameter Order : name

Description : 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()) ```

Path : v2/{+name}

HTTP Method : DELETE

Flat Path : v2/organizations/{organizationsId}/supportEventSubscriptions/{supportEventSubscriptionsId}

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

name

Pattern : ^organizations/[^/]+/supportEventSubscriptions/[^/]+$

Required : Yes

Location : path

Type : string

Description : Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

▼ ▲ cloudsupport.supportEventSubscriptions.list

Description : 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()) ```

Path : v2/{+parent}/supportEventSubscriptions

Parameters :

filter

Type : string

Description : 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`

Location : query

pageToken

Description : 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.

Location : query

Type : string

showDeleted

Type : boolean

Location : query

Description : Optional. Whether to show deleted subscriptions. By default, deleted subscriptions are not returned.

pageSize

Type : integer

Location : query

Description : Optional. The maximum number of support event subscriptions to return.

Format : int32

parent

Type : string

Pattern : ^[^/]+/[^/]+$

Required : Yes

Location : path

Description : Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id}

HTTP Method : GET

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameter Order : parent

Flat Path : v2/{v2Id}/{v2Id1}/supportEventSubscriptions

▼ ▲ cloudsupport.supportEventSubscriptions.undelete

Flat Path : v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete

Parameter Order : name

HTTP Method : POST

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

name

Pattern : ^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$

Type : string

Required : Yes

Description : Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

Location : path

Path : v2/{+name}:undelete

Description : 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()) ``` Undeletes a support event subscription.

▼ ▲ cloudsupport.supportEventSubscriptions.delete

Parameters :

name

Description : Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

Location : path

Pattern : ^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$

Type : string

Required : Yes

Path : v2/{+name}

Description : 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()) ```

Parameter Order : name

HTTP Method : DELETE

Scopes : https://www.googleapis.com/auth/cloud-platform

Flat Path : v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}

▼ ▲ cloudsupport.supportEventSubscriptions.expunge

Flat Path : v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge

Parameter Order : name

HTTP Method : POST

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

name

Required : Yes

Pattern : ^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$

Type : string

Description : Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

Location : path

Path : v2/{+name}:expunge

Description : Expunges a support event subscription.

▼ ▲ cloudsupport.supportEventSubscriptions.get

Parameter Order : name

HTTP Method : GET

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

name

Location : path

Description : Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}

Type : string

Pattern : ^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$

Required : Yes

Path : v2/{+name}

Description : 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()) ```

Flat Path : v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}

▼ ▲ cloudsupport.supportEventSubscriptions.patch

Parameter Order : name

HTTP Method : PATCH

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

name

Location : path

Description : Identifier. The resource name of the support event subscription.

Required : Yes

Type : string

Pattern : ^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$

updateMask

Type : string

Description : Optional. The list of fields to update. The only supported value is pub_sub_topic.

Format : google-fieldmask

Location : query

Description : 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()) ```

Path : v2/{+name}

Flat Path : v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}

▼ ▲ cloudsupport.supportEventSubscriptions.create

Flat Path : v2/{v2Id}/{v2Id1}/supportEventSubscriptions

Parameters :

parent

Required : Yes

Type : string

Pattern : ^[^/]+/[^/]+$

Location : path

Description : Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id}

Description : 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()) ```

Path : v2/{+parent}/supportEventSubscriptions

Parameter Order : parent

HTTP Method : POST

Scopes : https://www.googleapis.com/auth/cloud-platform