Class NotebookExecutionJob.Builder (3.56.0)

public static final class NotebookExecutionJob.Builder extends GeneratedMessageV3.Builder<NotebookExecutionJob.Builder> implements NotebookExecutionJobOrBuilder

NotebookExecutionJob represents an instance of a notebook execution.

Protobuf type google.cloud.aiplatform.v1beta1.NotebookExecutionJob

Inheritance

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

Implements

NotebookExecutionJobOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

build()

public NotebookExecutionJob build()

Returns
Type	Description
`NotebookExecutionJob`

buildPartial()

public NotebookExecutionJob buildPartial()

Returns
Type	Description
`NotebookExecutionJob`

clear()

public NotebookExecutionJob.Builder clear()

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public NotebookExecutionJob.Builder clearCreateTime()

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearCustomEnvironmentSpec()

public NotebookExecutionJob.Builder clearCustomEnvironmentSpec()

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearDataformRepositorySource()

public NotebookExecutionJob.Builder clearDataformRepositorySource()

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearDirectNotebookSource()

public NotebookExecutionJob.Builder clearDirectNotebookSource()

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearDisplayName()

public NotebookExecutionJob.Builder clearDisplayName()

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2;

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearEncryptionSpec()

public NotebookExecutionJob.Builder clearEncryptionSpec()

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearEnvironmentSpec()

public NotebookExecutionJob.Builder clearEnvironmentSpec()

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearExecutionIdentity()

public NotebookExecutionJob.Builder clearExecutionIdentity()

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearExecutionSink()

public NotebookExecutionJob.Builder clearExecutionSink()

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearExecutionTimeout()

public NotebookExecutionJob.Builder clearExecutionTimeout()

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearExecutionUser()

public NotebookExecutionJob.Builder clearExecutionUser()

The user email to run the execution as. Only supported by Colab runtimes.

string execution_user = 9;

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public NotebookExecutionJob.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

clearGcsNotebookSource()

public NotebookExecutionJob.Builder clearGcsNotebookSource()

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearGcsOutputUri()

public NotebookExecutionJob.Builder clearGcsOutputUri()

The Cloud Storage location to upload the result to. Format: gs://bucket-name

string gcs_output_uri = 8;

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearJobState()

public NotebookExecutionJob.Builder clearJobState()

Output only. The state of the NotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearKernelName()

public NotebookExecutionJob.Builder clearKernelName()

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

string kernel_name = 20;

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearLabels()

public NotebookExecutionJob.Builder clearLabels()

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearName()

public NotebookExecutionJob.Builder clearName()

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearNotebookRuntimeTemplateResourceName()

public NotebookExecutionJob.Builder clearNotebookRuntimeTemplateResourceName()

The NotebookRuntimeTemplate to source compute configuration from.

string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearNotebookSource()

public NotebookExecutionJob.Builder clearNotebookSource()

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public NotebookExecutionJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

clearRuntimeEnvironment()

public NotebookExecutionJob.Builder clearRuntimeEnvironment()

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearScheduleResourceName()

public NotebookExecutionJob.Builder clearScheduleResourceName()

Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearServiceAccount()

public NotebookExecutionJob.Builder clearServiceAccount()

The service account to run the execution as.

string service_account = 18;

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

clearStatus()

public NotebookExecutionJob.Builder clearStatus()

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearUpdateTime()

public NotebookExecutionJob.Builder clearUpdateTime()

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`NotebookExecutionJob.Builder`

clearWorkbenchRuntime()

public NotebookExecutionJob.Builder clearWorkbenchRuntime()

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Returns
Type	Description
`NotebookExecutionJob.Builder`

clone()

