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

Represents a Build.

Package

@google-cloud/cloudbuild!

Constructors

(constructor)(properties)

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

Constructs a new Build.

Parameter
Name Description
properties IBuild

Properties to set

Properties

approval

public approval?: (google.devtools.cloudbuild.v1.IBuildApproval|null);

Build approval.

Property Value
Type Description
(google.devtools.cloudbuild.v1.IBuildApproval|null)

artifacts

public artifacts?: (google.devtools.cloudbuild.v1.IArtifacts|null);

Build artifacts.

Property Value
Type Description
(google.devtools.cloudbuild.v1.IArtifacts|null)

availableSecrets

public availableSecrets?: (google.devtools.cloudbuild.v1.ISecrets|null);

Build availableSecrets.

Property Value
Type Description
(google.devtools.cloudbuild.v1.ISecrets|null)

buildTriggerId

public buildTriggerId: string;

Build buildTriggerId.

Property Value
Type Description
string

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Build createTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

failureInfo

public failureInfo?: (google.devtools.cloudbuild.v1.Build.IFailureInfo|null);

Build failureInfo.

Property Value
Type Description
(google.devtools.cloudbuild.v1.Build.IFailureInfo|null)

finishTime

public finishTime?: (google.protobuf.ITimestamp|null);

Build finishTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

id

public id: string;

Build id.

Property Value
Type Description
string

images

public images: string[];

Build images.

Property Value
Type Description
string[]

logsBucket

public logsBucket: string;

Build logsBucket.

Property Value
Type Description
string

logUrl

public logUrl: string;

Build logUrl.

Property Value
Type Description
string

name

public name: string;

Build name.

Property Value
Type Description
string

options

public options?: (google.devtools.cloudbuild.v1.IBuildOptions|null);

Build options.

Property Value
Type Description
(google.devtools.cloudbuild.v1.IBuildOptions|null)

projectId

public projectId: string;

Build projectId.

Property Value
Type Description
string

queueTtl

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

Build queueTtl.

Property Value
Type Description
(google.protobuf.IDuration|null)

results

public results?: (google.devtools.cloudbuild.v1.IResults|null);

Build results.

Property Value
Type Description
(google.devtools.cloudbuild.v1.IResults|null)

secrets

public secrets: google.devtools.cloudbuild.v1.ISecret[];

Build secrets.

Property Value
Type Description
google.devtools.cloudbuild.v1.ISecret[]

serviceAccount

public serviceAccount: string;

Build serviceAccount.

Property Value
Type Description
string

source

public source?: (google.devtools.cloudbuild.v1.ISource|null);

Build source.

Property Value
Type Description
(google.devtools.cloudbuild.v1.ISource|null)

sourceProvenance

public sourceProvenance?: (google.devtools.cloudbuild.v1.ISourceProvenance|null);

Build sourceProvenance.

Property Value
Type Description
(google.devtools.cloudbuild.v1.ISourceProvenance|null)

startTime

public startTime?: (google.protobuf.ITimestamp|null);

Build startTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

status

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

Build status.

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

statusDetail

public statusDetail: string;

Build statusDetail.

Property Value
Type Description
string

steps

public steps: google.devtools.cloudbuild.v1.IBuildStep[];

Build steps.

Property Value
Type Description
google.devtools.cloudbuild.v1.IBuildStep[]

substitutions

public substitutions: { [k: string]: string };

Build substitutions.

Property Value
Type Description
{ [k: string]: string }

tags

public tags: string[];

Build tags.

Property Value
Type Description
string[]

timeout

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

Build timeout.

Property Value
Type Description
(google.protobuf.IDuration|null)

timing

public timing: { [k: string]: google.devtools.cloudbuild.v1.ITimeSpan };

Build timing.

Property Value
Type Description
{ [k: string]: google.devtools.cloudbuild.v1.ITimeSpan }

warnings

public warnings: google.devtools.cloudbuild.v1.Build.IWarning[];

Build warnings.

Property Value
Type Description
google.devtools.cloudbuild.v1.Build.IWarning[]

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IBuild): google.devtools.cloudbuild.v1.Build;

Creates a new Build instance using the specified properties.

Parameter
Name Description
properties IBuild

Properties to set
Returns
Type Description
google.devtools.cloudbuild.v1.Build

Build instance

decode(reader, length)

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

Decodes a Build 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.Build

Build

decodeDelimited(reader)

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

Decodes a Build 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.Build

Build

encode(message, writer)

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

Encodes the specified Build message. Does not implicitly messages.

Parameters
Name Description
message IBuild

Build 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.IBuild, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBuild

Build 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.Build;

Creates a Build 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.Build

Build

toJSON()

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

Converts this Build to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.devtools.cloudbuild.v1.Build

Build
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 Build 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