google-cloud-support-v2 1.3.0 → 1.4.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.
@@ -33,37 +33,318 @@ module Google
33
33
  self.unmarshal_class_method = :decode
34
34
  self.service_name = 'google.cloud.support.v2.CaseService'
35
35
 
36
- # Retrieve the specified case.
36
+ # Retrieve a case.
37
+ #
38
+ # EXAMPLES:
39
+ #
40
+ # cURL:
41
+ #
42
+ # ```shell
43
+ # case="projects/some-project/cases/16033687"
44
+ # curl \
45
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
46
+ # "https://cloudsupport.googleapis.com/v2/$case"
47
+ # ```
48
+ #
49
+ # Python:
50
+ #
51
+ # ```python
52
+ # import googleapiclient.discovery
53
+ #
54
+ # api_version = "v2"
55
+ # supportApiService = googleapiclient.discovery.build(
56
+ # serviceName="cloudsupport",
57
+ # version=api_version,
58
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
59
+ # )
60
+ #
61
+ # request = supportApiService.cases().get(
62
+ # name="projects/some-project/cases/43595344",
63
+ # )
64
+ # print(request.execute())
65
+ # ```
37
66
  rpc :GetCase, ::Google::Cloud::Support::V2::GetCaseRequest, ::Google::Cloud::Support::V2::Case
38
- # Retrieve all cases under the specified parent.
67
+ # Retrieve all cases under a parent, but not its children.
68
+ #
69
+ # For example, listing cases under an organization only returns the cases
70
+ # that are directly parented by that organization. To retrieve cases
71
+ # under an organization and its projects, use `cases.search`.
72
+ #
73
+ # EXAMPLES:
74
+ #
75
+ # cURL:
76
+ #
77
+ # ```shell
78
+ # parent="projects/some-project"
79
+ # curl \
80
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
81
+ # "https://cloudsupport.googleapis.com/v2/$parent/cases"
82
+ # ```
83
+ #
84
+ # Python:
85
+ #
86
+ # ```python
87
+ # import googleapiclient.discovery
88
+ #
89
+ # api_version = "v2"
90
+ # supportApiService = googleapiclient.discovery.build(
91
+ # serviceName="cloudsupport",
92
+ # version=api_version,
93
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
94
+ # )
39
95
  #
40
- # Note: Listing cases under an Organization returns only the cases directly
41
- # parented by that organization. To retrieve all cases under an organization,
42
- # including cases parented by projects under that organization, use
43
- # `cases.search`.
96
+ # request =
97
+ # supportApiService.cases().list(parent="projects/some-project")
98
+ # print(request.execute())
99
+ # ```
44
100
  rpc :ListCases, ::Google::Cloud::Support::V2::ListCasesRequest, ::Google::Cloud::Support::V2::ListCasesResponse
45
- # Search cases using the specified query.
101
+ # Search for cases using a query.
102
+ #
103
+ # EXAMPLES:
104
+ #
105
+ # cURL:
106
+ #
107
+ # ```shell
108
+ # parent="projects/some-project"
109
+ # curl \
110
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
111
+ # "https://cloudsupport.googleapis.com/v2/$parent/cases:search"
112
+ # ```
113
+ #
114
+ # Python:
115
+ #
116
+ # ```python
117
+ # import googleapiclient.discovery
118
+ #
119
+ # api_version = "v2"
120
+ # supportApiService = googleapiclient.discovery.build(
121
+ # serviceName="cloudsupport",
122
+ # version=api_version,
123
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
124
+ # )
125
+ # request = supportApiService.cases().search(
126
+ # parent="projects/some-project", query="state=OPEN"
127
+ # )
128
+ # print(request.execute())
129
+ # ```
46
130
  rpc :SearchCases, ::Google::Cloud::Support::V2::SearchCasesRequest, ::Google::Cloud::Support::V2::SearchCasesResponse
