Cloud Build V1 API - Class Google::Cloud::Build::V1::BuildStep (v0.27.1)

Version 0.27.1

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.27.1
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.3

Reference documentation and code samples for the Cloud Build V1 API class Google::Cloud::Build::V1::BuildStep.

A step in the build pipeline.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#allow_exit_codes

def allow_exit_codes() -> ::Array<::Integer>

Returns

• (::Array<::Integer>) — 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.

#allow_exit_codes=

def allow_exit_codes=(value) -> ::Array<::Integer>

Parameter

• value (::Array<::Integer>) — 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.

Returns

• (::Array<::Integer>) — 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.

#allow_failure

def allow_failure() -> ::Boolean

Returns

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

#allow_failure=

def allow_failure=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

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

#args

def args() -> ::Array<::String>

Returns

• (::Array<::String>) — 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.

#args=

def args=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — 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.

Returns

• (::Array<::String>) — 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.

#automap_substitutions

def automap_substitutions() -> ::Boolean

Returns

• (::Boolean) — Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.

#automap_substitutions=

def automap_substitutions=(value) -> ::Boolean

Parameter

• value (::Boolean) — Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.

Returns

• (::Boolean) — Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption.

#dir

def dir() -> ::String

Returns

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

#dir=

def dir=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

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

#entrypoint

def entrypoint() -> ::String

Returns

• (::String) — Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

#entrypoint=

def entrypoint=(value) -> ::String

Parameter

• value (::String) — Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

Returns

• (::String) — Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.

#env

def env() -> ::Array<::String>

Returns

• (::Array<::String>) — 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".

#env=

def env=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — 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".

Returns

• (::Array<::String>) — 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".

#exit_code

def exit_code() -> ::Integer

Returns

• (::Integer) — Output only. Return code from running the step.

#id

def id() -> ::String

Returns

• (::String) — Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

#id=

def id=(value) -> ::String

Parameter

• value (::String) — Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

Returns

• (::String) — Unique identifier for this build step, used in wait_for to reference this build step as a dependency.

#name

def name() -> ::String

Returns

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

#name=

def name=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

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

#pull_timing

def pull_timing() -> ::Google::Cloud::Build::V1::TimeSpan

Returns

• (::Google::Cloud::Build::V1::TimeSpan) — Output only. Stores timing information for pulling this build step's builder image only.

#script

def script() -> ::String

Returns

• (::String) — A shell script to be executed in the step.

  When script is provided, the user cannot specify the entrypoint or args.

#script=

def script=(value) -> ::String

Parameter

• value (::String) — A shell script to be executed in the step.

  When script is provided, the user cannot specify the entrypoint or args.

Returns

• (::String) — A shell script to be executed in the step.

  When script is provided, the user cannot specify the entrypoint or args.

#secret_env

def secret_env() -> ::Array<::String>

Returns

• (::Array<::String>) — 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.

#secret_env=

def secret_env=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — 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.

Returns

• (::Array<::String>) — 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.

#status

def status() -> ::Google::Cloud::Build::V1::Build::Status

Returns

• (::Google::Cloud::Build::V1::Build::Status) — 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.

#timeout

def timeout() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — 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.

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — 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.

Returns

• (::Google::Protobuf::Duration) — 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.

#timing

def timing() -> ::Google::Cloud::Build::V1::TimeSpan

Returns

• (::Google::Cloud::Build::V1::TimeSpan) — Output only. Stores timing information for executing this build step.

#volumes

def volumes() -> ::Array<::Google::Cloud::Build::V1::Volume>

Returns

• (::Array<::Google::Cloud::Build::V1::Volume>) — 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.

#volumes=

def volumes=(value) -> ::Array<::Google::Cloud::Build::V1::Volume>

Parameter

• value (::Array<::Google::Cloud::Build::V1::Volume>) — 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.

Returns

• (::Array<::Google::Cloud::Build::V1::Volume>) — 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.

#wait_for

def wait_for() -> ::Array<::String>

Returns

• (::Array<::String>) — 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.

#wait_for=

def wait_for=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — 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.

Returns

• (::Array<::String>) — 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.