public NotebookExecutionJob.Builder clone()

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public boolean containsLabels(String key)

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Builder`

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getCustomEnvironmentSpec()

public NotebookExecutionJob.CustomEnvironmentSpec getCustomEnvironmentSpec()

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Returns
Type	Description
`NotebookExecutionJob.CustomEnvironmentSpec`	The customEnvironmentSpec.

getCustomEnvironmentSpecBuilder()

public NotebookExecutionJob.CustomEnvironmentSpec.Builder getCustomEnvironmentSpecBuilder()

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Returns
Type	Description
`NotebookExecutionJob.CustomEnvironmentSpec.Builder`

getCustomEnvironmentSpecOrBuilder()

public NotebookExecutionJob.CustomEnvironmentSpecOrBuilder getCustomEnvironmentSpecOrBuilder()

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Returns
Type	Description
`NotebookExecutionJob.CustomEnvironmentSpecOrBuilder`

getDataformRepositorySource()

public NotebookExecutionJob.DataformRepositorySource getDataformRepositorySource()

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Returns
Type	Description
`NotebookExecutionJob.DataformRepositorySource`	The dataformRepositorySource.

getDataformRepositorySourceBuilder()

public NotebookExecutionJob.DataformRepositorySource.Builder getDataformRepositorySourceBuilder()

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Returns
Type	Description
`NotebookExecutionJob.DataformRepositorySource.Builder`

getDataformRepositorySourceOrBuilder()

public NotebookExecutionJob.DataformRepositorySourceOrBuilder getDataformRepositorySourceOrBuilder()

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Returns
Type	Description
`NotebookExecutionJob.DataformRepositorySourceOrBuilder`

getDefaultInstanceForType()

public NotebookExecutionJob getDefaultInstanceForType()

Returns
Type	Description
`NotebookExecutionJob`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDirectNotebookSource()

public NotebookExecutionJob.DirectNotebookSource getDirectNotebookSource()

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Returns
Type	Description
`NotebookExecutionJob.DirectNotebookSource`	The directNotebookSource.

getDirectNotebookSourceBuilder()

public NotebookExecutionJob.DirectNotebookSource.Builder getDirectNotebookSourceBuilder()

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Returns
Type	Description
`NotebookExecutionJob.DirectNotebookSource.Builder`

getDirectNotebookSourceOrBuilder()

public NotebookExecutionJob.DirectNotebookSourceOrBuilder getDirectNotebookSourceOrBuilder()

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Returns
Type	Description
`NotebookExecutionJob.DirectNotebookSourceOrBuilder`

getDisplayName()

public String getDisplayName()

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Returns
Type	Description
`EncryptionSpec`	The encryptionSpec.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Returns
Type	Description
`EncryptionSpec.Builder`

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Returns
Type	Description
`EncryptionSpecOrBuilder`

getEnvironmentSpecCase()

public NotebookExecutionJob.EnvironmentSpecCase getEnvironmentSpecCase()

Returns
Type	Description
`NotebookExecutionJob.EnvironmentSpecCase`

getExecutionIdentityCase()

public NotebookExecutionJob.ExecutionIdentityCase getExecutionIdentityCase()

Returns
Type	Description
`NotebookExecutionJob.ExecutionIdentityCase`

getExecutionSinkCase()

public NotebookExecutionJob.ExecutionSinkCase getExecutionSinkCase()

Returns
Type	Description
`NotebookExecutionJob.ExecutionSinkCase`

getExecutionTimeout()

public Duration getExecutionTimeout()

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Returns
Type	Description
`Duration`	The executionTimeout.

getExecutionTimeoutBuilder()

public Duration.Builder getExecutionTimeoutBuilder()

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Returns
Type	Description
`Builder`

getExecutionTimeoutOrBuilder()

public DurationOrBuilder getExecutionTimeoutOrBuilder()

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Returns
Type	Description
`DurationOrBuilder`

getExecutionUser()

public String getExecutionUser()

The user email to run the execution as. Only supported by Colab runtimes.

string execution_user = 9;

Returns
Type	Description
`String`	The executionUser.

getExecutionUserBytes()

public ByteString getExecutionUserBytes()

The user email to run the execution as. Only supported by Colab runtimes.

string execution_user = 9;

Returns
Type	Description
`ByteString`	The bytes for executionUser.

getGcsNotebookSource()

public NotebookExecutionJob.GcsNotebookSource getGcsNotebookSource()

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Returns
Type	Description
`NotebookExecutionJob.GcsNotebookSource`	The gcsNotebookSource.

getGcsNotebookSourceBuilder()

public NotebookExecutionJob.GcsNotebookSource.Builder getGcsNotebookSourceBuilder()

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Returns
Type	Description
`NotebookExecutionJob.GcsNotebookSource.Builder`

getGcsNotebookSourceOrBuilder()

public NotebookExecutionJob.GcsNotebookSourceOrBuilder getGcsNotebookSourceOrBuilder()

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Returns
Type	Description
`NotebookExecutionJob.GcsNotebookSourceOrBuilder`

getGcsOutputUri()

public String getGcsOutputUri()

The Cloud Storage location to upload the result to. Format: gs://bucket-name

string gcs_output_uri = 8;

Returns
Type	Description
`String`	The gcsOutputUri.

getGcsOutputUriBytes()

public ByteString getGcsOutputUriBytes()

The Cloud Storage location to upload the result to. Format: gs://bucket-name

string gcs_output_uri = 8;

Returns
Type	Description
`ByteString`	The bytes for gcsOutputUri.

getJobState()

public JobState getJobState()

Output only. The state of the NotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`JobState`	The jobState.

getJobStateValue()

public int getJobStateValue()

Output only. The state of the NotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for jobState.

getKernelName()

public String getKernelName()

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

string kernel_name = 20;

Returns
Type	Description
`String`	The kernelName.

getKernelNameBytes()

public ByteString getKernelNameBytes()

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

string kernel_name = 20;

Returns
Type	Description
`ByteString`	The bytes for kernelName.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getName()

public String getName()

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for name.

getNotebookRuntimeTemplateResourceName()

public String getNotebookRuntimeTemplateResourceName()

The NotebookRuntimeTemplate to source compute configuration from.

string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The notebookRuntimeTemplateResourceName.

getNotebookRuntimeTemplateResourceNameBytes()

public ByteString getNotebookRuntimeTemplateResourceNameBytes()

The NotebookRuntimeTemplate to source compute configuration from.

string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for notebookRuntimeTemplateResourceName.

getNotebookSourceCase()

public NotebookExecutionJob.NotebookSourceCase getNotebookSourceCase()

Returns
Type	Description
`NotebookExecutionJob.NotebookSourceCase`

getRuntimeEnvironmentCase()

public NotebookExecutionJob.RuntimeEnvironmentCase getRuntimeEnvironmentCase()

Returns
Type	Description
`NotebookExecutionJob.RuntimeEnvironmentCase`

getScheduleResourceName()

public String getScheduleResourceName()

Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The scheduleResourceName.

getScheduleResourceNameBytes()

public ByteString getScheduleResourceNameBytes()

Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for scheduleResourceName.

getServiceAccount()

public String getServiceAccount()

The service account to run the execution as.

string service_account = 18;

Returns
Type	Description
`String`	The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

The service account to run the execution as.

string service_account = 18;

Returns
Type	Description
`ByteString`	The bytes for serviceAccount.

getStatus()

public Status getStatus()

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`com.google.rpc.Status`	The status.

getStatusBuilder()

public Status.Builder getStatusBuilder()

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`com.google.rpc.Status.Builder`

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`com.google.rpc.StatusOrBuilder`

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Builder`

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getWorkbenchRuntime()

