google-cloud-support-v2beta 0.1.0 → 0.2.0

data/lib/google/cloud/support/v2beta/comment_service/rest/client.rb

@@ -186,36 +186,6 @@ module Google
               ##
               # List all the comments associated with a case.
               #
-              # EXAMPLES:
-              #
-              # cURL:
-              #
-              # ```shell
-              # case="projects/some-project/cases/43595344"
-              # curl \
-              #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-              #   "https://cloudsupport.googleapis.com/v2/$case/comments"
-              # ```
-              #
-              # Python:
-              #
-              # ```python
-              # import googleapiclient.discovery
-              #
-              # api_version = "v2"
-              # supportApiService = googleapiclient.discovery.build(
-              #     serviceName="cloudsupport",
-              #     version=api_version,
-              #     discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
-              # )
-              # request = (
-              #     supportApiService.cases()
-              #     .comments()
-              #     .list(parent="projects/some-project/cases/43595344")
-              # )
-              # print(request.execute())
-              # ```
-              #
               # @overload list_comments(request, options = nil)
               #   Pass arguments to `list_comments` via a request object, either of type
               #   {::Google::Cloud::Support::V2beta::ListCommentsRequest} or an equivalent Hash.
@@ -307,44 +277,6 @@ module Google
               #
               # The comment must have the following fields set: `body`.
               #
-              # EXAMPLES:
-              #
-              # cURL:
-              #
-              # ```shell
-              # case="projects/some-project/cases/43591344"
-              # curl \
-              #   --request POST \
-              #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-              #   --header 'Content-Type: application/json' \
-              #   --data '{
-              #     "body": "This is a test comment."
-              #   }' \
-              #   "https://cloudsupport.googleapis.com/v2/$case/comments"
-              # ```
-              #
-              # Python:
-              #
-              # ```python
-              # import googleapiclient.discovery
-              #
-              # api_version = "v2"
-              # supportApiService = googleapiclient.discovery.build(
-              #     serviceName="cloudsupport",
-              #     version=api_version,
-              #     discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
-              # )
-              # request = (
-              #     supportApiService.cases()
-              #     .comments()
-              #     .create(
-              #         parent="projects/some-project/cases/43595344",
-              #         body=\\{"body": "This is a test comment."},
-              #     )
-              # )
-              # print(request.execute())
-              # ```
-              #
               # @overload create_comment(request, options = nil)
               #   Pass arguments to `create_comment` via a request object, either of type
               #   {::Google::Cloud::Support::V2beta::CreateCommentRequest} or an equivalent Hash.
@@ -422,6 +354,84 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Retrieve a comment.
+              #
+              # @overload get_comment(request, options = nil)
+              #   Pass arguments to `get_comment` via a request object, either of type
+              #   {::Google::Cloud::Support::V2beta::GetCommentRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Support::V2beta::GetCommentRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload get_comment(name: nil)
+              #   Pass arguments to `get_comment` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     Required. The name of the comment to retrieve.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Support::V2beta::Comment]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Support::V2beta::Comment]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/support/v2beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Support::V2beta::CommentService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Support::V2beta::GetCommentRequest.new
+              #
+              #   # Call the get_comment method.
+              #   result = client.get_comment request
+              #
+              #   # The returned object is of type Google::Cloud::Support::V2beta::Comment.
+              #   p result
+              #
+              def get_comment request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Support::V2beta::GetCommentRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.get_comment.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Support::V2beta::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.get_comment.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.get_comment.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @comment_service_stub.get_comment request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the CommentService REST API.
               #
@@ -578,6 +588,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :create_comment
+                  ##
+                  # RPC-specific configuration for `get_comment`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_comment
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -585,6 +600,8 @@ module Google
                     @list_comments = ::Gapic::Config::Method.new list_comments_config
                     create_comment_config = parent_rpcs.create_comment if parent_rpcs.respond_to? :create_comment
                     @create_comment = ::Gapic::Config::Method.new create_comment_config
+                    get_comment_config = parent_rpcs.get_comment if parent_rpcs.respond_to? :get_comment
+                    @get_comment = ::Gapic::Config::Method.new get_comment_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/support/v2beta/comment_service/rest/service_stub.rb

@@ -153,6 +153,46 @@ module Google
                 end
               end
 
+              ##
+              # Baseline implementation for the get_comment REST call
+              #
+              # @param request_pb [::Google::Cloud::Support::V2beta::GetCommentRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Support::V2beta::Comment]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Support::V2beta::Comment]
+              #   A result object deserialized from the server's reply
+              def get_comment request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_get_comment_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_comment",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Support::V2beta::Comment.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
               ##
               # @private
               #
