BuildStep

google.devtools.cloudbuild.v1. BuildStep

Represents a BuildStep.

Constructor

new BuildStep(propertiesopt)

Constructs a new BuildStep.

Parameters:
Name Type Attributes Description
properties google.devtools.cloudbuild.v1.IBuildStep <optional>

Properties to set

Implements:
  • IBuildStep

Members

_automapSubstitutions

BuildStep _automapSubstitutions.

allowExitCodes

BuildStep allowExitCodes.

allowFailure

BuildStep allowFailure.

args

BuildStep args.

automapSubstitutions

BuildStep automapSubstitutions.

dir

BuildStep dir.

entrypoint

BuildStep entrypoint.

env

BuildStep env.

exitCode

BuildStep exitCode.

id

BuildStep id.

name

BuildStep name.

pullTiming

BuildStep pullTiming.

script

BuildStep script.

secretEnv

BuildStep secretEnv.

status

BuildStep status.

timeout

BuildStep timeout.

timing

BuildStep timing.

volumes

BuildStep volumes.

waitFor

BuildStep waitFor.

Methods

toJSON() → {Object.<string, *>}

Converts this BuildStep to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.devtools.cloudbuild.v1.BuildStep}

Creates a new BuildStep instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.devtools.cloudbuild.v1.IBuildStep <optional>

Properties to set

Returns:
Type Description
google.devtools.cloudbuild.v1.BuildStep

BuildStep instance

(static) decode(reader, lengthopt) → {google.devtools.cloudbuild.v1.BuildStep}

Decodes a BuildStep message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.devtools.cloudbuild.v1.BuildStep

BuildStep

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.devtools.cloudbuild.v1.BuildStep}

Decodes a BuildStep message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.devtools.cloudbuild.v1.BuildStep

BuildStep

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified BuildStep message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v1.IBuildStep

BuildStep message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified BuildStep message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v1.IBuildStep

BuildStep message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.devtools.cloudbuild.v1.BuildStep}

Creates a BuildStep message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.devtools.cloudbuild.v1.BuildStep

BuildStep

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for BuildStep

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a BuildStep message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v1.BuildStep

BuildStep

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a BuildStep message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not