ExecutionTemplate class

The description a notebook execution workload.

Inheritance
  • Object
  • GeneratedMessage
  • ExecutionTemplate

Constructors

ExecutionTemplate({ExecutionTemplate_ScaleTier? scaleTier, String? masterType, ExecutionTemplate_SchedulerAcceleratorConfig? acceleratorConfig, Map<String, String>? labels, String? inputNotebookFile, String? containerImageUri, String? outputNotebookFolder, String? paramsYamlFile, String? parameters, String? serviceAccount, ExecutionTemplate_JobType? jobType, ExecutionTemplate_DataprocParameters? dataprocParameters, ExecutionTemplate_VertexAIParameters? vertexAiParameters, String? kernelSpec, String? tensorboard})
factory
ExecutionTemplate.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
ExecutionTemplate.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

acceleratorConfig ↔ ExecutionTemplate_SchedulerAcceleratorConfig
Configuration (count and accelerator type) for hardware running notebook execution.
getter/setter pair
containerImageUri ↔ String
Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
getter/setter pair
dataprocParameters ↔ ExecutionTemplate_DataprocParameters
Parameters used in Dataproc JobType executions.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setteroverride
inputNotebookFile ↔ String
Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{bucket_name}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
jobType ↔ ExecutionTemplate_JobType
The type of Job to be used on this execution.
getter/setter pair
kernelSpec ↔ String
Name of the kernel spec to use. This must be specified if the kernel spec name on the execution target does not match the name in the input notebook file.
getter/setter pair
labels → Map<String, String>
Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.
no setter
masterType ↔ String
Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when scaleTier is set to CUSTOM.
getter/setter pair
outputNotebookFolder ↔ String
Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{bucket_name}/{folder} Ex: gs://notebook_user/scheduled_notebooks
getter/setter pair
parameters ↔ String
Parameters used within the 'input_notebook_file' notebook.
getter/setter pair
paramsYamlFile ↔ String
Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaleTier ↔ ExecutionTemplate_ScaleTier
Required. Scale tier of the hardware used for notebook execution. DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
getter/setter pair
serviceAccount ↔ String
The email address of a service account to use when running the execution. You must have the iam.serviceAccounts.actAs permission for the specified service account.
getter/setter pair
tensorboard ↔ String
The name of a Vertex AI Tensorboard resource to which this execution will upload Tensorboard logs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
vertexAiParameters ↔ ExecutionTemplate_VertexAIParameters
Parameters used in Vertex AI JobType executions.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAcceleratorConfig() → void
clearContainerImageUri() → void
clearDataprocParameters() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearInputNotebookFile() → void
clearJobParameters() → void
clearJobType() → void
clearKernelSpec() → void
clearMasterType() → void
clearOutputNotebookFolder() → void
clearParameters() → void
clearParamsYamlFile() → void
clearScaleTier() → void
clearServiceAccount() → void
clearTensorboard() → void
clearVertexAiParameters() → void
clone() → ExecutionTemplate
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(ExecutionTemplate)) → ExecutionTemplate
Apply updates to a copy of this message.
override
createEmptyInstance() → ExecutionTemplate
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field.
inherited
ensureAcceleratorConfig() → ExecutionTemplate_SchedulerAcceleratorConfig
ensureDataprocParameters() → ExecutionTemplate_DataprocParameters
ensureVertexAiParameters() → ExecutionTemplate_VertexAIParameters
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasAcceleratorConfig() → bool
hasContainerImageUri() → bool
hasDataprocParameters() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasInputNotebookFile() → bool
hasJobType() → bool
hasKernelSpec() → bool
hasMasterType() → bool
hasOutputNotebookFolder() → bool
hasParameters() → bool
hasParamsYamlFile() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasScaleTier() → bool
hasServiceAccount() → bool
hasTensorboard() → bool
hasVertexAiParameters() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
whichJobParameters() → ExecutionTemplate_JobParameters
writeToBuffer() → Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited