Package com.google.cloudbuild.v1

Class BuildStep

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloudbuild.v1.BuildStep
All Implemented Interfaces:
BuildStepOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BuildStep extends com.google.protobuf.GeneratedMessage implements BuildStepOrBuilder
 A step in the build pipeline.
Protobuf type google.devtools.cloudbuild.v1.BuildStep
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BuildStep.Builder
    A step in the build pipeline.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALLOW_EXIT_CODES_FIELD_NUMBER
     
    static final int
    ALLOW_FAILURE_FIELD_NUMBER
     
    static final int
    ARGS_FIELD_NUMBER
     
    static final int
    AUTOMAP_SUBSTITUTIONS_FIELD_NUMBER
     
    static final int
    DIR_FIELD_NUMBER
     
    static final int
    ENTRYPOINT_FIELD_NUMBER
     
    static final int
    ENV_FIELD_NUMBER
     
    static final int
    EXIT_CODE_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PULL_TIMING_FIELD_NUMBER
     
    static final int
    SCRIPT_FIELD_NUMBER
     
    static final int
    SECRET_ENV_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     
    static final int
    TIMEOUT_FIELD_NUMBER
     
    static final int
    TIMING_FIELD_NUMBER
     
    static final int
    VOLUMES_FIELD_NUMBER
     
    static final int
    WAIT_FOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    com.google.protobuf.ProtocolStringList
    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.
    static BuildStep
    getDefaultInstance()
     
    BuildStep
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.ProtocolStringList
    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.
    com.google.protobuf.Parser<BuildStep>
    getParserForType()
     
    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.
    com.google.protobuf.ProtocolStringList
    getSecretEnvList()
    A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
    int
    getSerializedSize()
     
    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.
    com.google.protobuf.ProtocolStringList
    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.
    int
    hashCode()
     
    boolean
    hasPullTiming()
    Output only.
    boolean
    hasTimeout()
    Time limit for executing this build step.
    boolean
    hasTiming()
    Output only.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BuildStep.Builder
    newBuilder()
     
    static BuildStep.Builder
    newBuilder(BuildStep prototype)
     
    BuildStep.Builder
    newBuilderForType()
     
    protected BuildStep.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static BuildStep
    parseDelimitedFrom(InputStream input)
     
    static BuildStep
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildStep
    parseFrom(byte[] data)
     
    static BuildStep
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildStep
    parseFrom(com.google.protobuf.ByteString data)
     
    static BuildStep
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildStep
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BuildStep
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildStep
    parseFrom(InputStream input)
     
    static BuildStep
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildStep
    parseFrom(ByteBuffer data)
     
    static BuildStep
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BuildStep>
    parser()
     
    BuildStep.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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;
      Specified by:
      getName in interface BuildStepOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface BuildStepOrBuilder
      Returns:
      The bytes for name.

    • getEnvList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getEnvList in interface BuildStepOrBuilder
      Returns:
      A list containing the env.

    • getEnvCount

      public 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;
      Specified by:
      getEnvCount in interface BuildStepOrBuilder
      Returns:
      The count of env.

    • getEnv

      public 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;
      Specified by:
      getEnv in interface BuildStepOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The env at the given index.

    • getEnvBytes

      public 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;
      Specified by:
      getEnvBytes in interface BuildStepOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the env at the given index.

    • getArgsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getArgsList in interface BuildStepOrBuilder
      Returns:
      A list containing the args.

    • getArgsCount

      public 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;
      Specified by:
      getArgsCount in interface BuildStepOrBuilder
      Returns:
      The count of args.

    • getArgs

      public 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;
      Specified by:
      getArgs in interface BuildStepOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The args at the given index.

    • getArgsBytes

      public 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;
      Specified by:
      getArgsBytes in interface BuildStepOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the args at the given index.

    • getDir

      public 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;
      Specified by:
      getDir in interface BuildStepOrBuilder
      Returns:
      The dir.

    • getDirBytes

      public 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;
      Specified by:
      getDirBytes in interface BuildStepOrBuilder
      Returns:
      The bytes for dir.

    • getId

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

    • getIdBytes

      public 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;
      Specified by:
      getIdBytes in interface BuildStepOrBuilder
      Returns:
      The bytes for id.

    • getWaitForList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getWaitForList in interface BuildStepOrBuilder
      Returns:
      A list containing the waitFor.

    • getWaitForCount

      public 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;
      Specified by:
      getWaitForCount in interface BuildStepOrBuilder
      Returns:
      The count of waitFor.

    • getWaitFor

      public 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;
      Specified by:
      getWaitFor in interface BuildStepOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The waitFor at the given index.

    • getWaitForBytes

      public 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;
      Specified by:
      getWaitForBytes in interface BuildStepOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the waitFor at the given index.

    • getEntrypoint

      public 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;
      Specified by:
      getEntrypoint in interface BuildStepOrBuilder
      Returns:
      The entrypoint.

    • getEntrypointBytes

      public 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;
      Specified by:
      getEntrypointBytes in interface BuildStepOrBuilder
      Returns:
      The bytes for entrypoint.

    • getSecretEnvList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getSecretEnvList in interface BuildStepOrBuilder
      Returns:
      A list containing the secretEnv.

    • getSecretEnvCount

      public 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;
      Specified by:
      getSecretEnvCount in interface BuildStepOrBuilder
      Returns:
      The count of secretEnv.

    • getSecretEnv

      public 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;
      Specified by:
      getSecretEnv in interface BuildStepOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The secretEnv at the given index.

    • getSecretEnvBytes

      public 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;
      Specified by:
      getSecretEnvBytes in interface BuildStepOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the secretEnv at the given index.

    • getVolumesList

      public 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;
      Specified by:
      getVolumesList in interface BuildStepOrBuilder

    • getVolumesOrBuilderList

      public 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;
      Specified by:
      getVolumesOrBuilderList in interface BuildStepOrBuilder

    • getVolumesCount

      public 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;
      Specified by:
      getVolumesCount in interface BuildStepOrBuilder

    • getVolumes

      public 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;
      Specified by:
      getVolumes in interface BuildStepOrBuilder

    • getVolumesOrBuilder

      public 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;
      Specified by:
      getVolumesOrBuilder in interface BuildStepOrBuilder

    • hasTiming

      public 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];
      Specified by:
      hasTiming in interface BuildStepOrBuilder
      Returns:
      Whether the timing field is set.

    • getTiming

      public 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];
      Specified by:
      getTiming in interface BuildStepOrBuilder
      Returns:
      The timing.

    • getTimingOrBuilder

      public 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];
      Specified by:
      getTimingOrBuilder in interface BuildStepOrBuilder

    • hasPullTiming

      public 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];
      Specified by:
      hasPullTiming in interface BuildStepOrBuilder
      Returns:
      Whether the pullTiming field is set.

    • getPullTiming

      public 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];
      Specified by:
      getPullTiming in interface BuildStepOrBuilder
      Returns:
      The pullTiming.

    • getPullTimingOrBuilder

      public 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];
      Specified by:
      getPullTimingOrBuilder in interface BuildStepOrBuilder

    • hasTimeout

      public 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;
      Specified by:
      hasTimeout in interface BuildStepOrBuilder
      Returns:
      Whether the timeout field is set.

    • getTimeout

      public 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;
      Specified by:
      getTimeout in interface BuildStepOrBuilder
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      public 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;
      Specified by:
      getTimeoutOrBuilder in interface BuildStepOrBuilder

    • getStatusValue

      public 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];
      Specified by:
      getStatusValue in interface BuildStepOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      public 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];
      Specified by:
      getStatus in interface BuildStepOrBuilder
      Returns:
      The status.

    • getAllowFailure

      public 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;
      Specified by:
      getAllowFailure in interface BuildStepOrBuilder
      Returns:
      The allowFailure.

    • getExitCode

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

    • getAllowExitCodesList

      public 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;
      Specified by:
      getAllowExitCodesList in interface BuildStepOrBuilder
      Returns:
      A list containing the allowExitCodes.

    • getAllowExitCodesCount

      public 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;
      Specified by:
      getAllowExitCodesCount in interface BuildStepOrBuilder
      Returns:
      The count of allowExitCodes.

    • getAllowExitCodes

      public 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;
      Specified by:
      getAllowExitCodes in interface BuildStepOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowExitCodes at the given index.

    • getScript

      public 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;
      Specified by:
      getScript in interface BuildStepOrBuilder
      Returns:
      The script.

    • getScriptBytes

      public 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;
      Specified by:
      getScriptBytes in interface BuildStepOrBuilder
      Returns:
      The bytes for script.

    • hasAutomapSubstitutions

      public 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;
      Specified by:
      hasAutomapSubstitutions in interface BuildStepOrBuilder
      Returns:
      Whether the automapSubstitutions field is set.

    • getAutomapSubstitutions

      public 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;
      Specified by:
      getAutomapSubstitutions in interface BuildStepOrBuilder
      Returns:
      The automapSubstitutions.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static BuildStep parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BuildStep parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BuildStep parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BuildStep parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BuildStep parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BuildStep parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BuildStep parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BuildStep parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BuildStep parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BuildStep parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BuildStep parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BuildStep parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public BuildStep.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BuildStep.Builder newBuilder()

    • newBuilder

      public static BuildStep.Builder newBuilder(BuildStep prototype)

    • toBuilder

      public BuildStep.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BuildStep.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BuildStep getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BuildStep> parser()

    • getParserForType

      public com.google.protobuf.Parser<BuildStep> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public BuildStep getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder