Package com.google.cloudbuild.v1

Interface BuildOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BuildOptions, BuildOptions.Builder
@Generated public interface BuildOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSourceProvenanceHashList

      List<Hash.HashType> getSourceProvenanceHashList()
       Requested hash for SourceProvenance.
      repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
      Returns:
      A list containing the sourceProvenanceHash.

    • getSourceProvenanceHashCount

      int getSourceProvenanceHashCount()
       Requested hash for SourceProvenance.
      repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
      Returns:
      The count of sourceProvenanceHash.

    • getSourceProvenanceHash

      Hash.HashType getSourceProvenanceHash(int index)
       Requested hash for SourceProvenance.
      repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
      Parameters:
      index - The index of the element to return.
      Returns:
      The sourceProvenanceHash at the given index.

    • getSourceProvenanceHashValueList

      List<Integer> getSourceProvenanceHashValueList()
       Requested hash for SourceProvenance.
      repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
      Returns:
      A list containing the enum numeric values on the wire for sourceProvenanceHash.

    • getSourceProvenanceHashValue

      int getSourceProvenanceHashValue(int index)
       Requested hash for SourceProvenance.
      repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of sourceProvenanceHash at the given index.

    • getRequestedVerifyOptionValue

      int getRequestedVerifyOptionValue()
       Requested verifiability options.
      .google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
      Returns:
      The enum numeric value on the wire for requestedVerifyOption.

    • getRequestedVerifyOption

      BuildOptions.VerifyOption getRequestedVerifyOption()
       Requested verifiability options.
      .google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
      Returns:
      The requestedVerifyOption.

    • getMachineTypeValue

      int getMachineTypeValue()
       Compute Engine machine type on which to run the build.
      .google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
      Returns:
      The enum numeric value on the wire for machineType.

    • getMachineType

      BuildOptions.MachineType getMachineType()
       Compute Engine machine type on which to run the build.
      .google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
      Returns:
      The machineType.

    • getDiskSizeGb

      long getDiskSizeGb()
       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 4000GB; builds that request
 more than the maximum are rejected with an error.
      int64 disk_size_gb = 6;
      Returns:
      The diskSizeGb.

    • getSubstitutionOptionValue

      int getSubstitutionOptionValue()
       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.
      .google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
      Returns:
      The enum numeric value on the wire for substitutionOption.

    • getSubstitutionOption

      BuildOptions.SubstitutionOption getSubstitutionOption()
       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.
      .google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
      Returns:
      The substitutionOption.

    • getDynamicSubstitutions

      boolean getDynamicSubstitutions()
       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.
      bool dynamic_substitutions = 17;
      Returns:
      The dynamicSubstitutions.

    • getAutomapSubstitutions

      boolean getAutomapSubstitutions()
       Option to include built-in and custom substitutions as env variables
 for all build steps.
      bool automap_substitutions = 22;
      Returns:
      The automapSubstitutions.

    • getLogStreamingOptionValue

      int getLogStreamingOptionValue()
       Option to define build log streaming behavior to Cloud
 Storage.
      .google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
      Returns:
      The enum numeric value on the wire for logStreamingOption.

    • getLogStreamingOption

      BuildOptions.LogStreamingOption getLogStreamingOption()
       Option to define build log streaming behavior to Cloud
 Storage.
      .google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
      Returns:
      The logStreamingOption.

    • getWorkerPool

      @Deprecated String getWorkerPool()
      Deprecated.
      google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=2569
       This field deprecated; please use `pool.name` instead.
      string worker_pool = 7 [deprecated = true];
      Returns:
      The workerPool.

    • getWorkerPoolBytes

      @Deprecated com.google.protobuf.ByteString getWorkerPoolBytes()
      Deprecated.
      google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=2569
       This field deprecated; please use `pool.name` instead.
      string worker_pool = 7 [deprecated = true];
      Returns:
      The bytes for workerPool.

    • hasPool

      boolean hasPool()
       Optional. Specification for execution 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.
      .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the pool field is set.

    • getPool

      BuildOptions.PoolOption getPool()
       Optional. Specification for execution 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.
      .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pool.

    • getPoolOrBuilder

      BuildOptions.PoolOptionOrBuilder getPoolOrBuilder()
       Optional. Specification for execution 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.
      .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];

    • getLoggingValue

      int getLoggingValue()
       Option to specify the logging mode, which determines if and where build
 logs are stored.
      .google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
      Returns:
      The enum numeric value on the wire for logging.

    • getLogging

      BuildOptions.LoggingMode getLogging()
       Option to specify the logging mode, which determines if and where build
 logs are stored.
      .google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
      Returns:
      The logging.

    • getEnvList

      List<String> getEnvList()
       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".
      repeated string env = 12;
      Returns:
      A list containing the env.

    • getEnvCount

      int getEnvCount()
       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".
      repeated string env = 12;
      Returns:
      The count of env.

    • getEnv

      String getEnv(int index)
       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".
      repeated string env = 12;
      Parameters:
      index - The index of the element to return.
      Returns:
      The env at the given index.

    • getEnvBytes

      com.google.protobuf.ByteString getEnvBytes(int index)
       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".
      repeated string env = 12;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the env at the given index.

    • getSecretEnvList

      List<String> getSecretEnvList()
       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.
      repeated string secret_env = 13;
      Returns:
      A list containing the secretEnv.

    • getSecretEnvCount

      int getSecretEnvCount()
       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.
      repeated string secret_env = 13;
      Returns:
      The count of secretEnv.

    • getSecretEnv

      String getSecretEnv(int index)
       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.
      repeated string secret_env = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The secretEnv at the given index.

    • getSecretEnvBytes

      com.google.protobuf.ByteString getSecretEnvBytes(int index)
       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.
      repeated string secret_env = 13;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the secretEnv at the given index.

    • getVolumesList

      List<Volume> getVolumesList()
       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.
      repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

    • getVolumes

      Volume getVolumes(int index)
       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.
      repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

    • getVolumesCount

      int getVolumesCount()
       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.
      repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

    • getVolumesOrBuilderList

      List<? extends VolumeOrBuilder> getVolumesOrBuilderList()
       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.
      repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

    • getVolumesOrBuilder

      VolumeOrBuilder getVolumesOrBuilder(int index)
       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.
      repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;

    • getDefaultLogsBucketBehaviorValue

      int getDefaultLogsBucketBehaviorValue()
       Optional. Option to specify how default logs buckets are setup.
      .google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior default_logs_bucket_behavior = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for defaultLogsBucketBehavior.

    • getDefaultLogsBucketBehavior

      BuildOptions.DefaultLogsBucketBehavior getDefaultLogsBucketBehavior()
       Optional. Option to specify how default logs buckets are setup.
      .google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior default_logs_bucket_behavior = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The defaultLogsBucketBehavior.

    • getEnableStructuredLogging

      boolean getEnableStructuredLogging()
       Optional. Option to specify whether structured logging is enabled.

 If true, JSON-formatted logs are parsed as structured logs.
      bool enable_structured_logging = 23 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enableStructuredLogging.