google-cloud-support-v2 1.3.0 → 1.4.1

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 (21) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/support/v2/actor_pb.rb +1 -1
  3. data/lib/google/cloud/support/v2/attachment_pb.rb +1 -1
  4. data/lib/google/cloud/support/v2/attachment_service_services_pb.rb +2 -2
  5. data/lib/google/cloud/support/v2/case_attachment_service/client.rb +11 -7
  6. data/lib/google/cloud/support/v2/case_attachment_service.rb +1 -1
  7. data/lib/google/cloud/support/v2/case_pb.rb +1 -1
  8. data/lib/google/cloud/support/v2/case_service/client.rb +62 -57
  9. data/lib/google/cloud/support/v2/case_service_services_pb.rb +28 -21
  10. data/lib/google/cloud/support/v2/comment_pb.rb +1 -1
  11. data/lib/google/cloud/support/v2/comment_service/client.rb +9 -9
  12. data/lib/google/cloud/support/v2/comment_service_services_pb.rb +4 -3
  13. data/lib/google/cloud/support/v2/version.rb +1 -1
  14. data/proto_docs/google/cloud/support/v2/actor.rb +17 -7
  15. data/proto_docs/google/cloud/support/v2/attachment.rb +9 -2
  16. data/proto_docs/google/cloud/support/v2/attachment_service.rb +13 -9
  17. data/proto_docs/google/cloud/support/v2/case.rb +43 -4
  18. data/proto_docs/google/cloud/support/v2/case_service.rb +45 -47
  19. data/proto_docs/google/cloud/support/v2/comment.rb +16 -7
  20. data/proto_docs/google/cloud/support/v2/comment_service.rb +10 -11
  21. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3849242e47dbe8f4c18184a6db32ed02674382825090ff450a5fca4b05e698ad
4
- data.tar.gz: c749c316cf94f14c995f88ebc453c5a327e03b649f348f5e836cec38add3628c
3
+ metadata.gz: 8d39158c3d695b6aa74b3434a5165d9e91e3722da3ddaf787c8112ebbdf4ddf4
4
+ data.tar.gz: 915a4e79b13b827b9a82abc702aea717d274d1a4c14cc4b4f640bc4bb0419163
5
5
  SHA512:
6
- metadata.gz: cc62c571c23d035066a71b2c21c6fd9f4b1a84c6e390be92f497c91dc318155f545b6b02caf224621d75229a7c75caa2dc527e772f69dbdd21469801f0185568
7
- data.tar.gz: f214ca990e8af0032d5cae54e2da67490041a67d341098c1af5212e72830743624bc75a368ffb77d0f418e2b8076504da92e464e84f3a43351bd5a3017780cec
6
+ metadata.gz: 5a5e48a11f94ec1cda727f570a7b138df36c5eaf64abe20e616fa46e3e8dae6533276d2d2b3b2d52cdd6e006abef744099e5077df92f07d0e37defa5833f0e23
7
+ data.tar.gz: 52d3bbad6b88eef63d892ea252d771f7d13d09c6635fd4763606f75808078d1c0b09cbad6a774555be6c0e93896ea29eb57893f39bb4ceac8190994a00117567
data/lib/google/cloud/support/v2/actor_pb.rb CHANGED
@@ -7,7 +7,7 @@ require 'google/protobuf'
7
7
  require 'google/api/field_behavior_pb'
8
8
 
9
9
 
10
- descriptor_data = "\n#google/cloud/support/v2/actor.proto\x12\x17google.cloud.support.v2\x1a\x1fgoogle/api/field_behavior.proto\"I\n\x05\x41\x63tor\x12\x14\n\x0c\x64isplay_name\x18\x01 \x01(\t\x12\r\n\x05\x65mail\x18\x02 \x01(\t\x12\x1b\n\x0egoogle_support\x18\x04 \x01(\x08\x42\x03\xe0\x41\x03\x42\xb3\x01\n\x1b\x63om.google.cloud.support.v2B\nActorProtoP\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"
10
+ descriptor_data = "\n#google/cloud/support/v2/actor.proto\x12\x17google.cloud.support.v2\x1a\x1fgoogle/api/field_behavior.proto\"d\n\x05\x41\x63tor\x12\x14\n\x0c\x64isplay_name\x18\x01 \x01(\t\x12\x11\n\x05\x65mail\x18\x02 \x01(\tB\x02\x18\x01\x12\x1b\n\x0egoogle_support\x18\x04 \x01(\x08\x42\x03\xe0\x41\x03\x12\x15\n\x08username\x18\x05 \x01(\tB\x03\xe0\x41\x03\x42\xb3\x01\n\x1b\x63om.google.cloud.support.v2B\nActorProtoP\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"
11
11
 
12
12
  pool = Google::Protobuf::DescriptorPool.generated_pool
13
13
 
data/lib/google/cloud/support/v2/attachment_pb.rb CHANGED
@@ -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/attachment.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\"\x81\x03\n\nAttachment\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\x10\n\x08\x66ilename\x18\x04 \x01(\t\x12\x16\n\tmime_type\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x17\n\nsize_bytes\x18\x06 \x01(\x03\x42\x03\xe0\x41\x03:\xb0\x01\xea\x41\xac\x01\n&cloudsupport.googleapis.com/Attachment\x12\x45organizations/{organization}/cases/{case}/attachments/{attachment_id}\x12;projects/{project}/cases/{case}/attachments/{attachment_id}B\xb8\x01\n\x1b\x63om.google.cloud.support.v2B\x0f\x41ttachmentProtoP\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/attachment.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\"\x84\x03\n\nAttachment\x12\x14\n\x04name\x18\x01 \x01(\tB\x06\xe0\x41\x03\xe0\x41\x08\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\x10\n\x08\x66ilename\x18\x04 \x01(\t\x12\x16\n\tmime_type\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x17\n\nsize_bytes\x18\x06 \x01(\x03\x42\x03\xe0\x41\x03:\xb0\x01\xea\x41\xac\x01\n&cloudsupport.googleapis.com/Attachment\x12\x45organizations/{organization}/cases/{case}/attachments/{attachment_id}\x12;projects/{project}/cases/{case}/attachments/{attachment_id}B\xb8\x01\n\x1b\x63om.google.cloud.support.v2B\x0f\x41ttachmentProtoP\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
 
