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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudSupportService

Returns a new instance of CloudSupportService.



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

def initialize
  super('https://cloudsupport.googleapis.com/', '',
        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.



39
40
41
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 39

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.



44
45
46
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 44

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 the specified case. Here is an example of calling this endpoint using cURL: shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ " https://cloudsupport.googleapis.com/v2/$case:close"

Parameters:

  • name (String) —

    Required. The fully qualified name of the case resource to be closed.

  • 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



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 126

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 Google Cloud Resource. The case object 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. Here is an example of calling this endpoint using 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/v2/$parent/cases"

Parameters:

  • parent (String) —

    Required. The name of the Google Cloud Resource 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



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 172

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/v2/$case/ comments" 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.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



502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 502

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

#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. 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/v2/$name:download?alt=media" 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.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



591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 591

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. Escalating a case initiates the Google Cloud Support escalation management process. This operation is only available to certain Customer Care support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which support services let you perform escalations. Here is an example of calling this endpoint using 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/v2/$case:escalate"

Parameters:

  • name (String) —

    Required. The fully qualified name of the Case resource 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



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 214

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

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

Retrieve the specified case. Here is an example of calling this endpoint using cURL: shell case="projects/some-project/cases/16033687" curl \ --header " Authorization: Bearer $(gcloud auth print-access-token)" \ "https:// cloudsupport.googleapis.com/v2/$case"

Parameters:

  • name (String) —

    Required. The fully qualified 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



249
250
251
252
253
254
255
256
257
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 249

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

#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/v2/$case/attachments" 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.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.

  • 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



458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 458

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/v2/$ case/comments" 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.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



547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 547

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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::ListCasesResponse

Retrieve all cases under the specified parent. Note: Listing cases under an organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use cases.search. Here is an example of calling this endpoint using cURL: shell parent="projects/some-project" curl \ -- header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https:// cloudsupport.googleapis.com/v2/$parent/cases"

Parameters:

  • parent (String) —

    Required. The fully qualified name of parent resource to list cases under.

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

    An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (=) and AND:

    • state: The accepted values are OPEN or CLOSED. - priority: The accepted values are 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.

  • 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



300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 300

def list_cases(parent, filter: nil, page_size: nil, page_token: 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['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 the specified case. Only a subset of fields can be updated. Here is an example of calling this endpoint using 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/v2/$case?updateMask=priority"

Parameters:

  • name (String) —

    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 object that should be updated as part of this request. Supported values are priority, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields are updated. WARNING: 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



347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 347

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

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

Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by " > ". For example "Technical Issue > Compute > Compute Engine". Classification IDs returned by caseClassifications.search are guaranteed to be valid for at least six months. If a given classification is deactivated, it immediately stops being returned. After six months, case.create requests using the classification ID will fail. Here is an example of calling this endpoint using cURL: shell curl \ - -header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https:// cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"* Compute%20Engine*"'

Parameters:

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

    The maximum number of cases 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.

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

    An expression written in the Google Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out.

  • 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



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 90

def search_case_classifications(page_size: nil, page_token: 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['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 cases using the specified query. Here is an example of calling this endpoint using cURL: shell parent="projects/some-project" curl \ --header " Authorization: Bearer $(gcloud auth print-access-token)" \ "https:// cloudsupport.googleapis.com/v2/$parent/cases:search"

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 fully qualified name of parent resource to search cases under.

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

    An expression written in filter language. A query uses the following fields with the operators equals (=) and AND: - organization: An organization name in the form organizations/. - project: A project name in the form projects/. - state: The accepted values are OPEN or CLOSED. - priority : The accepted values are 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. - billingAccount: A billing account in the form billingAccounts/ You must specify either organization or project. 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 (>). Examples: - organization="organizations/123456789" - project="projects/my- project-id" - project="projects/123456789" - billing_account=" billingAccounts/123456-A0B0C0-CUZ789" - 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



410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 410

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

#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 = "v2" 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



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 646

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