google-cloud-build-v1 0.1.3 → 0.5.0

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb

@@ -22,6 +22,10 @@ module Google
     module Build
       module V1
         # Specifies a build to retry.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the `Build` to retry.
+        #     Format: `projects/{project}/locations/{location}/builds/{build}`
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. ID of the project.
@@ -42,7 +46,7 @@ module Google
         #     Required. ID of the trigger.
         # @!attribute [rw] source
         #   @return [::Google::Cloud::Build::V1::RepoSource]
-        #     Required. Source to build against this trigger.
+        #     Source to build against this trigger.
         class RunBuildTriggerRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -76,7 +80,7 @@ module Google
         #     project ID requesting the build is assumed.
         # @!attribute [rw] repo_name
         #   @return [::String]
-        #     Required. Name of the Cloud Source Repository.
+        #     Name of the Cloud Source Repository.
         # @!attribute [rw] branch_name
         #   @return [::String]
         #     Regex matching branches to build.
@@ -228,7 +232,7 @@ module Google
         # @!attribute [r] timing
         #   @return [::Google::Cloud::Build::V1::TimeSpan]
         #     Output only. Stores timing information for executing this build step.
-        # @!attribute [rw] pull_timing
+        # @!attribute [r] pull_timing
         #   @return [::Google::Cloud::Build::V1::TimeSpan]
         #     Output only. Stores timing information for pulling this build step's
         #     builder image only.
@@ -237,7 +241,7 @@ module Google
         #     Time limit for executing this build step. If not defined, the step has no
         #     time limit and will be allowed to continue to run until either it completes
         #     or the build itself times out.
-        # @!attribute [rw] status
+        # @!attribute [r] status
         #   @return [::Google::Cloud::Build::V1::Build::Status]
         #     Output only. Status of the build step. At this time, build step status is
         #     only updated on build completion; step status is not updated in real-time
@@ -321,6 +325,7 @@ module Google
         # build is created:
         #
         # - $PROJECT_ID: the project ID of the build.
+        # - $PROJECT_NUMBER: the project number of the build.
         # - $BUILD_ID: the autogenerated ID of the build.
         # - $REPO_NAME: the source repository name specified by RepoSource.
         # - $BRANCH_NAME: the branch name specified by RepoSource.
@@ -328,16 +333,21 @@ module Google
         # - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
         #   resolved from the specified branch or tag.
         # - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The 'Build' name with format:
+        #     `projects/{project}/locations/{location}/builds/{build}`, where \\{build}
+        #     is a unique identifier generated by the service.
         # @!attribute [r] id
         #   @return [::String]
         #     Output only. Unique identifier of the build.
         # @!attribute [r] project_id
         #   @return [::String]
         #     Output only. ID of the project.
-        # @!attribute [rw] status
+        # @!attribute [r] status
         #   @return [::Google::Cloud::Build::V1::Build::Status]
         #     Output only. Status of the build.
-        # @!attribute [rw] status_detail
+        # @!attribute [r] status_detail
         #   @return [::String]
         #     Output only. Customer-readable message about the current status.
         # @!attribute [rw] source
@@ -367,6 +377,8 @@ module Google
         #     granularity. If this amount of time elapses, work on the build will cease
         #     and the build status will be `TIMEOUT`.
         #
+        #     `timeout` starts ticking from `startTime`.
+        #
         #     Default time is ten minutes.
         # @!attribute [rw] images
         #   @return [::Array<::String>]
@@ -397,10 +409,10 @@ module Google
         #     [Bucket Name
         #     Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
         #     Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
-        # @!attribute [rw] source_provenance
+        # @!attribute [r] source_provenance
         #   @return [::Google::Cloud::Build::V1::SourceProvenance]
         #     Output only. A permanent fixed identifier for source.
-        # @!attribute [rw] build_trigger_id
+        # @!attribute [r] build_trigger_id
         #   @return [::String]
         #     Output only. The ID of the `BuildTrigger` that triggered this build, if it
         #     was triggered automatically.
@@ -419,6 +431,10 @@ module Google
         # @!attribute [rw] secrets
         #   @return [::Array<::Google::Cloud::Build::V1::Secret>]
         #     Secrets to decrypt using Cloud Key Management Service.
+        #     Note: Secret Manager is the recommended technique
+        #     for managing sensitive data with Cloud Build. Use `available_secrets` to
+        #     configure builds to access secrets from Secret Manager. For instructions,
+        #     see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets
         # @!attribute [r] timing
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Build::V1::TimeSpan}]
         #     Output only. Stores timing information for phases of the build. Valid keys
@@ -430,6 +446,16 @@ module Google
         #
         #     If the build does not specify source or images,
         #     these keys will not be included.