public NotebookExecutionJob.WorkbenchRuntime getWorkbenchRuntime()

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Returns
Type	Description
`NotebookExecutionJob.WorkbenchRuntime`	The workbenchRuntime.

getWorkbenchRuntimeBuilder()

public NotebookExecutionJob.WorkbenchRuntime.Builder getWorkbenchRuntimeBuilder()

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Returns
Type	Description
`NotebookExecutionJob.WorkbenchRuntime.Builder`

getWorkbenchRuntimeOrBuilder()

public NotebookExecutionJob.WorkbenchRuntimeOrBuilder getWorkbenchRuntimeOrBuilder()

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Returns
Type	Description
`NotebookExecutionJob.WorkbenchRuntimeOrBuilder`

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasCustomEnvironmentSpec()

public boolean hasCustomEnvironmentSpec()

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Returns
Type	Description
`boolean`	Whether the customEnvironmentSpec field is set.

hasDataformRepositorySource()

public boolean hasDataformRepositorySource()

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Returns
Type	Description
`boolean`	Whether the dataformRepositorySource field is set.

hasDirectNotebookSource()

public boolean hasDirectNotebookSource()

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Returns
Type	Description
`boolean`	Whether the directNotebookSource field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Returns
Type	Description
`boolean`	Whether the encryptionSpec field is set.

hasExecutionTimeout()

public boolean hasExecutionTimeout()

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Returns
Type	Description
`boolean`	Whether the executionTimeout field is set.

hasExecutionUser()

public boolean hasExecutionUser()

The user email to run the execution as. Only supported by Colab runtimes.

string execution_user = 9;

