Class ExecutionTemplate.Builder (0.6.2)

public static final class ExecutionTemplate.Builder extends GeneratedMessageV3.Builder<ExecutionTemplate.Builder> implements ExecutionTemplateOrBuilder

The description a notebook execution workload.

Protobuf type google.cloud.notebooks.v1.ExecutionTemplate

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecutionTemplate.Builder

Implements

ExecutionTemplateOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecutionTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ExecutionTemplate build()

Returns

Type	Description
ExecutionTemplate

buildPartial()

public ExecutionTemplate buildPartial()

Returns

Type	Description
ExecutionTemplate

clear()

public ExecutionTemplate.Builder clear()

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAcceleratorConfig()

public ExecutionTemplate.Builder clearAcceleratorConfig()

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Returns

Type	Description
ExecutionTemplate.Builder

clearContainerImageUri()

public ExecutionTemplate.Builder clearContainerImageUri()

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

string container_image_uri = 6;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearDataprocParameters()

public ExecutionTemplate.Builder clearDataprocParameters()

Parameters used in Dataproc JobType executions.

.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

Returns

Type	Description
ExecutionTemplate.Builder

clearField(Descriptors.FieldDescriptor field)

public ExecutionTemplate.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInputNotebookFile()

public ExecutionTemplate.Builder clearInputNotebookFile()

Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb

string input_notebook_file = 5;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearJobParameters()

public ExecutionTemplate.Builder clearJobParameters()

Returns

Type	Description
ExecutionTemplate.Builder

clearJobType()

public ExecutionTemplate.Builder clearJobType()

The type of Job to be used on this execution.

.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearLabels()

public ExecutionTemplate.Builder clearLabels()

Returns

Type	Description
ExecutionTemplate.Builder

clearMasterType()

public ExecutionTemplate.Builder clearMasterType()

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-4
n1-standard-8
n1-standard-16
n1-standard-32
n1-standard-64
n1-standard-96
n1-highmem-2
n1-highmem-4
n1-highmem-8
n1-highmem-16
n1-highmem-32
n1-highmem-64
n1-highmem-96
n1-highcpu-16
n1-highcpu-32
n1-highcpu-64
n1-highcpu-96 Alternatively, you can use the following legacy machine types:
standard
large_model
complex_model_s
complex_model_m
complex_model_l
standard_gpu
complex_model_m_gpu
complex_model_l_gpu
standard_p100
complex_model_m_p100
standard_v100
large_model_v100
complex_model_m_v100
complex_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;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecutionTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutputNotebookFolder()

public ExecutionTemplate.Builder clearOutputNotebookFolder()

Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

string output_notebook_folder = 7;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearParameters()

public ExecutionTemplate.Builder clearParameters()

Parameters used within the 'input_notebook_file' notebook.

string parameters = 9;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearParamsYamlFile()

public ExecutionTemplate.Builder clearParamsYamlFile()

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

string params_yaml_file = 8;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearScaleTier()

public ExecutionTemplate.Builder clearScaleTier()

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];

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clearServiceAccount()

public ExecutionTemplate.Builder clearServiceAccount()

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;

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

clone()

public ExecutionTemplate.Builder clone()

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getAcceleratorConfig()

public ExecutionTemplate.SchedulerAcceleratorConfig getAcceleratorConfig()

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Returns

Type	Description
ExecutionTemplate.SchedulerAcceleratorConfig	The acceleratorConfig.

getAcceleratorConfigBuilder()

public ExecutionTemplate.SchedulerAcceleratorConfig.Builder getAcceleratorConfigBuilder()

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Returns

Type	Description
ExecutionTemplate.SchedulerAcceleratorConfig.Builder

getAcceleratorConfigOrBuilder()

public ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder getAcceleratorConfigOrBuilder()

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Returns

Type	Description
ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder

getContainerImageUri()

public String getContainerImageUri()

string container_image_uri = 6;

Returns

Type	Description
String	The containerImageUri.

getContainerImageUriBytes()

public ByteString getContainerImageUriBytes()

string container_image_uri = 6;

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;

Returns

Type	Description
ExecutionTemplate.DataprocParameters	The dataprocParameters.

getDataprocParametersBuilder()

public ExecutionTemplate.DataprocParameters.Builder getDataprocParametersBuilder()

Parameters used in Dataproc JobType executions.

.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

Returns

Type	Description
ExecutionTemplate.DataprocParameters.Builder