+        # @!attribute [rw] service_account
+        #   @return [::String]
+        #     IAM service account whose credentials will be used at build runtime.
+        #     Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
+        #     ACCOUNT can be email address or uniqueId of the service account.
+        #
+        #     This field is in beta.
+        # @!attribute [rw] available_secrets
+        #   @return [::Google::Cloud::Build::V1::Secrets]
+        #     Secrets and secret environment variables.
         class Build
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -526,7 +552,7 @@ module Google
           # @!attribute [rw] paths
           #   @return [::Array<::String>]
           #     Path globs used to match files in the build's workspace.
-          # @!attribute [rw] timing
+          # @!attribute [r] timing
           #   @return [::Google::Cloud::Build::V1::TimeSpan]
           #     Output only. Stores timing information for pushing all artifact objects.
           class ArtifactObjects
@@ -626,8 +652,67 @@ module Google
           end
         end
 
+        # Secrets and secret environment variables.
+        # @!attribute [rw] secret_manager
+        #   @return [::Array<::Google::Cloud::Build::V1::SecretManagerSecret>]
+        #     Secrets in Secret Manager and associated secret environment variable.
+        # @!attribute [rw] inline
+        #   @return [::Array<::Google::Cloud::Build::V1::InlineSecret>]
+        #     Secrets encrypted with KMS key and the associated secret environment
+        #     variable.
+        class Secrets
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Pairs a set of secret environment variables mapped to encrypted
+        # values with the Cloud KMS key to use to decrypt the value.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     Resource name of Cloud KMS crypto key to decrypt the encrypted value.
+        #     In format: projects/*/locations/*/keyRings/*/cryptoKeys/*
+        # @!attribute [rw] env_map
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Map of environment variable name to its encrypted value.
+        #
+        #     Secret environment variables must be unique across all of a build's
+        #     secrets, and must be used by at least one build step. Values can be at most
+        #     64 KB in size. There can be at most 100 secret values across all of a
+        #     build's secrets.
+        class InlineSecret
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class EnvMapEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Pairs a secret environment variable with a SecretVersion in Secret Manager.
+        # @!attribute [rw] version_name
+        #   @return [::String]
+        #     Resource name of the SecretVersion. In format:
+        #     projects/*/secrets/*/versions/*
+        # @!attribute [rw] env
+        #   @return [::String]
+        #     Environment variable name to associate with the secret.
+        #     Secret environment variables must be unique across all of a build's
+        #     secrets, and must be used by at least one build step.
+        class SecretManagerSecret
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Pairs a set of secret environment variables containing encrypted
         # values with the Cloud KMS key to use to decrypt the value.
+        # Note: Use `kmsKeyName` with  `available_secrets` instead of using
+        # `kmsKeyName` with `secret`. For instructions see:
+        # https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
         # @!attribute [rw] kms_key_name
         #   @return [::String]
         #     Cloud KMS key name to use to decrypt these envs.
@@ -654,6 +739,10 @@ module Google
         end
 
         # Request to create a new build.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     The parent resource where this build will be created.
+        #     Format: `projects/{project}/locations/{location}`
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. ID of the project.
@@ -666,6 +755,10 @@ module Google
         end
 
         # Request to get a build.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the `Build` to retrieve.
+        #     Format: `projects/{project}/locations/{location}/builds/{build}`
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. ID of the project.
@@ -678,6 +771,10 @@ module Google
         end
 
         # Request to list builds.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     The parent of the collection of `Builds`.
+        #     Format: `projects/{project}/locations/location`
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. ID of the project.
@@ -686,7 +783,15 @@ module Google
         #     Number of results to return in the list.
         # @!attribute [rw] page_token
         #   @return [::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.
         # @!attribute [rw] filter
         #   @return [::String]
         #     The raw filter text to constrain the results.
@@ -702,12 +807,17 @@ module Google
         # @!attribute [rw] next_page_token
         #   @return [::String]
         #     Token to receive the next page of results.
+        #     This will be absent if the end of the response list has been reached.
         class ListBuildsResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # Request to cancel an ongoing build.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the `Build` to cancel.
+        #     Format: `projects/{project}/locations/{location}/builds/{build}`
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. ID of the project.
@@ -758,19 +868,18 @@ module Google
         #     Contents of the build template.
         # @!attribute [rw] filename
         #   @return [::String]
-        #     Path, from the source root, to a file whose contents is used for the
-        #     template.
+        #     Path, from the source root, to the build configuration file
+        #     (i.e. cloudbuild.yaml).
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Time when the trigger was created.
         # @!attribute [rw] disabled
         #   @return [::Boolean]
-        #     If true, the trigger will never result in a build.
+        #     If true, the trigger will never automatically execute a build.
         # @!attribute [rw] substitutions
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Substitutions for Build resource. The keys must match the following
-        #     regular expression: `^_[A-Z0-9_]+$`.The keys cannot conflict with the
-        #     keys in bindings.
+        #     regular expression: `^_[A-Z0-9_]+$`.
         # @!attribute [rw] ignored_files
         #   @return [::Array<::String>]
         #     ignored_files and included_files are file glob matches using
