google-cloud-build-v1 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8ae8afcf0aba7fb3d2e94b74e95174c6fc79fd075f56e1bc09e2399b724819e
-  data.tar.gz: 5e346d486d0cd3dd27e3b1047b7488df7fee7e48cbb475b283eb5fcba96ce8c2
+  metadata.gz: 9fd56485a3fdc9f9215f05e1d3635fb10f2ad27f8899f35170daeb98d0f26fae
+  data.tar.gz: f8b547de79d4f2a7a7ef0d8d8af57623e32b434c8d225dc4c8d2bf9e838e8943
 SHA512:
-  metadata.gz: 4c933089c27f86dab0dcaa2baabc5a5b83dce041ccdd4a5b95f78ac2277674618e353e28433a4593aae163b9516051f96f202c8df67ec201ed31875a07a56bf7
-  data.tar.gz: abdbc0dc7f27e77211896e02d4e424d08c69cd9ff66f63db31861d1eeb5a4009a23596ae10d2c965e9903c137c5b13f4f4eb0bf7cac52afd3ae2ea6f90e05cea
+  metadata.gz: e3173ebb82d6622a541e3bed982214c872637505a368b38928cc791d90eb6f6faedd8f936c26a0864ad0dc116408e857f82d5a347af505b1bd7bb072ed67bc4a
+  data.tar.gz: ffe588eee00a5e7e65b4743da9afa681c40f09a68230694441834a9a45febfedc25c31d3ee28f6d078de4dd45430f7733ccb34bb63edc90ccaef45c76f7b1e7d

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-build-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Build::V1::CloudBuild::Credentials}):
 
-1. `CLOUD_BUILD_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `CLOUD_BUILD_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `CLOUD_BUILD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `CLOUD_BUILD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/build/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/build/v1"
 
 client = ::Google::Cloud::Build::V1::CloudBuild::Client.new