47
- # Create a new case and associate it with the given Google Cloud Resource.
48
- # The case object must have the following fields set: `display_name`,
49
- # `description`, `classification`, and `priority`.
131
+ # Create a new case and associate it with a parent.
132
+ #
133
+ # It must have the following fields set: `display_name`, `description`,
134
+ # `classification`, and `priority`. If you're just testing the API and don't
135
+ # want to route your case to an agent, set `testCase=true`.
136
+ #
137
+ # EXAMPLES:
138
+ #
139
+ # cURL:
140
+ #
141
+ # ```shell
142
+ # parent="projects/some-project"
143
+ # curl \
144
+ # --request POST \
145
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
146
+ # --header 'Content-Type: application/json' \
147
+ # --data '{
148
+ # "display_name": "Test case created by me.",
149
+ # "description": "a random test case, feel free to close",
150
+ # "classification": {
151
+ # "id":
152
+ # "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
153
+ # },
154
+ # "time_zone": "-07:00",
155
+ # "subscriber_email_addresses": [
156
+ # "foo@domain.com",
157
+ # "bar@domain.com"
158
+ # ],
159
+ # "testCase": true,
160
+ # "priority": "P3"
161
+ # }' \
162
+ # "https://cloudsupport.googleapis.com/v2/$parent/cases"
163
+ # ```
164
+ #
165
+ # Python:
166
+ #
167
+ # ```python
168
+ # import googleapiclient.discovery
169
+ #
170
+ # api_version = "v2"
171
+ # supportApiService = googleapiclient.discovery.build(
172
+ # serviceName="cloudsupport",
173
+ # version=api_version,
174
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
175
+ # )
176
+ # request = supportApiService.cases().create(
177
+ # parent="projects/some-project",
178
+ # body={
179
+ # "displayName": "A Test Case",
180
+ # "description": "This is a test case.",
181
+ # "testCase": True,
182
+ # "priority": "P2",
183
+ # "classification": {
184
+ # "id":
185
+ # "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
186
+ # },
187
+ # },
188
+ # )
189
+ # print(request.execute())
190
+ # ```
50
191
  rpc :CreateCase, ::Google::Cloud::Support::V2::CreateCaseRequest, ::Google::Cloud::Support::V2::Case
51
- # Update the specified case. Only a subset of fields can be updated.
192
+ # Update a case. Only some fields can be updated.
193
+ #
194
+ # EXAMPLES:
195
+ #
196
+ # cURL:
197
+ #
198
+ # ```shell
199
+ # case="projects/some-project/cases/43595344"
200
+ # curl \
201
+ # --request PATCH \
202
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
203
+ # --header "Content-Type: application/json" \
204
+ # --data '{
205
+ # "priority": "P1"
206
+ # }' \
207
+ # "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority"
208
+ # ```
209
+ #
210
+ # Python:
211
+ #
212
+ # ```python
213
+ # import googleapiclient.discovery
214
+ #
215
+ # api_version = "v2"
216
+ # supportApiService = googleapiclient.discovery.build(
217
+ # serviceName="cloudsupport",
218
+ # version=api_version,
219
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
220
+ # )
221
+ # request = supportApiService.cases().patch(
222
+ # name="projects/some-project/cases/43112854",
223
+ # body={
224
+ # "displayName": "This is Now a New Title",
225
+ # "priority": "P2",
226
+ # },
227
+ # )
228
+ # print(request.execute())
229
+ # ```
52
230
  rpc :UpdateCase, ::Google::Cloud::Support::V2::UpdateCaseRequest, ::Google::Cloud::Support::V2::Case
53
- # Escalate a case. Escalating a case will initiate the Google Cloud Support
54
- # escalation management process.
231
+ # Escalate a case, starting the Google Cloud Support escalation management
232
+ # process.
55
233
  #
56
- # This operation is only available to certain Customer Care tiers. Go to
234
+ # This operation is only available for some support services. Go to
57
235
  # https://cloud.google.com/support and look for 'Technical support
58
- # escalations' in the feature list to find out which tiers are able to
59
- # perform escalations.
236
+ # escalations' in the feature list to find out which ones let you
237
+ # do that.
238
+ #
239
+ # EXAMPLES:
240
+ #
241
+ # cURL:
242
+ #
243
+ # ```shell
244
+ # case="projects/some-project/cases/43595344"
245
+ # curl \
246
+ # --request POST \
247
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
248
+ # --header "Content-Type: application/json" \
249
+ # --data '{
250
+ # "escalation": {
251
+ # "reason": "BUSINESS_IMPACT",
252
+ # "justification": "This is a test escalation."
253
+ # }
254
+ # }' \
255
+ # "https://cloudsupport.googleapis.com/v2/$case:escalate"
256
+ # ```
257
+ #
258
+ # Python:
259
+ #
260
+ # ```python
261
+ # import googleapiclient.discovery
262
+ #
263
+ # api_version = "v2"
264
+ # supportApiService = googleapiclient.discovery.build(
265
+ # serviceName="cloudsupport",
266
+ # version=api_version,
267
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
268
+ # )
269
+ # request = supportApiService.cases().escalate(
270
+ # name="projects/some-project/cases/43595344",
271
+ # body={
272
+ # "escalation": {
273
+ # "reason": "BUSINESS_IMPACT",
274
+ # "justification": "This is a test escalation.",
275
+ # },
276
+ # },
277
+ # )
278
+ # print(request.execute())
279
+ # ```
60
280
  rpc :EscalateCase, ::Google::Cloud::Support::V2::EscalateCaseRequest, ::Google::Cloud::Support::V2::Case
