BuildOptions

google.devtools.cloudbuild.v1. BuildOptions

Represents a BuildOptions.

Constructor

new BuildOptions(propertiesopt)

Constructs a new BuildOptions.

Parameters:
Name Type Attributes Description
properties google.devtools.cloudbuild.v1.IBuildOptions <optional>

Properties to set
Implements:
  • IBuildOptions

Classes

PoolOption

Members

automapSubstitutions

BuildOptions automapSubstitutions.

defaultLogsBucketBehavior

BuildOptions defaultLogsBucketBehavior.

diskSizeGb

BuildOptions diskSizeGb.

dynamicSubstitutions

BuildOptions dynamicSubstitutions.

env

BuildOptions env.

logStreamingOption

BuildOptions logStreamingOption.

logging

BuildOptions logging.

machineType

BuildOptions machineType.

pool

BuildOptions pool.

requestedVerifyOption

BuildOptions requestedVerifyOption.

secretEnv

BuildOptions secretEnv.

sourceProvenanceHash

BuildOptions sourceProvenanceHash.

substitutionOption

BuildOptions substitutionOption.

volumes

BuildOptions volumes.

workerPool

BuildOptions workerPool.

DefaultLogsBucketBehavior

DefaultLogsBucketBehavior enum.

Properties:
Name Type Description
DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED number

DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED value
REGIONAL_USER_OWNED_BUCKET number

REGIONAL_USER_OWNED_BUCKET value
LEGACY_BUCKET number

LEGACY_BUCKET value

LogStreamingOption

LogStreamingOption enum.

Properties:
Name Type Description
STREAM_DEFAULT number

STREAM_DEFAULT value
STREAM_ON number

STREAM_ON value
STREAM_OFF number

STREAM_OFF value

LoggingMode

LoggingMode enum.

Properties:
Name Type Description
LOGGING_UNSPECIFIED number

LOGGING_UNSPECIFIED value
LEGACY number

LEGACY value
GCS_ONLY number

GCS_ONLY value
STACKDRIVER_ONLY number

STACKDRIVER_ONLY value
CLOUD_LOGGING_ONLY number

CLOUD_LOGGING_ONLY value
NONE number

NONE value

MachineType

MachineType enum.

Properties:
Name Type Description
UNSPECIFIED number

UNSPECIFIED value
N1_HIGHCPU_8 number

N1_HIGHCPU_8 value
N1_HIGHCPU_32 number

N1_HIGHCPU_32 value
E2_HIGHCPU_8 number

E2_HIGHCPU_8 value
E2_HIGHCPU_32 number

E2_HIGHCPU_32 value
E2_MEDIUM number

E2_MEDIUM value

SubstitutionOption

SubstitutionOption enum.

Properties:
Name Type Description
MUST_MATCH number

MUST_MATCH value
ALLOW_LOOSE number

ALLOW_LOOSE value

VerifyOption

VerifyOption enum.

Properties:
Name Type Description
NOT_VERIFIED number

NOT_VERIFIED value
VERIFIED number

VERIFIED value

Methods

toJSON() → {Object.<string, *>}

Converts this BuildOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.devtools.cloudbuild.v1.BuildOptions}

Creates a new BuildOptions instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.devtools.cloudbuild.v1.IBuildOptions <optional>

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

BuildOptions instance

(static) decode(reader, lengthopt) → {google.devtools.cloudbuild.v1.BuildOptions}

Decodes a BuildOptions message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.devtools.cloudbuild.v1.BuildOptions

BuildOptions
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.devtools.cloudbuild.v1.BuildOptions}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.devtools.cloudbuild.v1.BuildOptions

BuildOptions
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified BuildOptions message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v1.IBuildOptions

BuildOptions message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v1.IBuildOptions

BuildOptions message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.devtools.cloudbuild.v1.BuildOptions}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.devtools.cloudbuild.v1.BuildOptions

BuildOptions

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for BuildOptions

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v1.BuildOptions

BuildOptions
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a BuildOptions message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not