Class: Google::Apis::CloudsupportV2beta::CloudSupportService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/cloudsupport_v2beta/service.rb

Overview

Google Cloud Support API

Manages Google Cloud technical support cases for Customer Care support offerings.

Examples:

require 'google/apis/cloudsupport_v2beta'

Cloudsupport = Google::Apis::CloudsupportV2beta # Alias the module
service = Cloudsupport::CloudSupportService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://cloudsupport.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudSupportService

Returns a new instance of CloudSupportService.



48
49
50
51
52
53
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-cloudsupport_v2beta',
        client_version: Google::Apis::CloudsupportV2beta::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#close_case(name, close_case_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Case

Close a case. EXAMPLES: cURL: shell case="projects/some-project/cases/ 43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case: close" Python: python import googleapiclient.discovery api_version = " v2beta" supportApiService = googleapiclient.discovery.build( serviceName=" cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport. googleapis.com/$discovery/rest?version=`api_version`", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute())

Parameters:

  • name (String) —

    Required. The name of the case to close.

  • close_case_request_object (Google::Apis::CloudsupportV2beta::CloseCaseRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 140

def close_case(name, close_case_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+name}:close', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::CloseCaseRequest::Representation
  command.request_object = close_case_request_object
  command.response_representation = Google::Apis::CloudsupportV2beta::Case::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Case
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_case(parent, case_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Case

Create a new case and associate it with a parent. It must have the following fields set: display_name, description, classification, and priority. If you're just testing the API and don't want to route your case to an agent, set testCase=true. EXAMPLES: cURL: shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print- access-token)" \ --header 'Content-Type: application/json' \ --data '` " display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": ` "id": " 1BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" `, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", " bar@domain.com" ], "testCase": true, "priority": "P3" `' \ "https:// cloudsupport.googleapis.com/v2beta/$parent/cases" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version= api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$ discovery/rest?version=`api_version`", ) request = supportApiService.cases(). create( parent="projects/some-project", body=` "displayName": "A Test Case", " description": "This is a test case.", "testCase": True, "priority": "P2", " classification": ` "id": " 1BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" `, `, ) print(request.execute())

Parameters:

  • parent (String) —

    Required. The name of the parent under which the case should be created.

  • case_object (Google::Apis::CloudsupportV2beta::Case) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 193

def create_case(parent, case_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/cases', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::Case::Representation
  command.request_object = case_object
  command.response_representation = Google::Apis::CloudsupportV2beta::Case::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Case
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_case_comment(parent, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Comment

Add a new comment to a case. The comment must have the following fields set: body. EXAMPLES: cURL: shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print- access-token)" \ --header 'Content-Type: application/json' \ --data '` "body": "This is a test comment." `' \ "https://cloudsupport.googleapis.com/v2beta/$ case/comments" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https:// cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some- project/cases/43595344", body=`"body": "This is a test comment."`, ) ) print( request.execute())

Parameters:

  • parent (String) —

    Required. The name of the case to which the comment should be added.

  • comment_object (Google::Apis::CloudsupportV2beta::Comment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 643

def create_case_comment(parent, comment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/comments', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::CloudsupportV2beta::Comment::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Comment
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_support_event_subscription(parent, support_event_subscription_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::SupportEventSubscription

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/v2beta/$parent/ supportEventSubscriptions" Python: python import googleapiclient. discovery api_version = "v2beta" 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())

Parameters:

  • parent (String) —

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

  • support_event_subscription_object (Google::Apis::CloudsupportV2beta::SupportEventSubscription) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 878

def create_organization_support_event_subscription(parent, support_event_subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/supportEventSubscriptions', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::SupportEventSubscription::Representation
  command.request_object = support_event_subscription_object
  command.response_representation = Google::Apis::CloudsupportV2beta::SupportEventSubscription::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::SupportEventSubscription
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_support_event_subscription(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::SupportEventSubscription

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/v2beta/ $support_event_subscription" Python: python import googleapiclient. discovery api_version = "v2beta" 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())

Parameters:

  • name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



921
922
923
924
925
926
927
928
929
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 921

def delete_organization_support_event_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::SupportEventSubscription::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::SupportEventSubscription
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_medium(name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Media

Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ " https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport" , version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis. com/$discovery/rest?version=`api_version`", ) request = supportApiService. media().download( name="projects/some-project/cases/43595344/attachments/ 0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute())

Parameters:

  • name (String) —

    The name of the file attachment to download.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • download_dest (IO, String) (defaults to: nil) —

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 772

def download_medium(name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'v2beta/{+name}:download', options)
  else
    command = make_download_command(:get, 'v2beta/{+name}:download', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::CloudsupportV2beta::Media::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Media
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#escalate_case(name, escalate_case_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Case

Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: shell case="projects/some-project/cases/43595344" curl \ --request POST \ -- header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header " Content-Type: application/json" \ --data '` "escalation": ` "reason": " BUSINESS_IMPACT", "justification": "This is a test escalation." ` `' \ "https:/ /cloudsupport.googleapis.com/v2beta/$case:escalate" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version= api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$ discovery/rest?version=`api_version`", ) request = supportApiService.cases(). escalate( name="projects/some-project/cases/43595344", body=` "escalation": ` " reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", `, ` , ) print(request.execute())

Parameters:

  • name (String) —

    Required. The name of the case to be escalated.

  • escalate_case_request_object (Google::Apis::CloudsupportV2beta::EscalateCaseRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 241

def escalate_case(name, escalate_case_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+name}:escalate', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::EscalateCaseRequest::Representation
  command.request_object = escalate_case_request_object
  command.response_representation = Google::Apis::CloudsupportV2beta::Case::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Case
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#expunge_support_event_subscription(name, expunge_support_event_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Empty

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/v2beta/$ support_event_subscription:expunge" Python: python import googleapiclient.discovery api_version = "v2beta" 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:

  • name (String) —

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

  • expunge_support_event_subscription_request_object (Google::Apis::CloudsupportV2beta::ExpungeSupportEventSubscriptionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



963
964
965
966
967
968
969
970
971
972
973
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 963

def expunge_support_event_subscription(name, expunge_support_event_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+name}:expunge', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::ExpungeSupportEventSubscriptionRequest::Representation
  command.request_object = expunge_support_event_subscription_request_object
  command.response_representation = Google::Apis::CloudsupportV2beta::Empty::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_case(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Case

Retrieve a case. EXAMPLES: cURL: shell case="projects/some-project/cases/ 16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access- token)" \ "https://cloudsupport.googleapis.com/v2beta/$case" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport" , version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis. com/$discovery/rest?version=`api_version`", ) request = supportApiService. cases().get( name="projects/some-project/cases/43595344", ) print(request. execute())

Parameters:

  • name (String) —

    Required. The full name of a case to be retrieved.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



281
282
283
284
285
286
287
288
289
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 281

def get_case(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::Case::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Case
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_case_attachment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Attachment

Retrieve an attachment associated with a support case. EXAMPLES: cURL: shell attachment="projects/some-project/cases/23598314/attachments/ 0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print- access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$attachment" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport" , version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis. com/$discovery/rest?version=`api_version`", ) request = ( supportApiService. cases() .attachments() .get(name="projects/some-project/cases/43595344/ attachments/0684M00000P3h1fQAB") ) print(request.execute())

Parameters:

  • name (String) —

    Required. The name of the attachment to get.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



551
552
553
554
555
556
557
558
559
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 551

def get_case_attachment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::Attachment::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Attachment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_case_comment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Comment

Retrieve a comment. EXAMPLES: cURL: shell comment="projects/some-project/ cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $( gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/ $comment" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName=" cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport. googleapis.com/$discovery/rest?version=`api_version`", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/ 43595344/comments/234567890", ) print(request.execute())

Parameters:

  • name (String) —

    Required. The name of the comment to retrieve.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



683
684
685
686
687
688
689
690
691
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 683

def get_case_comment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::Comment::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Comment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_support_event_subscription(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::SupportEventSubscription

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/v2beta/$ support_event_subscription" Python: python import googleapiclient. discovery api_version = "v2beta" 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())

Parameters:

  • name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 1006

def get_organization_support_event_subscription(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+name}', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::SupportEventSubscription::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::SupportEventSubscription
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_case_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::ListAttachmentsResponse

List all the attachments associated with a support case. EXAMPLES: cURL: shell case="projects/some-project/cases/23598314" curl \ --header " Authorization: Bearer $(gcloud auth print-access-token)" \ "https:// cloudsupport.googleapis.com/v2beta/$case/attachments" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version= api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$ discovery/rest?version=`api_version`", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print( request.execute())

Parameters:

  • parent (String) —

    Required. The name of the case for which attachments should be listed.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100. The size of each page can be smaller than the requested page size and can include zero. For example, you could request 100 attachments on one page, receive 0, and then on the next page, receive 90.

  • page_token (String) (defaults to: nil) —

    A token identifying the page of results to return. If unspecified, the first page is retrieved.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 599

def list_case_attachments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/attachments', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::ListAttachmentsResponse::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::ListAttachmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_case_comments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::ListCommentsResponse

List all the comments associated with a case. EXAMPLES: cURL: shell case=" projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $( gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/ $case/comments" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https:// cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/ cases/43595344") ) print(request.execute())

Parameters:

  • parent (String) —

    Required. The name of the case for which to list comments.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of comments to fetch. Defaults to 10.

  • page_token (String) (defaults to: nil) —

    A token identifying the page of results to return. If unspecified, the first page is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 726

def list_case_comments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/comments', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::ListCommentsResponse::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::ListCommentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_cases(parent, filter: nil, page_size: nil, page_token: nil, product_line: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::ListCasesResponse

Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use cases.search. EXAMPLES: cURL: shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ " https://cloudsupport.googleapis.com/v2beta/$parent/cases" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport" , version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis. com/$discovery/rest?version=`api_version`", ) request = supportApiService. cases().list(parent="projects/some-project") print(request.execute())

Parameters:

  • parent (String) —

    Required. The name of a parent to list cases under.

  • filter (String) (defaults to: nil) —

    An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that match the filter. Expressions use the following fields separated by AND and specified with =:

    • state: Can be OPEN or CLOSED. - priority: Can be P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2. - creator.email: The email address of the case creator. EXAMPLES: - state=CLOSED - state=OPEN AND creator.email="tester@example.com" - state=OPEN AND (priority=P0 OR priority=P1)
  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of cases fetched with each request. Defaults to 10.

  • page_token (String) (defaults to: nil) —

    A token identifying the page of results to return. If unspecified, the first page is retrieved.

  • product_line (String) (defaults to: nil) —

    The product line to request cases for. If unspecified, only Google Cloud cases will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 339

def list_cases(parent, filter: nil, page_size: nil, page_token: nil, product_line: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/cases', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::ListCasesResponse::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::ListCasesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['productLine'] = product_line unless product_line.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_support_event_subscriptions(parent, filter: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::ListSupportEventSubscriptionsResponse

Lists support event subscriptions. EXAMPLES: cURL: shell parent=" organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/ supportEventSubscriptions" Python: python import googleapiclient. discovery api_version = "v2beta" 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())

Parameters:

  • parent (String) —

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

  • filter (String) (defaults to: nil) —

    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

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

    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.

  • show_deleted (Boolean) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 1060

def list_organization_support_event_subscriptions(parent, filter: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}/supportEventSubscriptions', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::ListSupportEventSubscriptionsResponse::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::ListSupportEventSubscriptionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_case(name, case_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Case

Update a case. Only some fields can be updated. EXAMPLES: cURL: shell case=" projects/some-project/cases/43595344" curl \ --request PATCH \ --header " Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content- Type: application/json" \ --data '` "priority": "P1" `' \ "https:// cloudsupport.googleapis.com/v2beta/$case?updateMask=priority" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport" , version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis. com/$discovery/rest?version=`api_version`", ) request = supportApiService. cases().patch( name="projects/some-project/cases/43112854", body=` " displayName": "This is Now a New Title", "priority": "P2", `, ) print(request. execute())

Parameters:

  • name (String) —

    Identifier. The resource name for the case.

  • case_object (Google::Apis::CloudsupportV2beta::Case) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    A list of attributes of the case that should be updated. Supported values are priority, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields are updated. Be careful - if you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for subscriber_email_addresses, then subscriber_email_addresses is updated to empty.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 393

def patch_case(name, case_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta/{+name}', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::Case::Representation
  command.request_object = case_object
  command.response_representation = Google::Apis::CloudsupportV2beta::Case::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Case
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_support_event_subscription(name, support_event_subscription_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::SupportEventSubscription

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/v2beta/$support_event_subscription?updateMask= pub_sub_topic" Python: python import googleapiclient.discovery api_version = "v2beta" 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())

Parameters:

  • name (String) —

    Identifier. The resource name of the support event subscription.

  • support_event_subscription_object (Google::Apis::CloudsupportV2beta::SupportEventSubscription) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 1110

def patch_organization_support_event_subscription(name, support_event_subscription_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta/{+name}', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::SupportEventSubscription::Representation
  command.request_object = support_event_subscription_object
  command.response_representation = Google::Apis::CloudsupportV2beta::SupportEventSubscription::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::SupportEventSubscription
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_case_classifications(page_size: nil, page_token: nil, product_product_line: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::SearchCaseClassificationsResponse

Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by " > ". For example, "Technical Issue > Compute > Compute Engine". Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, case.create requests using the classification will fail. EXAMPLES: cURL: shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2beta/caseClassifications:search? query=display_name:"*Compute%20Engine*"' Python: python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2beta", discoveryServiceUrl=f"https:// cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute())

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of classifications fetched with each request.

  • page_token (String) (defaults to: nil) —

    A token identifying the page of results to return. If unspecified, the first page is retrieved.

  • product_product_line (String) (defaults to: nil) —

    The product line of the Product.

  • query (String) (defaults to: nil) —

    An expression used to filter case classifications. If it's an empty string, then no filtering happens. Otherwise, case classifications will be returned that match the filter.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 98

def search_case_classifications(page_size: nil, page_token: nil, product_product_line: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/caseClassifications:search', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::SearchCaseClassificationsResponse::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::SearchCaseClassificationsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['product.productLine'] = product_product_line unless product_product_line.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_cases(page_size: nil, page_token: nil, parent: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::SearchCasesResponse

Search for cases using a query. EXAMPLES: cURL: shell parent="projects/some- project" curl \ --header "Authorization: Bearer $(gcloud auth print-access- token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases:search" Python: python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport" , version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis. com/$discovery/rest?version=`api_version`", ) request = supportApiService. cases().search( parent="projects/some-project", query="state=OPEN" ) print( request.execute())

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of cases fetched with each request. The default page size is 10.

  • page_token (String) (defaults to: nil) —

    A token identifying the page of results to return. If unspecified, the first page is retrieved.

  • parent (String) (defaults to: nil) —

    The name of the parent resource to search for cases under.

  • query (String) (defaults to: nil) —

    An expression used to filter cases. Expressions use the following fields separated by AND and specified with =: - state: Can be OPEN or CLOSED . - priority: Can be P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority= P1 OR priority=P2. - creator.email: The email address of the case creator. To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search". To search only cases updated after a certain date, use update_time restricted with that particular date, time, and timezone in ISO datetime format. For example, update_time>"2020-01-01T00:00:00-05:00". update_time only supports the greater than operator (>). If you are using the v2 version of the API, you must specify the case parent in the parent field. If you provide an empty query, all cases under the parent resource will be returned. If you are using the v2beta version of the API, you must specify the case parent in the query field using one of the two fields below, which are only available for v2beta. The parent field will be ignored. - organization: An organization name in the form organizations/. - project: A project name in the form projects/. Examples: For v2: - state=CLOSED - state=OPEN AND creator. email="tester@example.com" - state=OPEN AND (priority=P0 OR priority=P1) - update_time>"2020-01-01T00:00:00-05:00" For v2beta: - organization=" organizations/123456789" - project="projects/my-project-id" - project=" projects/123456789" - organization="organizations/123456789" AND state= CLOSED - project="projects/my-project-id" AND creator.email="tester@example. com" - project="projects/my-project-id" AND (priority=P0 OR priority=P1)

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 465

def search_cases(page_size: nil, page_token: nil, parent: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/cases:search', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::SearchCasesResponse::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::SearchCasesResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#show_case_feed(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::ShowFeedResponse

Show items in the feed of this case, including case emails, attachments, and comments.

Parameters:

  • parent (String) —

    Required. The resource name of the case for which feed items should be listed.

  • order_by (String) (defaults to: nil) —

    Optional. Field to order feed items by, followed by asc or desc postfix. The only valid field is creation_time. This list is case-insensitive, default sorting order is ascending, and the redundant space characters are insignificant. Example: creation_time desc

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of feed items fetched with each request.

  • page_token (String) (defaults to: nil) —

    Optional. A token identifying the page of results to return. If unspecified, it retrieves the first page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 509

def show_case_feed(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta/{+parent}:showFeed', options)
  command.response_representation = Google::Apis::CloudsupportV2beta::ShowFeedResponse::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::ShowFeedResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undelete_support_event_subscription(name, undelete_support_event_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::SupportEventSubscription

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/v2beta/$ support_event_subscription:undelete" Python: python import googleapiclient.discovery api_version = "v2beta" 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())

Parameters:

  • name (String) —

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

  • undelete_support_event_subscription_request_object (Google::Apis::CloudsupportV2beta::UndeleteSupportEventSubscriptionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 1155

def undelete_support_event_subscription(name, undelete_support_event_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+name}:undelete', options)
  command.request_representation = Google::Apis::CloudsupportV2beta::UndeleteSupportEventSubscriptionRequest::Representation
  command.request_object = undelete_support_event_subscription_request_object
  command.response_representation = Google::Apis::CloudsupportV2beta::SupportEventSubscription::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::SupportEventSubscription
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_medium(parent, create_attachment_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Attachment

Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: filename. EXAMPLES: cURL: shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case=" projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $( gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ " https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment. filename=uploaded_via_curl.txt" Python: ``python import googleapiclient. discovery api_version = "v2beta" supportApiService = googleapiclient.discovery. build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f" https://cloudsupport.googleapis.com/$discovery/rest?version=api_version`", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/ cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0]

  • "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```

Parameters:

  • parent (String) —

    Required. The name of the case or Cloud resource to which the attachment should be attached.

  • create_attachment_request_object (Google::Apis::CloudsupportV2beta::CreateAttachmentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil) —

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 827

def upload_medium(parent, create_attachment_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'v2beta/{+parent}/attachments', options)
  else
    command = make_upload_command(:post, 'v2beta/{+parent}/attachments', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::CloudsupportV2beta::CreateAttachmentRequest::Representation
  command.request_object = create_attachment_request_object
  command.response_representation = Google::Apis::CloudsupportV2beta::Attachment::Representation
  command.response_class = Google::Apis::CloudsupportV2beta::Attachment
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end