public final class ExecutionTemplate extends GeneratedMessageV3 implements ExecutionTemplateOrBuilder
The description a notebook execution workload.
Protobuf type google.cloud.notebooks.v1.ExecutionTemplate
Static Fields
ACCELERATOR_CONFIG_FIELD_NUMBER
public static final int ACCELERATOR_CONFIG_FIELD_NUMBER
Field Value
CONTAINER_IMAGE_URI_FIELD_NUMBER
public static final int CONTAINER_IMAGE_URI_FIELD_NUMBER
Field Value
DATAPROC_PARAMETERS_FIELD_NUMBER
public static final int DATAPROC_PARAMETERS_FIELD_NUMBER
Field Value
public static final int INPUT_NOTEBOOK_FILE_FIELD_NUMBER
Field Value
JOB_TYPE_FIELD_NUMBER
public static final int JOB_TYPE_FIELD_NUMBER
Field Value
KERNEL_SPEC_FIELD_NUMBER
public static final int KERNEL_SPEC_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
MASTER_TYPE_FIELD_NUMBER
public static final int MASTER_TYPE_FIELD_NUMBER
Field Value
OUTPUT_NOTEBOOK_FOLDER_FIELD_NUMBER
public static final int OUTPUT_NOTEBOOK_FOLDER_FIELD_NUMBER
Field Value
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
PARAMS_YAML_FILE_FIELD_NUMBER
public static final int PARAMS_YAML_FILE_FIELD_NUMBER
Field Value
SCALE_TIER_FIELD_NUMBER
public static final int SCALE_TIER_FIELD_NUMBER
Field Value
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TENSORBOARD_FIELD_NUMBER
public static final int TENSORBOARD_FIELD_NUMBER
Field Value
VERTEX_AI_PARAMETERS_FIELD_NUMBER
public static final int VERTEX_AI_PARAMETERS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ExecutionTemplate getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ExecutionTemplate.Builder newBuilder()
Returns
newBuilder(ExecutionTemplate prototype)
public static ExecutionTemplate.Builder newBuilder(ExecutionTemplate prototype)
Parameter
Returns
public static ExecutionTemplate parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExecutionTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ExecutionTemplate parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExecutionTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ExecutionTemplate parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecutionTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExecutionTemplate parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ExecutionTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExecutionTemplate parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExecutionTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ExecutionTemplate parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExecutionTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ExecutionTemplate> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
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.
map<string, string> labels = 4;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAcceleratorConfig()
public ExecutionTemplate.SchedulerAcceleratorConfig getAcceleratorConfig()
Configuration (count and accelerator type) for hardware running notebook
execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
getAcceleratorConfigOrBuilder()
public ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()
Configuration (count and accelerator type) for hardware running notebook
execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
getContainerImageUri()
public String getContainerImageUri()
Returns
| Type | Description |
| String | The containerImageUri.
|
getContainerImageUriBytes()
public ByteString getContainerImageUriBytes()
Returns
| Type | Description |
| ByteString | The bytes for containerImageUri.
|
getDataprocParameters()
public ExecutionTemplate.DataprocParameters getDataprocParameters()
Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
getDataprocParametersOrBuilder()
public ExecutionTemplate.DataprocParametersOrBuilder getDataprocParametersOrBuilder()
Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
getDefaultInstanceForType()
public ExecutionTemplate getDefaultInstanceForType()
Returns
public String getInputNotebookFile()
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
string input_notebook_file = 5;
| Type | Description |
| String | The inputNotebookFile.
|
public ByteString getInputNotebookFileBytes()
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
string input_notebook_file = 5;
| Type | Description |
| ByteString | The bytes for inputNotebookFile.
|
getJobParametersCase()
public ExecutionTemplate.JobParametersCase getJobParametersCase()
Returns
getJobType()
public ExecutionTemplate.JobType getJobType()
The type of Job to be used on this execution.
.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
getJobTypeValue()
public int getJobTypeValue()
The type of Job to be used on this execution.
.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
| Type | Description |
| int | The enum numeric value on the wire for jobType.
|
getKernelSpec()
public String getKernelSpec()
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.
string kernel_spec = 14;
| Type | Description |
| String | The kernelSpec.
|
getKernelSpecBytes()
public ByteString getKernelSpecBytes()
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.
string kernel_spec = 14;
| Type | Description |
| ByteString | The bytes for kernelSpec.
|
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
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.
map<string, string> labels = 4;
getLabelsMap()
public Map<String,String> getLabelsMap()
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.
map<string, string> labels = 4;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
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.
map<string, string> labels = 4;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
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.
map<string, string> labels = 4;
getMasterType()
public String getMasterType()
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.
You can use certain Compute Engine machine types directly in this field.
The following types are supported:
n1-standard-4n1-standard-8n1-standard-16n1-standard-32n1-standard-64n1-standard-96n1-highmem-2n1-highmem-4n1-highmem-8n1-highmem-16n1-highmem-32n1-highmem-64n1-highmem-96n1-highcpu-16n1-highcpu-32n1-highcpu-64n1-highcpu-96
Alternatively, you can use the following legacy machine types:standardlarge_modelcomplex_model_scomplex_model_mcomplex_model_lstandard_gpucomplex_model_m_gpucomplex_model_l_gpustandard_p100complex_model_m_p100standard_v100large_model_v100complex_model_m_v100complex_model_l_v100
Finally, if you want to use a TPU for training, specify cloud_tpu in this
field. Learn more about the special configuration options for training
with
TPU.
string master_type = 2;
| Type | Description |
| String | The masterType.
|
getMasterTypeBytes()
public ByteString getMasterTypeBytes()
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.
You can use certain Compute Engine machine types directly in this field.
The following types are supported:
n1-standard-4n1-standard-8n1-standard-16n1-standard-32n1-standard-64n1-standard-96n1-highmem-2n1-highmem-4n1-highmem-8n1-highmem-16n1-highmem-32n1-highmem-64n1-highmem-96n1-highcpu-16n1-highcpu-32n1-highcpu-64n1-highcpu-96
Alternatively, you can use the following legacy machine types:standardlarge_modelcomplex_model_scomplex_model_mcomplex_model_lstandard_gpucomplex_model_m_gpucomplex_model_l_gpustandard_p100complex_model_m_p100standard_v100large_model_v100complex_model_m_v100complex_model_l_v100
Finally, if you want to use a TPU for training, specify cloud_tpu in this
field. Learn more about the special configuration options for training
with
TPU.
string master_type = 2;
| Type | Description |
| ByteString | The bytes for masterType.
|
getOutputNotebookFolder()
public String getOutputNotebookFolder()
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
string output_notebook_folder = 7;
| Type | Description |
| String | The outputNotebookFolder.
|
getOutputNotebookFolderBytes()
public ByteString getOutputNotebookFolderBytes()
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
string output_notebook_folder = 7;
| Type | Description |
| ByteString | The bytes for outputNotebookFolder.
|
getParameters()
public String getParameters()
Parameters used within the 'input_notebook_file' notebook.
string parameters = 9;
| Type | Description |
| String | The parameters.
|
getParametersBytes()
public ByteString getParametersBytes()
Parameters used within the 'input_notebook_file' notebook.
string parameters = 9;
| Type | Description |
| ByteString | The bytes for parameters.
|
getParamsYamlFile()
public String getParamsYamlFile()
Returns
| Type | Description |
| String | The paramsYamlFile.
|
getParamsYamlFileBytes()
public ByteString getParamsYamlFileBytes()
Returns
| Type | Description |
| ByteString | The bytes for paramsYamlFile.
|
getParserForType()
public Parser<ExecutionTemplate> getParserForType()
Returns
Overrides
getScaleTier() (deprecated)
public ExecutionTemplate.ScaleTier getScaleTier()
Deprecated. google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See
google/cloud/notebooks/v1/execution.proto;l=151
Required. Scale tier of the hardware used for notebook execution.
DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
getScaleTierValue() (deprecated)
public int getScaleTierValue()
Deprecated. google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See
google/cloud/notebooks/v1/execution.proto;l=151
Required. Scale tier of the hardware used for notebook execution.
DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
| Type | Description |
| int | The enum numeric value on the wire for scaleTier.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServiceAccount()
public String getServiceAccount()
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.
string service_account = 10;
| Type | Description |
| String | The serviceAccount.
|
getServiceAccountBytes()
public ByteString getServiceAccountBytes()
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.
string service_account = 10;
| Type | Description |
| ByteString | The bytes for serviceAccount.
|
getTensorboard()
public String getTensorboard()
The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string tensorboard = 15 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The tensorboard.
|
getTensorboardBytes()
public ByteString getTensorboardBytes()
The name of a Vertex AI [Tensorboard] resource to which this execution
will upload Tensorboard logs.
Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}
string tensorboard = 15 [(.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for tensorboard.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVertexAiParameters()
public ExecutionTemplate.VertexAIParameters getVertexAiParameters()
Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
getVertexAiParametersOrBuilder()
public ExecutionTemplate.VertexAIParametersOrBuilder getVertexAiParametersOrBuilder()
Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
hasAcceleratorConfig()
public boolean hasAcceleratorConfig()
Configuration (count and accelerator type) for hardware running notebook
execution.
.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
| Type | Description |
| boolean | Whether the acceleratorConfig field is set.
|
hasDataprocParameters()
public boolean hasDataprocParameters()
Parameters used in Dataproc JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
| Type | Description |
| boolean | Whether the dataprocParameters field is set.
|
hasVertexAiParameters()
public boolean hasVertexAiParameters()
Parameters used in Vertex AI JobType executions.
.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
| Type | Description |
| boolean | Whether the vertexAiParameters field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ExecutionTemplate.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExecutionTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ExecutionTemplate.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
