Class protos.google.devtools.cloudbuild.v1.BuildStep

Represents a BuildStep.

Package

@google-cloud/cloudbuild

Constructors

(constructor)(properties)

constructor(properties?: google.devtools.cloudbuild.v1.IBuildStep);

Constructs a new BuildStep.

Parameter
NameDescription
properties IBuildStep

Properties to set

Properties

args

public args: string[];

BuildStep args.

dir

public dir: string;

BuildStep dir.

entrypoint

public entrypoint: string;

BuildStep entrypoint.

env

public env: string[];

BuildStep env.

id

public id: string;

BuildStep id.

name

public name: string;

BuildStep name.

pullTiming

public pullTiming?: (google.devtools.cloudbuild.v1.ITimeSpan|null);

BuildStep pullTiming.

script

public script: string;

BuildStep script.

secretEnv

public secretEnv: string[];

BuildStep secretEnv.

status

public status: (google.devtools.cloudbuild.v1.Build.Status|keyof typeof google.devtools.cloudbuild.v1.Build.Status);

BuildStep status.

timeout

public timeout?: (google.protobuf.IDuration|null);

BuildStep timeout.

timing

public timing?: (google.devtools.cloudbuild.v1.ITimeSpan|null);

BuildStep timing.

volumes

public volumes: google.devtools.cloudbuild.v1.IVolume[];

BuildStep volumes.

waitFor

public waitFor: string[];

BuildStep waitFor.

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IBuildStep): google.devtools.cloudbuild.v1.BuildStep;

Creates a new BuildStep instance using the specified properties.

Parameter
NameDescription
properties IBuildStep

Properties to set

Returns
TypeDescription
google.devtools.cloudbuild.v1.BuildStep

BuildStep instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.devtools.cloudbuild.v1.BuildStep;

Decodes a BuildStep message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.devtools.cloudbuild.v1.BuildStep

BuildStep

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devtools.cloudbuild.v1.BuildStep;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.devtools.cloudbuild.v1.BuildStep

BuildStep

encode(message, writer)

public static encode(message: google.devtools.cloudbuild.v1.IBuildStep, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BuildStep message. Does not implicitly messages.

Parameters
NameDescription
message IBuildStep

BuildStep message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.devtools.cloudbuild.v1.IBuildStep, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBuildStep

BuildStep message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.devtools.cloudbuild.v1.BuildStep;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.devtools.cloudbuild.v1.BuildStep

BuildStep

toJSON()

public toJSON(): { [k: string]: any };

Converts this BuildStep to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.devtools.cloudbuild.v1.BuildStep, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.devtools.cloudbuild.v1.BuildStep

BuildStep

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a BuildStep message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not