google-apis-cloudsupport_v2beta 0.26.0 → 0.28.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.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/lib/google/apis/cloudsupport_v2beta/classes.rb +21 -21
  4. data/lib/google/apis/cloudsupport_v2beta/gem_version.rb +2 -2
  5. data/lib/google/apis/cloudsupport_v2beta/service.rb +207 -140
  6. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 11b7b98694bd54f24a2b2c16872fba4040bb4c5b44ea3d8234473a6654c39a71
4
- data.tar.gz: 61ae2b86f4186e44342fd6d6cd32f2d152cc3a0dba0357dbb7a87563799dfbc1
3
+ metadata.gz: 9f39d56eb38f84807afcfc4c6dbda7197df541f382edb784579e394b36b1f29e
4
+ data.tar.gz: a04dfebf26395a2bce4d166eeabaa853ea0ded7cf5a373b648356c0dd3eaee12
5
5
  SHA512:
6
- metadata.gz: f8cb4f4738730baf055acfd335748c50e786db585df330604adc53de55f09039f3ee5304b890d65181818dbf8cbe9fd5025a9e45ab50e9727ee394f839e16f1a
7
- data.tar.gz: 2d02306e5e312cb10645c9ff98ad97219a405a96dd62f06d235ad6b835723958f34f0a0f4a390a865dba0946805ef1d15918ebe0bea274f59ef1b9606706bda4
6
+ metadata.gz: 3fd82da5e727575991a90a4b0c476685397011c0787ccd5bc7fd12719d7e87e04954dcd326c52809194210ab26263bc0cd8fec1b10a08df1e2b1be79a63d9f9f
7
+ data.tar.gz: 61470fbbc9eae8fcb75788326e5a1c89732a72991e9b556e4b19a604bec98e9f6239b53e4fb51aaf20d15f5ca43ff1f2ef6be59ffd19578703d69d68ff4f3c20
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-cloudsupport_v2beta
2
2
 
3
+ ### v0.28.0 (2023-09-24)
4
+
5
+ * Regenerated from discovery document revision 20230920
6
+
7
+ ### v0.27.0 (2023-09-10)
8
+
9
+ * Regenerated from discovery document revision 20230904
10
+
3
11
  ### v0.26.0 (2023-08-27)
4
12
 
5
13
  * Regenerated from discovery document revision 20230818
data/lib/google/apis/cloudsupport_v2beta/classes.rb CHANGED
@@ -736,14 +736,14 @@ module Google
736
736
  class ListAttachmentsResponse
737
737
  include Google::Apis::Core::Hashable
738
738
 
739
- # The list of attachments associated with the given case.
739
+ # The list of attachments associated with a case.
740
740
  # Corresponds to the JSON property `attachments`
741
741
  # @return [Array<Google::Apis::CloudsupportV2beta::Attachment>]
742
742
  attr_accessor :attachments
743
743
 
744
- # A token to retrieve the next page of results. This should be set in the `
745
- # page_token` field of subsequent `cases.attachments.list` requests. If
746
- # unspecified, there are no more results to retrieve.
744
+ # A token to retrieve the next page of results. Set this in the `page_token`
745
+ # field of subsequent `cases.attachments.list` requests. If unspecified, there
746
+ # are no more results to retrieve.
747
747
  # Corresponds to the JSON property `nextPageToken`
748
748
  # @return [String]
749
749
  attr_accessor :next_page_token
@@ -763,15 +763,15 @@ module Google
763
763
  class ListCasesResponse
764
764
  include Google::Apis::Core::Hashable
765
765
 
766
- # The list of cases associated with the Google Cloud Resource, after any filters
767
- # have been applied.
766
+ # The list of cases associated with the parent after any filters have been
767
+ # applied.
768
768
  # Corresponds to the JSON property `cases`
769
769
  # @return [Array<Google::Apis::CloudsupportV2beta::Case>]
770
770
  attr_accessor :cases