61
- # Close the specified case.
281
+ # Close a case.
282
+ #
283
+ # EXAMPLES:
284
+ #
285
+ # cURL:
286
+ #
287
+ # ```shell
288
+ # case="projects/some-project/cases/43595344"
289
+ # curl \
290
+ # --request POST \
291
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
292
+ # "https://cloudsupport.googleapis.com/v2/$case:close"
293
+ # ```
294
+ #
295
+ # Python:
296
+ #
297
+ # ```python
298
+ # import googleapiclient.discovery
299
+ #
300
+ # api_version = "v2"
301
+ # supportApiService = googleapiclient.discovery.build(
302
+ # serviceName="cloudsupport",
303
+ # version=api_version,
304
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
305
+ # )
306
+ # request = supportApiService.cases().close(
307
+ # name="projects/some-project/cases/43595344"
308
+ # )
309
+ # print(request.execute())
310
+ # ```
62
311
  rpc :CloseCase, ::Google::Cloud::Support::V2::CloseCaseRequest, ::Google::Cloud::Support::V2::Case
63
- # Retrieve valid classifications to be used when creating a support case.
64
- # The classications are hierarchical, with each classification containing
65
- # all levels of the hierarchy, separated by " > ". For example "Technical
66
- # Issue > Compute > Compute Engine".
312
+ # Retrieve valid classifications to use when creating a support case.
313
+ #
314
+ # Classifications are hierarchical. Each classification is a string
315
+ # containing all levels of the hierarchy separated by `" > "`. For example,
316
+ # `"Technical Issue > Compute > Compute Engine"`.
317
+ #
318
+ # Classification IDs returned by this endpoint are valid for at least six
319
+ # months. When a classification is deactivated, this endpoint immediately
320
+ # stops returning it. After six months, `case.create` requests using the
321
+ # classification will fail.
322
+ #
323
+ # EXAMPLES:
324
+ #
325
+ # cURL:
326
+ #
327
+ # ```shell
328
+ # curl \
329
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
330
+ # 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
331
+ # ```
332
+ #
333
+ # Python:
334
+ #
335
+ # ```python
336
+ # import googleapiclient.discovery
337
+ #
338
+ # supportApiService = googleapiclient.discovery.build(
339
+ # serviceName="cloudsupport",
340
+ # version="v2",
341
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2",
342
+ # )
343
+ # request = supportApiService.caseClassifications().search(
344
+ # query='display_name:"*Compute Engine*"'
345
+ # )
346
+ # print(request.execute())
347
+ # ```
67
348
  rpc :SearchCaseClassifications, ::Google::Cloud::Support::V2::SearchCaseClassificationsRequest, ::Google::Cloud::Support::V2::SearchCaseClassificationsResponse
68
349
  end
69
350
 
@@ -10,7 +10,7 @@ require 'google/cloud/support/v2/actor_pb'
10
10
  require 'google/protobuf/timestamp_pb'
11
11
 
12
12
 