getDataprocParametersOrBuilder()

public ExecutionTemplate.DataprocParametersOrBuilder getDataprocParametersOrBuilder()

Parameters used in Dataproc JobType executions.

.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

Returns

Type	Description
ExecutionTemplate.DataprocParametersOrBuilder

getDefaultInstanceForType()

public ExecutionTemplate getDefaultInstanceForType()

Returns

Type	Description
ExecutionTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getInputNotebookFile()

public String getInputNotebookFile()

string input_notebook_file = 5;

Returns

Type	Description
String	The inputNotebookFile.

getInputNotebookFileBytes()

public ByteString getInputNotebookFileBytes()

string input_notebook_file = 5;

Returns

Type	Description
ByteString	The bytes for inputNotebookFile.

getJobParametersCase()

public ExecutionTemplate.JobParametersCase getJobParametersCase()

Returns

Type	Description
ExecutionTemplate.JobParametersCase

getJobType()

public ExecutionTemplate.JobType getJobType()

The type of Job to be used on this execution.

.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;

Returns

Type	Description
ExecutionTemplate.JobType	The jobType.

getJobTypeValue()

public int getJobTypeValue()

The type of Job to be used on this execution.

.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;

Returns

Type	Description
int	The enum numeric value on the wire for jobType.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

map<string, string> labels = 4;

Returns

Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

map<string, string> labels = 4;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

map<string, string> labels = 4;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

map<string, string> labels = 4;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getMasterType()

public String getMasterType()

n1-standard-4
n1-standard-8
n1-standard-16
n1-standard-32
n1-standard-64
n1-standard-96
n1-highmem-2
n1-highmem-4
n1-highmem-8
n1-highmem-16
n1-highmem-32
n1-highmem-64
n1-highmem-96
n1-highcpu-16
n1-highcpu-32
n1-highcpu-64
n1-highcpu-96 Alternatively, you can use the following legacy machine types:
standard
large_model
complex_model_s
complex_model_m
complex_model_l
standard_gpu
complex_model_m_gpu
complex_model_l_gpu
standard_p100
complex_model_m_p100
standard_v100
large_model_v100
complex_model_m_v100
complex_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;

Returns

Type	Description
String	The masterType.

getMasterTypeBytes()

public ByteString getMasterTypeBytes()

n1-standard-4
n1-standard-8
n1-standard-16
n1-standard-32
n1-standard-64
n1-standard-96
n1-highmem-2
n1-highmem-4
n1-highmem-8
n1-highmem-16
n1-highmem-32
n1-highmem-64
n1-highmem-96
n1-highcpu-16
n1-highcpu-32
n1-highcpu-64
n1-highcpu-96 Alternatively, you can use the following legacy machine types:
standard
large_model
complex_model_s
complex_model_m
complex_model_l
standard_gpu
complex_model_m_gpu
complex_model_l_gpu
standard_p100
complex_model_m_p100
standard_v100
large_model_v100
complex_model_m_v100
complex_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;

Returns

Type	Description
ByteString	The bytes for masterType.

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,String>

getOutputNotebookFolder()

public String getOutputNotebookFolder()

Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

string output_notebook_folder = 7;

Returns

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://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

string output_notebook_folder = 7;

Returns

Type	Description
ByteString	The bytes for outputNotebookFolder.

getParameters()

public String getParameters()

Parameters used within the 'input_notebook_file' notebook.

string parameters = 9;

Returns

Type	Description
String	The parameters.

getParametersBytes()

public ByteString getParametersBytes()

Parameters used within the 'input_notebook_file' notebook.

string parameters = 9;

Returns

Type	Description
ByteString	The bytes for parameters.

getParamsYamlFile()

public String getParamsYamlFile()

string params_yaml_file = 8;

Returns

Type	Description
String	The paramsYamlFile.

getParamsYamlFileBytes()

public ByteString getParamsYamlFileBytes()

string params_yaml_file = 8;

Returns

Type	Description
ByteString	The bytes for paramsYamlFile.

getScaleTier()

public ExecutionTemplate.ScaleTier getScaleTier()

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];

Returns

Type	Description
ExecutionTemplate.ScaleTier	The scaleTier.

getScaleTierValue()

public int getScaleTierValue()

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];

Returns

Type	Description
int	The enum numeric value on the wire for scaleTier.

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;

Returns

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;

Returns

