Class: Google::Apis::CloudsupportV2beta::CloudSupportService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::CloudsupportV2beta::CloudSupportService
- 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.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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.
-
#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 Google Cloud Resource.
-
#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.
-
#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.
-
#escalate_case(name, escalate_case_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Case
Escalate a case.
-
#get_case(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudsupportV2beta::Case
Retrieve the specified case.
-
#initialize ⇒ CloudSupportService
constructor
A new instance of CloudSupportService.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
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.
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.
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.
120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 120 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', ) 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 the given Google Cloud Resource. The
case object must have the following fields set: display_name
, description
,
classification
, and priority
.
156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 156 def create_case(parent, case_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/cases', ) 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. The comment object must have the following fields set: body.
446 447 448 449 450 451 452 453 454 455 456 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 446 def create_case_comment(parent, comment_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/comments', ) 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.
518 519 520 521 522 523 524 525 526 527 528 529 530 531 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 518 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', ) else command = make_download_command(:get, 'v2beta/{+name}:download', ) 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 Google 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.
193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 193 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', ) 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.
225 226 227 228 229 230 231 232 233 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 225 def get_case(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) 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.
412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 412 def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+parent}/attachments', ) 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.
483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 483 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', ) 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
.
273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 273 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', ) 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.
315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 315 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}', ) 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 6 months.
If a given classification is deactiveated, it will immediately stop being
returned. After 6 months, case.create
requests using the classification ID
will fail.
87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 87 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', ) 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.
373 374 375 376 377 378 379 380 381 382 383 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 373 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', ) 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. The attachment object must have the following fields set: filename.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 560 def upload_medium(parent, = 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', ) else command = make_upload_command(:post, 'v2beta/{+parent}/attachments', ) command.upload_source = upload_source command.upload_content_type = content_type end command.request_representation = Google::Apis::CloudsupportV2beta::CreateAttachmentRequest::Representation command.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 |