- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.51.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.6
- 3.4.1
- 3.3.12
public final class BuildStep extends GeneratedMessageV3 implements BuildStepOrBuilderA step in the build pipeline.
Protobuf type google.devtools.cloudbuild.v1.BuildStep
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BuildStepImplements
BuildStepOrBuilderStatic Fields
ARGS_FIELD_NUMBER
public static final int ARGS_FIELD_NUMBER| Type | Description |
| int |
DIR_FIELD_NUMBER
public static final int DIR_FIELD_NUMBER| Type | Description |
| int |
ENTRYPOINT_FIELD_NUMBER
public static final int ENTRYPOINT_FIELD_NUMBER| Type | Description |
| int |
ENV_FIELD_NUMBER
public static final int ENV_FIELD_NUMBER| Type | Description |
| int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER| Type | Description |
| int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Type | Description |
| int |
PULL_TIMING_FIELD_NUMBER
public static final int PULL_TIMING_FIELD_NUMBER| Type | Description |
| int |
SCRIPT_FIELD_NUMBER
public static final int SCRIPT_FIELD_NUMBER| Type | Description |
| int |
SECRET_ENV_FIELD_NUMBER
public static final int SECRET_ENV_FIELD_NUMBER| Type | Description |
| int |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER| Type | Description |
| int |
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER| Type | Description |
| int |
TIMING_FIELD_NUMBER
public static final int TIMING_FIELD_NUMBER| Type | Description |
| int |
VOLUMES_FIELD_NUMBER
public static final int VOLUMES_FIELD_NUMBER| Type | Description |
| int |
WAIT_FOR_FIELD_NUMBER
public static final int WAIT_FOR_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static BuildStep getDefaultInstance()| Type | Description |
| BuildStep |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static BuildStep.Builder newBuilder()| Type | Description |
| BuildStep.Builder |
newBuilder(BuildStep prototype)
public static BuildStep.Builder newBuilder(BuildStep prototype)| Name | Description |
| prototype | BuildStep |
| Type | Description |
| BuildStep.Builder |
parseDelimitedFrom(InputStream input)
public static BuildStep parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| BuildStep |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BuildStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| BuildStep |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static BuildStep parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| BuildStep |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BuildStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| BuildStep |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static BuildStep parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| BuildStep |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BuildStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| BuildStep |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static BuildStep parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| BuildStep |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BuildStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| BuildStep |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static BuildStep parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| BuildStep |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BuildStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| BuildStep |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static BuildStep parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| BuildStep |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BuildStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| BuildStep |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<BuildStep> parser()| Type | Description |
| Parser<BuildStep> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getArgs(int index)
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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The args at the given index. |
getArgsBytes(int index)
public 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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the args at the given index. |
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;
| Type | Description |
| int | The count of args. |
getArgsList()
public 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;
| Type | Description |
| ProtocolStringList | A list containing the args. |
getDefaultInstanceForType()
public BuildStep getDefaultInstanceForType()| Type | Description |
| BuildStep |
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;
| Type | Description |
| String | The dir. |
getDirBytes()
public 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;
| Type | Description |
| ByteString | The bytes for dir. |
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;
| Type | Description |
| String | The entrypoint. |
getEntrypointBytes()
public 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;
| Type | Description |
| ByteString | The bytes for entrypoint. |
getEnv(int index)
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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The env at the given index. |
getEnvBytes(int index)
public 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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the env at the given index. |
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;
| Type | Description |
| int | The count of env. |
getEnvList()
public 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;
| Type | Description |
| ProtocolStringList | A list containing the env. |
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;
| Type | Description |
| String | The id. |
getIdBytes()
public ByteString getIdBytes() Unique identifier for this build step, used in wait_for to
reference this build step as a dependency.
string id = 5;
| Type | Description |
| ByteString | The bytes for id. |
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). 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;
| Type | Description |
| String | The name. |
getNameBytes()
public 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). 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;
| Type | Description |
| ByteString | The bytes for name. |
getParserForType()
public Parser<BuildStep> getParserForType()| Type | Description |
| Parser<BuildStep> |
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];
| Type | Description |
| TimeSpan | 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];
| Type | Description |
| TimeSpanOrBuilder |
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;
| Type | Description |
| String | The script. |
getScriptBytes()
public 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;
| Type | Description |
| ByteString | The bytes for script. |
getSecretEnv(int index)
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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The secretEnv at the given index. |
getSecretEnvBytes(int index)
public 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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the secretEnv at the given index. |
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;
| Type | Description |
| int | The count of secretEnv. |
getSecretEnvList()
public 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;
| Type | Description |
| ProtocolStringList | A list containing the secretEnv. |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
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];
| Type | Description |
| Build.Status | The status. |
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];
| Type | Description |
| int | The enum numeric value on the wire for status. |
getTimeout()
public 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;
| Type | Description |
| Duration | The timeout. |
getTimeoutOrBuilder()
public 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;
| Type | Description |
| DurationOrBuilder |
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];
| Type | Description |
| TimeSpan | 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];
| Type | Description |
| TimeSpanOrBuilder |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
getVolumes(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| Volume |
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;
| Type | Description |
| int |
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;
| Type | Description |
| List<Volume> |
getVolumesOrBuilder(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| VolumeOrBuilder |
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;
| Type | Description |
| List<? extends com.google.cloudbuild.v1.VolumeOrBuilder> |
getWaitFor(int index)
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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The waitFor at the given index. |
getWaitForBytes(int index)
public 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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the waitFor at the given index. |
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;
| Type | Description |
| int | The count of waitFor. |
getWaitForList()
public 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;
| Type | Description |
| ProtocolStringList | A list containing the waitFor. |
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];
| Type | Description |
| boolean | Whether the pullTiming field is set. |
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;
| Type | Description |
| boolean | Whether the timeout field is set. |
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];
| Type | Description |
| boolean | Whether the timing field is set. |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public BuildStep.Builder newBuilderForType()| Type | Description |
| BuildStep.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BuildStep.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| BuildStep.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public BuildStep.Builder toBuilder()| Type | Description |
| BuildStep.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |