ExecutionTemplate

google.cloud.notebooks.v1. ExecutionTemplate

Represents an ExecutionTemplate.

Constructor

new ExecutionTemplate(propertiesopt)

Constructs a new ExecutionTemplate.

Parameters:
Name Type Attributes Description
properties google.cloud.notebooks.v1.IExecutionTemplate <optional>

Properties to set

Implements:
  • IExecutionTemplate

Classes

DataprocParameters
SchedulerAcceleratorConfig
VertexAIParameters

Members

acceleratorConfig

ExecutionTemplate acceleratorConfig.

containerImageUri

ExecutionTemplate containerImageUri.

dataprocParameters

ExecutionTemplate dataprocParameters.

inputNotebookFile

ExecutionTemplate inputNotebookFile.

jobParameters

ExecutionTemplate jobParameters.

jobType

ExecutionTemplate jobType.

kernelSpec

ExecutionTemplate kernelSpec.

labels

ExecutionTemplate labels.

masterType

ExecutionTemplate masterType.

outputNotebookFolder

ExecutionTemplate outputNotebookFolder.

parameters

ExecutionTemplate parameters.

paramsYamlFile

ExecutionTemplate paramsYamlFile.

scaleTier

ExecutionTemplate scaleTier.

serviceAccount

ExecutionTemplate serviceAccount.

tensorboard

ExecutionTemplate tensorboard.

vertexAiParameters

ExecutionTemplate vertexAiParameters.

JobType

JobType enum.

Properties:
Name Type Description
JOB_TYPE_UNSPECIFIED number

JOB_TYPE_UNSPECIFIED value

VERTEX_AI number

VERTEX_AI value

DATAPROC number

DATAPROC value

ScaleTier

ScaleTier enum.

Properties:
Name Type Description
SCALE_TIER_UNSPECIFIED number

SCALE_TIER_UNSPECIFIED value

BASIC number

BASIC value

STANDARD_1 number

STANDARD_1 value

PREMIUM_1 number

PREMIUM_1 value

BASIC_GPU number

BASIC_GPU value

BASIC_TPU number

BASIC_TPU value

CUSTOM number

CUSTOM value

SchedulerAcceleratorType

SchedulerAcceleratorType enum.

Properties:
Name Type Description
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED number

SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED value

NVIDIA_TESLA_K80 number

NVIDIA_TESLA_K80 value

NVIDIA_TESLA_P100 number

NVIDIA_TESLA_P100 value

NVIDIA_TESLA_V100 number

NVIDIA_TESLA_V100 value

NVIDIA_TESLA_P4 number

NVIDIA_TESLA_P4 value

NVIDIA_TESLA_T4 number

NVIDIA_TESLA_T4 value

NVIDIA_TESLA_A100 number

NVIDIA_TESLA_A100 value

TPU_V2 number

TPU_V2 value

TPU_V3 number

TPU_V3 value

Methods

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

Converts this ExecutionTemplate to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.notebooks.v1.ExecutionTemplate}

Creates a new ExecutionTemplate instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.notebooks.v1.IExecutionTemplate <optional>

Properties to set

Returns:
Type Description
google.cloud.notebooks.v1.ExecutionTemplate

ExecutionTemplate instance

(static) decode(reader, lengthopt) → {google.cloud.notebooks.v1.ExecutionTemplate}

Decodes an ExecutionTemplate 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.cloud.notebooks.v1.ExecutionTemplate

ExecutionTemplate

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.cloud.notebooks.v1.ExecutionTemplate}

Decodes an ExecutionTemplate 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.cloud.notebooks.v1.ExecutionTemplate

ExecutionTemplate

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 ExecutionTemplate message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.notebooks.v1.IExecutionTemplate

ExecutionTemplate 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 ExecutionTemplate message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.notebooks.v1.IExecutionTemplate

ExecutionTemplate message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.notebooks.v1.ExecutionTemplate}

Creates an ExecutionTemplate 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.cloud.notebooks.v1.ExecutionTemplate

ExecutionTemplate

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ExecutionTemplate

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 an ExecutionTemplate message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.notebooks.v1.ExecutionTemplate

ExecutionTemplate

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an ExecutionTemplate 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