Class protos.google.cloud.notebooks.v1.ExecutionTemplate (2.1.4)

Represents an ExecutionTemplate.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.notebooks.v1.IExecutionTemplate);

Constructs a new ExecutionTemplate.

Parameter
Name	Description
`properties`	`IExecutionTemplate` Properties to set

Properties

acceleratorConfig

public acceleratorConfig?: (google.cloud.notebooks.v1.ExecutionTemplate.ISchedulerAcceleratorConfig|null);

ExecutionTemplate acceleratorConfig.

containerImageUri

public containerImageUri: string;

ExecutionTemplate containerImageUri.

dataprocParameters

public dataprocParameters?: (google.cloud.notebooks.v1.ExecutionTemplate.IDataprocParameters|null);

ExecutionTemplate dataprocParameters.

inputNotebookFile

public inputNotebookFile: string;

ExecutionTemplate inputNotebookFile.

jobParameters

public jobParameters?: ("dataprocParameters"|"vertexAiParameters");

ExecutionTemplate jobParameters.

jobType

public jobType: (google.cloud.notebooks.v1.ExecutionTemplate.JobType|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.JobType);

ExecutionTemplate jobType.

kernelSpec

public kernelSpec: string;

ExecutionTemplate kernelSpec.

labels

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

ExecutionTemplate labels.

masterType

public masterType: string;

ExecutionTemplate masterType.

outputNotebookFolder

public outputNotebookFolder: string;

ExecutionTemplate outputNotebookFolder.

parameters

public parameters: string;

ExecutionTemplate parameters.

paramsYamlFile

public paramsYamlFile: string;

ExecutionTemplate paramsYamlFile.

scaleTier

public scaleTier: (google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier);

ExecutionTemplate scaleTier.

serviceAccount

public serviceAccount: string;

ExecutionTemplate serviceAccount.

tensorboard

public tensorboard: string;

ExecutionTemplate tensorboard.

vertexAiParameters

public vertexAiParameters?: (google.cloud.notebooks.v1.ExecutionTemplate.IVertexAIParameters|null);

ExecutionTemplate vertexAiParameters.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1.IExecutionTemplate): google.cloud.notebooks.v1.ExecutionTemplate;

Creates a new ExecutionTemplate instance using the specified properties.

Parameter
Name	Description
`properties`	`IExecutionTemplate` Properties to set

Returns
Type	Description
`google.cloud.notebooks.v1.ExecutionTemplate`	ExecutionTemplate instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.ExecutionTemplate;

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

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.ExecutionTemplate;

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

encode(message, writer)

public static encode(message: google.cloud.notebooks.v1.IExecutionTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ExecutionTemplate message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IExecutionTemplate` ExecutionTemplate 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.cloud.notebooks.v1.IExecutionTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IExecutionTemplate` ExecutionTemplate 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.cloud.notebooks.v1.ExecutionTemplate;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ExecutionTemplate

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

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.cloud.notebooks.v1.ExecutionTemplate` ExecutionTemplate
`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 an ExecutionTemplate 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