data/lib/google/cloud/support/v2/attachment_service_services_pb.rb CHANGED
@@ -24,7 +24,7 @@ module Google
24
24
  module Support
25
25
  module V2
26
26
  module CaseAttachmentService
27
- # A service to manage file attachment for Google Cloud support cases.
27
+ # A service to manage file attachments for Google Cloud support cases.
28
28
  class Service
29
29
 
30
30
  include ::GRPC::GenericService
@@ -33,7 +33,7 @@ module Google
33
33
  self.unmarshal_class_method = :decode
34
34
  self.service_name = 'google.cloud.support.v2.CaseAttachmentService'
35
35
 
36
- # Retrieve all attachments associated with a support case.
36
+ # List all the attachments associated with a support case.
37
37
  rpc :ListAttachments, ::Google::Cloud::Support::V2::ListAttachmentsRequest, ::Google::Cloud::Support::V2::ListAttachmentsResponse
38
38
  end
39
39
 
data/lib/google/cloud/support/v2/case_attachment_service/client.rb CHANGED
@@ -27,7 +27,7 @@ module Google
27
27
  ##
28
28
  # Client for the CaseAttachmentService service.
29
29
  #
30
- # A service to manage file attachment for Google Cloud support cases.
30
+ # A service to manage file attachments for Google Cloud support cases.
31
31
  #
32
32
  class Client
33
33
  # @private
@@ -189,7 +189,7 @@ module Google
189
189
  # Service calls
190
190
 
191
191
  ##
192
- # Retrieve all attachments associated with a support case.
192
+ # List all the attachments associated with a support case.
193
193
  #
194
194
  # @overload list_attachments(request, options = nil)
195
195
  # Pass arguments to `list_attachments` via a request object, either of type
@@ -207,12 +207,16 @@ module Google
207
207
  # the default parameter values, pass an empty Hash as a request object (see above).
208
208
  #
209
209
  # @param parent [::String]
210
- # Required. The resource name of Case object for which attachments should be
211
- # listed.
210
+ # Required. The name of the case for which attachments should be listed.
212
211
  # @param page_size [::Integer]
213
- # The maximum number of attachments fetched with each request. If not
214
- # provided, the default is 10. The maximum page size that will be returned is
215
- # 100.
212
+ # The maximum number of attachments fetched with each request.
213
+ #
214
+ # If not provided, the default is 10. The maximum page size that will be
215
+ # returned is 100.
216
+ #
217
+ # The size of each page can be smaller than the requested page size and can
218
+ # include zero. For example, you could request 100 attachments on one page,
219
+ # receive 0, and then on the next page, receive 90.
216
220
  # @param page_token [::String]
217
221
  # A token identifying the page of results to return. If unspecified, the
218
222
  # first page is retrieved.
data/lib/google/cloud/support/v2/case_attachment_service.rb CHANGED
@@ -31,7 +31,7 @@ module Google
31
31
  module Support
32
32
  module V2
33
33
  ##
34
- # A service to manage file attachment for Google Cloud support cases.
34
+ # A service to manage file attachments for Google Cloud support cases.
35
35
  #
36
36
  # @example Load this service and instantiate a gRPC client
37
37
  #
data/lib/google/cloud/support/v2/case_pb.rb CHANGED
@@ -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/case.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\"\xe1\x06\n\x04\x43\x61se\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x14\n\x0c\x64isplay_name\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x43\n\x0e\x63lassification\x18\x04 \x01(\x0b\x32+.google.cloud.support.v2.CaseClassification\x12\x11\n\ttime_zone\x18\x08 \x01(\t\x12\"\n\x1asubscriber_email_addresses\x18\t \x03(\t\x12\x37\n\x05state\x18\x0c \x01(\x0e\x32#.google.cloud.support.v2.Case.StateB\x03\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\r \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x0e \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12/\n\x07\x63reator\x18\x0f \x01(\x0b\x32\x1e.google.cloud.support.v2.Actor\x12\x15\n\rcontact_email\x18# \x01(\t\x12\x11\n\tescalated\x18\x11 \x01(\x08\x12\x11\n\ttest_case\x18\x13 \x01(\x08\x12\x15\n\rlanguage_code\x18\x17 \x01(\t\x12\x38\n\x08priority\x18 \x01(\x0e\x32&.google.cloud.support.v2.Case.Priority\"\x7f\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x07\n\x03NEW\x10\x01\x12\x1e\n\x1aIN_PROGRESS_GOOGLE_SUPPORT\x10\x02\x12\x13\n\x0f\x41\x43TION_REQUIRED\x10\x03\x12\x15\n\x11SOLUTION_PROVIDED\x10\x04\x12\n\n\x06\x43LOSED\x10\x05\"L\n\x08Priority\x12\x18\n\x14PRIORITY_UNSPECIFIED\x10\x00\x12\x06\n\x02P0\x10\x01\x12\x06\n\x02P1\x10\x02\x12\x06\n\x02P2\x10\x03\x12\x06\n\x02P3\x10\x04\x12\x06\n\x02P4\x10\x05:q\xea\x41n\n cloudsupport.googleapis.com/Case\x12)organizations/{organization}/cases/{case}\x12\x1fprojects/{project}/cases/{case}\"6\n\x12\x43\x61seClassification\x12\n\n\x02id\x18\x03 \x01(\t\x12\x14\n\x0c\x64isplay_name\x18\x04 \x01(\tB\xb2\x01\n\x1b\x63om.google.cloud.support.v2B\tCaseProtoP\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/case.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\"\xe6\x06\n\x04\x43\x61se\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x14\n\x0c\x64isplay_name\x18\x02 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x03 \x01(\t\x12\x43\n\x0e\x63lassification\x18\x04 \x01(\x0b\x32+.google.cloud.support.v2.CaseClassification\x12\x11\n\ttime_zone\x18\x08 \x01(\t\x12\"\n\x1asubscriber_email_addresses\x18\t \x03(\t\x12\x37\n\x05state\x18\x0c \x01(\x0e\x32#.google.cloud.support.v2.Case.StateB\x03\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\r \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x0e \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12/\n\x07\x63reator\x18\x0f \x01(\x0b\x32\x1e.google.cloud.support.v2.Actor\x12\x15\n\rcontact_email\x18# \x01(\t\x12\x11\n\tescalated\x18\x11 \x01(\x08\x12\x11\n\ttest_case\x18\x13 \x01(\x08\x12\x15\n\rlanguage_code\x18\x17 \x01(\t\x12\x38\n\x08priority\x18 \x01(\x0e\x32&.google.cloud.support.v2.Case.Priority\"\x7f\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x07\n\x03NEW\x10\x01\x12\x1e\n\x1aIN_PROGRESS_GOOGLE_SUPPORT\x10\x02\x12\x13\n\x0f\x41\x43TION_REQUIRED\x10\x03\x12\x15\n\x11SOLUTION_PROVIDED\x10\x04\x12\n\n\x06\x43LOSED\x10\x05\"L\n\x08Priority\x12\x18\n\x14PRIORITY_UNSPECIFIED\x10\x00\x12\x06\n\x02P0\x10\x01\x12\x06\n\x02P1\x10\x02\x12\x06\n\x02P2\x10\x03\x12\x06\n\x02P3\x10\x04\x12\x06\n\x02P4\x10\x05:q\xea\x41n\n cloudsupport.googleapis.com/Case\x12)organizations/{organization}/cases/{case}\x12\x1fprojects/{project}/cases/{case}\"6\n\x12\x43\x61seClassification\x12\n\n\x02id\x18\x03 \x01(\t\x12\x14\n\x0c\x64isplay_name\x18\x04 \x01(\tB\xb2\x01\n\x1b\x63om.google.cloud.support.v2B\tCaseProtoP\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
 