Type	Description
ByteString	The bytes for serviceAccount.

hasAcceleratorConfig()

public boolean hasAcceleratorConfig()

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Returns

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;

Returns

Type	Description
boolean	Whether the dataprocParameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	`int`

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	`int`

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)

public ExecutionTemplate.Builder mergeAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Parameter

Name	Description
value	`ExecutionTemplate.SchedulerAcceleratorConfig`

Returns

Type	Description
ExecutionTemplate.Builder

mergeDataprocParameters(ExecutionTemplate.DataprocParameters value)

public ExecutionTemplate.Builder mergeDataprocParameters(ExecutionTemplate.DataprocParameters value)

Parameters used in Dataproc JobType executions.

.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

Parameter

Name	Description
value	`ExecutionTemplate.DataprocParameters`

Returns

Type	Description
ExecutionTemplate.Builder

mergeFrom(ExecutionTemplate other)

public ExecutionTemplate.Builder mergeFrom(ExecutionTemplate other)

Parameter

Name	Description
other	`ExecutionTemplate`

Returns

Type	Description
ExecutionTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecutionTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ExecutionTemplate.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllLabels(Map<String,String> values)

public ExecutionTemplate.Builder putAllLabels(Map<String,String> values)

map<string, string> labels = 4;

Parameter

Name	Description
values	`Map<String,String>`

Returns

Type	Description
ExecutionTemplate.Builder

putLabels(String key, String value)

public ExecutionTemplate.Builder putLabels(String key, String value)

map<string, string> labels = 4;

Parameters

Name	Description
key	`String`
value	`String`

Returns

Type	Description
ExecutionTemplate.Builder

removeLabels(String key)

public ExecutionTemplate.Builder removeLabels(String key)

map<string, string> labels = 4;

Parameter

Name	Description
key	`String`

Returns

Type	Description
ExecutionTemplate.Builder

setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)

public ExecutionTemplate.Builder setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig value)

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Parameter

Name	Description
value	`ExecutionTemplate.SchedulerAcceleratorConfig`

Returns

Type	Description
ExecutionTemplate.Builder

setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig.Builder builderForValue)

public ExecutionTemplate.Builder setAcceleratorConfig(ExecutionTemplate.SchedulerAcceleratorConfig.Builder builderForValue)

Configuration (count and accelerator type) for hardware running notebook execution.

.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

Parameter

Name	Description
builderForValue	`ExecutionTemplate.SchedulerAcceleratorConfig.Builder`

Returns

Type	Description
ExecutionTemplate.Builder

setContainerImageUri(String value)

public ExecutionTemplate.Builder setContainerImageUri(String value)

string container_image_uri = 6;

Parameter

Name	Description
value	`String` The containerImageUri to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setContainerImageUriBytes(ByteString value)

public ExecutionTemplate.Builder setContainerImageUriBytes(ByteString value)

string container_image_uri = 6;

Parameter

Name	Description
value	`ByteString` The bytes for containerImageUri to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setDataprocParameters(ExecutionTemplate.DataprocParameters value)

public ExecutionTemplate.Builder setDataprocParameters(ExecutionTemplate.DataprocParameters value)

Parameters used in Dataproc JobType executions.

.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

Parameter

Name	Description
value	`ExecutionTemplate.DataprocParameters`

Returns

Type	Description
ExecutionTemplate.Builder

setDataprocParameters(ExecutionTemplate.DataprocParameters.Builder builderForValue)

public ExecutionTemplate.Builder setDataprocParameters(ExecutionTemplate.DataprocParameters.Builder builderForValue)

Parameters used in Dataproc JobType executions.

.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

Parameter

Name	Description
builderForValue	`ExecutionTemplate.DataprocParameters.Builder`

Returns

Type	Description
ExecutionTemplate.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExecutionTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInputNotebookFile(String value)

public ExecutionTemplate.Builder setInputNotebookFile(String value)

string input_notebook_file = 5;

Parameter

Name	Description
value	`String` The inputNotebookFile to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setInputNotebookFileBytes(ByteString value)

public ExecutionTemplate.Builder setInputNotebookFileBytes(ByteString value)

string input_notebook_file = 5;

Parameter

Name	Description
value	`ByteString` The bytes for inputNotebookFile to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setJobType(ExecutionTemplate.JobType value)

public ExecutionTemplate.Builder setJobType(ExecutionTemplate.JobType value)