771
771
 
772
- # A token to retrieve the next page of results. This should be set in the `
773
- # page_token` field of the subsequent `ListCasesRequest` message that is issued.
774
- # If unspecified, there are no more results to retrieve.
772
+ # A token to retrieve the next page of results. Set this in the `page_token`
773
+ # field of subsequent `cases.list` requests. If unspecified, there are no more
774
+ # results to retrieve.
775
775
  # Corresponds to the JSON property `nextPageToken`
776
776
  # @return [String]
777
777
  attr_accessor :next_page_token
@@ -791,14 +791,14 @@ module Google
791
791
  class ListCommentsResponse
792
792
  include Google::Apis::Core::Hashable
793
793
 
794
- # The list of Comments associated with the given Case.
794
+ # List of the comments associated with the case.
795
795
  # Corresponds to the JSON property `comments`
796
796
  # @return [Array<Google::Apis::CloudsupportV2beta::Comment>]
797
797
  attr_accessor :comments
798
798
 
799
- # A token to retrieve the next page of results. This should be set in the `
800
- # page_token` field of subsequent `ListCommentsRequest` message that is issued.
801
- # If unspecified, there are no more results to retrieve.
799
+ # A token to retrieve the next page of results. Set this in the `page_token`
800
+ # field of subsequent `cases.comments.list` requests. If unspecified, there are
801
+ # no more results to retrieve.
802
802
  # Corresponds to the JSON property `nextPageToken`
803
803
  # @return [String]
804
804
  attr_accessor :next_page_token
@@ -1057,9 +1057,9 @@ module Google
1057
1057
  # @return [Array<Google::Apis::CloudsupportV2beta::CaseClassification>]
1058
1058
  attr_accessor :case_classifications
1059
1059
 
1060
- # A token to retrieve the next page of results. This should be set in the `
1061
- # page_token` field of subsequent `SearchCaseClassificationsRequest` message
1062
- # that is issued. If unspecified, there are no more results to retrieve.
1060
+ # A token to retrieve the next page of results. Set this in the `page_token`
1061
+ # field of subsequent `caseClassifications.list` requests. If unspecified, there
1062
+ # are no more results to retrieve.
1063
1063
  # Corresponds to the JSON property `nextPageToken`
1064
1064
  # @return [String]
1065
1065
  attr_accessor :next_page_token
@@ -1079,15 +1079,15 @@ module Google
1079
1079
  class SearchCasesResponse
1080
1080
  include Google::Apis::Core::Hashable
1081
1081
 
1082
- # The list of cases associated with the Google Cloud Resource, after any filters
1083
- # have been applied.
1082
+ # The list of cases associated with the parent after any filters have been
1083
+ # applied.
1084
1084
  # Corresponds to the JSON property `cases`
1085
1085
  # @return [Array<Google::Apis::CloudsupportV2beta::Case>]
1086
1086
  attr_accessor :cases
1087
1087
 
1088
- # A token to retrieve the next page of results. This should be set in the `
1089
- # page_token` field of subsequent `SearchCaseRequest` message that is issued. If
1090
- # unspecified, there are no more results to retrieve.
1088
+ # A token to retrieve the next page of results. Set this in the `page_token`
1089
+ # field of subsequent `cases.search` requests. If unspecified, there are no more
1090
+ # results to retrieve.
1091
1091
  # Corresponds to the JSON property `nextPageToken`
1092
1092
  # @return [String]
1093
1093
  attr_accessor :next_page_token
data/lib/google/apis/cloudsupport_v2beta/gem_version.rb CHANGED
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module CloudsupportV2beta
18
18
  # Version of the google-apis-cloudsupport_v2beta gem
19
- GEM_VERSION = "0.26.0"
19
+ GEM_VERSION = "0.28.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 = "20230818"
25
+ REVISION = "20230920"
26
26
  end
27
27
  end
28
28
  end