@@ -210,6 +250,27 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the get_comment REST call
+              #
+              # @param request_pb [::Google::Cloud::Support::V2beta::GetCommentRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_get_comment_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v2beta/{name}",
+                                                          matches: [
+                                                            ["name", %r{^[^/]+/[^/]+/cases/[^/]+/comments/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

data/lib/google/cloud/support/v2beta/comment_service_pb.rb

@@ -11,7 +11,7 @@ require 'google/api/resource_pb'
 require 'google/cloud/support/v2beta/comment_pb'
 
 
-descriptor_data = "\n1google/cloud/support/v2beta/comment_service.proto\x12\x1bgoogle.cloud.support.v2beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a)google/cloud/support/v2beta/comment.proto\"v\n\x13ListCommentsRequest\x12\x38\n\x06parent\x18\x01 \x01(\tB(\xe0\x41\x02\xfa\x41\"\n cloudsupport.googleapis.com/Case\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\"g\n\x14ListCommentsResponse\x12\x36\n\x08\x63omments\x18\x01 \x03(\x0b\x32$.google.cloud.support.v2beta.Comment\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\x8c\x01\n\x14\x43reateCommentRequest\x12\x38\n\x06parent\x18\x01 \x01(\tB(\xe0\x41\x02\xfa\x41\"\n cloudsupport.googleapis.com/Case\x12:\n\x07\x63omment\x18\x02 \x01(\x0b\x32$.google.cloud.support.v2beta.CommentB\x03\xe0\x41\x02\x32\xc5\x04\n\x0e\x43ommentService\x12\xe7\x01\n\x0cListComments\x12\x30.google.cloud.support.v2beta.ListCommentsRequest\x1a\x31.google.cloud.support.v2beta.ListCommentsResponse\"r\xda\x41\x06parent\x82\xd3\xe4\x93\x02\x63\x12,/v2beta/{parent=projects/*/cases/*}/commentsZ3\x12\x31/v2beta/{parent=organizations/*/cases/*}/comments\x12\xf7\x01\n\rCreateComment\x12\x31.google.cloud.support.v2beta.CreateCommentRequest\x1a$.google.cloud.support.v2beta.Comment\"\x8c\x01\xda\x41\x0eparent,comment\x82\xd3\xe4\x93\x02u\",/v2beta/{parent=projects/*/cases/*}/comments:\x07\x63ommentZ<\"1/v2beta/{parent=organizations/*/cases/*}/comments:\x07\x63omment\x1aO\xca\x41\x1b\x63loudsupport.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xd0\x01\n\x1f\x63om.google.cloud.support.v2betaB\x13\x43ommentServiceProtoP\x01Z9cloud.google.com/go/support/apiv2beta/supportpb;supportpb\xaa\x02\x1bGoogle.Cloud.Support.V2Beta\xca\x02\x1bGoogle\\Cloud\\Support\\V2beta\xea\x02\x1eGoogle::Cloud::Support::V2betab\x06proto3"
+descriptor_data = "\n1google/cloud/support/v2beta/comment_service.proto\x12\x1bgoogle.cloud.support.v2beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a)google/cloud/support/v2beta/comment.proto\"v\n\x13ListCommentsRequest\x12\x38\n\x06parent\x18\x01 \x01(\tB(\xe0\x41\x02\xfa\x41\"\n cloudsupport.googleapis.com/Case\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\"g\n\x14ListCommentsResponse\x12\x36\n\x08\x63omments\x18\x01 \x03(\x0b\x32$.google.cloud.support.v2beta.Comment\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\x8c\x01\n\x14\x43reateCommentRequest\x12\x38\n\x06parent\x18\x01 \x01(\tB(\xe0\x41\x02\xfa\x41\"\n cloudsupport.googleapis.com/Case\x12:\n\x07\x63omment\x18\x02 \x01(\x0b\x32$.google.cloud.support.v2beta.CommentB\x03\xe0\x41\x02\"N\n\x11GetCommentRequest\x12\x39\n\x04name\x18\x01 \x01(\tB+\xe0\x41\x02\xfa\x41%\n#cloudsupport.googleapis.com/Comment2\xe0\x05\n\x0e\x43ommentService\x12\xe7\x01\n\x0cListComments\x12\x30.google.cloud.support.v2beta.ListCommentsRequest\x1a\x31.google.cloud.support.v2beta.ListCommentsResponse\"r\xda\x41\x06parent\x82\xd3\xe4\x93\x02\x63\x12,/v2beta/{parent=projects/*/cases/*}/commentsZ3\x12\x31/v2beta/{parent=organizations/*/cases/*}/comments\x12\xf7\x01\n\rCreateComment\x12\x31.google.cloud.support.v2beta.CreateCommentRequest\x1a$.google.cloud.support.v2beta.Comment\"\x8c\x01\xda\x41\x0eparent,comment\x82\xd3\xe4\x93\x02u\",/v2beta/{parent=projects/*/cases/*}/comments:\x07\x63ommentZ<\"1/v2beta/{parent=organizations/*/cases/*}/comments:\x07\x63omment\x12\x98\x01\n\nGetComment\x12..google.cloud.support.v2beta.GetCommentRequest\x1a$.google.cloud.support.v2beta.Comment\"4\xda\x41\x04name\x82\xd3\xe4\x93\x02\'\x12%/v2beta/{name=*/*/cases/*/comments/*}\x1aO\xca\x41\x1b\x63loudsupport.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xd0\x01\n\x1f\x63om.google.cloud.support.v2betaB\x13\x43ommentServiceProtoP\x01Z9cloud.google.com/go/support/apiv2beta/supportpb;supportpb\xaa\x02\x1bGoogle.Cloud.Support.V2Beta\xca\x02\x1bGoogle\\Cloud\\Support\\V2beta\xea\x02\x1eGoogle::Cloud::Support::V2betab\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 
@@ -45,6 +45,7 @@ module Google
         ListCommentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2beta.ListCommentsRequest").msgclass
         ListCommentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2beta.ListCommentsResponse").msgclass
         CreateCommentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2beta.CreateCommentRequest").msgclass
+        GetCommentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.support.v2beta.GetCommentRequest").msgclass
       end
     end
   end

data/lib/google/cloud/support/v2beta/comment_service_services_pb.rb

@@ -34,79 +34,13 @@ module Google
             self.service_name = 'google.cloud.support.v2beta.CommentService'
 
             # List all the comments associated with a case.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # case="projects/some-project/cases/43595344"
-            # curl \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   "https://cloudsupport.googleapis.com/v2/$case/comments"
-            # ```
-            #
-            # Python:
-            #
-            # ```python
-            # import googleapiclient.discovery
-            #
-            # api_version = "v2"
-            # supportApiService = googleapiclient.discovery.build(
-            #     serviceName="cloudsupport",
-            #     version=api_version,
-            #     discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
-            # )
-            # request = (
-            #     supportApiService.cases()
-            #     .comments()
-            #     .list(parent="projects/some-project/cases/43595344")
-            # )
-            # print(request.execute())
-            # ```
             rpc :ListComments, ::Google::Cloud::Support::V2beta::ListCommentsRequest, ::Google::Cloud::Support::V2beta::ListCommentsResponse
             # Add a new comment to a case.
             #
             # The comment must have the following fields set: `body`.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # case="projects/some-project/cases/43591344"
-            # curl \
-            #   --request POST \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   --header 'Content-Type: application/json' \
-            #   --data '{
-            #     "body": "This is a test comment."
-            #   }' \
-            #   "https://cloudsupport.googleapis.com/v2/$case/comments"
-            # ```
-            #
-            # Python:
-            #
-            # ```python
-            # import googleapiclient.discovery
-            #
-            # api_version = "v2"
-            # supportApiService = googleapiclient.discovery.build(
-            #     serviceName="cloudsupport",
-            #     version=api_version,
-            #     discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
-            # )
-            # request = (
-            #     supportApiService.cases()
-            #     .comments()
-            #     .create(
-            #         parent="projects/some-project/cases/43595344",
-            #         body={"body": "This is a test comment."},
-            #     )
-            # )
-            # print(request.execute())
-            # ```
             rpc :CreateComment, ::Google::Cloud::Support::V2beta::CreateCommentRequest, ::Google::Cloud::Support::V2beta::Comment
+            # Retrieve a comment.
+            rpc :GetComment, ::Google::Cloud::Support::V2beta::GetCommentRequest, ::Google::Cloud::Support::V2beta::Comment
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/cloud/support/v2beta/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Support
       module V2beta
-        VERSION = "0.1.0"
+        VERSION = "0.2.0"
       end
     end
   end

data/proto_docs/google/cloud/support/v2beta/actor.rb

@@ -38,7 +38,7 @@ module Google
         #     email must also be provided. If the user is a Google Support agent, this is
         #     obfuscated.
         #
-        #     This field is deprecated. Use **username** field instead.
+        #     This field is deprecated. Use `username` instead.
         # @!attribute [r] google_support
         #   @return [::Boolean]
         #     Output only. Whether the actor is a Google support actor.

data/proto_docs/google/cloud/support/v2beta/attachment.rb

@@ -31,7 +31,7 @@ module Google
         # "comment" level.
         # @!attribute [r] name
         #   @return [::String]
-        #     Output only. The resource name of the attachment.
+        #     Output only. Identifier. The resource name of the attachment.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time at which the attachment was created.

data/proto_docs/google/cloud/support/v2beta/attachment_service.rb

@@ -44,6 +44,15 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request for getting an attachment.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the attachment to get.
+        class GetAttachmentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The response message for the ListAttachments endpoint.
         # @!attribute [rw] attachments
         #   @return [::Array<::Google::Cloud::Support::V2beta::Attachment>]

data/proto_docs/google/cloud/support/v2beta/case.rb

@@ -50,7 +50,7 @@ module Google
         # about project identifiers, see [AIP-2510](https://google.aip.dev/cloud/2510).
         # @!attribute [rw] name
         #   @return [::String]
-        #     The resource name for the case.
+        #     Identifier. The resource name for the case.
         # @!attribute [rw] display_name
         #   @return [::String]
         #     The short summary of the issue reported in this case.

data/proto_docs/google/cloud/support/v2beta/comment_service.rb

@@ -62,6 +62,15 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # The request message for the GetComment endpoint.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the comment to retrieve.
+        class GetCommentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-support-v2beta
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Manages Google Cloud technical support cases for Customer Care support offerings.
 test_files: []