data/lib/google/cloud/support/v2/case_service/client.rb CHANGED
@@ -212,7 +212,7 @@ module Google
212
212
  # Service calls
213
213
 
214
214
  ##
215
- # Retrieve the specified case.
215
+ # Retrieve a case.
216
216
  #
217
217
  # @overload get_case(request, options = nil)
218
218
  # Pass arguments to `get_case` via a request object, either of type
@@ -230,7 +230,7 @@ module Google
230
230
  # the default parameter values, pass an empty Hash as a request object (see above).
231
231
  #
232
232
  # @param name [::String]
233
- # Required. The fully qualified name of a case to be retrieved.
233
+ # Required. The full name of a case to be retrieved.
234
234
  #
235
235
  # @yield [response, operation] Access the result along with the RPC operation
236
236
  # @yieldparam response [::Google::Cloud::Support::V2::Case]
@@ -297,12 +297,11 @@ module Google
297
297
  end
298
298
 
299
299
  ##
300
- # Retrieve all cases under the specified parent.
300
+ # Retrieve all cases under a parent, but not its children.
301
301
  #
302
- # Note: Listing cases under an Organization returns only the cases directly
303
- # parented by that organization. To retrieve all cases under an organization,
304
- # including cases parented by projects under that organization, use
305
- # `cases.search`.
302
+ # For example, listing cases under an organization only returns the cases
303
+ # that are directly parented by that organization. To retrieve cases
304
+ # under an organization and its projects, use `cases.search`.
306
305
  #
307
306
  # @overload list_cases(request, options = nil)
308
307
  # Pass arguments to `list_cases` via a request object, either of type
@@ -320,21 +319,23 @@ module Google
320
319
  # the default parameter values, pass an empty Hash as a request object (see above).
321
320
  #
322
321
  # @param parent [::String]
323
- # Required. The fully qualified name of parent resource to list cases under.
322
+ # Required. The name of a parent to list cases under.
324
323
  # @param filter [::String]
325
- # An expression written in filter language. If non-empty, the query returns
326
- # the cases that match the filter. Else, the query doesn't filter the cases.
324
+ # An expression used to filter cases.
327
325
  #
328
- # Filter expressions use the following fields with the operators equals (`=`)
329
- # and `AND`:
326
+ # If it's an empty string, then no filtering happens. Otherwise, the endpoint
327
+ # returns the cases that match the filter.
330
328
  #
331
- # - `state`: The accepted values are `OPEN` or `CLOSED`.
332
- # - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
329
+ # Expressions use the following fields separated by `AND` and specified with
330
+ # `=`:
331
+ #
332
+ # - `state`: Can be `OPEN` or `CLOSED`.
333
+ # - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You
333
334
  # can specify multiple values for priority using the `OR` operator. For
334
335
  # example, `priority=P1 OR priority=P2`.
335
336
  # - `creator.email`: The email address of the case creator.
336
337
  #
337
- # Examples:
338
+ # EXAMPLES:
338
339
  #
339
340
  # - `state=CLOSED`
340
341
  # - `state=OPEN AND creator.email="tester@example.com"`
@@ -416,7 +417,7 @@ module Google
416
417
  end
417
418
 
418
419
  ##
419
- # Search cases using the specified query.
420
+ # Search for cases using a query.
420
421
  #
421
422
  # @overload search_cases(request, options = nil)
422
423
  # Pass arguments to `search_cases` via a request object, either of type
@@ -434,23 +435,21 @@ module Google
434
435
  # the default parameter values, pass an empty Hash as a request object (see above).
435
436
  #
436
437
  # @param parent [::String]
437
- # The fully qualified name of parent resource to search cases under.
438
+ # The name of the parent resource to search for cases under.
438
439
  # @param query [::String]
439
- # An expression written in filter language.
440
+ # An expression used to filter cases.
440
441
  #
441
- # A query uses the following fields with the operators equals (`=`) and
442
- # `AND`:
442
+ # Expressions use the following fields separated by `AND` and specified with
443
+ # `=`:
443
444
  #
444
445
  # - `organization`: An organization name in the form
445
446
  # `organizations/<organization_id>`.
446
447
  # - `project`: A project name in the form `projects/<project_id>`.
447
- # - `state`: The accepted values are `OPEN` or `CLOSED`.
448
- # - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
448
+ # - `state`: Can be `OPEN` or `CLOSED`.
449
+ # - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You
449
450
  # can specify multiple values for priority using the `OR` operator. For
450
451
  # example, `priority=P1 OR priority=P2`.
