Class protos.google.devtools.cloudbuild.v1.BuildStep (2.5.0)

Represents a BuildStep.

Package

@google-cloud/cloudbuild!

Constructors

(constructor)(properties)

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

Constructs a new BuildStep.

Parameter

Name	Description
properties	`IBuildStep` Properties to set

Properties

args

public args: string[];

BuildStep args.

Property Value

Type	Description
string[]

dir

public dir: string;

BuildStep dir.

Property Value

Type	Description
string

entrypoint

public entrypoint: string;

BuildStep entrypoint.

Property Value

Type	Description
string

env

public env: string[];

BuildStep env.

Property Value

Type	Description
string[]

id

public id: string;

BuildStep id.

Property Value

Type	Description
string

name

public name: string;

BuildStep name.

Property Value

Type	Description
string

pullTiming

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

BuildStep pullTiming.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.ITimeSpan\|null)

secretEnv

public secretEnv: string[];

BuildStep secretEnv.

Property Value

Type	Description
string[]

status

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

BuildStep status.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.Build.Status\|keyof typeof google.devtools.cloudbuild.v1.Build.Status)

timeout

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

BuildStep timeout.

Property Value

Type	Description
(google.protobuf.IDuration\|null)

timing

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

BuildStep timing.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.ITimeSpan\|null)

volumes

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

BuildStep volumes.

Property Value

Type	Description
google.devtools.cloudbuild.v1.IVolume[]

waitFor

public waitFor: string[];

BuildStep waitFor.

Property Value

Type	Description
string[]

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

Name	Description
properties	`IBuildStep` Properties to set

Returns

Type	Description
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

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
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

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
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

Name	Description
message	`IBuildStep` BuildStep message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$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

Name	Description
message	`IBuildStep` BuildStep message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$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

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

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

toJSON()

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

Converts this BuildStep to JSON.

Returns

Type	Description
{ [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

Name	Description
message	`google.devtools.cloudbuild.v1.BuildStep` BuildStep
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies a BuildStep message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not