google-cloud-support-v2beta 0.1.0 → 0.2.0

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

@@ -34,199 +34,22 @@ module Google
             self.service_name = 'google.cloud.support.v2beta.CaseService'
 
             # Retrieve a case.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # case="projects/some-project/cases/16033687"
-            # curl \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   "https://cloudsupport.googleapis.com/v2/$case"
-            # ```
-            #
-            # 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().get(
-            #     name="projects/some-project/cases/43595344",
-            # )
-            # print(request.execute())
-            # ```
             rpc :GetCase, ::Google::Cloud::Support::V2beta::GetCaseRequest, ::Google::Cloud::Support::V2beta::Case
             # Retrieve all cases under a parent, but not its children.
             #
             # For example, listing cases under an organization only returns the cases
             # that are directly parented by that organization. To retrieve cases
             # under an organization and its projects, use `cases.search`.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # parent="projects/some-project"
-            # curl \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   "https://cloudsupport.googleapis.com/v2/$parent/cases"
-            # ```
-            #
-            # 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().list(parent="projects/some-project")
-            # print(request.execute())
-            # ```
             rpc :ListCases, ::Google::Cloud::Support::V2beta::ListCasesRequest, ::Google::Cloud::Support::V2beta::ListCasesResponse
             # Search for cases using a query.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # parent="projects/some-project"
-            # curl \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   "https://cloudsupport.googleapis.com/v2/$parent/cases:search"
-            # ```
-            #
-            # 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().search(
-            #     parent="projects/some-project", query="state=OPEN"
-            # )
-            # print(request.execute())
-            # ```
             rpc :SearchCases, ::Google::Cloud::Support::V2beta::SearchCasesRequest, ::Google::Cloud::Support::V2beta::SearchCasesResponse
             # Create a new case and associate it with a parent.
             #
             # It must have the following fields set: `display_name`, `description`,
             # `classification`, and `priority`. If you're just testing the API and don't
             # want to route your case to an agent, set `testCase=true`.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # parent="projects/some-project"
-            # curl \
-            #   --request POST \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   --header 'Content-Type: application/json' \
-            #   --data '{
-            #     "display_name": "Test case created by me.",
-            #     "description": "a random test case, feel free to close",
-            #     "classification": {
-            #       "id":
-            #       "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
-            #     },
-            #     "time_zone": "-07:00",
-            #     "subscriber_email_addresses": [
-            #       "foo@domain.com",
-            #       "bar@domain.com"
-            #     ],
-            #     "testCase": true,
-            #     "priority": "P3"
-            #   }' \
-            #   "https://cloudsupport.googleapis.com/v2/$parent/cases"
-            # ```
-            #
-            # 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().create(
-            #     parent="projects/some-project",
-            #     body={
-            #         "displayName": "A Test Case",
-            #         "description": "This is a test case.",
-            #         "testCase": True,
-            #         "priority": "P2",
-            #         "classification": {
-            #             "id":
-            #               "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
-            #         },
-            #     },
-            # )
-            # print(request.execute())
-            # ```
             rpc :CreateCase, ::Google::Cloud::Support::V2beta::CreateCaseRequest, ::Google::Cloud::Support::V2beta::Case
             # Update a case. Only some fields can be updated.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # case="projects/some-project/cases/43595344"
-            # curl \
-            #   --request PATCH \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   --header "Content-Type: application/json" \
-            #   --data '{
-            #     "priority": "P1"
-            #   }' \
-            #   "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority"
-            # ```
-            #
-            # 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().patch(
-            #     name="projects/some-project/cases/43112854",
-            #     body={
-            #         "displayName": "This is Now a New Title",
-            #         "priority": "P2",
-            #     },
-            # )
-            # print(request.execute())
-            # ```
             rpc :UpdateCase, ::Google::Cloud::Support::V2beta::UpdateCaseRequest, ::Google::Cloud::Support::V2beta::Case
             # Escalate a case, starting the Google Cloud Support escalation management
             # process.
@@ -235,79 +58,8 @@ module Google
             # https://cloud.google.com/support and look for 'Technical support
             # escalations' in the feature list to find out which ones let you
             # do that.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # case="projects/some-project/cases/43595344"
-            # curl \
-            #   --request POST \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   --header "Content-Type: application/json" \
-            #   --data '{
-            #     "escalation": {
-            #       "reason": "BUSINESS_IMPACT",
-            #       "justification": "This is a test escalation."
-            #     }
-            #   }' \
-            #   "https://cloudsupport.googleapis.com/v2/$case:escalate"
-            # ```
-            #
-            # 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().escalate(
-            #     name="projects/some-project/cases/43595344",
-            #     body={
-            #         "escalation": {
-            #             "reason": "BUSINESS_IMPACT",
-            #             "justification": "This is a test escalation.",
-            #         },
-            #     },
-            # )
-            # print(request.execute())
-            # ```
             rpc :EscalateCase, ::Google::Cloud::Support::V2beta::EscalateCaseRequest, ::Google::Cloud::Support::V2beta::Case
             # Close a case.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # case="projects/some-project/cases/43595344"
-            # curl \
-            #   --request POST \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   "https://cloudsupport.googleapis.com/v2/$case:close"
-            # ```
-            #
-            # 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().close(
-            #     name="projects/some-project/cases/43595344"
-            # )
-            # print(request.execute())
-            # ```
             rpc :CloseCase, ::Google::Cloud::Support::V2beta::CloseCaseRequest, ::Google::Cloud::Support::V2beta::Case
             # Retrieve valid classifications to use when creating a support case.
             #
@@ -319,32 +71,6 @@ module Google
             # months. When a classification is deactivated, this endpoint immediately
             # stops returning it. After six months, `case.create` requests using the
             # classification will fail.
-            #
-            # EXAMPLES:
-            #
-            # cURL:
-            #
-            # ```shell
-            # curl \
-            #   --header "Authorization: Bearer $(gcloud auth print-access-token)" \
-            #   'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
-            # ```
-            #
-            # Python:
-            #
-            # ```python
-            # import googleapiclient.discovery
-            #
-            # supportApiService = googleapiclient.discovery.build(
-            #     serviceName="cloudsupport",
-            #     version="v2",
-            #     discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2",
-            # )
-            # request = supportApiService.caseClassifications().search(
-            #     query='display_name:"*Compute Engine*"'
-            # )
-            # print(request.execute())
-            # ```
             rpc :SearchCaseClassifications, ::Google::Cloud::Support::V2beta::SearchCaseClassificationsRequest, ::Google::Cloud::Support::V2beta::SearchCaseClassificationsResponse
           end
 

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

@@ -193,36 +193,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.
@@ -321,44 +291,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.
@@ -443,6 +375,91 @@ 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 [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Support::V2beta::Comment]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Support::V2beta::Comment]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC 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::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
+              metadata = @config.rpcs.get_comment.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              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
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.get_comment.timeout,
+                                     metadata:     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.call_rpc :get_comment, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the CommentService API.
             #
@@ -619,6 +636,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
@@ -626,6 +648,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