451
452
  # - `creator.email`: The email address of the case creator.
452
- # - `billingAccount`: A billing account in the form
453
- # `billingAccounts/<billing_account_id>`
454
453
  #
455
454
  # You must specify either `organization` or `project`.
456
455
  #
@@ -467,7 +466,6 @@ module Google
467
466
  # - `organization="organizations/123456789"`
468
467
  # - `project="projects/my-project-id"`
469
468
  # - `project="projects/123456789"`
470
- # - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"`
471
469
  # - `organization="organizations/123456789" AND state=CLOSED`
472
470
  # - `project="projects/my-project-id" AND creator.email="tester@example.com"`
473
471
  # - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
@@ -549,9 +547,11 @@ module Google
549
547
  end
550
548
 
551
549
  ##
552
- # Create a new case and associate it with the given Google Cloud Resource.
553
- # The case object must have the following fields set: `display_name`,
554
- # `description`, `classification`, and `priority`.
550
+ # Create a new case and associate it with a parent.
551
+ #
552
+ # It must have the following fields set: `display_name`, `description`,
553
+ # `classification`, and `priority`. If you're just testing the API and don't
554
+ # want to route your case to an agent, set `testCase=true`.
555
555
  #
556
556
  # @overload create_case(request, options = nil)
557
557
  # Pass arguments to `create_case` via a request object, either of type
@@ -569,8 +569,7 @@ module Google
569
569
  # the default parameter values, pass an empty Hash as a request object (see above).
570
570
  #
571
571
  # @param parent [::String]
572
- # Required. The name of the Google Cloud Resource under which the case should
573
- # be created.
572
+ # Required. The name of the parent under which the case should be created.
574
573
  # @param case [::Google::Cloud::Support::V2::Case, ::Hash]
575
574
  # Required. The case to be created.
576
575
  #
@@ -639,7 +638,7 @@ module Google
639
638
  end
640
639
 
641
640
  ##
642
- # Update the specified case. Only a subset of fields can be updated.
641
+ # Update a case. Only some fields can be updated.
643
642
  #
644
643
  # @overload update_case(request, options = nil)
645
644
  # Pass arguments to `update_case` via a request object, either of type
@@ -657,16 +656,15 @@ module Google
657
656
  # the default parameter values, pass an empty Hash as a request object (see above).
658
657
  #
659
658
  # @param case [::Google::Cloud::Support::V2::Case, ::Hash]
660
- # Required. The case object to update.
659
+ # Required. The case to update.
661
660
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
662
- # A list of attributes of the case object that should be updated
663
- # as part of this request. Supported values are `priority`, `display_name`,
664
- # and `subscriber_email_addresses`. If no fields are specified, all supported
665
- # fields are updated.
666
- #
667
- # WARNING: If you do not provide a field mask, then you might accidentally
668
- # clear some fields. For example, if you leave the field mask empty and do
669
- # not provide a value for `subscriber_email_addresses`, then
661
+ # A list of attributes of the case that should be updated. Supported values
662
+ # are `priority`, `display_name`, and `subscriber_email_addresses`. If no
663
+ # fields are specified, all supported fields are updated.
664
+ #
665
+ # Be careful - if you do not provide a field mask, then you might
666
+ # accidentally clear some fields. For example, if you leave the field mask
667
+ # empty and do not provide a value for `subscriber_email_addresses`, then
670
668
  # `subscriber_email_addresses` is updated to empty.
671
669
  #
672
670
  # @yield [response, operation] Access the result along with the RPC operation
@@ -734,13 +732,13 @@ module Google
734
732
  end
735
733
 
736
734
  ##
737
- # Escalate a case. Escalating a case will initiate the Google Cloud Support
738
- # escalation management process.
735
+ # Escalate a case, starting the Google Cloud Support escalation management
736
+ # process.
739
737
  #
740
- # This operation is only available to certain Customer Care tiers. Go to
738
+ # This operation is only available for some support services. Go to
741
739
  # https://cloud.google.com/support and look for 'Technical support
742
- # escalations' in the feature list to find out which tiers are able to
743
- # perform escalations.
740
+ # escalations' in the feature list to find out which ones let you
741
+ # do that.
744
742
  #
745
743
  # @overload escalate_case(request, options = nil)
746
744
  # Pass arguments to `escalate_case` via a request object, either of type
@@ -758,9 +756,9 @@ module Google
758
756
  # the default parameter values, pass an empty Hash as a request object (see above).
759
757
  #
760
758
  # @param name [::String]
761
- # Required. The fully qualified name of the Case resource to be escalated.
759
+ # Required. The name of the case to be escalated.
762
760
  # @param escalation [::Google::Cloud::Support::V2::Escalation, ::Hash]
763
- # The escalation object to be sent with the escalation request.
761
+ # The escalation information to be sent with the escalation request.
764
762
  #
765
763
  # @yield [response, operation] Access the result along with the RPC operation
766
764
  # @yieldparam response [::Google::Cloud::Support::V2::Case]
@@ -827,7 +825,7 @@ module Google
827
825
  end
828
826
 
829
827
  ##
830
- # Close the specified case.
828
+ # Close a case.
831
829
  #
832
830
  # @overload close_case(request, options = nil)
833
831
  # Pass arguments to `close_case` via a request object, either of type
@@ -845,7 +843,7 @@ module Google
845
843
  # the default parameter values, pass an empty Hash as a request object (see above).
846
844
  #
847
845
  # @param name [::String]
848
- # Required. The fully qualified name of the case resource to be closed.
846
+ # Required. The name of the case to close.
849
847
  #
850
848
  # @yield [response, operation] Access the result along with the RPC operation
851
849
  # @yieldparam response [::Google::Cloud::Support::V2::Case]
@@ -912,10 +910,16 @@ module Google
912
910
  end
913
911
 
914
912
  ##