@@ -843,8 +952,8 @@ module Google
         #     RE2 and described at https://github.com/google/re2/wiki/Syntax
         # @!attribute [rw] comment_control
         #   @return [::Google::Cloud::Build::V1::PullRequestFilter::CommentControl]
-        #     Whether to block builds on a "/gcbrun" comment from a repository admin or
-        #     collaborator.
+        #     Configure builds to run whether a repository owner or collaborator need to
+        #     comment `/gcbrun`.
         # @!attribute [rw] invert_regex
         #   @return [::Boolean]
         #     If true, branches that do NOT match the git_ref will trigger a build.
@@ -860,6 +969,10 @@ module Google
             # Enforce that repository owners or collaborators must comment on Pull
             # Requests before builds are triggered.
             COMMENTS_ENABLED = 1
+
+            # Enforce that repository owners or collaborators must comment on external
+            # contributors' Pull Requests before builds are triggered.
+            COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY = 2
           end
         end
 
@@ -985,6 +1098,16 @@ module Google
         #   @return [::Google::Cloud::Build::V1::BuildOptions::SubstitutionOption]
         #     Option to specify behavior when there is an error in the substitution
         #     checks.
+        #
+        #     NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot
+        #     be overridden in the build configuration file.
+        # @!attribute [rw] dynamic_substitutions
+        #   @return [::Boolean]
+        #     Option to specify whether or not to apply bash style string
+        #     operations to the substitutions.
+        #
+        #     NOTE: this is always enabled for triggered builds and cannot be
+        #     overridden in the build configuration file.
         # @!attribute [rw] log_streaming_option
         #   @return [::Google::Cloud::Build::V1::BuildOptions::LogStreamingOption]
         #     Option to define build log streaming behavior to Google Cloud
@@ -997,8 +1120,8 @@ module Google
         #     This field is experimental.
         # @!attribute [rw] logging
         #   @return [::Google::Cloud::Build::V1::BuildOptions::LoggingMode]
-        #     Option to specify the logging mode, which determines where the logs are
-        #     stored.
+        #     Option to specify the logging mode, which determines if and where build
+        #     logs are stored.
         # @!attribute [rw] env
         #   @return [::Array<::String>]
         #     A list of global environment variable definitions that will exist for all
@@ -1037,7 +1160,9 @@ module Google
             VERIFIED = 1
           end
 
-          # Supported VM sizes.
+          # Supported Compute Engine machine types.
+          # For more information, see [Machine
+          # types](https://cloud.google.com/compute/docs/machine-types).
           module MachineType
             # Standard machine type.
             UNSPECIFIED = 0
@@ -1047,6 +1172,12 @@ module Google
 
             # Highcpu machine with 32 CPUs.
             N1_HIGHCPU_32 = 2
+
+            # Highcpu e2 machine with 8 CPUs.
+            E2_HIGHCPU_8 = 5
+
+            # Highcpu e2 machine with 32 CPUs.
+            E2_HIGHCPU_32 = 6
           end
 
           # Specifies the behavior when there is an error in the substitution checks.
@@ -1078,14 +1209,51 @@ module Google
             # rely on the default logging behavior as it may change in the future.
             LOGGING_UNSPECIFIED = 0
 
-            # Stackdriver logging and Cloud Storage logging are enabled.
+            # Cloud Logging and Cloud Storage logging are enabled.
             LEGACY = 1
 
             # Only Cloud Storage logging is enabled.
             GCS_ONLY = 2
+
+            # This option is the same as CLOUD_LOGGING_ONLY.
+            STACKDRIVER_ONLY = 3
+
+            # Only Cloud Logging is enabled. Note that logs for both the Cloud Console
+            # UI and Cloud SDK are based on Cloud Storage logs, so neither will provide
+            # logs if this option is chosen.
+            CLOUD_LOGGING_ONLY = 5
+
+            # Turn off all logging. No build logs will be captured.
+            NONE = 4
           end
         end
 
+        # ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by
+        # the ReceiveTriggerWebhook method.
+        # @!attribute [rw] body
+        #   @return [::Google::Api::HttpBody]
+        #     HTTP request body.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Project in which the specified trigger lives
+        # @!attribute [rw] trigger
+        #   @return [::String]
+        #     Name of the trigger to run the payload against
+        # @!attribute [rw] secret
+        #   @return [::String]
+        #     Secret token used for authorization if an OAuth token isn't provided.
+        class ReceiveTriggerWebhookRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # ReceiveTriggerWebhookResponse [Experimental] is the response object for the
+        # ReceiveTriggerWebhook method.
+        class ReceiveTriggerWebhookResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Configuration for a WorkerPool to run the builds.
         #
         # Workers are machines that Cloud Build uses to run your builds. By default,