@google-cloud/notebooks
Version:
Notebooks client for Node.js
977 lines (790 loc) • 1.38 MB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace cloud. */
namespace cloud {
/** Namespace notebooks. */
namespace notebooks {
/** Namespace v1. */
namespace v1 {
/** Properties of a DiagnosticConfig. */
interface IDiagnosticConfig {
/** DiagnosticConfig gcsBucket */
gcsBucket?: (string|null);
/** DiagnosticConfig relativePath */
relativePath?: (string|null);
/** DiagnosticConfig repairFlagEnabled */
repairFlagEnabled?: (boolean|null);
/** DiagnosticConfig packetCaptureFlagEnabled */
packetCaptureFlagEnabled?: (boolean|null);
/** DiagnosticConfig copyHomeFilesFlagEnabled */
copyHomeFilesFlagEnabled?: (boolean|null);
}
/** Represents a DiagnosticConfig. */
class DiagnosticConfig implements IDiagnosticConfig {
/**
* Constructs a new DiagnosticConfig.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.IDiagnosticConfig);
/** DiagnosticConfig gcsBucket. */
public gcsBucket: string;
/** DiagnosticConfig relativePath. */
public relativePath: string;
/** DiagnosticConfig repairFlagEnabled. */
public repairFlagEnabled: boolean;
/** DiagnosticConfig packetCaptureFlagEnabled. */
public packetCaptureFlagEnabled: boolean;
/** DiagnosticConfig copyHomeFilesFlagEnabled. */
public copyHomeFilesFlagEnabled: boolean;
/**
* Creates a new DiagnosticConfig instance using the specified properties.
* @param [properties] Properties to set
* @returns DiagnosticConfig instance
*/
public static create(properties?: google.cloud.notebooks.v1.IDiagnosticConfig): google.cloud.notebooks.v1.DiagnosticConfig;
/**
* Encodes the specified DiagnosticConfig message. Does not implicitly {@link google.cloud.notebooks.v1.DiagnosticConfig.verify|verify} messages.
* @param message DiagnosticConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.IDiagnosticConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified DiagnosticConfig message, length delimited. Does not implicitly {@link google.cloud.notebooks.v1.DiagnosticConfig.verify|verify} messages.
* @param message DiagnosticConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.notebooks.v1.IDiagnosticConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a DiagnosticConfig message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns DiagnosticConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.DiagnosticConfig;
/**
* Decodes a DiagnosticConfig message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns DiagnosticConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.DiagnosticConfig;
/**
* Verifies a DiagnosticConfig message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a DiagnosticConfig message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns DiagnosticConfig
*/
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.DiagnosticConfig;
/**
* Creates a plain object from a DiagnosticConfig message. Also converts values to other types if specified.
* @param message DiagnosticConfig
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.notebooks.v1.DiagnosticConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this DiagnosticConfig to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for DiagnosticConfig
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an Environment. */
interface IEnvironment {
/** Environment name */
name?: (string|null);
/** Environment displayName */
displayName?: (string|null);
/** Environment description */
description?: (string|null);
/** Environment vmImage */
vmImage?: (google.cloud.notebooks.v1.IVmImage|null);
/** Environment containerImage */
containerImage?: (google.cloud.notebooks.v1.IContainerImage|null);
/** Environment postStartupScript */
postStartupScript?: (string|null);
/** Environment createTime */
createTime?: (google.protobuf.ITimestamp|null);
}
/** Represents an Environment. */
class Environment implements IEnvironment {
/**
* Constructs a new Environment.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.IEnvironment);
/** Environment name. */
public name: string;
/** Environment displayName. */
public displayName: string;
/** Environment description. */
public description: string;
/** Environment vmImage. */
public vmImage?: (google.cloud.notebooks.v1.IVmImage|null);
/** Environment containerImage. */
public containerImage?: (google.cloud.notebooks.v1.IContainerImage|null);
/** Environment postStartupScript. */
public postStartupScript: string;
/** Environment createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** Environment imageType. */
public imageType?: ("vmImage"|"containerImage");
/**
* Creates a new Environment instance using the specified properties.
* @param [properties] Properties to set
* @returns Environment instance
*/
public static create(properties?: google.cloud.notebooks.v1.IEnvironment): google.cloud.notebooks.v1.Environment;
/**
* Encodes the specified Environment message. Does not implicitly {@link google.cloud.notebooks.v1.Environment.verify|verify} messages.
* @param message Environment message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Environment message, length delimited. Does not implicitly {@link google.cloud.notebooks.v1.Environment.verify|verify} messages.
* @param message Environment message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.notebooks.v1.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an Environment message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Environment
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.Environment;
/**
* Decodes an Environment message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Environment
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.Environment;
/**
* Verifies an Environment message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an Environment message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Environment
*/
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.Environment;
/**
* Creates a plain object from an Environment message. Also converts values to other types if specified.
* @param message Environment
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.notebooks.v1.Environment, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Environment to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Environment
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a VmImage. */
interface IVmImage {
/** VmImage project */
project?: (string|null);
/** VmImage imageName */
imageName?: (string|null);
/** VmImage imageFamily */
imageFamily?: (string|null);
}
/** Represents a VmImage. */
class VmImage implements IVmImage {
/**
* Constructs a new VmImage.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.IVmImage);
/** VmImage project. */
public project: string;
/** VmImage imageName. */
public imageName?: (string|null);
/** VmImage imageFamily. */
public imageFamily?: (string|null);
/** VmImage image. */
public image?: ("imageName"|"imageFamily");
/**
* Creates a new VmImage instance using the specified properties.
* @param [properties] Properties to set
* @returns VmImage instance
*/
public static create(properties?: google.cloud.notebooks.v1.IVmImage): google.cloud.notebooks.v1.VmImage;
/**
* Encodes the specified VmImage message. Does not implicitly {@link google.cloud.notebooks.v1.VmImage.verify|verify} messages.
* @param message VmImage message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.IVmImage, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified VmImage message, length delimited. Does not implicitly {@link google.cloud.notebooks.v1.VmImage.verify|verify} messages.
* @param message VmImage message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.notebooks.v1.IVmImage, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a VmImage message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns VmImage
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.VmImage;
/**
* Decodes a VmImage message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns VmImage
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.VmImage;
/**
* Verifies a VmImage message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a VmImage message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns VmImage
*/
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.VmImage;
/**
* Creates a plain object from a VmImage message. Also converts values to other types if specified.
* @param message VmImage
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.notebooks.v1.VmImage, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this VmImage to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for VmImage
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ContainerImage. */
interface IContainerImage {
/** ContainerImage repository */
repository?: (string|null);
/** ContainerImage tag */
tag?: (string|null);
}
/** Represents a ContainerImage. */
class ContainerImage implements IContainerImage {
/**
* Constructs a new ContainerImage.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.IContainerImage);
/** ContainerImage repository. */
public repository: string;
/** ContainerImage tag. */
public tag: string;
/**
* Creates a new ContainerImage instance using the specified properties.
* @param [properties] Properties to set
* @returns ContainerImage instance
*/
public static create(properties?: google.cloud.notebooks.v1.IContainerImage): google.cloud.notebooks.v1.ContainerImage;
/**
* Encodes the specified ContainerImage message. Does not implicitly {@link google.cloud.notebooks.v1.ContainerImage.verify|verify} messages.
* @param message ContainerImage message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.IContainerImage, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ContainerImage message, length delimited. Does not implicitly {@link google.cloud.notebooks.v1.ContainerImage.verify|verify} messages.
* @param message ContainerImage message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.notebooks.v1.IContainerImage, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ContainerImage message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ContainerImage
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.ContainerImage;
/**
* Decodes a ContainerImage message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ContainerImage
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.ContainerImage;
/**
* Verifies a ContainerImage message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a ContainerImage message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ContainerImage
*/
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.ContainerImage;
/**
* Creates a plain object from a ContainerImage message. Also converts values to other types if specified.
* @param message ContainerImage
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.notebooks.v1.ContainerImage, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ContainerImage to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ContainerImage
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an Event. */
interface IEvent {
/** Event reportTime */
reportTime?: (google.protobuf.ITimestamp|null);
/** Event type */
type?: (google.cloud.notebooks.v1.Event.EventType|keyof typeof google.cloud.notebooks.v1.Event.EventType|null);
/** Event details */
details?: ({ [k: string]: string }|null);
}
/** Represents an Event. */
class Event implements IEvent {
/**
* Constructs a new Event.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.IEvent);
/** Event reportTime. */
public reportTime?: (google.protobuf.ITimestamp|null);
/** Event type. */
public type: (google.cloud.notebooks.v1.Event.EventType|keyof typeof google.cloud.notebooks.v1.Event.EventType);
/** Event details. */
public details: { [k: string]: string };
/**
* Creates a new Event instance using the specified properties.
* @param [properties] Properties to set
* @returns Event instance
*/
public static create(properties?: google.cloud.notebooks.v1.IEvent): google.cloud.notebooks.v1.Event;
/**
* Encodes the specified Event message. Does not implicitly {@link google.cloud.notebooks.v1.Event.verify|verify} messages.
* @param message Event message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.IEvent, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Event message, length delimited. Does not implicitly {@link google.cloud.notebooks.v1.Event.verify|verify} messages.
* @param message Event message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.notebooks.v1.IEvent, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an Event message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Event
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.Event;
/**
* Decodes an Event message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Event
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.Event;
/**
* Verifies an Event message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an Event message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Event
*/
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.Event;
/**
* Creates a plain object from an Event message. Also converts values to other types if specified.
* @param message Event
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.notebooks.v1.Event, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Event to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Event
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace Event {
/** EventType enum. */
enum EventType {
EVENT_TYPE_UNSPECIFIED = 0,
IDLE = 1,
HEARTBEAT = 2,
HEALTH = 3,
MAINTENANCE = 4
}
}
/** Properties of an ExecutionTemplate. */
interface IExecutionTemplate {
/** ExecutionTemplate scaleTier */
scaleTier?: (google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier|null);
/** ExecutionTemplate masterType */
masterType?: (string|null);
/** ExecutionTemplate acceleratorConfig */
acceleratorConfig?: (google.cloud.notebooks.v1.ExecutionTemplate.ISchedulerAcceleratorConfig|null);
/** ExecutionTemplate labels */
labels?: ({ [k: string]: string }|null);
/** ExecutionTemplate inputNotebookFile */
inputNotebookFile?: (string|null);
/** ExecutionTemplate containerImageUri */
containerImageUri?: (string|null);
/** ExecutionTemplate outputNotebookFolder */
outputNotebookFolder?: (string|null);
/** ExecutionTemplate paramsYamlFile */
paramsYamlFile?: (string|null);
/** ExecutionTemplate parameters */
parameters?: (string|null);
/** ExecutionTemplate serviceAccount */
serviceAccount?: (string|null);
/** ExecutionTemplate jobType */
jobType?: (google.cloud.notebooks.v1.ExecutionTemplate.JobType|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.JobType|null);
/** ExecutionTemplate dataprocParameters */
dataprocParameters?: (google.cloud.notebooks.v1.ExecutionTemplate.IDataprocParameters|null);
/** ExecutionTemplate vertexAiParameters */
vertexAiParameters?: (google.cloud.notebooks.v1.ExecutionTemplate.IVertexAIParameters|null);
/** ExecutionTemplate kernelSpec */
kernelSpec?: (string|null);
/** ExecutionTemplate tensorboard */
tensorboard?: (string|null);
}
/** Represents an ExecutionTemplate. */
class ExecutionTemplate implements IExecutionTemplate {
/**
* Constructs a new ExecutionTemplate.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.IExecutionTemplate);
/** ExecutionTemplate scaleTier. */
public scaleTier: (google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier);
/** ExecutionTemplate masterType. */
public masterType: string;
/** ExecutionTemplate acceleratorConfig. */
public acceleratorConfig?: (google.cloud.notebooks.v1.ExecutionTemplate.ISchedulerAcceleratorConfig|null);
/** ExecutionTemplate labels. */
public labels: { [k: string]: string };
/** ExecutionTemplate inputNotebookFile. */
public inputNotebookFile: string;
/** ExecutionTemplate containerImageUri. */
public containerImageUri: string;
/** ExecutionTemplate outputNotebookFolder. */
public outputNotebookFolder: string;
/** ExecutionTemplate paramsYamlFile. */
public paramsYamlFile: string;
/** ExecutionTemplate parameters. */
public parameters: string;
/** ExecutionTemplate serviceAccount. */
public serviceAccount: string;
/** ExecutionTemplate jobType. */
public jobType: (google.cloud.notebooks.v1.ExecutionTemplate.JobType|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.JobType);
/** ExecutionTemplate dataprocParameters. */
public dataprocParameters?: (google.cloud.notebooks.v1.ExecutionTemplate.IDataprocParameters|null);
/** ExecutionTemplate vertexAiParameters. */
public vertexAiParameters?: (google.cloud.notebooks.v1.ExecutionTemplate.IVertexAIParameters|null);
/** ExecutionTemplate kernelSpec. */
public kernelSpec: string;
/** ExecutionTemplate tensorboard. */
public tensorboard: string;
/** ExecutionTemplate jobParameters. */
public jobParameters?: ("dataprocParameters"|"vertexAiParameters");
/**
* Creates a new ExecutionTemplate instance using the specified properties.
* @param [properties] Properties to set
* @returns ExecutionTemplate instance
*/
public static create(properties?: google.cloud.notebooks.v1.IExecutionTemplate): google.cloud.notebooks.v1.ExecutionTemplate;
/**
* Encodes the specified ExecutionTemplate message. Does not implicitly {@link google.cloud.notebooks.v1.ExecutionTemplate.verify|verify} messages.
* @param message ExecutionTemplate message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.IExecutionTemplate, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ExecutionTemplate message, length delimited. Does not implicitly {@link google.cloud.notebooks.v1.ExecutionTemplate.verify|verify} messages.
* @param message ExecutionTemplate message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.notebooks.v1.IExecutionTemplate, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ExecutionTemplate message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ExecutionTemplate
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.ExecutionTemplate;
/**
* Decodes an ExecutionTemplate message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ExecutionTemplate
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.ExecutionTemplate;
/**
* Verifies an ExecutionTemplate message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ExecutionTemplate message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ExecutionTemplate
*/
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.ExecutionTemplate;
/**
* Creates a plain object from an ExecutionTemplate message. Also converts values to other types if specified.
* @param message ExecutionTemplate
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.notebooks.v1.ExecutionTemplate, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ExecutionTemplate to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ExecutionTemplate
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace ExecutionTemplate {
/** ScaleTier enum. */
enum ScaleTier {
SCALE_TIER_UNSPECIFIED = 0,
BASIC = 1,
STANDARD_1 = 2,
PREMIUM_1 = 3,
BASIC_GPU = 4,
BASIC_TPU = 5,
CUSTOM = 6
}
/** SchedulerAcceleratorType enum. */
enum SchedulerAcceleratorType {
SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED = 0,
NVIDIA_TESLA_K80 = 1,
NVIDIA_TESLA_P100 = 2,
NVIDIA_TESLA_V100 = 3,
NVIDIA_TESLA_P4 = 4,
NVIDIA_TESLA_T4 = 5,
NVIDIA_TESLA_A100 = 10,
TPU_V2 = 6,
TPU_V3 = 7
}
/** Properties of a SchedulerAcceleratorConfig. */
interface ISchedulerAcceleratorConfig {
/** SchedulerAcceleratorConfig type */
type?: (google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorType|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorType|null);
/** SchedulerAcceleratorConfig coreCount */
coreCount?: (number|Long|string|null);
}
/** Represents a SchedulerAcceleratorConfig. */
class SchedulerAcceleratorConfig implements ISchedulerAcceleratorConfig {
/**
* Constructs a new SchedulerAcceleratorConfig.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.ExecutionTemplate.ISchedulerAcceleratorConfig);
/** SchedulerAcceleratorConfig type. */
public type: (google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorType|keyof typeof google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorType);
/** SchedulerAcceleratorConfig coreCount. */
public coreCount: (number|Long|string);
/**
* Creates a new SchedulerAcceleratorConfig instance using the specified properties.
* @param [properties] Properties to set
* @returns SchedulerAcceleratorConfig instance
*/
public static create(properties?: google.cloud.notebooks.v1.ExecutionTemplate.ISchedulerAcceleratorConfig): google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig;
/**
* Encodes the specified SchedulerAcceleratorConfig message. Does not implicitly {@link google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig.verify|verify} messages.
* @param message SchedulerAcceleratorConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.ExecutionTemplate.ISchedulerAcceleratorConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SchedulerAcceleratorConfig message, length delimited. Does not implicitly {@link google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig.verify|verify} messages.
* @param message SchedulerAcceleratorConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.notebooks.v1.ExecutionTemplate.ISchedulerAcceleratorConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SchedulerAcceleratorConfig message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SchedulerAcceleratorConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig;
/**
* Decodes a SchedulerAcceleratorConfig message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SchedulerAcceleratorConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig;
/**
* Verifies a SchedulerAcceleratorConfig message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a SchedulerAcceleratorConfig message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SchedulerAcceleratorConfig
*/
public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig;
/**
* Creates a plain object from a SchedulerAcceleratorConfig message. Also converts values to other types if specified.
* @param message SchedulerAcceleratorConfig
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SchedulerAcceleratorConfig to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SchedulerAcceleratorConfig
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** JobType enum. */
enum JobType {
JOB_TYPE_UNSPECIFIED = 0,
VERTEX_AI = 1,
DATAPROC = 2
}
/** Properties of a DataprocParameters. */
interface IDataprocParameters {
/** DataprocParameters cluster */
cluster?: (string|null);
}
/** Represents a DataprocParameters. */
class DataprocParameters implements IDataprocParameters {
/**
* Constructs a new DataprocParameters.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.notebooks.v1.ExecutionTemplate.IDataprocParameters);
/** DataprocParameters cluster. */
public cluster: string;
/**
* Creates a new DataprocParameters instance using the specified properties.
* @param [properties] Properties to set
* @returns DataprocParameters instance
*/
public static create(properties?: google.cloud.notebooks.v1.ExecutionTemplate.IDataprocParameters): google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters;
/**
* Encodes the specified DataprocParameters message. Does not implicitly {@link google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters.verify|verify} messages.
* @param message DataprocParameters message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.notebooks.v1.ExecutionTemplate.IDataprocParameters, writer?: $protobuf.Writer): $protobuf.Writer;
/**