Skip to content

Commit b0d0cfa

Browse files
feat(support-v2): Deprecated the Actor email field and replaced with username
docs(support-v2): Deprecated the Comment plain_text_body field docs(support-v2): Numerous additional edits and clarifications to the reference documentation
1 parent de9f707 commit b0d0cfa

16 files changed

Lines changed: 1014 additions & 187 deletions

File tree

google-cloud-support-v2/lib/google/cloud/support/v2/actor_pb.rb

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

google-cloud-support-v2/lib/google/cloud/support/v2/attachment_service_services_pb.rb

Lines changed: 32 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

google-cloud-support-v2/lib/google/cloud/support/v2/case_attachment_service.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module Cloud
3131
module Support
3232
module V2
3333
##
34-
# A service to manage file attachment for Google Cloud support cases.
34+
# A service to manage file attachments for Google Cloud support cases.
3535
#
3636
# @example Load this service and instantiate a gRPC client
3737
#

google-cloud-support-v2/lib/google/cloud/support/v2/case_attachment_service/client.rb

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module CaseAttachmentService
2727
##
2828
# Client for the CaseAttachmentService service.
2929
#
30-
# A service to manage file attachment for Google Cloud support cases.
30+
# A service to manage file attachments for Google Cloud support cases.
3131
#
3232
class Client
3333
# @private
@@ -189,7 +189,37 @@ def logger
189189
# Service calls
190190

191191
##
192-
# Retrieve all attachments associated with a support case.
192+
# List all the attachments associated with a support case.
193+
#
194+
# EXAMPLES:
195+
#
196+
# cURL:
197+
#
198+
# ```shell
199+
# case="projects/some-project/cases/23598314"
200+
# curl \
201+
# --header "Authorization: Bearer $(gcloud auth print-access-token)" \
202+
# "https://cloudsupport.googleapis.com/v2/$case/attachments"
203+
# ```
204+
#
205+
# Python:
206+
#
207+
# ```python
208+
# import googleapiclient.discovery
209+
#
210+
# api_version = "v2"
211+
# supportApiService = googleapiclient.discovery.build(
212+
# serviceName="cloudsupport",
213+
# version=api_version,
214+
# discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
215+
# )
216+
# request = (
217+
# supportApiService.cases()
218+
# .attachments()
219+
# .list(parent="projects/some-project/cases/43595344")
220+
# )
221+
# print(request.execute())
222+
# ```
193223
#
194224
# @overload list_attachments(request, options = nil)
195225
# Pass arguments to `list_attachments` via a request object, either of type
@@ -207,12 +237,16 @@ def logger
207237
# the default parameter values, pass an empty Hash as a request object (see above).
208238
#
209239
# @param parent [::String]
210-
# Required. The resource name of Case object for which attachments should be
211-
# listed.
240+
# Required. The name of the case for which attachments should be listed.
212241
# @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.
242+
# The maximum number of attachments fetched with each request.
243+
#
244+
# If not provided, the default is 10. The maximum page size that will be
245+
# returned is 100.
246+
#
247+
# The size of each page can be smaller than the requested page size and can
248+
# include zero. For example, you could request 100 attachments on one page,
249+
# receive 0, and then on the next page, receive 90.
216250
# @param page_token [::String]
217251
# A token identifying the page of results to return. If unspecified, the
218252
# first page is retrieved.

0 commit comments

Comments
 (0)