data/lib/google/apis/cloudsupport_v2beta/service.rb CHANGED
@@ -50,26 +50,30 @@ module Google
50
50
  @batch_path = 'batch'
51
51
  end
52
52
 
53
- # Retrieve valid classifications to be used when creating a support case. The
54
- # classications are hierarchical, with each classification containing all levels
55
- # of the hierarchy, separated by `" > "`. For example `"Technical Issue >
56
- # Compute > Compute Engine"`. Classification IDs returned by `
57
- # caseClassifications.search` are guaranteed to be valid for at least six months.
58
- # If a given classification is deactivated, it immediately stops being returned.
59
- # After six months, `case.create` requests using the classification ID will
60
- # fail. Here is an example of calling this endpoint using cURL: ```shell curl \ -
61
- # -header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://
62
- # cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*
63
- # Compute%20Engine*"' ```
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 cases fetched with each request.
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 written in the Google Cloud filter language. If non-empty, then
71
- # only cases whose fields match the filter are returned. If empty, then no
72
- # messages are filtered out.
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 the specified case. Here is an example of calling this endpoint using
103
- # cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request
104
- # POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "
105
- # https://cloudsupport.googleapis.com/v2/$case:close" ```
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 fully qualified name of the case resource to be closed.
116
+ # Required. The name of the case to close.
108
117
  # @param [Google::Apis::CloudsupportV2beta::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 Google Cloud Resource. The case
139
- # object must have the following fields set: `display_name`, `description`, `
140
- # classification`, and `priority`. If you're just testing the API and don't want
141
- # to route your case to an agent, set `testCase=true`. Here is an example of
142
- # calling this endpoint using cURL: ```shell parent="projects/some-project" curl
143
- # \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-
144
- # token)" \ --header 'Content-Type: application/json' \ --data '` "display_name":
145
- # "Test case created by me.", "description": "a random test case, feel free to
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 Google Cloud Resource under which the case should be
153
- # created.
169
+ # Required. The name of the parent under which the case should be created.
154
170
  # @param [Google::Apis::CloudsupportV2beta::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. Escalating a case initiates the Google Cloud Support
185
- # escalation management process. This operation is only available to certain
186
- # Customer Care support services. Go to https://cloud.google.com/support and
187
- # look for 'Technical support escalations' in the feature list to find out which
188
- # support services let you perform escalations. Here is an example of calling
189
- # this endpoint using cURL: ```shell case="projects/some-project/cases/43595344"
190
- # curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-
191
- # access-token)" \ --header "Content-Type: application/json" \ --data '` "
192
- # escalation": ` "reason": "BUSINESS_IMPACT", "justification": "This is a test
193
- # escalation." ` `' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ```
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 fully qualified name of the Case resource to be escalated.
217
+ # Required. The name of the case to be escalated.
196
218
  # @param [Google::Apis::CloudsupportV2beta::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 the specified case. Here is an example of calling this endpoint using
227
- # cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "
228
- # Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
229
- # cloudsupport.googleapis.com/v2/$case" ```
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 fully qualified name of a case to be retrieved.
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 the specified parent. Note: Listing cases under an
260
- # organization returns only the cases directly parented by that organization. To
261
- # retrieve all cases under an organization, including cases parented by projects
262
- # under that organization, use `cases.search`. Here is an example of calling
263
- # this endpoint using cURL: ```shell parent="projects/some-project" curl \ --
264
- # header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
265
- # cloudsupport.googleapis.com/v2/$parent/cases" ```
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 fully qualified name of parent resource to list cases under.
298
+ # Required. The name of a parent to list cases under.
268
299
  # @param [String] filter
