Package com.google.cloudbuild.v1

Interface BuildStepOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAllowExitCodes(int index)
    Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes.
    int
    getAllowExitCodesCount()
    Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes.
    List<Integer>
    getAllowExitCodesList()
    Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes.
    boolean
    getAllowFailure()
    Allow this build step to fail without failing the entire build.
    String
    getArgs(int index)
    A list of arguments that will be presented to the step when it is started.
    com.google.protobuf.ByteString
    getArgsBytes(int index)
    A list of arguments that will be presented to the step when it is started.
    int
    getArgsCount()
    A list of arguments that will be presented to the step when it is started.
    List<String>
    getArgsList()
    A list of arguments that will be presented to the step when it is started.
    boolean
    getAutomapSubstitutions()
    Option to include built-in and custom substitutions as env variables for this build step.
    String
    getDir()
    Working directory to use when running this step's container.
    com.google.protobuf.ByteString
    getDirBytes()
    Working directory to use when running this step's container.
    String
    getEntrypoint()
    Entrypoint to be used instead of the build step image's default entrypoint.
    com.google.protobuf.ByteString
    getEntrypointBytes()
    Entrypoint to be used instead of the build step image's default entrypoint.
    String
    getEnv(int index)
    A list of environment variable definitions to be used when running a step.
    com.google.protobuf.ByteString
    getEnvBytes(int index)
    A list of environment variable definitions to be used when running a step.
    int
    getEnvCount()
    A list of environment variable definitions to be used when running a step.
    List<String>
    getEnvList()
    A list of environment variable definitions to be used when running a step.
    int
    getExitCode()
    Output only.
    String
    getId()
    Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
    com.google.protobuf.ByteString
    getIdBytes()
    Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    TimeSpan
    getPullTiming()
    Output only.
    TimeSpanOrBuilder
    getPullTimingOrBuilder()
    Output only.
    String
    getScript()
    A shell script to be executed in the step.
    com.google.protobuf.ByteString
    getScriptBytes()
    A shell script to be executed in the step.
    String
    getSecretEnv(int index)
    A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
    com.google.protobuf.ByteString
    getSecretEnvBytes(int index)
    A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
    int
    getSecretEnvCount()
    A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
    List<String>
    getSecretEnvList()
    A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
    Build.Status
    getStatus()
    Output only.
    int
    getStatusValue()
    Output only.
    com.google.protobuf.Duration
    getTimeout()
    Time limit for executing this build step.
    com.google.protobuf.DurationOrBuilder
    getTimeoutOrBuilder()
    Time limit for executing this build step.
    TimeSpan
    getTiming()
    Output only.
    TimeSpanOrBuilder
    getTimingOrBuilder()
    Output only.
    Volume
    getVolumes(int index)
    List of volumes to mount into the build step.
    int
    getVolumesCount()
    List of volumes to mount into the build step.
    List<Volume>
    getVolumesList()
    List of volumes to mount into the build step.
    VolumeOrBuilder
    getVolumesOrBuilder(int index)
    List of volumes to mount into the build step.
    List<? extends VolumeOrBuilder>
    getVolumesOrBuilderList()
    List of volumes to mount into the build step.
    String
    getWaitFor(int index)
    The ID(s) of the step(s) that this build step depends on.
    com.google.protobuf.ByteString
    getWaitForBytes(int index)
    The ID(s) of the step(s) that this build step depends on.
    int
    getWaitForCount()
    The ID(s) of the step(s) that this build step depends on.
    List<String>
    getWaitForList()
    The ID(s) of the step(s) that this build step depends on.
    boolean
    hasAutomapSubstitutions()
    Option to include built-in and custom substitutions as env variables for this build step.
    boolean
    hasPullTiming()
    Output only.
    boolean
    hasTimeout()
    Time limit for executing this build step.
    boolean
    hasTiming()
    Output only.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       Required. The name of the container image that will run this particular
 build step.

 If the image is available in the host's Docker daemon's cache, it
 will be run directly. If not, the host will attempt to pull the image
 first, using the builder service account's credentials if necessary.

 The Docker daemon's cache will already have the latest versions of all of
 the officially supported build steps
 ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
 The Docker daemon will also have cached many of the layers for some popular
 images, like "ubuntu", "debian", but they will be refreshed at the time you
 attempt to use them.

 If you built an image in a previous build step, it will be stored in the
 host's Docker daemon's cache and is available to use as the name for a
 later build step.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The name of the container image that will run this particular
 build step.

 If the image is available in the host's Docker daemon's cache, it
 will be run directly. If not, the host will attempt to pull the image
 first, using the builder service account's credentials if necessary.

 The Docker daemon's cache will already have the latest versions of all of
 the officially supported build steps
 ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
 The Docker daemon will also have cached many of the layers for some popular
 images, like "ubuntu", "debian", but they will be refreshed at the time you
 attempt to use them.

 If you built an image in a previous build step, it will be stored in the
 host's Docker daemon's cache and is available to use as the name for a
 later build step.
      string name = 1;
      Returns:
      The bytes for name.

    • getEnvList

      List<String> getEnvList()
       A list of environment variable definitions to be used when running a step.

 The elements are of the form "KEY=VALUE" for the environment variable "KEY"
 being given the value "VALUE".
      repeated string env = 2;
      Returns:
      A list containing the env.

    • getEnvCount

      int getEnvCount()
       A list of environment variable definitions to be used when running a step.

 The elements are of the form "KEY=VALUE" for the environment variable "KEY"
 being given the value "VALUE".
      repeated string env = 2;
      Returns:
      The count of env.

    • getEnv

      String getEnv(int index)
       A list of environment variable definitions to be used when running a step.

 The elements are of the form "KEY=VALUE" for the environment variable "KEY"
 being given the value "VALUE".
      repeated string env = 2;
      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 environment variable definitions to be used when running a step.

 The elements are of the form "KEY=VALUE" for the environment variable "KEY"
 being given the value "VALUE".
      repeated string env = 2;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the env at the given index.

    • getArgsList

      List<String> getArgsList()
       A list of arguments that will be presented to the step when it is started.

 If the image used to run the step's container has an entrypoint, the `args`
 are used as arguments to that entrypoint. If the image does not define
 an entrypoint, the first element in args is used as the entrypoint,
 and the remainder will be used as arguments.
      repeated string args = 3;
      Returns:
      A list containing the args.

    • getArgsCount

      int getArgsCount()
       A list of arguments that will be presented to the step when it is started.

 If the image used to run the step's container has an entrypoint, the `args`
 are used as arguments to that entrypoint. If the image does not define
 an entrypoint, the first element in args is used as the entrypoint,
 and the remainder will be used as arguments.
      repeated string args = 3;
      Returns:
      The count of args.

    • getArgs

      String getArgs(int index)
       A list of arguments that will be presented to the step when it is started.

 If the image used to run the step's container has an entrypoint, the `args`
 are used as arguments to that entrypoint. If the image does not define
 an entrypoint, the first element in args is used as the entrypoint,
 and the remainder will be used as arguments.
      repeated string args = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The args at the given index.

    • getArgsBytes

      com.google.protobuf.ByteString getArgsBytes(int index)
       A list of arguments that will be presented to the step when it is started.

 If the image used to run the step's container has an entrypoint, the `args`
 are used as arguments to that entrypoint. If the image does not define
 an entrypoint, the first element in args is used as the entrypoint,
 and the remainder will be used as arguments.
      repeated string args = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the args at the given index.

    • getDir

      String getDir()
       Working directory to use when running this step's container.

 If this value is a relative path, it is relative to the build's working
 directory. If this value is absolute, it may be outside the build's working
 directory, in which case the contents of the path may not be persisted
 across build step executions, unless a `volume` for that path is specified.

 If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
 which specifies an absolute path, the `RepoSource` `dir` is ignored for
 the step's execution.
      string dir = 4;
      Returns:
      The dir.

    • getDirBytes

      com.google.protobuf.ByteString getDirBytes()
       Working directory to use when running this step's container.

 If this value is a relative path, it is relative to the build's working
 directory. If this value is absolute, it may be outside the build's working
 directory, in which case the contents of the path may not be persisted
 across build step executions, unless a `volume` for that path is specified.

 If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
 which specifies an absolute path, the `RepoSource` `dir` is ignored for
 the step's execution.
      string dir = 4;
      Returns:
      The bytes for dir.

    • getId

      String getId()
       Unique identifier for this build step, used in `wait_for` to
 reference this build step as a dependency.
      string id = 5;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Unique identifier for this build step, used in `wait_for` to
 reference this build step as a dependency.
      string id = 5;
      Returns:
      The bytes for id.

    • getWaitForList

      List<String> getWaitForList()
       The ID(s) of the step(s) that this build step depends on.
 This build step will not start until all the build steps in `wait_for`
 have completed successfully. If `wait_for` is empty, this build step will
 start when all previous build steps in the `Build.Steps` list have
 completed successfully.
      repeated string wait_for = 6;
      Returns:
      A list containing the waitFor.

    • getWaitForCount

      int getWaitForCount()
       The ID(s) of the step(s) that this build step depends on.
 This build step will not start until all the build steps in `wait_for`
 have completed successfully. If `wait_for` is empty, this build step will
 start when all previous build steps in the `Build.Steps` list have
 completed successfully.
      repeated string wait_for = 6;
      Returns:
      The count of waitFor.

    • getWaitFor

      String getWaitFor(int index)
       The ID(s) of the step(s) that this build step depends on.
 This build step will not start until all the build steps in `wait_for`
 have completed successfully. If `wait_for` is empty, this build step will
 start when all previous build steps in the `Build.Steps` list have
 completed successfully.
      repeated string wait_for = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The waitFor at the given index.

    • getWaitForBytes

      com.google.protobuf.ByteString getWaitForBytes(int index)
       The ID(s) of the step(s) that this build step depends on.
 This build step will not start until all the build steps in `wait_for`
 have completed successfully. If `wait_for` is empty, this build step will
 start when all previous build steps in the `Build.Steps` list have
 completed successfully.
      repeated string wait_for = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the waitFor at the given index.

    • getEntrypoint

      String getEntrypoint()
       Entrypoint to be used instead of the build step image's default entrypoint.
 If unset, the image's default entrypoint is used.
      string entrypoint = 7;
      Returns:
      The entrypoint.

    • getEntrypointBytes

      com.google.protobuf.ByteString getEntrypointBytes()
       Entrypoint to be used instead of the build step image's default entrypoint.
 If unset, the image's default entrypoint is used.
      string entrypoint = 7;
      Returns:
      The bytes for entrypoint.

    • getSecretEnvList

      List<String> getSecretEnvList()
       A list of environment variables which are encrypted using a Cloud Key
 Management Service crypto key. These values must be specified in the
 build's `Secret`.
      repeated string secret_env = 8;
      Returns:
      A list containing the secretEnv.

    • getSecretEnvCount

      int getSecretEnvCount()
       A list of environment variables which are encrypted using a Cloud Key
 Management Service crypto key. These values must be specified in the
 build's `Secret`.
      repeated string secret_env = 8;
      Returns:
      The count of secretEnv.

    • getSecretEnv

      String getSecretEnv(int index)
       A list of environment variables which are encrypted using a Cloud Key
 Management Service crypto key. These values must be specified in the
 build's `Secret`.
      repeated string secret_env = 8;
      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 environment variables which are encrypted using a Cloud Key
 Management Service crypto key. These values must be specified in the
 build's `Secret`.
      repeated string secret_env = 8;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the secretEnv at the given index.

    • getVolumesList

      List<Volume> getVolumesList()
       List of volumes to mount into the build step.

 Each volume is created as an empty volume prior to execution of the
 build step. Upon completion of the build, volumes and their contents are
 discarded.

 Using a named volume in 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 = 9;

    • getVolumes

      Volume getVolumes(int index)
       List of volumes to mount into the build step.

 Each volume is created as an empty volume prior to execution of the
 build step. Upon completion of the build, volumes and their contents are
 discarded.

 Using a named volume in 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 = 9;

    • getVolumesCount

      int getVolumesCount()
       List of volumes to mount into the build step.

 Each volume is created as an empty volume prior to execution of the
 build step. Upon completion of the build, volumes and their contents are
 discarded.

 Using a named volume in 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 = 9;

    • getVolumesOrBuilderList

      List<? extends VolumeOrBuilder> getVolumesOrBuilderList()
       List of volumes to mount into the build step.

 Each volume is created as an empty volume prior to execution of the
 build step. Upon completion of the build, volumes and their contents are
 discarded.

 Using a named volume in 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 = 9;

    • getVolumesOrBuilder

      VolumeOrBuilder getVolumesOrBuilder(int index)
       List of volumes to mount into the build step.

 Each volume is created as an empty volume prior to execution of the
 build step. Upon completion of the build, volumes and their contents are
 discarded.

 Using a named volume in 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 = 9;

    • hasTiming

      boolean hasTiming()
       Output only. Stores timing information for executing this build step.
      .google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the timing field is set.

    • getTiming

      TimeSpan getTiming()
       Output only. Stores timing information for executing this build step.
      .google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The timing.

    • getTimingOrBuilder

      TimeSpanOrBuilder getTimingOrBuilder()
       Output only. Stores timing information for executing this build step.
      .google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasPullTiming

      boolean hasPullTiming()
       Output only. Stores timing information for pulling this build step's
 builder image only.
      .google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the pullTiming field is set.

    • getPullTiming

      TimeSpan getPullTiming()
       Output only. Stores timing information for pulling this build step's
 builder image only.
      .google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The pullTiming.

    • getPullTimingOrBuilder

      TimeSpanOrBuilder getPullTimingOrBuilder()
       Output only. Stores timing information for pulling this build step's
 builder image only.
      .google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasTimeout

      boolean hasTimeout()
       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.
      .google.protobuf.Duration timeout = 11;
      Returns:
      Whether the timeout field is set.

    • getTimeout

      com.google.protobuf.Duration getTimeout()
       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.
      .google.protobuf.Duration timeout = 11;
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       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.
      .google.protobuf.Duration timeout = 11;

    • getStatusValue

      int getStatusValue()
       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
 as the build progresses.
      .google.devtools.cloudbuild.v1.Build.Status status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      Build.Status getStatus()
       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
 as the build progresses.
      .google.devtools.cloudbuild.v1.Build.Status status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The status.

    • getAllowFailure

      boolean getAllowFailure()
       Allow this build step to fail without failing the entire build.

 If false, the entire build will fail if this step fails. Otherwise, the
 build will succeed, but this step will still have a failure status.
 Error information will be reported in the failure_detail field.
      bool allow_failure = 14;
      Returns:
      The allowFailure.

    • getExitCode

      int getExitCode()
       Output only. Return code from running the step.
      int32 exit_code = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The exitCode.

    • getAllowExitCodesList

      List<Integer> getAllowExitCodesList()
       Allow this build step to fail without failing the entire build if and
 only if the exit code is one of the specified codes. If allow_failure
 is also specified, this field will take precedence.
      repeated int32 allow_exit_codes = 18;
      Returns:
      A list containing the allowExitCodes.

    • getAllowExitCodesCount

      int getAllowExitCodesCount()
       Allow this build step to fail without failing the entire build if and
 only if the exit code is one of the specified codes. If allow_failure
 is also specified, this field will take precedence.
      repeated int32 allow_exit_codes = 18;
      Returns:
      The count of allowExitCodes.

    • getAllowExitCodes

      int getAllowExitCodes(int index)
       Allow this build step to fail without failing the entire build if and
 only if the exit code is one of the specified codes. If allow_failure
 is also specified, this field will take precedence.
      repeated int32 allow_exit_codes = 18;
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowExitCodes at the given index.

    • getScript

      String getScript()
       A shell script to be executed in the step.

 When script is provided, the user cannot specify the entrypoint or args.
      string script = 19;
      Returns:
      The script.

    • getScriptBytes

      com.google.protobuf.ByteString getScriptBytes()
       A shell script to be executed in the step.

 When script is provided, the user cannot specify the entrypoint or args.
      string script = 19;
      Returns:
      The bytes for script.

    • hasAutomapSubstitutions

      boolean hasAutomapSubstitutions()
       Option to include built-in and custom substitutions as env variables
 for this build step. This option will override the global option
 in BuildOption.
      optional bool automap_substitutions = 20;
      Returns:
      Whether the automapSubstitutions field is set.

    • getAutomapSubstitutions

      boolean getAutomapSubstitutions()
       Option to include built-in and custom substitutions as env variables
 for this build step. This option will override the global option
 in BuildOption.
      optional bool automap_substitutions = 20;
      Returns:
      The automapSubstitutions.