Class protos.google.devtools.cloudbuild.v1.BuildOptions (3.6.0)

Represents a BuildOptions.

Package

@google-cloud/cloudbuild

Constructors

(constructor)(properties)

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

Constructs a new BuildOptions.

Parameter
Name Description
properties IBuildOptions

Properties to set

Properties

defaultLogsBucketBehavior

public defaultLogsBucketBehavior: (google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior|keyof typeof google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior);

BuildOptions defaultLogsBucketBehavior.

diskSizeGb

public diskSizeGb: (number|Long|string);

BuildOptions diskSizeGb.

dynamicSubstitutions

public dynamicSubstitutions: boolean;

BuildOptions dynamicSubstitutions.

env

public env: string[];

BuildOptions env.

logging

public logging: (google.devtools.cloudbuild.v1.BuildOptions.LoggingMode|keyof typeof google.devtools.cloudbuild.v1.BuildOptions.LoggingMode);

BuildOptions logging.

logStreamingOption

public logStreamingOption: (google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption|keyof typeof google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption);

BuildOptions logStreamingOption.

machineType

public machineType: (google.devtools.cloudbuild.v1.BuildOptions.MachineType|keyof typeof google.devtools.cloudbuild.v1.BuildOptions.MachineType);

BuildOptions machineType.

pool

public pool?: (google.devtools.cloudbuild.v1.BuildOptions.IPoolOption|null);

BuildOptions pool.

requestedVerifyOption

public requestedVerifyOption: (google.devtools.cloudbuild.v1.BuildOptions.VerifyOption|keyof typeof google.devtools.cloudbuild.v1.BuildOptions.VerifyOption);

BuildOptions requestedVerifyOption.

secretEnv

public secretEnv: string[];

BuildOptions secretEnv.

sourceProvenanceHash

public sourceProvenanceHash: google.devtools.cloudbuild.v1.Hash.HashType[];

BuildOptions sourceProvenanceHash.

substitutionOption

public substitutionOption: (google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption|keyof typeof google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption);

BuildOptions substitutionOption.

volumes

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

BuildOptions volumes.

workerPool

public workerPool: string;

BuildOptions workerPool.

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IBuildOptions): google.devtools.cloudbuild.v1.BuildOptions;

Creates a new BuildOptions instance using the specified properties.

Parameter
Name Description
properties IBuildOptions

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

BuildOptions instance

decode(reader, length)

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

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

BuildOptions

decodeDelimited(reader)

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

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

BuildOptions

encode(message, writer)

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

Encodes the specified BuildOptions message. Does not implicitly messages.

Parameters
Name Description
message IBuildOptions

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

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

Parameters
Name Description
message IBuildOptions

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

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

BuildOptions

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for BuildOptions

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 BuildOptions to JSON.

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

JSON object

toObject(message, options)

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

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

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

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