13
- descriptor_data = "\n%google/cloud/support/v2/comment.proto\x12\x17google.cloud.support.v2\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/cloud/support/v2/actor.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xd2\x02\n\x07\x43omment\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x07\x63reator\x18\x03 \x01(\x0b\x32\x1e.google.cloud.support.v2.ActorB\x03\xe0\x41\x03\x12\x0c\n\x04\x62ody\x18\x04 \x01(\t\x12\x1c\n\x0fplain_text_body\x18\x05 \x01(\tB\x03\xe0\x41\x03:\x9b\x01\xea\x41\x97\x01\n#cloudsupport.googleapis.com/Comment\x12<organizations/{organization}/cases/{case}/comments/{comment}\x12\x32projects/{project}/cases/{case}/comments/{comment}B\xb5\x01\n\x1b\x63om.google.cloud.support.v2B\x0c\x43ommentProtoP\x01Z5cloud.google.com/go/support/apiv2/supportpb;supportpb\xaa\x02\x17Google.Cloud.Support.V2\xca\x02\x17Google\\Cloud\\Support\\V2\xea\x02\x1aGoogle::Cloud::Support::V2b\x06proto3"
13
+ descriptor_data = "\n%google/cloud/support/v2/comment.proto\x12\x17google.cloud.support.v2\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/cloud/support/v2/actor.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xd7\x02\n\x07\x43omment\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xe0\x41\x08\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x07\x63reator\x18\x03 \x01(\x0b\x32\x1e.google.cloud.support.v2.ActorB\x03\xe0\x41\x03\x12\x0c\n\x04\x62ody\x18\x04 \x01(\t\x12\x1e\n\x0fplain_text_body\x18\x05 \x01(\tB\x05\x18\x01\xe0\x41\x03:\x9b\x01\xea\x41\x97\x01\n#cloudsupport.googleapis.com/Comment\x12<organizations/{organization}/cases/{case}/comments/{comment}\x12\x32projects/{project}/cases/{case}/comments/{comment}B\xb5\x01\n\x1b\x63om.google.cloud.support.v2B\x0c\x43ommentProtoP\x01Z5cloud.google.com/go/support/apiv2/supportpb;supportpb\xaa\x02\x17Google.Cloud.Support.V2\xca\x02\x17Google\\Cloud\\Support\\V2\xea\x02\x1aGoogle::Cloud::Support::V2b\x06proto3"
14
14
 
15
15
  pool = Google::Protobuf::DescriptorPool.generated_pool
16
16
 
@@ -191,7 +191,37 @@ module Google
191
191
  # Service calls
192
192
 
193
193
  ##
194
- # Retrieve all Comments associated with the Case object.
194
+ # List all the comments associated with a case.
195
+ #
196
+ # EXAMPLES:
197
+ #
198
+ # cURL:
199
+ #
200
+ # ```shell
201
+ # case="projects/some-project/cases/43595344"
202
+ # curl \
203
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
204
+ # "https://cloudsupport.googleapis.com/v2/$case/comments"
205
+ # ```
206
+ #
207
+ # Python:
208
+ #
209
+ # ```python
210
+ # import googleapiclient.discovery
211
+ #
212
+ # api_version = "v2"
213
+ # supportApiService = googleapiclient.discovery.build(
214
+ # serviceName="cloudsupport",
215
+ # version=api_version,
216
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
217
+ # )
218
+ # request = (
219
+ # supportApiService.cases()
220
+ # .comments()
221
+ # .list(parent="projects/some-project/cases/43595344")
222
+ # )
223
+ # print(request.execute())
224
+ # ```
195
225
  #
196
226
  # @overload list_comments(request, options = nil)
197
227
  # Pass arguments to `list_comments` via a request object, either of type
@@ -209,13 +239,12 @@ module Google
209
239
  # the default parameter values, pass an empty Hash as a request object (see above).
210
240
  #
211
241
  # @param parent [::String]
212
- # Required. The resource name of Case object for which comments should be
213
- # listed.
242
+ # Required. The name of the case for which to list comments.
214
243
  # @param page_size [::Integer]
215
- # The maximum number of comments fetched with each request. Defaults to 10.
244
+ # The maximum number of comments to fetch. Defaults to 10.
216
245
  # @param page_token [::String]
217
246
  # A token identifying the page of results to return. If unspecified, the
218
- # first page is retrieved.
247
+ # first page is returned.
219
248
  #
220
249
  # @yield [response, operation] Access the result along with the RPC operation
221
250
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Support::V2::Comment>]
@@ -288,8 +317,47 @@ module Google
288
317
  end
289
318
 
290
319
  ##
291
- # Add a new comment to the specified Case.
292
- # The comment object must have the following fields set: body.
320
+ # Add a new comment to a case.
321
+ #
322
+ # The comment must have the following fields set: `body`.
323
+ #
324
+ # EXAMPLES:
325
+ #
326
+ # cURL:
327
+ #
328
+ # ```shell
329
+ # case="projects/some-project/cases/43591344"
330
+ # curl \
331
+ # --request POST \
332
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
333
+ # --header 'Content-Type: application/json' \
334
+ # --data '{
335
+ # "body": "This is a test comment."
336
+ # }' \
337
+ # "https://cloudsupport.googleapis.com/v2/$case/comments"
338
+ # ```
339
+ #
340
+ # Python:
341
+ #
342
+ # ```python
343
+ # import googleapiclient.discovery
344
+ #
345
+ # api_version = "v2"
346
+ # supportApiService = googleapiclient.discovery.build(
347
+ # serviceName="cloudsupport",
348
+ # version=api_version,
349
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
350
+ # )
351
+ # request = (
352
+ # supportApiService.cases()
353
+ # .comments()
354
+ # .create(
355
+ # parent="projects/some-project/cases/43595344",
356
+ # body=\\{"body": "This is a test comment."},
357
+ # )
358
+ # )
359
+ # print(request.execute())
360
+ # ```
293
361
  #
