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, parent: 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. 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"
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', ) 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
. 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": [ "[email protected]", "
[email protected]" ], "testCase": true, "priority": "P3" `' \ "https://
cloudsupport.googleapis.com/v2/$parent/cases"
171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 171 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. Here is an example of calling this endpoint using
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"
490 491 492 493 494 495 496 497 498 499 500 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 490 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. Here is an example of calling this endpoint using 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"
570 571 572 573 574 575 576 577 578 579 580 581 582 583 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 570 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 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"
213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 213 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. 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"
248 249 250 251 252 253 254 255 256 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 248 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. Here is an example of
calling this endpoint using cURL: shell case="projects/some-project/cases/
23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-
token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments"
452 453 454 455 456 457 458 459 460 461 462 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 452 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. Here is an example of calling this endpoint using cURL: ```shell case="projects/cloud-support-qa- premium/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments"
</code>
531 532 533 534 535 536 537 538 539 540 541 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 531 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
. 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"
299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 299 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. 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"
346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 346 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 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*"'
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', ) 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"
409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 409 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', ) 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 object
must have the following fields set: filename. Here is an example of calling
this endpoint using 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"
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
# File 'lib/google/apis/cloudsupport_v2beta/service.rb', line 618 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 |