-request = my_create_request
+request = ::Google::Cloud::Build::V1::CreateBuildRequest.new # (request fields as keyword arguments...)
 response = client.create_build request
 ```
 

data/lib/google/cloud/build/v1/cloud_build/client.rb

@@ -76,18 +76,12 @@ module Google
 
                 default_config.rpcs.get_build.timeout = 600.0
                 default_config.rpcs.get_build.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.list_builds.timeout = 600.0
                 default_config.rpcs.list_builds.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.cancel_build.timeout = 600.0
@@ -98,26 +92,17 @@ module Google
 
                 default_config.rpcs.get_build_trigger.timeout = 600.0
                 default_config.rpcs.get_build_trigger.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.list_build_triggers.timeout = 600.0
                 default_config.rpcs.list_build_triggers.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.delete_build_trigger.timeout = 600.0
                 default_config.rpcs.delete_build_trigger.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.update_build_trigger.timeout = 600.0
@@ -128,10 +113,7 @@ module Google
 
                 default_config.rpcs.get_worker_pool.timeout = 600.0
                 default_config.rpcs.get_worker_pool.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config.rpcs.delete_worker_pool.timeout = 600.0
@@ -140,10 +122,7 @@ module Google
 
                 default_config.rpcs.list_worker_pools.timeout = 600.0
                 default_config.rpcs.list_worker_pools.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -214,7 +193,7 @@ module Google
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -423,7 +402,15 @@ module Google
             #   @param page_size [::Integer]
             #     Number of results to return in the list.
             #   @param page_token [::String]
-            #     Token to provide to skip to a particular spot in the list.
+            #     The page token for the next page of Builds.
+            #
+            #     If unspecified, the first page of results is returned.
+            #
+            #     If the token is rejected for any reason, INVALID_ARGUMENT will be thrown.
+            #     In this case, the token should be discarded, and pagination should be
+            #     restarted from the first page of results.
+            #
+            #     See https://google.aip.dev/158 for more.
             #   @param filter [::String]
             #     The raw filter text to constrain the results.
             #
@@ -492,7 +479,7 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     The name of the `Build` to retrieve.
+            #     The name of the `Build` to cancel.
             #     Format: `projects/{project}/locations/{location}/builds/{build}`
             #   @param project_id [::String]
             #     Required. ID of the project.
@@ -659,11 +646,14 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload create_build_trigger(project_id: nil, trigger: nil)
+            # @overload create_build_trigger(parent: nil, project_id: nil, trigger: nil)
             #   Pass arguments to `create_build_trigger` 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 parent [::String]
+            #     The parent resource where this trigger will be created.
+            #     Format: `projects/{project}/locations/{location}`
             #   @param project_id [::String]
             #     Required. ID of the project for which to configure automatic builds.
             #   @param trigger [::Google::Cloud::Build::V1::BuildTrigger, ::Hash]
@@ -729,11 +719,14 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload get_build_trigger(project_id: nil, trigger_id: nil)
+            # @overload get_build_trigger(name: nil, project_id: nil, trigger_id: nil)
             #   Pass arguments to `get_build_trigger` 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]
+            #     The name of the `Trigger` to retrieve.
+            #     Format: `projects/{project}/locations/{location}/triggers/{trigger}`
             #   @param project_id [::String]
             #     Required. ID of the project that owns the trigger.
             #   @param trigger_id [::String]
@@ -800,11 +793,14 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_build_triggers(project_id: nil, page_size: nil, page_token: nil)
+            # @overload list_build_triggers(parent: nil, project_id: nil, page_size: nil, page_token: nil)
             #   Pass arguments to `list_build_triggers` 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 parent [::String]
+            #     The parent of the collection of `Triggers`.
+            #     Format: `projects/{project}/locations/{location}`
             #   @param project_id [::String]
             #     Required. ID of the project for which to list BuildTriggers.
             #   @param page_size [::Integer]
@@ -873,11 +869,14 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload delete_build_trigger(project_id: nil, trigger_id: nil)
+            # @overload delete_build_trigger(name: nil, project_id: nil, trigger_id: nil)
             #   Pass arguments to `delete_build_trigger` 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]
+            #     The name of the `Trigger` to delete.
+            #     Format: `projects/{project}/locations/{location}/triggers/{trigger}`
             #   @param project_id [::String]
             #     Required. ID of the project that owns the trigger.
             #   @param trigger_id [::String]
@@ -1015,17 +1014,20 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload run_build_trigger(project_id: nil, trigger_id: nil, source: nil)
+            # @overload run_build_trigger(name: nil, project_id: nil, trigger_id: nil, source: nil)
             #   Pass arguments to `run_build_trigger` 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]
+            #     The name of the `Trigger` to run.
+            #     Format: `projects/{project}/locations/{location}/triggers/{trigger}`
             #   @param project_id [::String]
             #     Required. ID of the project.
             #   @param trigger_id [::String]
             #     Required. ID of the trigger.
             #   @param source [::Google::Cloud::Build::V1::RepoSource, ::Hash]
-            #     Required. Source to build against this trigger.
+            #     Source to build against this trigger.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -1074,6 +1076,83 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # ReceiveTriggerWebhook [Experimental] is called when the API receives a
+            # webhook request targeted at a specific trigger.
+            #
+            # @overload receive_trigger_webhook(request, options = nil)
+            #   Pass arguments to `receive_trigger_webhook` via a request object, either of type
+            #   {::Google::Cloud::Build::V1::ReceiveTriggerWebhookRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Build::V1::ReceiveTriggerWebhookRequest, ::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 receive_trigger_webhook(name: nil, body: nil, project_id: nil, trigger: nil, secret: nil)
+            #   Pass arguments to `receive_trigger_webhook` 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]
+            #     The name of the `ReceiveTriggerWebhook` to retrieve.
+            #     Format: `projects/{project}/locations/{location}/triggers/{trigger}`
+            #   @param body [::Google::Api::HttpBody, ::Hash]
+            #     HTTP request body.
+            #   @param project_id [::String]
+            #     Project in which the specified trigger lives
+            #   @param trigger [::String]
+            #     Name of the trigger to run the payload against
+            #   @param secret [::String]
+            #     Secret token used for authorization if an OAuth token isn't provided.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Build::V1::ReceiveTriggerWebhookResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Build::V1::ReceiveTriggerWebhookResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def receive_trigger_webhook request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Build::V1::ReceiveTriggerWebhookRequest
+
+              # 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.receive_trigger_webhook.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project 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::Build::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "project_id" => request.project_id,
+                "trigger" => request.trigger
+              }
+              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.receive_trigger_webhook.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.receive_trigger_webhook.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_build_stub.call_rpc :receive_trigger_webhook, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Creates a `WorkerPool` to run the builds, and returns the new worker pool.
             #
@@ -1583,6 +1662,11 @@ module Google
                 #
                 attr_reader :run_build_trigger
                 ##
+                # RPC-specific configuration for `receive_trigger_webhook`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :receive_trigger_webhook
+                ##
                 # RPC-specific configuration for `create_worker_pool`
                 # @return [::Gapic::Config::Method]
                 #
@@ -1632,6 +1716,8 @@ module Google
                   @update_build_trigger = ::Gapic::Config::Method.new update_build_trigger_config
                   run_build_trigger_config = parent_rpcs.run_build_trigger if parent_rpcs.respond_to? :run_build_trigger
                   @run_build_trigger = ::Gapic::Config::Method.new run_build_trigger_config
+                  receive_trigger_webhook_config = parent_rpcs.receive_trigger_webhook if parent_rpcs.respond_to? :receive_trigger_webhook
+                  @receive_trigger_webhook = ::Gapic::Config::Method.new receive_trigger_webhook_config
                   create_worker_pool_config = parent_rpcs.create_worker_pool if parent_rpcs.respond_to? :create_worker_pool
                   @create_worker_pool = ::Gapic::Config::Method.new create_worker_pool_config
                   get_worker_pool_config = parent_rpcs.get_worker_pool if parent_rpcs.respond_to? :get_worker_pool

data/lib/google/cloud/build/v1/cloud_build/operations.rb

@@ -82,7 +82,7 @@ module Google
               # Create credentials
               credentials = @config.credentials
               credentials ||= Credentials.default scope: @config.scope
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project

data/lib/google/cloud/build/v1/cloud_build/paths.rb

@@ -68,18 +68,63 @@ module Google
             ##
             # Create a fully-qualified BuildTrigger resource string.
             #
+            # @overload build_trigger_path(project:, trigger:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/triggers/{trigger}`
+            #
+            #   @param project [String]
+            #   @param trigger [String]
+            #
+            # @overload build_trigger_path(project:, location:, trigger:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/triggers/{trigger}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param trigger [String]
+            #
+            # @return [::String]
+            def build_trigger_path **args
+              resources = {
+                "project:trigger" => (proc do |project:, trigger:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                  "projects/#{project}/triggers/#{trigger}"
+                end),
+                "location:project:trigger" => (proc do |project:, location:, trigger:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/triggers/#{trigger}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
+            ##
+            # Create a fully-qualified CryptoKey resource string.
+            #
             # The resource will be in the following format:
             #
-            # `projects/{project}/triggers/{trigger}`
+            # `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
             #
             # @param project [String]
-            # @param trigger [String]
+            # @param location [String]
+            # @param keyring [String]
+            # @param key [String]
             #
             # @return [::String]
-            def build_trigger_path project:, trigger:
+            def crypto_key_path project:, location:, keyring:, key:
               raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "keyring cannot contain /" if keyring.to_s.include? "/"
 
-              "projects/#{project}/triggers/#{trigger}"
+              "projects/#{project}/locations/#{location}/keyRings/#{keyring}/cryptoKeys/#{key}"
             end
 
             ##
@@ -113,6 +158,25 @@ module Google
               "projects/#{project}"
             end
 
+            ##
+            # Create a fully-qualified SecretVersion resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/secrets/{secret}/versions/{version}`
+            #
+            # @param project [String]
+            # @param secret [String]
+            # @param version [String]
+            #
+            # @return [::String]
+            def secret_version_path project:, secret:, version:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "secret cannot contain /" if secret.to_s.include? "/"
+
+              "projects/#{project}/secrets/#{secret}/versions/#{version}"
+            end
+
             ##
             # Create a fully-qualified ServiceAccount resource string.
             #
@@ -130,6 +194,40 @@ module Google
               "projects/#{project}/serviceAccounts/#{service_account}"
             end
 
+            ##
+            # Create a fully-qualified Subscription resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/subscriptions/{subscription}`
+            #
+            # @param project [String]
+            # @param subscription [String]
+            #
+            # @return [::String]
+            def subscription_path project:, subscription:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/subscriptions/#{subscription}"
+            end
+
+            ##
+            # Create a fully-qualified Topic resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/topics/{topic}`
+            #
+            # @param project [String]
+            # @param topic [String]
+            #
+            # @return [::String]
+            def topic_path project:, topic:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/topics/#{topic}"
+            end
+
             extend self
           end
         end