google-apis-cloudsupport_v2 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9855bd223eb33fd972bbce63cf9eb6dad8aaae4d1993efb78c87ca039469775c
|
4
|
+
data.tar.gz: 5ea09b7507768bf1d12766f4edb33b7dd40080df369a4551a51b421262d2860f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 898ff4f6b1c44cb0ef5783815461cff738fd1ffb297b0beb26843cf3f5cbabaff75849b306f05440cf18cb03eee6117c9d89f51a7cd6c7309611c604d7017e64
|
7
|
+
data.tar.gz: 6119c7f3666be20c0364842685360e442e7bd34040c0590b9ea3c3900831bbe13386c709e511773bf47868bfcb96de439270a357dc24fd21b6ff2a30bfc77fec
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-cloudsupport_v2
|
2
2
|
|
3
|
+
### v0.6.0 (2023-12-24)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20231217
|
6
|
+
|
7
|
+
### v0.5.0 (2023-10-01)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20230926
|
10
|
+
|
3
11
|
### v0.4.0 (2023-09-10)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20230904
|
@@ -22,8 +22,9 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module CloudsupportV2
|
24
24
|
|
25
|
-
# An
|
26
|
-
#
|
25
|
+
# An Actor represents an entity that performed an action. For example, an actor
|
26
|
+
# could be a user who posted a comment on a support case, a user who uploaded an
|
27
|
+
# attachment, or a service account that created a support case.
|
27
28
|
class Actor
|
28
29
|
include Google::Apis::Core::Hashable
|
29
30
|
|
@@ -35,11 +36,10 @@ module Google
|
|
35
36
|
# @return [String]
|
36
37
|
attr_accessor :display_name
|
37
38
|
|
38
|
-
# The email address of the actor. If not provided, it is inferred from
|
39
|
-
# credentials supplied during case creation.
|
40
|
-
#
|
41
|
-
#
|
42
|
-
# Support agent.
|
39
|
+
# The email address of the actor. If not provided, it is inferred from the
|
40
|
+
# credentials supplied during case creation. When a name is provided, an email
|
41
|
+
# must also be provided. If the user is a Google Support agent, this is
|
42
|
+
# obfuscated. This field is deprecated. Use **username** field instead.
|
43
43
|
# Corresponds to the JSON property `email`
|
44
44
|
# @return [String]
|
45
45
|
attr_accessor :email
|
@@ -50,6 +50,14 @@ module Google
|
|
50
50
|
attr_accessor :google_support
|
51
51
|
alias_method :google_support?, :google_support
|
52
52
|
|
53
|
+
# Output only. The username of the actor. It may look like an email or other
|
54
|
+
# format provided by the identity provider. If not provided, it is inferred from
|
55
|
+
# the credentials supplied. When a name is provided, a username must also be
|
56
|
+
# provided. If the user is a Google Support agent, this will not be set.
|
57
|
+
# Corresponds to the JSON property `username`
|
58
|
+
# @return [String]
|
59
|
+
attr_accessor :username
|
60
|
+
|
53
61
|
def initialize(**args)
|
54
62
|
update!(**args)
|
55
63
|
end
|
@@ -59,10 +67,15 @@ module Google
|
|
59
67
|
@display_name = args[:display_name] if args.key?(:display_name)
|
60
68
|
@email = args[:email] if args.key?(:email)
|
61
69
|
@google_support = args[:google_support] if args.key?(:google_support)
|
70
|
+
@username = args[:username] if args.key?(:username)
|
62
71
|
end
|
63
72
|
end
|
64
73
|
|
65
|
-
#
|
74
|
+
# An Attachment contains metadata about a file that was uploaded to a case - it
|
75
|
+
# is NOT a file itself. That being said, the name of an Attachment object can be
|
76
|
+
# used to download its accompanying file through the `media.download` endpoint.
|
77
|
+
# While attachments can be uploaded in the console at the same time as a comment,
|
78
|
+
# they're associated on a "case" level, not a "comment" level.
|
66
79
|
class Attachment
|
67
80
|
include Google::Apis::Core::Hashable
|
68
81
|
|
@@ -71,8 +84,9 @@ module Google
|
|
71
84
|
# @return [String]
|
72
85
|
attr_accessor :create_time
|
73
86
|
|
74
|
-
# An
|
75
|
-
#
|
87
|
+
# An Actor represents an entity that performed an action. For example, an actor
|
88
|
+
# could be a user who posted a comment on a support case, a user who uploaded an
|
89
|
+
# attachment, or a service account that created a support case.
|
76
90
|
# Corresponds to the JSON property `creator`
|
77
91
|
# @return [Google::Apis::CloudsupportV2::Actor]
|
78
92
|
attr_accessor :creator
|
@@ -157,11 +171,23 @@ module Google
|
|
157
171
|
end
|
158
172
|
end
|
159
173
|
|
160
|
-
# A support case.
|
174
|
+
# A Case is an object that contains the details of a support case. It contains
|
175
|
+
# fields for the time it was created, its priority, its classification, and more.
|
176
|
+
# Cases can also have comments and attachments that get added over time. A case
|
177
|
+
# is parented by a Google Cloud organization or project. Organizations are
|
178
|
+
# identified by a number, so the name of a case parented by an organization
|
179
|
+
# would look like this: ``` organizations/123/cases/456 ``` Projects have two
|
180
|
+
# unique identifiers, an ID and a number, and they look like this: ``` projects/
|
181
|
+
# abc/cases/456 ``` ``` projects/123/cases/456 ``` You can use either of them
|
182
|
+
# when calling the API. To learn more about project identifiers, see [AIP-2510](
|
183
|
+
# https://google.aip.dev/cloud/2510).
|
161
184
|
class Case
|
162
185
|
include Google::Apis::Core::Hashable
|
163
186
|
|
164
|
-
# A
|
187
|
+
# A Case Classification represents the topic that a case is about. It's very
|
188
|
+
# important to use accurate classifications, because they're used to route your
|
189
|
+
# cases to specialists who can help you. A classification always has an ID that
|
190
|
+
# is its unique identifier. A valid ID is required when creating a case.
|
165
191
|
# Corresponds to the JSON property `classification`
|
166
192
|
# @return [Google::Apis::CloudsupportV2::CaseClassification]
|
167
193
|
attr_accessor :classification
|
@@ -178,8 +204,9 @@ module Google
|
|
178
204
|
# @return [String]
|
179
205
|
attr_accessor :create_time
|
180
206
|
|
181
|
-
# An
|
182
|
-
#
|
207
|
+
# An Actor represents an entity that performed an action. For example, an actor
|
208
|
+
# could be a user who posted a comment on a support case, a user who uploaded an
|
209
|
+
# attachment, or a service account that created a support case.
|
183
210
|
# Corresponds to the JSON property `creator`
|
184
211
|
# @return [Google::Apis::CloudsupportV2::Actor]
|
185
212
|
attr_accessor :creator
|
@@ -274,7 +301,10 @@ module Google
|
|
274
301
|
end
|
275
302
|
end
|
276
303
|
|
277
|
-
# A
|
304
|
+
# A Case Classification represents the topic that a case is about. It's very
|
305
|
+
# important to use accurate classifications, because they're used to route your
|
306
|
+
# cases to specialists who can help you. A classification always has an ID that
|
307
|
+
# is its unique identifier. A valid ID is required when creating a case.
|
278
308
|
class CaseClassification
|
279
309
|
include Google::Apis::Core::Hashable
|
280
310
|
|
@@ -319,7 +349,9 @@ module Google
|
|
319
349
|
end
|
320
350
|
end
|
321
351
|
|
322
|
-
#
|
352
|
+
# Case comments are the main way Google Support communicates with a user who has
|
353
|
+
# opened a case. When a user responds to Google Support, the user's responses
|
354
|
+
# also appear as comments.
|
323
355
|
class Comment
|
324
356
|
include Google::Apis::Core::Hashable
|
325
357
|
|
@@ -334,8 +366,9 @@ module Google
|
|
334
366
|
# @return [String]
|
335
367
|
attr_accessor :create_time
|
336
368
|
|
337
|
-
# An
|
338
|
-
#
|
369
|
+
# An Actor represents an entity that performed an action. For example, an actor
|
370
|
+
# could be a user who posted a comment on a support case, a user who uploaded an
|
371
|
+
# attachment, or a service account that created a support case.
|
339
372
|
# Corresponds to the JSON property `creator`
|
340
373
|
# @return [Google::Apis::CloudsupportV2::Actor]
|
341
374
|
attr_accessor :creator
|
@@ -496,7 +529,11 @@ module Google
|
|
496
529
|
class CreateAttachmentRequest
|
497
530
|
include Google::Apis::Core::Hashable
|
498
531
|
|
499
|
-
#
|
532
|
+
# An Attachment contains metadata about a file that was uploaded to a case - it
|
533
|
+
# is NOT a file itself. That being said, the name of an Attachment object can be
|
534
|
+
# used to download its accompanying file through the `media.download` endpoint.
|
535
|
+
# While attachments can be uploaded in the console at the same time as a comment,
|
536
|
+
# they're associated on a "case" level, not a "comment" level.
|
500
537
|
# Corresponds to the JSON property `attachment`
|
501
538
|
# @return [Google::Apis::CloudsupportV2::Attachment]
|
502
539
|
attr_accessor :attachment
|
@@ -757,15 +794,15 @@ module Google
|
|
757
794
|
class ListCasesResponse
|
758
795
|
include Google::Apis::Core::Hashable
|
759
796
|
|
760
|
-
# The list of cases associated with the
|
761
|
-
#
|
797
|
+
# The list of cases associated with the parent after any filters have been
|
798
|
+
# applied.
|
762
799
|
# Corresponds to the JSON property `cases`
|
763
800
|
# @return [Array<Google::Apis::CloudsupportV2::Case>]
|
764
801
|
attr_accessor :cases
|
765
802
|
|
766
|
-
# A token to retrieve the next page of results.
|
767
|
-
#
|
768
|
-
#
|
803
|
+
# A token to retrieve the next page of results. Set this in the `page_token`
|
804
|
+
# field of subsequent `cases.list` requests. If unspecified, there are no more
|
805
|
+
# results to retrieve.
|
769
806
|
# Corresponds to the JSON property `nextPageToken`
|
770
807
|
# @return [String]
|
771
808
|
attr_accessor :next_page_token
|
@@ -1051,9 +1088,9 @@ module Google
|
|
1051
1088
|
# @return [Array<Google::Apis::CloudsupportV2::CaseClassification>]
|
1052
1089
|
attr_accessor :case_classifications
|
1053
1090
|
|
1054
|
-
# A token to retrieve the next page of results.
|
1055
|
-
#
|
1056
|
-
#
|
1091
|
+
# A token to retrieve the next page of results. Set this in the `page_token`
|
1092
|
+
# field of subsequent `caseClassifications.list` requests. If unspecified, there
|
1093
|
+
# are no more results to retrieve.
|
1057
1094
|
# Corresponds to the JSON property `nextPageToken`
|
1058
1095
|
# @return [String]
|
1059
1096
|
attr_accessor :next_page_token
|
@@ -1073,15 +1110,15 @@ module Google
|
|
1073
1110
|
class SearchCasesResponse
|
1074
1111
|
include Google::Apis::Core::Hashable
|
1075
1112
|
|
1076
|
-
# The list of cases associated with the
|
1077
|
-
#
|
1113
|
+
# The list of cases associated with the parent after any filters have been
|
1114
|
+
# applied.
|
1078
1115
|
# Corresponds to the JSON property `cases`
|
1079
1116
|
# @return [Array<Google::Apis::CloudsupportV2::Case>]
|
1080
1117
|
attr_accessor :cases
|
1081
1118
|
|
1082
|
-
# A token to retrieve the next page of results.
|
1083
|
-
#
|
1084
|
-
#
|
1119
|
+
# A token to retrieve the next page of results. Set this in the `page_token`
|
1120
|
+
# field of subsequent `cases.search` requests. If unspecified, there are no more
|
1121
|
+
# results to retrieve.
|
1085
1122
|
# Corresponds to the JSON property `nextPageToken`
|
1086
1123
|
# @return [String]
|
1087
1124
|
attr_accessor :next_page_token
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module CloudsupportV2
|
18
18
|
# Version of the google-apis-cloudsupport_v2 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.6.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20231217"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -50,26 +50,30 @@ module Google
|
|
50
50
|
@batch_path = 'batch'
|
51
51
|
end
|
52
52
|
|
53
|
-
# Retrieve valid classifications to
|
54
|
-
#
|
55
|
-
# of the hierarchy
|
56
|
-
# Compute > Compute Engine"`. Classification IDs returned by
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
53
|
+
# Retrieve valid classifications to use when creating a support case.
|
54
|
+
# Classifications are hierarchical. Each classification is a string containing
|
55
|
+
# all levels of the hierarchy separated by `" > "`. For example, `"Technical
|
56
|
+
# Issue > Compute > Compute Engine"`. Classification IDs returned by this
|
57
|
+
# endpoint are valid for at least six months. When a classification is
|
58
|
+
# deactivated, this endpoint immediately stops returning it. After six months, `
|
59
|
+
# case.create` requests using the classification will fail. EXAMPLES: cURL: ```
|
60
|
+
# shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)"
|
61
|
+
# \ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=
|
62
|
+
# display_name:"*Compute%20Engine*"' ``` Python: ```python import
|
63
|
+
# googleapiclient.discovery supportApiService = googleapiclient.discovery.build(
|
64
|
+
# serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://
|
65
|
+
# cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request =
|
66
|
+
# supportApiService.caseClassifications().search( query='display_name:"*Compute
|
67
|
+
# Engine*"' ) print(request.execute()) ```
|
64
68
|
# @param [Fixnum] page_size
|
65
|
-
# The maximum number of
|
69
|
+
# The maximum number of classifications fetched with each request.
|
66
70
|
# @param [String] page_token
|
67
71
|
# A token identifying the page of results to return. If unspecified, the first
|
68
72
|
# page is retrieved.
|
69
73
|
# @param [String] query
|
70
|
-
# An expression
|
71
|
-
#
|
72
|
-
#
|
74
|
+
# An expression used to filter case classifications. If it's an empty string,
|
75
|
+
# then no filtering happens. Otherwise, case classifications will be returned
|
76
|
+
# that match the filter.
|
73
77
|
# @param [String] fields
|
74
78
|
# Selector specifying which fields to include in a partial response.
|
75
79
|
# @param [String] quota_user
|
@@ -99,12 +103,17 @@ module Google
|
|
99
103
|
execute_or_queue_command(command, &block)
|
100
104
|
end
|
101
105
|
|
102
|
-
# Close
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
+
# Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/
|
107
|
+
# 43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud
|
108
|
+
# auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:
|
109
|
+
# close" ``` Python: ```python import googleapiclient.discovery api_version = "
|
110
|
+
# v2" supportApiService = googleapiclient.discovery.build( serviceName="
|
111
|
+
# cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.
|
112
|
+
# googleapis.com/$discovery/rest?version=`api_version`", ) request =
|
113
|
+
# supportApiService.cases().close( name="projects/some-project/cases/43595344" )
|
114
|
+
# print(request.execute()) ```
|
106
115
|
# @param [String] name
|
107
|
-
# Required. The
|
116
|
+
# Required. The name of the case to close.
|
108
117
|
# @param [Google::Apis::CloudsupportV2::CloseCaseRequest] close_case_request_object
|
109
118
|
# @param [String] fields
|
110
119
|
# Selector specifying which fields to include in a partial response.
|
@@ -135,22 +144,29 @@ module Google
|
|
135
144
|
execute_or_queue_command(command, &block)
|
136
145
|
end
|
137
146
|
|
138
|
-
# Create a new case and associate it with a
|
139
|
-
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
#
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
# close", "classification": ` "id": "
|
147
|
+
# Create a new case and associate it with a parent. It must have the following
|
148
|
+
# fields set: `display_name`, `description`, `classification`, and `priority`.
|
149
|
+
# If you're just testing the API and don't want to route your case to an agent,
|
150
|
+
# set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project"
|
151
|
+
# curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-
|
152
|
+
# access-token)" \ --header 'Content-Type: application/json' \ --data '` "
|
153
|
+
# display_name": "Test case created by me.", "description": "a random test case,
|
154
|
+
# feel free to close", "classification": ` "id": "
|
147
155
|
# 1BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
|
148
156
|
# `, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "
|
149
157
|
# bar@domain.com" ], "testCase": true, "priority": "P3" `' \ "https://
|
150
|
-
# cloudsupport.googleapis.com/v2/$parent/cases" ```
|
158
|
+
# cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import
|
159
|
+
# googleapiclient.discovery api_version = "v2" supportApiService =
|
160
|
+
# googleapiclient.discovery.build( serviceName="cloudsupport", version=
|
161
|
+
# api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$
|
162
|
+
# discovery/rest?version=`api_version`", ) request = supportApiService.cases().
|
163
|
+
# create( parent="projects/some-project", body=` "displayName": "A Test Case", "
|
164
|
+
# description": "This is a test case.", "testCase": True, "priority": "P2", "
|
165
|
+
# classification": ` "id": "
|
166
|
+
# 1BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
|
167
|
+
# `, `, ) print(request.execute()) ```
|
151
168
|
# @param [String] parent
|
152
|
-
# Required. The name of the
|
153
|
-
# created.
|
169
|
+
# Required. The name of the parent under which the case should be created.
|
154
170
|
# @param [Google::Apis::CloudsupportV2::Case] case_object
|
155
171
|
# @param [String] fields
|
156
172
|
# Selector specifying which fields to include in a partial response.
|
@@ -181,18 +197,24 @@ module Google
|
|
181
197
|
execute_or_queue_command(command, &block)
|
182
198
|
end
|
183
199
|
|
184
|
-
# Escalate a case
|
185
|
-
#
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
200
|
+
# Escalate a case, starting the Google Cloud Support escalation management
|
201
|
+
# process. This operation is only available for some support services. Go to
|
202
|
+
# https://cloud.google.com/support and look for 'Technical support escalations'
|
203
|
+
# in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```
|
204
|
+
# shell case="projects/some-project/cases/43595344" curl \ --request POST \ --
|
205
|
+
# header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "
|
206
|
+
# Content-Type: application/json" \ --data '` "escalation": ` "reason": "
|
207
|
+
# BUSINESS_IMPACT", "justification": "This is a test escalation." ` `' \ "https:/
|
208
|
+
# /cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import
|
209
|
+
# googleapiclient.discovery api_version = "v2" supportApiService =
|
210
|
+
# googleapiclient.discovery.build( serviceName="cloudsupport", version=
|
211
|
+
# api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$
|
212
|
+
# discovery/rest?version=`api_version`", ) request = supportApiService.cases().
|
213
|
+
# escalate( name="projects/some-project/cases/43595344", body=` "escalation": ` "
|
214
|
+
# reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", `, `
|
215
|
+
# , ) print(request.execute()) ```
|
194
216
|
# @param [String] name
|
195
|
-
# Required. The
|
217
|
+
# Required. The name of the case to be escalated.
|
196
218
|
# @param [Google::Apis::CloudsupportV2::EscalateCaseRequest] escalate_case_request_object
|
197
219
|
# @param [String] fields
|
198
220
|
# Selector specifying which fields to include in a partial response.
|
@@ -223,12 +245,17 @@ module Google
|
|
223
245
|
execute_or_queue_command(command, &block)
|
224
246
|
end
|
225
247
|
|
226
|
-
# Retrieve
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
248
|
+
# Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/
|
249
|
+
# 16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-
|
250
|
+
# token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python
|
251
|
+
# import googleapiclient.discovery api_version = "v2" supportApiService =
|
252
|
+
# googleapiclient.discovery.build( serviceName="cloudsupport", version=
|
253
|
+
# api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$
|
254
|
+
# discovery/rest?version=`api_version`", ) request = supportApiService.cases().
|
255
|
+
# get( name="projects/some-project/cases/43595344", ) print(request.execute()) ``
|
256
|
+
# `
|
230
257
|
# @param [String] name
|
231
|
-
# Required. The
|
258
|
+
# Required. The full name of a case to be retrieved.
|
232
259
|
# @param [String] fields
|
233
260
|
# Selector specifying which fields to include in a partial response.
|
234
261
|
# @param [String] quota_user
|
@@ -256,25 +283,29 @@ module Google
|
|
256
283
|
execute_or_queue_command(command, &block)
|
257
284
|
end
|
258
285
|
|
259
|
-
# Retrieve all cases under
|
260
|
-
# organization returns
|
261
|
-
# retrieve
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
286
|
+
# Retrieve all cases under a parent, but not its children. For example, listing
|
287
|
+
# cases under an organization only returns the cases that are directly parented
|
288
|
+
# by that organization. To retrieve cases under an organization and its projects,
|
289
|
+
# use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project"
|
290
|
+
# curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "
|
291
|
+
# https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python
|
292
|
+
# import googleapiclient.discovery api_version = "v2" supportApiService =
|
293
|
+
# googleapiclient.discovery.build( serviceName="cloudsupport", version=
|
294
|
+
# api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$
|
295
|
+
# discovery/rest?version=`api_version`", ) request = supportApiService.cases().
|
296
|
+
# list(parent="projects/some-project") print(request.execute()) ```
|
266
297
|
# @param [String] parent
|
267
|
-
# Required. The
|
298
|
+
# Required. The name of a parent to list cases under.
|
268
299
|
# @param [String] filter
|
269
|
-
# An expression
|
270
|
-
#
|
271
|
-
#
|
272
|
-
# - `state`:
|
273
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
300
|
+
# An expression used to filter cases. If it's an empty string, then no filtering
|
301
|
+
# happens. Otherwise, the endpoint returns the cases that match the filter.
|
302
|
+
# Expressions use the following fields separated by `AND` and specified with `=`:
|
303
|
+
# - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `
|
304
|
+
# P3`, or `P4`. You can specify multiple values for priority using the `OR`
|
305
|
+
# operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The
|
306
|
+
# email address of the case creator. EXAMPLES: - `state=CLOSED` - `state=OPEN
|
307
|
+
# AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR
|
308
|
+
# priority=P1)`
|
278
309
|
# @param [Fixnum] page_size
|
279
310
|
# The maximum number of cases fetched with each request. Defaults to 10.
|
280
311
|
# @param [String] page_token
|
@@ -310,23 +341,28 @@ module Google
|
|
310
341
|
execute_or_queue_command(command, &block)
|
311
342
|
end
|
312
343
|
|
313
|
-
# Update
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
344
|
+
# Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="
|
345
|
+
# projects/some-project/cases/43595344" curl \ --request PATCH \ --header "
|
346
|
+
# Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-
|
347
|
+
# Type: application/json" \ --data '` "priority": "P1" `' \ "https://
|
348
|
+
# cloudsupport.googleapis.com/v2/$case?updateMask=priority" ``` Python: ```
|
349
|
+
# python import googleapiclient.discovery api_version = "v2" supportApiService =
|
350
|
+
# googleapiclient.discovery.build( serviceName="cloudsupport", version=
|
351
|
+
# api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$
|
352
|
+
# discovery/rest?version=`api_version`", ) request = supportApiService.cases().
|
353
|
+
# patch( name="projects/some-project/cases/43112854", body=` "displayName": "
|
354
|
+
# This is Now a New Title", "priority": "P2", `, ) print(request.execute()) ```
|
319
355
|
# @param [String] name
|
320
356
|
# The resource name for the case.
|
321
357
|
# @param [Google::Apis::CloudsupportV2::Case] case_object
|
322
358
|
# @param [String] update_mask
|
323
|
-
# A list of attributes of the case
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
359
|
+
# A list of attributes of the case that should be updated. Supported values are `
|
360
|
+
# priority`, `display_name`, and `subscriber_email_addresses`. If no fields are
|
361
|
+
# specified, all supported fields are updated. Be careful - if you do not
|
362
|
+
# provide a field mask, then you might accidentally clear some fields. For
|
363
|
+
# example, if you leave the field mask empty and do not provide a value for `
|
364
|
+
# subscriber_email_addresses`, then `subscriber_email_addresses` is updated to
|
365
|
+
# empty.
|
330
366
|
# @param [String] fields
|
331
367
|
# Selector specifying which fields to include in a partial response.
|
332
368
|
# @param [String] quota_user
|
@@ -357,12 +393,17 @@ module Google
|
|
357
393
|
execute_or_queue_command(command, &block)
|
358
394
|
end
|
359
395
|
|
360
|
-
# Search cases using
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
396
|
+
# Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-
|
397
|
+
# project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-
|
398
|
+
# token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ```
|
399
|
+
# Python: ```python import googleapiclient.discovery api_version = "v2"
|
400
|
+
# supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport"
|
401
|
+
# , version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.
|
402
|
+
# com/$discovery/rest?version=`api_version`", ) request = supportApiService.
|
403
|
+
# cases().search( parent="projects/some-project", query="state=OPEN" ) print(
|
404
|
+
# request.execute()) ```
|
364
405
|
# @param [String] parent
|
365
|
-
# The
|
406
|
+
# The name of the parent resource to search for cases under.
|
366
407
|
# @param [Fixnum] page_size
|
367
408
|
# The maximum number of cases fetched with each request. The default page size
|
368
409
|
# is 10.
|
@@ -370,26 +411,23 @@ module Google
|
|
370
411
|
# A token identifying the page of results to return. If unspecified, the first
|
371
412
|
# page is retrieved.
|
372
413
|
# @param [String] query
|
373
|
-
# An expression
|
374
|
-
#
|
414
|
+
# An expression used to filter cases. Expressions use the following fields
|
415
|
+
# separated by `AND` and specified with `=`: - `organization`: An organization
|
375
416
|
# name in the form `organizations/`. - `project`: A project name in the form `
|
376
|
-
# projects/`. - `state`:
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
# `
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
# 123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.
|
391
|
-
# email="tester@example.com"` - `project="projects/my-project-id" AND (priority=
|
392
|
-
# P0 OR priority=P1)`
|
417
|
+
# projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `
|
418
|
+
# P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using
|
419
|
+
# the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`
|
420
|
+
# : The email address of the case creator. You must specify either `organization`
|
421
|
+
# or `project`. To search across `displayName`, `description`, and comments,
|
422
|
+
# use a global restriction with no keyword or operator. For example, `"my search"
|
423
|
+
# `. To search only cases updated after a certain date, use `update_time`
|
424
|
+
# restricted with that particular date, time, and timezone in ISO datetime
|
425
|
+
# format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time`
|
426
|
+
# only supports the greater than operator (`>`). Examples: - `organization="
|
427
|
+
# organizations/123456789"` - `project="projects/my-project-id"` - `project="
|
428
|
+
# projects/123456789"` - `organization="organizations/123456789" AND state=
|
429
|
+
# CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.
|
430
|
+
# com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
|
393
431
|
# @param [String] fields
|
394
432
|
# Selector specifying which fields to include in a partial response.
|
395
433
|
# @param [String] quota_user
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-cloudsupport_v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.6.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-12-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsupport_v2/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsupport_v2/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsupport_v2/v0.6.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsupport_v2
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|