Returns
Type	Description
`boolean`	Whether the executionUser field is set.

hasGcsNotebookSource()

public boolean hasGcsNotebookSource()

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Returns
Type	Description
`boolean`	Whether the gcsNotebookSource field is set.

hasGcsOutputUri()

public boolean hasGcsOutputUri()

The Cloud Storage location to upload the result to. Format: gs://bucket-name

string gcs_output_uri = 8;

Returns
Type	Description
`boolean`	Whether the gcsOutputUri field is set.

hasNotebookRuntimeTemplateResourceName()

public boolean hasNotebookRuntimeTemplateResourceName()

The NotebookRuntimeTemplate to source compute configuration from.

string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`boolean`	Whether the notebookRuntimeTemplateResourceName field is set.

hasServiceAccount()

public boolean hasServiceAccount()

The service account to run the execution as.

string service_account = 18;

Returns
Type	Description
`boolean`	Whether the serviceAccount field is set.

hasStatus()

public boolean hasStatus()

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the status field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.

hasWorkbenchRuntime()

public boolean hasWorkbenchRuntime()

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Returns
Type	Description
`boolean`	Whether the workbenchRuntime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public NotebookExecutionJob.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeCustomEnvironmentSpec(NotebookExecutionJob.CustomEnvironmentSpec value)

public NotebookExecutionJob.Builder mergeCustomEnvironmentSpec(NotebookExecutionJob.CustomEnvironmentSpec value)

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Parameter
Name	Description
`value`	`NotebookExecutionJob.CustomEnvironmentSpec`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeDataformRepositorySource(NotebookExecutionJob.DataformRepositorySource value)

public NotebookExecutionJob.Builder mergeDataformRepositorySource(NotebookExecutionJob.DataformRepositorySource value)

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Parameter
Name	Description
`value`	`NotebookExecutionJob.DataformRepositorySource`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeDirectNotebookSource(NotebookExecutionJob.DirectNotebookSource value)

public NotebookExecutionJob.Builder mergeDirectNotebookSource(NotebookExecutionJob.DirectNotebookSource value)

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Parameter
Name	Description
`value`	`NotebookExecutionJob.DirectNotebookSource`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeEncryptionSpec(EncryptionSpec value)

public NotebookExecutionJob.Builder mergeEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Parameter
Name	Description
`value`	`EncryptionSpec`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeExecutionTimeout(Duration value)

public NotebookExecutionJob.Builder mergeExecutionTimeout(Duration value)

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeFrom(NotebookExecutionJob other)

public NotebookExecutionJob.Builder mergeFrom(NotebookExecutionJob other)

Parameter
Name	Description
`other`	`NotebookExecutionJob`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public NotebookExecutionJob.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

mergeGcsNotebookSource(NotebookExecutionJob.GcsNotebookSource value)

public NotebookExecutionJob.Builder mergeGcsNotebookSource(NotebookExecutionJob.GcsNotebookSource value)

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Parameter
Name	Description
`value`	`NotebookExecutionJob.GcsNotebookSource`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeStatus(Status value)

public NotebookExecutionJob.Builder mergeStatus(Status value)

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`com.google.rpc.Status`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NotebookExecutionJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

mergeUpdateTime(Timestamp value)

public NotebookExecutionJob.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`NotebookExecutionJob.Builder`

mergeWorkbenchRuntime(NotebookExecutionJob.WorkbenchRuntime value)

public NotebookExecutionJob.Builder mergeWorkbenchRuntime(NotebookExecutionJob.WorkbenchRuntime value)

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Parameter
Name	Description
`value`	`NotebookExecutionJob.WorkbenchRuntime`

Returns
Type	Description
`NotebookExecutionJob.Builder`

putAllLabels(Map<String,String> values)

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

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`NotebookExecutionJob.Builder`

putLabels(String key, String value)

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

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`NotebookExecutionJob.Builder`

removeLabels(String key)

public NotebookExecutionJob.Builder removeLabels(String key)

The labels with user-defined metadata to organize NotebookExecutionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> labels = 19;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setCreateTime(Timestamp value)

public NotebookExecutionJob.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public NotebookExecutionJob.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this NotebookExecutionJob was created.

.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setCustomEnvironmentSpec(NotebookExecutionJob.CustomEnvironmentSpec value)