915
- # Retrieve valid classifications to be used when creating a support case.
916
- # The classications are hierarchical, with each classification containing
917
- # all levels of the hierarchy, separated by " > ". For example "Technical
918
- # Issue > Compute > Compute Engine".
913
+ # Retrieve valid classifications to use when creating a support case.
914
+ #
915
+ # Classifications are hierarchical. Each classification is a string
916
+ # containing all levels of the hierarchy separated by `" > "`. For example,
917
+ # `"Technical Issue > Compute > Compute Engine"`.
918
+ #
919
+ # Classification IDs returned by this endpoint are valid for at least six
920
+ # months. When a classification is deactivated, this endpoint immediately
921
+ # stops returning it. After six months, `case.create` requests using the
922
+ # classification will fail.
919
923
  #
920
924
  # @overload search_case_classifications(request, options = nil)
921
925
  # Pass arguments to `search_case_classifications` via a request object, either of type
@@ -933,11 +937,12 @@ module Google
933
937
  # the default parameter values, pass an empty Hash as a request object (see above).
934
938
  #
935
939
  # @param query [::String]
936
- # An expression written in the Google Cloud filter language. If non-empty,
937
- # then only cases whose fields match the filter are returned. If empty, then
938
- # no messages are filtered out.
940
+ # An expression used to filter case classifications.
941
+ #
942
+ # If it's an empty string, then no filtering happens. Otherwise, case
943
+ # classifications will be returned that match the filter.
939
944
  # @param page_size [::Integer]
940
- # The maximum number of cases fetched with each request.
945
+ # The maximum number of classifications fetched with each request.
941
946
  # @param page_token [::String]
942
947
  # A token identifying the page of results to return. If unspecified, the
943
948
  # first page is retrieved.
data/lib/google/cloud/support/v2/case_service_services_pb.rb CHANGED
@@ -33,37 +33,44 @@ 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
37
  rpc :GetCase, ::Google::Cloud::Support::V2::GetCaseRequest, ::Google::Cloud::Support::V2::Case
38
- # Retrieve all cases under the specified parent.
38
+ # Retrieve all cases under a parent, but not its children.
39
39
  #
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`.
40
+ # For example, listing cases under an organization only returns the cases
41
+ # that are directly parented by that organization. To retrieve cases
42
+ # under an organization and its projects, use `cases.search`.
44
43
  rpc :ListCases, ::Google::Cloud::Support::V2::ListCasesRequest, ::Google::Cloud::Support::V2::ListCasesResponse
45
- # Search cases using the specified query.
44
+ # Search for cases using a query.
46
45
  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`.
46
+ # Create a new case and associate it with a parent.
47
+ #
48
+ # It must have the following fields set: `display_name`, `description`,
49
+ # `classification`, and `priority`. If you're just testing the API and don't
50
+ # want to route your case to an agent, set `testCase=true`.
50
51
  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.
52
+ # Update a case. Only some fields can be updated.
52
53
  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.
54
+ # Escalate a case, starting the Google Cloud Support escalation management
55
+ # process.
55
56
  #
56
- # This operation is only available to certain Customer Care tiers. Go to
57
+ # This operation is only available for some support services. Go to
57
58
  # 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.
59
+ # escalations' in the feature list to find out which ones let you
60
+ # do that.
60
61
  rpc :EscalateCase, ::Google::Cloud::Support::V2::EscalateCaseRequest, ::Google::Cloud::Support::V2::Case
61
- # Close the specified case.
62
+ # Close a case.
62
63
  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".
64
+ # Retrieve valid classifications to use when creating a support case.
65
+ #
66
+ # Classifications are hierarchical. Each classification is a string
67
+ # containing all levels of the hierarchy separated by `" > "`. For example,
68
+ # `"Technical Issue > Compute > Compute Engine"`.
69
+ #
70
+ # Classification IDs returned by this endpoint are valid for at least six
71
+ # months. When a classification is deactivated, this endpoint immediately
72
+ # stops returning it. After six months, `case.create` requests using the
73
+ # classification will fail.
67
74
  rpc :SearchCaseClassifications, ::Google::Cloud::Support::V2::SearchCaseClassificationsRequest, ::Google::Cloud::Support::V2::SearchCaseClassificationsResponse
68
75
  end
69
76
 
data/lib/google/cloud/support/v2/comment_pb.rb CHANGED
@@ -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
 
data/lib/google/cloud/support/v2/comment_service/client.rb CHANGED
@@ -191,7 +191,7 @@ 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
195
  #
196
196
  # @overload list_comments(request, options = nil)
197
197
  # Pass arguments to `list_comments` via a request object, either of type
@@ -209,13 +209,12 @@ module Google
209
209
  # the default parameter values, pass an empty Hash as a request object (see above).
210
210
  #
211
211
  # @param parent [::String]
212
- # Required. The resource name of Case object for which comments should be
213
- # listed.
212
+ # Required. The name of the case for which to list comments.
214
213
  # @param page_size [::Integer]
215
- # The maximum number of comments fetched with each request. Defaults to 10.
214
+ # The maximum number of comments to fetch. Defaults to 10.
216
215
  # @param page_token [::String]
217
216
  # A token identifying the page of results to return. If unspecified, the
218
- # first page is retrieved.
217
+ # first page is returned.
219
218
  #
220
219
  # @yield [response, operation] Access the result along with the RPC operation
221
220
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Support::V2::Comment>]
@@ -288,8 +287,9 @@ module Google
288
287
  end
289
288
 
290
289
  ##
291
- # Add a new comment to the specified Case.
292
- # The comment object must have the following fields set: body.
290
+ # Add a new comment to a case.
291
+ #
292
+ # The comment must have the following fields set: `body`.
293
293
  #
294
294
  # @overload create_comment(request, options = nil)
295
295
  # Pass arguments to `create_comment` via a request object, either of type
@@ -307,9 +307,9 @@ module Google
307
307
  # the default parameter values, pass an empty Hash as a request object (see above).
308
308
  #
309
309
  # @param parent [::String]
310
- # Required. The resource name of Case to which this comment should be added.
310
+ # Required. The name of the case to which the comment should be added.
311
311
  # @param comment [::Google::Cloud::Support::V2::Comment, ::Hash]
312
- # Required. The Comment object to be added to this Case.
312
+ # Required. The comment to be added.
313
313
  #
314
314
  # @yield [response, operation] Access the result along with the RPC operation
315
315
  # @yieldparam response [::Google::Cloud::Support::V2::Comment]
data/lib/google/cloud/support/v2/comment_service_services_pb.rb CHANGED
@@ -33,10 +33,11 @@ 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
37
  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.
