Represents a BuildStep.
Package
@google-cloud/cloudbuildConstructors
(constructor)(properties)
constructor(properties?: google.devtools.cloudbuild.v1.IBuildStep);Constructs a new BuildStep.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBuildStep
Properties to set |
Properties
_automapSubstitutions
public _automapSubstitutions?: "automapSubstitutions";BuildStep _automapSubstitutions.
allowExitCodes
public allowExitCodes: number[];BuildStep allowExitCodes.
allowFailure
public allowFailure: boolean;BuildStep allowFailure.
args
public args: string[];BuildStep args.
automapSubstitutions
public automapSubstitutions?: (boolean|null);BuildStep automapSubstitutions.
dir
public dir: string;BuildStep dir.
entrypoint
public entrypoint: string;BuildStep entrypoint.
env
public env: string[];BuildStep env.
exitCode
public exitCode: number;BuildStep exitCode.
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 | |
|---|---|
| Name | Description |
properties |
IBuildStep
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 |
BuildStep | BuildStep |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BuildStep
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
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 |
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) |
|