Class: Google::Cloud::Build::V1::BuildStep

Inherits:

Object

Object
Google::Cloud::Build::V1::BuildStep

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb

Overview

A step in the build pipeline.

Instance Attribute Summary collapse

#allow_exit_codes ⇒ ::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.
#allow_failure ⇒ ::Boolean
Allow this build step to fail without failing the entire build.
#args ⇒ ::Array<::String>
A list of arguments that will be presented to the step when it is started.
#automap_substitutions ⇒ ::Boolean
Option to include built-in and custom substitutions as env variables for this build step.
#dir ⇒ ::String
Working directory to use when running this step's container.
#entrypoint ⇒ ::String
Entrypoint to be used instead of the build step image's default entrypoint.
#env ⇒ ::Array<::String>
A list of environment variable definitions to be used when running a step.
#exit_code ⇒ ::Integer readonly
Output only.
#id ⇒ ::String
Unique identifier for this build step, used in wait_for to reference this build step as a dependency.
#name ⇒ ::String
Required.
#pull_timing ⇒ ::Google::Cloud::Build::V1::TimeSpan readonly
Output only.
#script ⇒ ::String
A shell script to be executed in the step.
#secret_env ⇒ ::Array<::String>
A list of environment variables which are encrypted using a Cloud Key Management Service crypto key.
#status ⇒ ::Google::Cloud::Build::V1::Build::Status readonly
Output only.
#timeout ⇒ ::Google::Protobuf::Duration
Time limit for executing this build step.
#timing ⇒ ::Google::Cloud::Build::V1::TimeSpan readonly
Output only.
#volumes ⇒ ::Array<::Google::Cloud::Build::V1::Volume>
List of volumes to mount into the build step.
#wait_for ⇒ ::Array<::String>
The ID(s) of the step(s) that this build step depends on.

Instance Attribute Details

#allow_exit_codes ⇒ `::Array<::Integer>`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#allow_failure ⇒ `::Boolean`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#args ⇒ `::Array<::String>`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#automap_substitutions ⇒ `::Boolean`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#dir ⇒ `::String`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#entrypoint ⇒ `::String`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#env ⇒ `::Array<::String>`

Returns 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".

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#exit_code ⇒ `::Integer` (readonly)

Returns Output only. Return code from running the step.

Returns:

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

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ `::String`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ `::String`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pull_timing ⇒ `::Google::Cloud::Build::V1::TimeSpan` (readonly)

Returns Output only. Stores timing information for pulling this build step's builder image only.

Returns:

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

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#script ⇒ `::String`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#secret_env ⇒ `::Array<::String>`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#status ⇒ `::Google::Cloud::Build::V1::Build::Status` (readonly)

Returns 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.

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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#timeout ⇒ `::Google::Protobuf::Duration`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#timing ⇒ `::Google::Cloud::Build::V1::TimeSpan` (readonly)

Returns Output only. Stores timing information for executing this build step.

Returns:

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

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#volumes ⇒ `::Array<::Google::Cloud::Build::V1::Volume>`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#wait_for ⇒ `::Array<::String>`

Returns 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.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 399

class BuildStep
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

Class: Google::Cloud::Build::V1::BuildStep

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#allow_exit_codes ⇒ ::Array<::Integer>

#allow_failure ⇒ ::Boolean

#args ⇒ ::Array<::String>

#automap_substitutions ⇒ ::Boolean

#dir ⇒ ::String

#entrypoint ⇒ ::String

#env ⇒ ::Array<::String>

#exit_code ⇒ ::Integer (readonly)

#id ⇒ ::String

#name ⇒ ::String

#pull_timing ⇒ ::Google::Cloud::Build::V1::TimeSpan (readonly)

#script ⇒ ::String

#secret_env ⇒ ::Array<::String>

#status ⇒ ::Google::Cloud::Build::V1::Build::Status (readonly)

#timeout ⇒ ::Google::Protobuf::Duration

#timing ⇒ ::Google::Cloud::Build::V1::TimeSpan (readonly)

#volumes ⇒ ::Array<::Google::Cloud::Build::V1::Volume>

#wait_for ⇒ ::Array<::String>

#allow_exit_codes ⇒ `::Array<::Integer>`

#allow_failure ⇒ `::Boolean`

#args ⇒ `::Array<::String>`

#automap_substitutions ⇒ `::Boolean`

#dir ⇒ `::String`

#entrypoint ⇒ `::String`

#env ⇒ `::Array<::String>`

#exit_code ⇒ `::Integer` (readonly)

#id ⇒ `::String`

#name ⇒ `::String`

#pull_timing ⇒ `::Google::Cloud::Build::V1::TimeSpan` (readonly)

#script ⇒ `::String`

#secret_env ⇒ `::Array<::String>`

#status ⇒ `::Google::Cloud::Build::V1::Build::Status` (readonly)

#timeout ⇒ `::Google::Protobuf::Duration`

#timing ⇒ `::Google::Cloud::Build::V1::TimeSpan` (readonly)

#volumes ⇒ `::Array<::Google::Cloud::Build::V1::Volume>`

#wait_for ⇒ `::Array<::String>`