294
362
  # @overload create_comment(request, options = nil)
295
363
  # Pass arguments to `create_comment` via a request object, either of type
@@ -307,9 +375,9 @@ module Google
307
375
  # the default parameter values, pass an empty Hash as a request object (see above).
308
376
  #
309
377
  # @param parent [::String]
310
- # Required. The resource name of Case to which this comment should be added.
378
+ # Required. The name of the case to which the comment should be added.
311
379
  # @param comment [::Google::Cloud::Support::V2::Comment, ::Hash]
312
- # Required. The Comment object to be added to this Case.
380
+ # Required. The comment to be added.
313
381
  #
314
382
  # @yield [response, operation] Access the result along with the RPC operation
315
383
  # @yieldparam response [::Google::Cloud::Support::V2::Comment]
@@ -33,10 +33,79 @@ module Google
33
33
  self.unmarshal_class_method = :decode
34
34
  self.service_name = 'google.cloud.support.v2.CommentService'
35
35
 
36
- # Retrieve all Comments associated with the Case object.
36
+ # List all the comments associated with a case.
37
+ #
38
+ # EXAMPLES:
39
+ #
40
+ # cURL:
41
+ #
42
+ # ```shell
43
+ # case="projects/some-project/cases/43595344"
44
+ # curl \
45
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
46
+ # "https://cloudsupport.googleapis.com/v2/$case/comments"
47
+ # ```
48
+ #
49
+ # Python:
50
+ #
51
+ # ```python
52
+ # import googleapiclient.discovery
53
+ #
54
+ # api_version = "v2"
55
+ # supportApiService = googleapiclient.discovery.build(
56
+ # serviceName="cloudsupport",
57
+ # version=api_version,
58
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
59
+ # )
60
+ # request = (
61
+ # supportApiService.cases()
62
+ # .comments()
63
+ # .list(parent="projects/some-project/cases/43595344")
64
+ # )
65
+ # print(request.execute())
66
+ # ```
37
67
  rpc :ListComments, ::Google::Cloud::Support::V2::ListCommentsRequest, ::Google::Cloud::Support::V2::ListCommentsResponse
38
- # Add a new comment to the specified Case.
39
- # The comment object must have the following fields set: body.
68
+ # Add a new comment to a case.
69
+ #
70
+ # The comment must have the following fields set: `body`.
71
+ #
72
+ # EXAMPLES:
73
+ #
74
+ # cURL:
75
+ #
76
+ # ```shell
77
+ # case="projects/some-project/cases/43591344"
78
+ # curl \
79
+ # --request POST \
80
+ # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
81
+ # --header 'Content-Type: application/json' \
82
+ # --data '{
83
+ # "body": "This is a test comment."
84
+ # }' \
85
+ # "https://cloudsupport.googleapis.com/v2/$case/comments"
86
+ # ```
87
+ #
88
+ # Python:
89
+ #
90
+ # ```python
91
+ # import googleapiclient.discovery
92
+ #
93
+ # api_version = "v2"
94
+ # supportApiService = googleapiclient.discovery.build(
95
+ # serviceName="cloudsupport",
96
+ # version=api_version,
97
+ # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
98
+ # )
99
+ # request = (
100
+ # supportApiService.cases()
101
+ # .comments()
102
+ # .create(
103
+ # parent="projects/some-project/cases/43595344",
104
+ # body={"body": "This is a test comment."},
105
+ # )
106
+ # )
107
+ # print(request.execute())
108
+ # ```
40
109
  rpc :CreateComment, ::Google::Cloud::Support::V2::CreateCommentRequest, ::Google::Cloud::Support::V2::Comment
41
110
  end
42
111
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Support
23
23
  module V2
24
- VERSION = "1.3.0"
24
+ VERSION = "1.4.0"
25
25
  end
26
26
  end
27
27
  end
@@ -21,8 +21,9 @@ module Google
21
21
  module Cloud
22
22
  module Support
23
23
  module V2
