Class: Google::Cloud::Build::V1::BuildOptions

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb

Overview

Optional arguments to enable specific features of builds.

Defined Under Namespace

Modules: DefaultLogsBucketBehavior, LogStreamingOption, LoggingMode, MachineType, SubstitutionOption, VerifyOption Classes: PoolOption

Instance Attribute Summary collapse

Instance Attribute Details

#automap_substitutions ⇒ ::Boolean

Returns Option to include built-in and custom substitutions as env variables for all build steps.

Returns:

  • (::Boolean) —

    Option to include built-in and custom substitutions as env variables for all build steps.



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#default_logs_bucket_behavior ⇒ ::Google::Cloud::Build::V1::BuildOptions::DefaultLogsBucketBehavior

Returns Optional. Option to specify how default logs buckets are setup.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#disk_size_gb ⇒ ::Integer

Returns Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error.

Returns:

  • (::Integer) —

    Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 2000GB; builds that request more than the maximum are rejected with an error.



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#dynamic_substitutions ⇒ ::Boolean

Returns 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.

Returns:

  • (::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.



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#env ⇒ ::Array<::String>

Returns A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value.

The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

Returns:

  • (::Array<::String>) —

    A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value.

    The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#log_streaming_option ⇒ ::Google::Cloud::Build::V1::BuildOptions::LogStreamingOption

Returns Option to define build log streaming behavior to Cloud Storage.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#logging ⇒ ::Google::Cloud::Build::V1::BuildOptions::LoggingMode

Returns Option to specify the logging mode, which determines if and where build logs are stored.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#machine_type ⇒ ::Google::Cloud::Build::V1::BuildOptions::MachineType

Returns Compute Engine machine type on which to run the build.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#pool ⇒ ::Google::Cloud::Build::V1::BuildOptions::PoolOption

Returns Optional. Specification for execution on a WorkerPool.

See running builds in a private pool for more information.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#requested_verify_option ⇒ ::Google::Cloud::Build::V1::BuildOptions::VerifyOption

Returns Requested verifiability options.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#secret_env ⇒ ::Array<::String>

Returns A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build.

Returns:

  • (::Array<::String>) —

    A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build.



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#source_provenance_hash ⇒ ::Array<::Google::Cloud::Build::V1::Hash::HashType>

Returns Requested hash for SourceProvenance.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#substitution_option ⇒ ::Google::Cloud::Build::V1::BuildOptions::SubstitutionOption

Returns 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.

Returns:



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#volumes ⇒ ::Array<::Google::Cloud::Build::V1::Volume>

Returns Global list of volumes to mount for ALL build steps

Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step.

Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.

Returns:

  • (::Array<::Google::Cloud::Build::V1::Volume>) —

    Global list of volumes to mount for ALL build steps

    Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step.

    Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end

#worker_pool ⇒ ::String

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns This field deprecated; please use pool.name instead.

Returns:

  • (::String) —

    This field deprecated; please use pool.name instead.



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 1865

class BuildOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Details about how a build should be executed on a `WorkerPool`.
  #
  # See [running builds in a private
  # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
  # for more information.
  # @!attribute [rw] name
  #   @return [::String]
  #     The `WorkerPool` resource to execute the build on.
  #     You must have `cloudbuild.workerpools.use` on the project hosting the
  #     WorkerPool.
  #
  #     Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
  class PoolOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the manner in which the build should be verified, if at all.
  #
  # If a verified build is requested, and any part of the process to generate
  # and upload provenance fails, the build will also fail.
  #
  # If the build does not request verification then that process may occur, but
  # is not guaranteed to. If it does occur and fails, the build will not fail.
  #
  # For more information, see [Viewing Build
  # Provenance](https://cloud.google.com/build/docs/securing-builds/view-build-provenance).
  module VerifyOption
    # Not a verifiable build (the default).
    NOT_VERIFIED = 0

    # Build must be verified.
    VERIFIED = 1
  end

  # 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

    # Highcpu machine with 8 CPUs.
    N1_HIGHCPU_8 = 1

    # 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

    # E2 machine with 1 CPU.
    E2_MEDIUM = 7
  end

  # Specifies the behavior when there is an error in the substitution checks.
  module SubstitutionOption
    # Fails the build if error in substitutions checks, like missing
    # a substitution in the template or in the map.
    MUST_MATCH = 0

    # Do not fail the build if error in substitutions checks.
    ALLOW_LOOSE = 1
  end

  # Specifies the behavior when writing build logs to Cloud Storage.
  module LogStreamingOption
    # Service may automatically determine build log streaming behavior.
    STREAM_DEFAULT = 0

    # Build logs should be streamed to Cloud Storage.
    STREAM_ON = 1

    # Build logs should not be streamed to Cloud Storage; they will be
    # written when the build is completed.
    STREAM_OFF = 2
  end

  # Specifies the logging mode.
  module LoggingMode
    # The service determines the logging mode. The default is `LEGACY`. Do not
    # rely on the default logging behavior as it may change in the future.
    LOGGING_UNSPECIFIED = 0

    # Build logs are stored in Cloud Logging and Cloud Storage.
    LEGACY = 1

    # Build logs are stored in Cloud Storage.
    GCS_ONLY = 2

    # This option is the same as CLOUD_LOGGING_ONLY.
    STACKDRIVER_ONLY = 3

    # Build logs are stored in Cloud Logging. Selecting this option will not
    # allow [logs
    # streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
    CLOUD_LOGGING_ONLY = 5

    # Turn off all logging. No build logs will be captured.
    NONE = 4
  end

  # Default Cloud Storage log bucket behavior options.
  module DefaultLogsBucketBehavior
    # Unspecified.
    DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED = 0

    # Bucket is located in user-owned project in the same region as the
    # build. The builder service account must have access to create and write
    # to Cloud Storage buckets in the build project.
    REGIONAL_USER_OWNED_BUCKET = 1

    # Bucket is located in a Google-owned project and is not regionalized.
    LEGACY_BUCKET = 2
  end
end