269
- # An expression written in filter language. If non-empty, the query returns the
270
- # cases that match the filter. Else, the query doesn't filter the cases. Filter
271
- # expressions use the following fields with the operators equals (`=`) and `AND`:
272
- # - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The
273
- # accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple
274
- # values for priority using the `OR` operator. For example, `priority=P1 OR
275
- # priority=P2`. - `creator.email`: The email address of the case creator.
276
- # Examples: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"
277
- # ` - `state=OPEN AND (priority=P0 OR priority=P1)`
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 the specified case. Only a subset of fields can be updated. Here is an
314
- # example of calling this endpoint using cURL: ```shell case="projects/some-
315
- # project/cases/43595344" curl \ --request PATCH \ --header "Authorization:
316
- # Bearer $(gcloud auth print-access-token)" \ --header "Content-Type:
317
- # application/json" \ --data '` "priority": "P1" `' \ "https://cloudsupport.
318
- # googleapis.com/v2/$case?updateMask=priority" ```
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::CloudsupportV2beta::Case] case_object
322
358
  # @param [String] update_mask
323
- # A list of attributes of the case object that should be updated as part of this
324
- # request. Supported values are `priority`, `display_name`, and `
325
- # subscriber_email_addresses`. If no fields are specified, all supported fields
326
- # are updated. WARNING: If you do not provide a field mask, then you might
327
- # accidentally clear some fields. For example, if you leave the field mask empty
328
- # and do not provide a value for `subscriber_email_addresses`, then `
329
- # subscriber_email_addresses` is updated to empty.
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,10 +393,15 @@ module Google
357
393
  execute_or_queue_command(command, &block)
358
394
  end
359
395
 
360
- # Search cases using the specified query. Here is an example of calling this
361
- # endpoint using cURL: ```shell parent="projects/some-project" curl \ --header "
362
- # Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
363
- # cloudsupport.googleapis.com/v2/$parent/cases:search" ```
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 [Fixnum] page_size
365
406
  # The maximum number of cases fetched with each request. The default page size
366
407
  # is 10.
@@ -368,28 +409,27 @@ module Google
368
409
  # A token identifying the page of results to return. If unspecified, the first
369
410
  # page is retrieved.
370
411
  # @param [String] parent
371
- # The fully qualified name of parent resource to search cases under.
412
+ # The name of the parent resource to search for cases under.
372
413
  # @param [String] query
373
- # An expression written in filter language. A query uses the following fields
374
- # with the operators equals (`=`) and `AND`: - `organization`: An organization
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`: The accepted values are `OPEN` or `CLOSED`. - `priority`
377
- # : The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify
378
- # multiple values for priority using the `OR` operator. For example, `priority=
379
- # P1 OR priority=P2`. - `creator.email`: The email address of the case creator. -
380
- # `billingAccount`: A billing account in the form `billingAccounts/` You must
381
- # specify either `organization` or `project`. To search across `displayName`, `
382
- # description`, and comments, use a global restriction with no keyword or
383
- # operator. For example, `"my search"`. To search only cases updated after a
384
- # certain date, use `update_time` restricted with that particular date, time,
385
- # and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:
386
- # 00:00-05:00"`. `update_time` only supports the greater than operator (`>`).
387
- # Examples: - `organization="organizations/123456789"` - `project="projects/my-
388
- # project-id"` - `project="projects/123456789"` - `billing_account="
389
- # billingAccounts/123456-A0B0C0-CUZ789"` - `organization="organizations/
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. - `billingAccount`: A billing account
421
+ # in the form `billingAccounts/` You must specify either `organization` or `
422
+ # project`. To search across `displayName`, `description`, and comments, use a
423
+ # global restriction with no keyword or operator. For example, `"my search"`. To
424
+ # search only cases updated after a certain date, use `update_time` restricted
425
+ # with that particular date, time, and timezone in ISO datetime format. For
426
+ # example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only
427
+ # supports the greater than operator (`>`). Examples: - `organization="
428
+ # organizations/123456789"` - `project="projects/my-project-id"` - `project="
429
+ # projects/123456789"` - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"`
430
+ # - `organization="organizations/123456789" AND state=CLOSED` - `project="
431
+ # projects/my-project-id" AND creator.email="tester@example.com"` - `project="
432
+ # projects/my-project-id" AND (priority=P0 OR priority=P1)`
393
433
  # @param [String] fields
