google-apis-cloudsupport_v2 0.3.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/lib/google/apis/cloudsupport_v2/classes.rb +21 -21
  4. data/lib/google/apis/cloudsupport_v2/gem_version.rb +2 -2
  5. data/lib/google/apis/cloudsupport_v2/service.rb +205 -140
  6. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9e71bf8078540186c463d7806e543dc506dec619582dd2dffeef5ad3ba1568b8
4
- data.tar.gz: e49e75175d1e926e2f91e9c6a295a6a7cdce8270c0c80bd1545992cc53ab4ab8
3
+ metadata.gz: 890fce46d41bf2e587b6bbe9f5b3f1b30bc7c6b78b0fb4341aa68593d5787a3a
4
+ data.tar.gz: ce17286d25f9af0d9ff9f32f6c264dde414410166ea527e77113a1bc85297d7a
5
5
  SHA512:
6
- metadata.gz: 1c08c3bde964244b221e8f68863bd7146454c4571281e7f4f6f59fe4b4bf77fa0e2ee09de8018eb627fc5a39999f968bfb039bc67336add106f196782e4626e7
7
- data.tar.gz: db504c2fde0cf65eca87bdd05160ce5c5efff0955b5f07443cfc35b91cc60a6cb74156875fd92b990811ea09a52963baeab01c99a1502d02c2123dd96cc0db61
6
+ metadata.gz: 37a77ef56cc1cbaa4dfc378d5e5b4ef2166247a86007ee3e181ea7047873a3ba9ba5102e408d033323e74025f65cd23059de6863f496f6ce421ee6c2011bf68d
7
+ data.tar.gz: 42e0b9bd8313ac03d75a91d4765c2539fc02acaf75b4d4e1adb99fa04cfbe8abf2696dbe3a900a279a238ade211b19c775e022c294e836564d8a085eab561ddd
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-cloudsupport_v2
2
2
 
3
+ ### v0.5.0 (2023-10-01)
4
+
5
+ * Regenerated from discovery document revision 20230926
6
+
7
+ ### v0.4.0 (2023-09-10)
8
+
9
+ * Regenerated from discovery document revision 20230904
10
+
3
11
  ### v0.3.0 (2023-08-27)
4
12
 
5
13
  * Regenerated from discovery document revision 20230818
data/lib/google/apis/cloudsupport_v2/classes.rb CHANGED
@@ -730,14 +730,14 @@ module Google
730
730
  class ListAttachmentsResponse
731
731
  include Google::Apis::Core::Hashable
732
732
 
733
- # The list of attachments associated with the given case.
733
+ # The list of attachments associated with a case.
734
734
  # Corresponds to the JSON property `attachments`
735
735
  # @return [Array<Google::Apis::CloudsupportV2::Attachment>]
736
736
  attr_accessor :attachments
737
737
 
738
- # A token to retrieve the next page of results. This should be set in the `
739
- # page_token` field of subsequent `cases.attachments.list` requests. If
740
- # unspecified, there are no more results to retrieve.
738
+ # A token to retrieve the next page of results. Set this in the `page_token`
739
+ # field of subsequent `cases.attachments.list` requests. If unspecified, there
740
+ # are no more results to retrieve.
741
741
  # Corresponds to the JSON property `nextPageToken`
742
742
  # @return [String]
743
743
  attr_accessor :next_page_token
@@ -757,15 +757,15 @@ module Google
757
757
  class ListCasesResponse
758
758
  include Google::Apis::Core::Hashable
759
759
 
760
- # The list of cases associated with the Google Cloud Resource, after any filters
761
- # have been applied.
760
+ # The list of cases associated with the parent after any filters have been
761
+ # applied.
762
762
  # Corresponds to the JSON property `cases`
763
763
  # @return [Array<Google::Apis::CloudsupportV2::Case>]
764
764
  attr_accessor :cases
765
765
 
766
- # A token to retrieve the next page of results. This should be set in the `
767
- # page_token` field of the subsequent `ListCasesRequest` message that is issued.
768
- # If unspecified, there are no more results to retrieve.
766
+ # A token to retrieve the next page of results. Set this in the `page_token`
767
+ # field of subsequent `cases.list` requests. If unspecified, there are no more
768
+ # results to retrieve.
769
769
  # Corresponds to the JSON property `nextPageToken`
770
770
  # @return [String]
771
771
  attr_accessor :next_page_token
@@ -785,14 +785,14 @@ module Google
785
785
  class ListCommentsResponse
786
786
  include Google::Apis::Core::Hashable
787
787
 