The type of Job to be used on this execution.

.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;

Parameter

Name	Description
value	`ExecutionTemplate.JobType` The jobType to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setJobTypeValue(int value)

public ExecutionTemplate.Builder setJobTypeValue(int value)

The type of Job to be used on this execution.

.google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for jobType to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setMasterType(String value)

public ExecutionTemplate.Builder setMasterType(String value)

n1-standard-4
n1-standard-8
n1-standard-16
n1-standard-32
n1-standard-64
n1-standard-96
n1-highmem-2
n1-highmem-4
n1-highmem-8
n1-highmem-16
n1-highmem-32
n1-highmem-64
n1-highmem-96
n1-highcpu-16
n1-highcpu-32
n1-highcpu-64
n1-highcpu-96 Alternatively, you can use the following legacy machine types:
standard
large_model
complex_model_s
complex_model_m
complex_model_l
standard_gpu
complex_model_m_gpu
complex_model_l_gpu
standard_p100
complex_model_m_p100
standard_v100
large_model_v100
complex_model_m_v100
complex_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;

Parameter

Name	Description
value	`String` The masterType to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setMasterTypeBytes(ByteString value)

public ExecutionTemplate.Builder setMasterTypeBytes(ByteString value)

n1-standard-4
n1-standard-8
n1-standard-16
n1-standard-32
n1-standard-64
n1-standard-96
n1-highmem-2
n1-highmem-4
n1-highmem-8
n1-highmem-16
n1-highmem-32
n1-highmem-64
n1-highmem-96
n1-highcpu-16
n1-highcpu-32
n1-highcpu-64
n1-highcpu-96 Alternatively, you can use the following legacy machine types:
standard
large_model
complex_model_s
complex_model_m
complex_model_l
standard_gpu
complex_model_m_gpu
complex_model_l_gpu
standard_p100
complex_model_m_p100
standard_v100
large_model_v100
complex_model_m_v100
complex_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;

Parameter

Name	Description
value	`ByteString` The bytes for masterType to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setOutputNotebookFolder(String value)

public ExecutionTemplate.Builder setOutputNotebookFolder(String value)

Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

string output_notebook_folder = 7;

Parameter

Name	Description
value	`String` The outputNotebookFolder to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setOutputNotebookFolderBytes(ByteString value)

public ExecutionTemplate.Builder setOutputNotebookFolderBytes(ByteString value)

Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks

string output_notebook_folder = 7;

Parameter

Name	Description
value	`ByteString` The bytes for outputNotebookFolder to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setParameters(String value)

public ExecutionTemplate.Builder setParameters(String value)

Parameters used within the 'input_notebook_file' notebook.

string parameters = 9;

Parameter

Name	Description
value	`String` The parameters to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setParametersBytes(ByteString value)

public ExecutionTemplate.Builder setParametersBytes(ByteString value)

Parameters used within the 'input_notebook_file' notebook.

string parameters = 9;

Parameter

Name	Description
value	`ByteString` The bytes for parameters to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setParamsYamlFile(String value)

public ExecutionTemplate.Builder setParamsYamlFile(String value)

string params_yaml_file = 8;

Parameter

Name	Description
value	`String` The paramsYamlFile to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setParamsYamlFileBytes(ByteString value)

public ExecutionTemplate.Builder setParamsYamlFileBytes(ByteString value)

string params_yaml_file = 8;

Parameter

Name	Description
value	`ByteString` The bytes for paramsYamlFile to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecutionTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setScaleTier(ExecutionTemplate.ScaleTier value)

public ExecutionTemplate.Builder setScaleTier(ExecutionTemplate.ScaleTier value)

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];

Parameter

Name	Description
value	`ExecutionTemplate.ScaleTier` The scaleTier to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setScaleTierValue(int value)

public ExecutionTemplate.Builder setScaleTierValue(int value)

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];

Parameter

Name	Description
value	`int` The enum numeric value on the wire for scaleTier to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setServiceAccount(String value)

public ExecutionTemplate.Builder setServiceAccount(String value)

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;

Parameter

Name	Description
value	`String` The serviceAccount to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setServiceAccountBytes(ByteString value)

public ExecutionTemplate.Builder setServiceAccountBytes(ByteString value)

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;

Parameter

Name	Description
value	`ByteString` The bytes for serviceAccount to set.

Returns

Type	Description
ExecutionTemplate.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ExecutionTemplate.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)