38
+ # Add a new comment to a case.
39
+ #
40
+ # The comment must have the following fields set: `body`.
40
41
  rpc :CreateComment, ::Google::Cloud::Support::V2::CreateCommentRequest, ::Google::Cloud::Support::V2::Comment
41
42
  end
42
43
 
data/lib/google/cloud/support/v2/version.rb CHANGED
@@ -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.1"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/cloud/support/v2/actor.rb CHANGED
@@ -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` 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
data/proto_docs/google/cloud/support/v2/attachment.rb CHANGED
@@ -21,10 +21,17 @@ 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
- # Output only. The resource name of the attachment.
34
+ # Output only. Identifier. The resource name of the attachment.
28
35
  # @!attribute [r] create_time
29
36
  # @return [::Google::Protobuf::Timestamp]
30
37
  # Output only. The time at which the attachment was created.
data/proto_docs/google/cloud/support/v2/attachment_service.rb CHANGED
@@ -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
data/proto_docs/google/cloud/support/v2/case.rb CHANGED
@@ -21,10 +21,36 @@ module Google
21
21
  module Cloud
22
22
  module Support
23
23
  module V2
24
- # A support case.
24
+ # A Case is an object that contains the details of a support case. It
25
+ # contains fields for the time it was created, its priority, its
26
+ # classification, and more. Cases can also have comments and attachments that
27
+ # get added over time.
28
+ #
29
+ # A case is parented by a Google Cloud organization or project.
30
+ #
31
+ # Organizations are identified by a number, so the name of a case parented by
32
+ # an organization would look like this:
33
+ #
34
+ # ```
35
+ # organizations/123/cases/456
36
+ # ```
37
+ #
38
+ # Projects have two unique identifiers, an ID and a number, and they look like
39
+ # this:
40
+ #
41
+ # ```
42
+ # projects/abc/cases/456
43
+ # ```
44
+ #
45
+ # ```
46
+ # projects/123/cases/456
47
+ # ```
48
+ #
49
+ # You can use either of them when calling the API. To learn more
50
+ # about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
25
51
  # @!attribute [rw] name
26
52
  # @return [::String]
27
- # The resource name for the case.
53
+ # Identifier. The resource name for the case.
28
54
  # @!attribute [rw] display_name
29
55
  # @return [::String]
30
56
  # The short summary of the issue reported in this case.
@@ -132,16 +158,29 @@ module Google
132
158
  end
133
159
  end
134
160
 
135
- # A classification object with a product type and value.
161
+ # A Case Classification represents the topic that a case is about. It's very
162
+ # important to use accurate classifications, because they're
163
+ # used to route your cases to specialists who can help you.
164
+ #
165
+ # A classification always has an ID that is its unique identifier.
166
+ # A valid ID is required when creating a case.
136
167
  # @!attribute [rw] id
137
168
  # @return [::String]
138
169
  # The unique ID for a classification. Must be specified for case creation.
139
170
  #
140
171
  # To retrieve valid classification IDs for case creation, use
141
172
  # `caseClassifications.search`.
173
+ #
174
+ # Classification IDs returned by `caseClassifications.search` are guaranteed
175
+ # to be valid for at least 6 months. If a given classification is
176
+ # deactiveated, it will immediately stop being returned. After 6 months,
177
+ # `case.create` requests using the classification ID will fail.
142
178
  # @!attribute [rw] display_name
143
179
  # @return [::String]
144
- # The display name of the classification.
180
+ # A display name for the classification.
181
+ #
182
+ # The display name is not static and can change. To uniquely and consistently
183
+ # identify classifications, use the `CaseClassification.id` field.
145
184
  class CaseClassification
146
185
  include ::Google::Protobuf::MessageExts
147
186
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/support/v2/case_service.rb CHANGED
@@ -24,7 +24,7 @@ module Google
24
24
  # The request message for the GetCase endpoint.
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
- # Required. The fully qualified name of a case to be retrieved.
27
+ # Required. The full name of a case to be retrieved.
28
28
  class GetCaseRequest
29
29
  include ::Google::Protobuf::MessageExts
30
30
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -33,8 +33,7 @@ module Google
33
33
  # The request message for the CreateCase endpoint.
34
34
  # @!attribute [rw] parent
35
35
  # @return [::String]
36
- # Required. The name of the Google Cloud Resource under which the case should
37
- # be created.
36
+ # Required. The name of the parent under which the case should be created.
38
37
  # @!attribute [rw] case
39
38
  # @return [::Google::Cloud::Support::V2::Case]
40
39
  # Required. The case to be created.
@@ -46,22 +45,24 @@ module Google
46
45
  # The request message for the ListCases endpoint.
47
46
  # @!attribute [rw] parent
48
47
  # @return [::String]
49
- # Required. The fully qualified name of parent resource to list cases under.
48
+ # Required. The name of a parent to list cases under.
50
49
  # @!attribute [rw] filter
51
50
  # @return [::String]
52
- # An expression written in filter language. If non-empty, the query returns
53
- # the cases that match the filter. Else, the query doesn't filter the cases.
51
+ # An expression used to filter cases.
54
52
  #
55
- # Filter expressions use the following fields with the operators equals (`=`)
56
- # and `AND`:
53
+ # If it's an empty string, then no filtering happens. Otherwise, the endpoint
54
+ # returns the cases that match the filter.
57
55
  #
58
- # - `state`: The accepted values are `OPEN` or `CLOSED`.
59
- # - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
56
+ # Expressions use the following fields separated by `AND` and specified with
57
+ # `=`:
58
+ #
59
+ # - `state`: Can be `OPEN` or `CLOSED`.
60
+ # - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You
60
61
  # can specify multiple values for priority using the `OR` operator. For
61
62
  # example, `priority=P1 OR priority=P2`.
62
63
  # - `creator.email`: The email address of the case creator.
63
64
  #
64
- # Examples:
65
+ # EXAMPLES:
65
66
  #
66
67
  # - `state=CLOSED`
67
68
  # - `state=OPEN AND creator.email="tester@example.com"`
@@ -81,13 +82,13 @@ module Google
81
82
  # The response message for the ListCases endpoint.