394
434
  # Selector specifying which fields to include in a partial response.
395
435
  # @param [String] quota_user
@@ -420,13 +460,18 @@ module Google
420
460
  execute_or_queue_command(command, &block)
421
461
  end
422
462
 
423
- # Retrieve all attachments associated with a support case. Here is an example of
424
- # calling this endpoint using cURL: ```shell case="projects/some-project/cases/
425
- # 23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-
426
- # token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ```
463
+ # List all the attachments associated with a support case. EXAMPLES: cURL: ```
464
+ # shell case="projects/some-project/cases/23598314" curl \ --header "
465
+ # Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
466
+ # cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import
467
+ # googleapiclient.discovery api_version = "v2" supportApiService =
468
+ # googleapiclient.discovery.build( serviceName="cloudsupport", version=
469
+ # api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$
470
+ # discovery/rest?version=`api_version`", ) request = ( supportApiService.cases()
471
+ # .attachments() .list(parent="projects/some-project/cases/43595344") ) print(
472
+ # request.execute()) ```
427
473
  # @param [String] parent
428
- # Required. The resource name of Case object for which attachments should be
429
- # listed.
474
+ # Required. The name of the case for which attachments should be listed.
430
475
  # @param [Fixnum] page_size
431
476
  # The maximum number of attachments fetched with each request. If not provided,
432
477
  # the default is 10. The maximum page size that will be returned is 100.
@@ -462,14 +507,20 @@ module Google
462
507
  execute_or_queue_command(command, &block)
463
508
  end
464
509
 
465
- # Add a new comment to the specified Case. The comment object must have the
466
- # following fields set: body. Here is an example of calling this endpoint using
467
- # cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request
468
- # POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --
469
- # header 'Content-Type: application/json' \ --data '` "body": "This is a test
470
- # comment." `' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ```
510
+ # Add a new comment to a case. The comment must have the following fields set: `
511
+ # body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344"
512
+ # curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-
513
+ # access-token)" \ --header 'Content-Type: application/json' \ --data '` "body":
514
+ # "This is a test comment." `' \ "https://cloudsupport.googleapis.com/v2/$case/
515
+ # comments" ``` Python: ```python import googleapiclient.discovery api_version =
516
+ # "v2" supportApiService = googleapiclient.discovery.build( serviceName="
517
+ # cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.
518
+ # googleapis.com/$discovery/rest?version=`api_version`", ) request = (
519
+ # supportApiService.cases() .comments() .create( parent="projects/some-project/
520
+ # cases/43595344", body=`"body": "This is a test comment."`, ) ) print(request.
521
+ # execute()) ```
471
522
  # @param [String] parent
472
- # Required. The resource name of Case to which this comment should be added.
523
+ # Required. The name of the case to which the comment should be added.
473
524
  # @param [Google::Apis::CloudsupportV2beta::Comment] comment_object
474
525
  # @param [String] fields
475
526
  # Selector specifying which fields to include in a partial response.
@@ -500,18 +551,22 @@ module Google
500
551
  execute_or_queue_command(command, &block)
501
552
  end
502
553
 
503
- # Retrieve all comments associated with the Case object. Here is an example of
504
- # calling this endpoint using cURL: ```shell case="projects/cloud-support-qa-
505
- # premium/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth
506
- # print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments"
507
- # ```
554
+ # List all the comments associated with a case. EXAMPLES: cURL: ```shell case="
555
+ # projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(
556
+ # gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$
557
+ # case/comments" ``` Python: ```python import googleapiclient.discovery
558
+ # api_version = "v2" supportApiService = googleapiclient.discovery.build(
559
+ # serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://
560
+ # cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", ) request =
561
+ # ( supportApiService.cases() .comments() .list(parent="projects/some-project/
562
+ # cases/43595344") ) print(request.execute()) ```
508
563
  # @param [String] parent