public NotebookExecutionJob.Builder setCustomEnvironmentSpec(NotebookExecutionJob.CustomEnvironmentSpec value)

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Parameter
Name	Description
`value`	`NotebookExecutionJob.CustomEnvironmentSpec`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setCustomEnvironmentSpec(NotebookExecutionJob.CustomEnvironmentSpec.Builder builderForValue)

public NotebookExecutionJob.Builder setCustomEnvironmentSpec(NotebookExecutionJob.CustomEnvironmentSpec.Builder builderForValue)

The custom compute configuration for an execution job.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;

Parameter
Name	Description
`builderForValue`	`NotebookExecutionJob.CustomEnvironmentSpec.Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setDataformRepositorySource(NotebookExecutionJob.DataformRepositorySource value)

public NotebookExecutionJob.Builder setDataformRepositorySource(NotebookExecutionJob.DataformRepositorySource value)

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Parameter
Name	Description
`value`	`NotebookExecutionJob.DataformRepositorySource`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setDataformRepositorySource(NotebookExecutionJob.DataformRepositorySource.Builder builderForValue)

public NotebookExecutionJob.Builder setDataformRepositorySource(NotebookExecutionJob.DataformRepositorySource.Builder builderForValue)

The Dataform Repository pointing to a single file notebook repository.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;

Parameter
Name	Description
`builderForValue`	`NotebookExecutionJob.DataformRepositorySource.Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setDirectNotebookSource(NotebookExecutionJob.DirectNotebookSource value)

public NotebookExecutionJob.Builder setDirectNotebookSource(NotebookExecutionJob.DirectNotebookSource value)

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Parameter
Name	Description
`value`	`NotebookExecutionJob.DirectNotebookSource`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setDirectNotebookSource(NotebookExecutionJob.DirectNotebookSource.Builder builderForValue)

public NotebookExecutionJob.Builder setDirectNotebookSource(NotebookExecutionJob.DirectNotebookSource.Builder builderForValue)

The contents of an input notebook file.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;

Parameter
Name	Description
`builderForValue`	`NotebookExecutionJob.DirectNotebookSource.Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setDisplayName(String value)

public NotebookExecutionJob.Builder setDisplayName(String value)

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2;

Parameter
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public NotebookExecutionJob.Builder setDisplayNameBytes(ByteString value)

The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public NotebookExecutionJob.Builder setEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Parameter
Name	Description
`value`	`EncryptionSpec`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public NotebookExecutionJob.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.

.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;

Parameter
Name	Description
`builderForValue`	`EncryptionSpec.Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setExecutionTimeout(Duration value)

public NotebookExecutionJob.Builder setExecutionTimeout(Duration value)

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setExecutionTimeout(Duration.Builder builderForValue)

public NotebookExecutionJob.Builder setExecutionTimeout(Duration.Builder builderForValue)

Max running time of the execution job in seconds (default 86400s / 24 hrs).

.google.protobuf.Duration execution_timeout = 5;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setExecutionUser(String value)

public NotebookExecutionJob.Builder setExecutionUser(String value)

The user email to run the execution as. Only supported by Colab runtimes.

string execution_user = 9;

Parameter
Name	Description
`value`	`String` The executionUser to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setExecutionUserBytes(ByteString value)

public NotebookExecutionJob.Builder setExecutionUserBytes(ByteString value)

The user email to run the execution as. Only supported by Colab runtimes.

string execution_user = 9;

Parameter
Name	Description
`value`	`ByteString` The bytes for executionUser to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

setGcsNotebookSource(NotebookExecutionJob.GcsNotebookSource value)

public NotebookExecutionJob.Builder setGcsNotebookSource(NotebookExecutionJob.GcsNotebookSource value)

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Parameter
Name	Description
`value`	`NotebookExecutionJob.GcsNotebookSource`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setGcsNotebookSource(NotebookExecutionJob.GcsNotebookSource.Builder builderForValue)

public NotebookExecutionJob.Builder setGcsNotebookSource(NotebookExecutionJob.GcsNotebookSource.Builder builderForValue)

The Cloud Storage url pointing to the ipynb file. Format: gs://bucket/notebook_file.ipynb

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;

