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.

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



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 149

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_attachment(parent, create_attachment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Attachment

Create a file attachment on a case or Cloud resource.

Parameters:

  • parent (String) —

    Required. The resource name of the case to which 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.

  • 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



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 74

def create_attachment(parent, create_attachment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta/{+parent}/attachments', options)
  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

#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 the given Cloud resource.

Parameters:

  • parent (String) —

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



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 183

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 the specified Case.

Parameters:

  • parent (String) —

    Required. The resource name of Case to which this 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



476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 476

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 attachment on a case. Note: HTTP requests must append "?alt= media" to the URL.

Parameters:

  • name (String) —

    The resource name of the attachment to be downloaded.

  • 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



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

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 will initiate the Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.

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



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 220

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.

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 252

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

Retrieve all attachments associated with a support case.

Parameters:

  • parent (String) —

    Required. The resource name of Case object 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



443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 443

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

Retrieve all Comments associated with the Case object.

Parameters:

  • parent (String) —

    Required. The resource name of Case object for which comments should be listed.

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

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



513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 513

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.

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. - [DEPRECATED] severity: The accepted values are S0, S1, S2, S3, or S4. - 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



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

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 (display_name, description, time_zone, subscriber_email_addresses, related_resources, severity, priority, primary_contact, and labels) can be updated.

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 field that represents attributes of a case object that should be updated as part of this request. Supported values are severity, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields will be updated. WARNING: If you do not provide a field mask then you may accidentally clear some fields. For example, if you leave field mask empty and do not provide a value for subscriber_email_addresses then subscriber_email_addresses will be 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



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

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".

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 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



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 116

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

Search cases using the specified query.

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.

  • 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. - [DEPRECATED] severity: The accepted values are S0, S1, S2, S3, or S4. - creator.email: The email address of the case creator. - billingAccount: A billing account in the form billingAccounts/ You must specify eitehr 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 retricted 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



404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 404

def search_cases(page_size: nil, page_token: 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['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.

Parameters:

  • parent (String) —

    Required. The resource name of the case to which 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



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

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