509
- # Required. The resource name of Case object for which comments should be listed.
564
+ # Required. The name of the case for which to list comments.
510
565
  # @param [Fixnum] page_size
511
- # The maximum number of comments fetched with each request. Defaults to 10.
566
+ # The maximum number of comments to fetch. Defaults to 10.
512
567
  # @param [String] page_token
513
568
  # A token identifying the page of results to return. If unspecified, the first
514
- # page is retrieved.
569
+ # page is returned.
515
570
  # @param [String] fields
516
571
  # Selector specifying which fields to include in a partial response.
517
572
  # @param [String] quota_user
@@ -541,14 +596,19 @@ module Google
541
596
  execute_or_queue_command(command, &block)
542
597
  end
543
598
 
544
- # Download a file attachment on a case. Note: HTTP requests must append "?alt=
545
- # media" to the URL. Here is an example of calling this endpoint using cURL: ```
546
- # shell name="projects/some-project/cases/43594844/attachments/
547
- # 0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-
548
- # access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=
549
- # media" ```
599
+ # Download a file attached to a case. Note: HTTP requests must append "?alt=
600
+ # media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/
601
+ # 43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization:
602
+ # Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.
603
+ # com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.
604
+ # discovery api_version = "v2" supportApiService = googleapiclient.discovery.
605
+ # build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"
606
+ # https://cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", )
607
+ # request = supportApiService.media().download( name="projects/some-project/
608
+ # cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.
609
+ # split("?")[0] + "?alt=media" print(request.execute()) ```
550
610
  # @param [String] name
551
- # The resource name of the attachment to be downloaded.
611
+ # The name of the file attachment to download.
552
612
  # @param [String] fields
553
613
  # Selector specifying which fields to include in a partial response.
554
614
  # @param [String] quota_user
@@ -583,17 +643,24 @@ module Google
583
643
  execute_or_queue_command(command, &block)
584
644
  end
585
645
 
586
- # Create a file attachment on a case or Cloud resource. The attachment object
587
- # must have the following fields set: filename. Here is an example of calling
588
- # this endpoint using cURL: ```shell echo "This text is in a file I'm uploading
589
- # using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/
590
- # 43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-
591
- # token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.
592
- # googleapis.com/upload/v2beta/$case/attachments?attachment.filename=
593
- # uploaded_via_curl.txt" ```
646
+ # Create a file attachment on a case or Cloud resource. The attachment must have
647
+ # the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text
648
+ # is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="
649
+ # projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(
650
+ # gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "
651
+ # https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.
652
+ # filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.
653
+ # discovery api_version = "v2" supportApiService = googleapiclient.discovery.
654
+ # build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"
655
+ # https://cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", )
656
+ # file_path = "./example_file.txt" with open(file_path, "w") as file: file.write(
657
+ # "This text is inside a file I'm going to upload using the Cloud Support API.",
658
+ # ) request = supportApiService.media().upload( parent="projects/some-project/
659
+ # cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0]
660
+ # + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
594
661
  # @param [String] parent
595
- # Required. The resource name of the case (or case parent) to which the
596
- # attachment should be attached.
662
+ # Required. The name of the case or Cloud resource to which the attachment
663
+ # should be attached.
597
664
  # @param [Google::Apis::CloudsupportV2beta::CreateAttachmentRequest] create_attachment_request_object
598
665
  # @param [String] fields
599
666
  # Selector specifying which fields to include in a partial response.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-cloudsupport_v2beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.26.0
4
+ version: 0.28.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-08-27 00:00:00.000000000 Z
11
+ date: 2023-09-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_v2beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsupport_v2beta/v0.26.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsupport_v2beta/v0.28.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudsupport_v2beta
63
63
  post_install_message:
64
64
  rdoc_options: []