Parameter
Name	Description
`builderForValue`	`NotebookExecutionJob.GcsNotebookSource.Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setGcsOutputUri(String value)

public NotebookExecutionJob.Builder setGcsOutputUri(String value)

The Cloud Storage location to upload the result to. Format: gs://bucket-name

string gcs_output_uri = 8;

Parameter
Name	Description
`value`	`String` The gcsOutputUri to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setGcsOutputUriBytes(ByteString value)

public NotebookExecutionJob.Builder setGcsOutputUriBytes(ByteString value)

The Cloud Storage location to upload the result to. Format: gs://bucket-name

string gcs_output_uri = 8;

Parameter
Name	Description
`value`	`ByteString` The bytes for gcsOutputUri to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setJobState(JobState value)

public NotebookExecutionJob.Builder setJobState(JobState value)

Output only. The state of the NotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`JobState` The jobState to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setJobStateValue(int value)

public NotebookExecutionJob.Builder setJobStateValue(int value)

Output only. The state of the NotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setKernelName(String value)

public NotebookExecutionJob.Builder setKernelName(String value)

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

string kernel_name = 20;

Parameter
Name	Description
`value`	`String` The kernelName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setKernelNameBytes(ByteString value)

public NotebookExecutionJob.Builder setKernelNameBytes(ByteString value)

The name of the kernel to use during notebook execution. If unset, the default kernel is used.

string kernel_name = 20;

Parameter
Name	Description
`value`	`ByteString` The bytes for kernelName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setName(String value)

public NotebookExecutionJob.Builder setName(String value)

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public NotebookExecutionJob.Builder setNameBytes(ByteString value)

Output only. The resource name of this NotebookExecutionJob. Format: projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setNotebookRuntimeTemplateResourceName(String value)

public NotebookExecutionJob.Builder setNotebookRuntimeTemplateResourceName(String value)

The NotebookRuntimeTemplate to source compute configuration from.

string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The notebookRuntimeTemplateResourceName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setNotebookRuntimeTemplateResourceNameBytes(ByteString value)

public NotebookExecutionJob.Builder setNotebookRuntimeTemplateResourceNameBytes(ByteString value)

The NotebookRuntimeTemplate to source compute configuration from.

string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for notebookRuntimeTemplateResourceName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

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

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

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

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

setScheduleResourceName(String value)

public NotebookExecutionJob.Builder setScheduleResourceName(String value)

Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The scheduleResourceName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setScheduleResourceNameBytes(ByteString value)

public NotebookExecutionJob.Builder setScheduleResourceNameBytes(ByteString value)

Output only. The Schedule resource name if this job is triggered by one. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for scheduleResourceName to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setServiceAccount(String value)

public NotebookExecutionJob.Builder setServiceAccount(String value)

The service account to run the execution as.

string service_account = 18;

Parameter
Name	Description
`value`	`String` The serviceAccount to set.

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setServiceAccountBytes(ByteString value)

public NotebookExecutionJob.Builder setServiceAccountBytes(ByteString value)

The service account to run the execution as.

string service_account = 18;

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

Returns
Type	Description
`NotebookExecutionJob.Builder`	This builder for chaining.

setStatus(Status value)

public NotebookExecutionJob.Builder setStatus(Status value)

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`com.google.rpc.Status`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setStatus(Status.Builder builderForValue)

public NotebookExecutionJob.Builder setStatus(Status.Builder builderForValue)

Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.

.google.rpc.Status status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`com.google.rpc.Status.Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final NotebookExecutionJob.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`NotebookExecutionJob.Builder`

Overrides

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

setUpdateTime(Timestamp value)

public NotebookExecutionJob.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public NotebookExecutionJob.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this NotebookExecutionJob was most recently updated.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setWorkbenchRuntime(NotebookExecutionJob.WorkbenchRuntime value)

public NotebookExecutionJob.Builder setWorkbenchRuntime(NotebookExecutionJob.WorkbenchRuntime value)

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Parameter
Name	Description
`value`	`NotebookExecutionJob.WorkbenchRuntime`

Returns
Type	Description
`NotebookExecutionJob.Builder`

setWorkbenchRuntime(NotebookExecutionJob.WorkbenchRuntime.Builder builderForValue)

public NotebookExecutionJob.Builder setWorkbenchRuntime(NotebookExecutionJob.WorkbenchRuntime.Builder builderForValue)

The Workbench runtime configuration to use for the notebook execution.

.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;

Parameter
Name	Description
`builderForValue`	`NotebookExecutionJob.WorkbenchRuntime.Builder`

Returns
Type	Description
`NotebookExecutionJob.Builder`