788
- # The list of Comments associated with the given Case.
788
+ # List of the comments associated with the case.
789
789
  # Corresponds to the JSON property `comments`
790
790
  # @return [Array<Google::Apis::CloudsupportV2::Comment>]
791
791
  attr_accessor :comments
792
792
 
793
- # A token to retrieve the next page of results. This should be set in the `
794
- # page_token` field of subsequent `ListCommentsRequest` message that is issued.
795
- # If unspecified, there are no more results to retrieve.
793
+ # A token to retrieve the next page of results. Set this in the `page_token`
794
+ # field of subsequent `cases.comments.list` requests. If unspecified, there are
795
+ # no more results to retrieve.
796
796
  # Corresponds to the JSON property `nextPageToken`
797
797
  # @return [String]
798
798
  attr_accessor :next_page_token
@@ -1051,9 +1051,9 @@ module Google
1051
1051
  # @return [Array<Google::Apis::CloudsupportV2::CaseClassification>]
1052
1052
  attr_accessor :case_classifications
1053
1053
 
1054
- # A token to retrieve the next page of results. This should be set in the `
1055
- # page_token` field of subsequent `SearchCaseClassificationsRequest` message
1056
- # that is issued. If unspecified, there are no more results to retrieve.
1054
+ # A token to retrieve the next page of results. Set this in the `page_token`
1055
+ # field of subsequent `caseClassifications.list` requests. If unspecified, there
1056
+ # are no more results to retrieve.
1057
1057
  # Corresponds to the JSON property `nextPageToken`
1058
1058
  # @return [String]
1059
1059
  attr_accessor :next_page_token
@@ -1073,15 +1073,15 @@ module Google
1073
1073
  class SearchCasesResponse
1074
1074
  include Google::Apis::Core::Hashable
1075
1075
 
1076
- # The list of cases associated with the Google Cloud Resource, after any filters
1077
- # have been applied.
1076
+ # The list of cases associated with the parent after any filters have been
1077
+ # applied.
1078
1078
  # Corresponds to the JSON property `cases`
1079
1079
  # @return [Array<Google::Apis::CloudsupportV2::Case>]
1080
1080
  attr_accessor :cases
1081
1081
 
1082
- # A token to retrieve the next page of results. This should be set in the `
1083
- # page_token` field of subsequent `SearchCaseRequest` message that is issued. If
1084
- # unspecified, there are no more results to retrieve.
1082
+ # A token to retrieve the next page of results. Set this in the `page_token`
1083
+ # field of subsequent `cases.search` requests. If unspecified, there are no more
1084
+ # results to retrieve.
1085
1085
  # Corresponds to the JSON property `nextPageToken`
1086
1086
  # @return [String]
1087
1087
  attr_accessor :next_page_token
data/lib/google/apis/cloudsupport_v2/gem_version.rb CHANGED
@@ -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.3.0"
19
+ GEM_VERSION = "0.5.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 = "20230926"
26
26
  end
27
27
  end
28
28
  end
data/lib/google/apis/cloudsupport_v2/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::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 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::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. 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::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 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::CloudsupportV2::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,12 +393,17 @@ 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 [String] parent
365
- # The fully qualified name of parent resource to search cases under.
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 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. 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
@@ -420,13 +458,18 @@ module Google
420
458
  execute_or_queue_command(command, &block)
421
459
  end
422
460
 
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" ```
461
+ # List all the attachments associated with a support case. EXAMPLES: cURL: ```
462
+ # shell case="projects/some-project/cases/23598314" curl \ --header "
463
+ # Authorization: Bearer $(gcloud auth print-access-token)" \ "https://
464
+ # cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import
465
+ # googleapiclient.discovery api_version = "v2" supportApiService =
466
+ # googleapiclient.discovery.build( serviceName="cloudsupport", version=
467
+ # api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$
468
+ # discovery/rest?version=`api_version`", ) request = ( supportApiService.cases()
469
+ # .attachments() .list(parent="projects/some-project/cases/43595344") ) print(
470
+ # request.execute()) ```
427
471
  # @param [String] parent
428
- # Required. The resource name of Case object for which attachments should be
429
- # listed.
472
+ # Required. The name of the case for which attachments should be listed.
430
473
  # @param [Fixnum] page_size
431
474
  # The maximum number of attachments fetched with each request. If not provided,
432
475
  # the default is 10. The maximum page size that will be returned is 100.
@@ -462,14 +505,20 @@ module Google
462
505
  execute_or_queue_command(command, &block)
463
506
  end