82
83
  # @!attribute [rw] cases
83
84
  # @return [::Array<::Google::Cloud::Support::V2::Case>]
84
- # The list of cases associated with the Google Cloud Resource, after any
85
+ # The list of cases associated with the parent after any
85
86
  # filters have been applied.
86
87
  # @!attribute [rw] next_page_token
87
88
  # @return [::String]
88
- # A token to retrieve the next page of results. This should be set in the
89
- # `page_token` field of the subsequent `ListCasesRequest` message that is
90
- # issued. If unspecified, there are no more results to retrieve.
89
+ # A token to retrieve the next page of results. Set this in the `page_token`
90
+ # field of subsequent `cases.list` requests. If unspecified, there are no
91
+ # more results to retrieve.
91
92
  class ListCasesResponse
92
93
  include ::Google::Protobuf::MessageExts
93
94
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -96,24 +97,22 @@ module Google
96
97
  # The request message for the SearchCases endpoint.
97
98
  # @!attribute [rw] parent
98
99
  # @return [::String]
99
- # The fully qualified name of parent resource to search cases under.
100
+ # The name of the parent resource to search for cases under.
100
101
  # @!attribute [rw] query
101
102
  # @return [::String]
102
- # An expression written in filter language.
103
+ # An expression used to filter cases.
103
104
  #
104
- # A query uses the following fields with the operators equals (`=`) and
105
- # `AND`:
105
+ # Expressions use the following fields separated by `AND` and specified with
106
+ # `=`:
106
107
  #
107
108
  # - `organization`: An organization name in the form
108
109
  # `organizations/<organization_id>`.
109
110
  # - `project`: A project name in the form `projects/<project_id>`.
110
- # - `state`: The accepted values are `OPEN` or `CLOSED`.
111
- # - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
111
+ # - `state`: Can be `OPEN` or `CLOSED`.
112
+ # - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You
112
113
  # can specify multiple values for priority using the `OR` operator. For
113
114
  # example, `priority=P1 OR priority=P2`.
114
115
  # - `creator.email`: The email address of the case creator.
115
- # - `billingAccount`: A billing account in the form
116
- # `billingAccounts/<billing_account_id>`
117
116
  #
118
117
  # You must specify either `organization` or `project`.
119
118
  #
@@ -130,7 +129,6 @@ module Google
130
129
  # - `organization="organizations/123456789"`
131
130
  # - `project="projects/my-project-id"`
132
131
  # - `project="projects/123456789"`
133
- # - `billing_account="billingAccounts/123456-A0B0C0-CUZ789"`
134
132
  # - `organization="organizations/123456789" AND state=CLOSED`
135
133
  # - `project="projects/my-project-id" AND creator.email="tester@example.com"`
136
134
  # - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)`
@@ -150,13 +148,13 @@ module Google
150
148
  # The response message for the SearchCases endpoint.
151
149
  # @!attribute [rw] cases
152
150
  # @return [::Array<::Google::Cloud::Support::V2::Case>]
153
- # The list of cases associated with the Google Cloud Resource, after any
151
+ # The list of cases associated with the parent after any
154
152
  # filters have been applied.
155
153
  # @!attribute [rw] next_page_token
156
154
  # @return [::String]
157
- # A token to retrieve the next page of results. This should be set in the
158
- # `page_token` field of subsequent `SearchCaseRequest` message that is
159
- # issued. If unspecified, there are no more results to retrieve.
155
+ # A token to retrieve the next page of results. Set this in the
156
+ # `page_token` field of subsequent `cases.search` requests. If unspecified,
157
+ # there are no more results to retrieve.
160
158
  class SearchCasesResponse
161
159
  include ::Google::Protobuf::MessageExts
162
160
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -165,10 +163,10 @@ module Google
165
163
  # The request message for the EscalateCase endpoint.
166
164
  # @!attribute [rw] name
167
165
  # @return [::String]
168
- # Required. The fully qualified name of the Case resource to be escalated.
166
+ # Required. The name of the case to be escalated.
169
167
  # @!attribute [rw] escalation
170
168
  # @return [::Google::Cloud::Support::V2::Escalation]
171
- # The escalation object to be sent with the escalation request.
169
+ # The escalation information to be sent with the escalation request.
172
170
  class EscalateCaseRequest
173
171
  include ::Google::Protobuf::MessageExts
174
172
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -177,17 +175,16 @@ module Google
177
175
  # The request message for the UpdateCase endpoint
178
176
  # @!attribute [rw] case
179
177
  # @return [::Google::Cloud::Support::V2::Case]
180
- # Required. The case object to update.
178
+ # Required. The case to update.
181
179
  # @!attribute [rw] update_mask
182
180
  # @return [::Google::Protobuf::FieldMask]
183
- # A list of attributes of the case object that should be updated
184
- # as part of this request. Supported values are `priority`, `display_name`,
185
- # and `subscriber_email_addresses`. If no fields are specified, all supported
186
- # fields are updated.
181
+ # A list of attributes of the case that should be updated. Supported values
182
+ # are `priority`, `display_name`, and `subscriber_email_addresses`. If no
183
+ # fields are specified, all supported fields are updated.
187
184
  #
188
- # WARNING: If you do not provide a field mask, then you might accidentally
189
- # clear some fields. For example, if you leave the field mask empty and do
190
- # not provide a value for `subscriber_email_addresses`, then
185
+ # Be careful - if you do not provide a field mask, then you might
186
+ # accidentally clear some fields. For example, if you leave the field mask
187
+ # empty and do not provide a value for `subscriber_email_addresses`, then
191
188
  # `subscriber_email_addresses` is updated to empty.
192
189
  class UpdateCaseRequest
193
190
  include ::Google::Protobuf::MessageExts
@@ -197,21 +194,22 @@ module Google
197
194
  # The request message for the CloseCase endpoint.
198
195
  # @!attribute [rw] name
199
196
  # @return [::String]
200
- # Required. The fully qualified name of the case resource to be closed.
197
+ # Required. The name of the case to close.
201
198
  class CloseCaseRequest
202
199
  include ::Google::Protobuf::MessageExts
203
200
  extend ::Google::Protobuf::MessageExts::ClassMethods
204
201
  end