24
- # An object containing information about the effective user and
25
- # authenticated principal responsible for an action.
24
+ # An Actor represents an entity that performed an action. For example, an actor
25
+ # could be a user who posted a comment on a support case, a user who
26
+ # uploaded an attachment, or a service account that created a support case.
26
27
  # @!attribute [rw] display_name
27
28
  # @return [::String]
28
29
  # The name to display for the actor. If not provided, it is inferred from
@@ -30,15 +31,24 @@ module Google
30
31
  # display name must also be provided. This will be obfuscated if the user
31
32
  # is a Google Support agent.
32
33
  # @!attribute [rw] email
34
+ # @deprecated This field is deprecated and may be removed in the next major version update.
33
35
  # @return [::String]
34
- # The email address of the actor. If not provided, it is inferred from
35
- # credentials supplied during case creation. If the authenticated principal
36
- # does not have an email address, one must be provided. When a name is
37
- # provided, an email must also be provided. This will be obfuscated if the
38
- # user is a Google Support agent.
36
+ # The email address of the actor. If not provided, it is inferred from the
37
+ # credentials supplied during case creation. When a name is provided, an
38
+ # email must also be provided. If the user is a Google Support agent, this is
39
+ # obfuscated.
40
+ #
41
+ # This field is deprecated. Use **username** field instead.
39
42
  # @!attribute [r] google_support
40
43
  # @return [::Boolean]
41
44
  # Output only. Whether the actor is a Google support actor.
45
+ # @!attribute [r] username
46
+ # @return [::String]
47
+ # Output only. The username of the actor. It may look like an email or other
48
+ # format provided by the identity provider. If not provided, it is inferred
49
+ # from the credentials supplied. When a name is provided, a username must
50
+ # also be provided. If the user is a Google Support agent, this will not be
51
+ # set.
42
52
  class Actor
43
53
  include ::Google::Protobuf::MessageExts
44
54
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -21,7 +21,14 @@ module Google
21
21
  module Cloud
22
22
  module Support
23
23
  module V2
24
- # Represents a file attached to a support case.
24
+ # An Attachment contains metadata about a file that was uploaded to a
25
+ # case - it is NOT a file itself. That being said, the name of an Attachment
26
+ # object can be used to download its accompanying file through the
27
+ # `media.download` endpoint.
28
+ #
29
+ # While attachments can be uploaded in the console at the
30
+ # same time as a comment, they're associated on a "case" level, not a
31
+ # "comment" level.
25
32
  # @!attribute [r] name
26
33
  # @return [::String]
27
34
  # Output only. The resource name of the attachment.
@@ -24,13 +24,17 @@ module Google
24
24
  # The request message for the ListAttachments endpoint.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. The resource name of Case object for which attachments should be
28
- # listed.
27
+ # Required. The name of the case for which attachments should be listed.
29
28
  # @!attribute [rw] page_size
30
29
  # @return [::Integer]
31
- # The maximum number of attachments fetched with each request. If not
32
- # provided, the default is 10. The maximum page size that will be returned is
33
- # 100.
30
+ # The maximum number of attachments fetched with each request.
31
+ #
32
+ # If not provided, the default is 10. The maximum page size that will be
33
+ # returned is 100.
34
+ #
35
+ # The size of each page can be smaller than the requested page size and can
36
+ # include zero. For example, you could request 100 attachments on one page,
37
+ # receive 0, and then on the next page, receive 90.
34
38
  # @!attribute [rw] page_token
35
39
  # @return [::String]
36
40
  # A token identifying the page of results to return. If unspecified, the
@@ -43,12 +47,12 @@ module Google
43
47
  # The response message for the ListAttachments endpoint.
44
48
  # @!attribute [rw] attachments
45
49
  # @return [::Array<::Google::Cloud::Support::V2::Attachment>]
46
- # The list of attachments associated with the given case.
50
+ # The list of attachments associated with a case.
47
51
  # @!attribute [rw] next_page_token
48
52
  # @return [::String]
49
- # A token to retrieve the next page of results. This should be set in the
50
- # `page_token` field of subsequent `cases.attachments.list` requests. If
51
- # unspecified, there are no more results to retrieve.
53
+ # A token to retrieve the next page of results. Set this in the `page_token`
54
+ # field of subsequent `cases.attachments.list` requests. If unspecified,
55
+ # there are no more results to retrieve.
52
56
  class ListAttachmentsResponse
53
57
  include ::Google::Protobuf::MessageExts
54
58
  extend ::Google::Protobuf::MessageExts::ClassMethods