464
507
 
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" ```
508
+ # Add a new comment to a case. The comment must have the following fields set: `
509
+ # body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344"
510
+ # curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-
511
+ # access-token)" \ --header 'Content-Type: application/json' \ --data '` "body":
512
+ # "This is a test comment." `' \ "https://cloudsupport.googleapis.com/v2/$case/
513
+ # comments" ``` Python: ```python import googleapiclient.discovery api_version =
514
+ # "v2" supportApiService = googleapiclient.discovery.build( serviceName="
515
+ # cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.
516
+ # googleapis.com/$discovery/rest?version=`api_version`", ) request = (
517
+ # supportApiService.cases() .comments() .create( parent="projects/some-project/
518
+ # cases/43595344", body=`"body": "This is a test comment."`, ) ) print(request.
519
+ # execute()) ```
471
520
  # @param [String] parent
472
- # Required. The resource name of Case to which this comment should be added.
521
+ # Required. The name of the case to which the comment should be added.
473
522
  # @param [Google::Apis::CloudsupportV2::Comment] comment_object
474
523
  # @param [String] fields
475
524
  # Selector specifying which fields to include in a partial response.
@@ -500,18 +549,22 @@ module Google
500
549
  execute_or_queue_command(command, &block)
501
550
  end
502
551
 
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
- # ```
552
+ # List all the comments associated with a case. EXAMPLES: cURL: ```shell case="
553
+ # projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(
554
+ # gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$
555
+ # case/comments" ``` Python: ```python import googleapiclient.discovery
556
+ # api_version = "v2" supportApiService = googleapiclient.discovery.build(
557
+ # serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://
558
+ # cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", ) request =
559
+ # ( supportApiService.cases() .comments() .list(parent="projects/some-project/
560
+ # cases/43595344") ) print(request.execute()) ```
508
561
  # @param [String] parent
509
- # Required. The resource name of Case object for which comments should be listed.
562
+ # Required. The name of the case for which to list comments.
510
563
  # @param [Fixnum] page_size
511
- # The maximum number of comments fetched with each request. Defaults to 10.
564
+ # The maximum number of comments to fetch. Defaults to 10.
512
565
  # @param [String] page_token
513
566
  # A token identifying the page of results to return. If unspecified, the first
514
- # page is retrieved.
567
+ # page is returned.
515
568
  # @param [String] fields
516
569
  # Selector specifying which fields to include in a partial response.
517
570
  # @param [String] quota_user
@@ -541,14 +594,19 @@ module Google
541
594
  execute_or_queue_command(command, &block)
542
595
  end
543
596
 
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" ```
597
+ # Download a file attached to a case. Note: HTTP requests must append "?alt=
598
+ # media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/
599
+ # 43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization:
600
+ # Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.
601
+ # com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.
602
+ # discovery api_version = "v2" supportApiService = googleapiclient.discovery.
603
+ # build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"
604
+ # https://cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", )
605
+ # request = supportApiService.media().download( name="projects/some-project/
606
+ # cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.
607
+ # split("?")[0] + "?alt=media" print(request.execute()) ```
550
608
  # @param [String] name
551
- # The resource name of the attachment to be downloaded.
609
+ # The name of the file attachment to download.
552
610
  # @param [String] fields
553
611
  # Selector specifying which fields to include in a partial response.
554
612
  # @param [String] quota_user
@@ -583,17 +641,24 @@ module Google
583
641
  execute_or_queue_command(command, &block)
584
642
  end
585
643
 
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" ```
644
+ # Create a file attachment on a case or Cloud resource. The attachment must have
645
+ # the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text
646
+ # is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="
647
+ # projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(
648
+ # gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "
649
+ # https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.
650
+ # filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.
651
+ # discovery api_version = "v2" supportApiService = googleapiclient.discovery.
652
+ # build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"
653
+ # https://cloudsupport.googleapis.com/$discovery/rest?version=`api_version`", )
654
+ # file_path = "./example_file.txt" with open(file_path, "w") as file: file.write(
655
+ # "This text is inside a file I'm going to upload using the Cloud Support API.",
656
+ # ) request = supportApiService.media().upload( parent="projects/some-project/
657
+ # cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0]
658
+ # + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
594
659
  # @param [String] parent
595
- # Required. The resource name of the case (or case parent) to which the
596
- # attachment should be attached.
660
+ # Required. The name of the case or Cloud resource to which the attachment
661
+ # should be attached.
597
662
  # @param [Google::Apis::CloudsupportV2::CreateAttachmentRequest] create_attachment_request_object
598
663
  # @param [String] fields
599
664
  # 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_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.5.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-10-01 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.3.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudsupport_v2/v0.5.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: []