205
202
 
206
- # The request message for SearchCaseClassifications endpoint.
203
+ # The request message for the SearchCaseClassifications endpoint.
207
204
  # @!attribute [rw] query
208
205
  # @return [::String]
209
- # An expression written in the Google Cloud filter language. If non-empty,
210
- # then only cases whose fields match the filter are returned. If empty, then
211
- # no messages are filtered out.
206
+ # An expression used to filter case classifications.
207
+ #
208
+ # If it's an empty string, then no filtering happens. Otherwise, case
209
+ # classifications will be returned that match the filter.
212
210
  # @!attribute [rw] page_size
213
211
  # @return [::Integer]
214
- # The maximum number of cases fetched with each request.
212
+ # The maximum number of classifications fetched with each request.
215
213
  # @!attribute [rw] page_token
216
214
  # @return [::String]
217
215
  # A token identifying the page of results to return. If unspecified, the
@@ -227,9 +225,9 @@ module Google
227
225
  # The classifications retrieved.
228
226
  # @!attribute [rw] next_page_token
229
227
  # @return [::String]
230
- # A token to retrieve the next page of results. This should be set in the
231
- # `page_token` field of subsequent `SearchCaseClassificationsRequest` message
232
- # that is issued. If unspecified, there are no more results to retrieve.
228
+ # A token to retrieve the next page of results. Set this in the `page_token`
229
+ # field of subsequent `caseClassifications.list` requests. If unspecified,
230
+ # there are no more results to retrieve.
233
231
  class SearchCaseClassificationsResponse
234
232
  include ::Google::Protobuf::MessageExts
235
233
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/support/v2/comment.rb CHANGED
@@ -22,23 +22,32 @@ module Google
22
22
  module Support
23
23
  module V2
24
24
  # A comment associated with a support case.
25
+ #
26
+ # Case comments are the primary way for Google Support to communicate with a
27
+ # user who has opened a case. When a user responds to Google Support, the
28
+ # user's responses also appear as comments.
25
29
  # @!attribute [r] name
26
30
  # @return [::String]
27
- # Output only. The resource name for the comment.
31
+ # Output only. Identifier. The resource name of the comment.
28
32
  # @!attribute [r] create_time
29
33
  # @return [::Google::Protobuf::Timestamp]
30
- # Output only. The time when this comment was created.
34
+ # Output only. The time when the comment was created.
31
35
  # @!attribute [r] creator
32
36
  # @return [::Google::Cloud::Support::V2::Actor]
33
- # Output only. The user or Google Support agent created this comment.
37
+ # Output only. The user or Google Support agent who created the comment.
34
38
  # @!attribute [rw] body
35
39
  # @return [::String]
36
- # The full comment body. Maximum of 12800 characters. This can contain rich
37
- # text syntax.
40
+ # The full comment body.
41
+ #
42
+ # Maximum of 12800 characters.
38
43
  # @!attribute [r] plain_text_body
44
+ # @deprecated This field is deprecated and may be removed in the next major version update.
39
45
  # @return [::String]
40
- # Output only. DEPRECATED. An automatically generated plain text version of
41
- # body with all rich text syntax stripped.
46
+ # Output only. DEPRECATED. DO NOT USE.
47
+ #
48
+ # A duplicate of the `body` field.
49
+ #
50
+ # This field is only present for legacy reasons.
42
51
  class Comment
43
52
  include ::Google::Protobuf::MessageExts
44
53
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/support/v2/comment_service.rb CHANGED
@@ -24,15 +24,14 @@ module Google
24
24
  # The request message for the ListComments endpoint.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. The resource name of Case object for which comments should be
28
- # listed.
27
+ # Required. The name of the case for which to list comments.
29
28
  # @!attribute [rw] page_size
30
29
  # @return [::Integer]
31
- # The maximum number of comments fetched with each request. Defaults to 10.
30
+ # The maximum number of comments to fetch. Defaults to 10.
32
31
  # @!attribute [rw] page_token
33
32
  # @return [::String]
34
33
  # A token identifying the page of results to return. If unspecified, the
35
- # first page is retrieved.
34
+ # first page is returned.
36
35
  class ListCommentsRequest
37
36
  include ::Google::Protobuf::MessageExts
38
37
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -41,24 +40,24 @@ module Google
41
40
  # The response message for the ListComments endpoint.
42
41
  # @!attribute [rw] comments
43
42
  # @return [::Array<::Google::Cloud::Support::V2::Comment>]
44
- # The list of Comments associated with the given Case.
43
+ # List of the comments associated with the case.
45
44
  # @!attribute [rw] next_page_token
46
45
  # @return [::String]
47
- # A token to retrieve the next page of results. This should be set in the
48
- # `page_token` field of subsequent `ListCommentsRequest` message that is
49
- # issued. If unspecified, there are no more results to retrieve.
46
+ # A token to retrieve the next page of results. Set this in the `page_token`
47
+ # field of subsequent `cases.comments.list` requests. If unspecified, there
48
+ # are no more results to retrieve.
50
49
  class ListCommentsResponse
51
50
  include ::Google::Protobuf::MessageExts
52
51
  extend ::Google::Protobuf::MessageExts::ClassMethods
53
52
  end
54
53
 
55
- # The request message for CreateComment endpoint.
54
+ # The request message for the CreateComment endpoint.
56
55
  # @!attribute [rw] parent
57
56
  # @return [::String]
58
- # Required. The resource name of Case to which this comment should be added.
57
+ # Required. The name of the case to which the comment should be added.
59
58
  # @!attribute [rw] comment
60
59
  # @return [::Google::Cloud::Support::V2::Comment]
61
- # Required. The Comment object to be added to this Case.
60
+ # Required. The comment to be added.
62
61
  class CreateCommentRequest
63
62
  include ::Google::Protobuf::MessageExts
64
63
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-support-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.0
4
+ version: 1.4.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
110
110
  - !ruby/object:Gem::Version
111
111
  version: '0'
112
112
  requirements: []
113
- rubygems_version: 3.6.8
113
+ rubygems_version: 3.6.9
114
114
  specification_version: 4
115
115
  summary: Manages Google Cloud technical support cases for Customer Care support offerings.
116
116
  test_files: []