NotebookExecutionJob (proto-google-cloud-aiplatform-v1beta1 0.73.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.aiplatform.v1beta1.NotebookExecutionJob

All Implemented Interfaces:

NotebookExecutionJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class NotebookExecutionJob
extends com.google.protobuf.GeneratedMessageV3
implements NotebookExecutionJobOrBuilder
```
```
 NotebookExecutionJob represents an instance of a notebook execution.
 
```
Protobuf type google.cloud.aiplatform.v1beta1.NotebookExecutionJob
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NotebookExecutionJob.Builder` NotebookExecutionJob represents an instance of a notebook execution.
`static class`	`NotebookExecutionJob.CustomEnvironmentSpec` Compute configuration to use for an execution job.
`static interface`	`NotebookExecutionJob.CustomEnvironmentSpecOrBuilder`
`static class`	`NotebookExecutionJob.DataformRepositorySource` The Dataform Repository containing the input notebook.
`static interface`	`NotebookExecutionJob.DataformRepositorySourceOrBuilder`
`static class`	`NotebookExecutionJob.DirectNotebookSource` The content of the input notebook in ipynb format.
`static interface`	`NotebookExecutionJob.DirectNotebookSourceOrBuilder`
`static class`	`NotebookExecutionJob.EnvironmentSpecCase`
`static class`	`NotebookExecutionJob.ExecutionIdentityCase`
`static class`	`NotebookExecutionJob.ExecutionSinkCase`
`static class`	`NotebookExecutionJob.GcsNotebookSource` The Cloud Storage uri for the input notebook.
`static interface`	`NotebookExecutionJob.GcsNotebookSourceOrBuilder`
`static class`	`NotebookExecutionJob.NotebookSourceCase`
`static class`	`NotebookExecutionJob.RuntimeEnvironmentCase`
`static class`	`NotebookExecutionJob.WorkbenchRuntime` Configuration for a Workbench Instances-based environment.
`static interface`	`NotebookExecutionJob.WorkbenchRuntimeOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`CUSTOM_ENVIRONMENT_SPEC_FIELD_NUMBER`
`static int`	`DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER`
`static int`	`DIRECT_NOTEBOOK_SOURCE_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ENCRYPTION_SPEC_FIELD_NUMBER`
`static int`	`EXECUTION_TIMEOUT_FIELD_NUMBER`
`static int`	`EXECUTION_USER_FIELD_NUMBER`
`static int`	`GCS_NOTEBOOK_SOURCE_FIELD_NUMBER`
`static int`	`GCS_OUTPUT_URI_FIELD_NUMBER`
`static int`	`JOB_STATE_FIELD_NUMBER`
`static int`	`KERNEL_NAME_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER`
`static int`	`SCHEDULE_RESOURCE_NAME_FIELD_NUMBER`
`static int`	`SERVICE_ACCOUNT_FIELD_NUMBER`
`static int`	`STATUS_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`
`static int`	`WORKBENCH_RUNTIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` The labels with user-defined metadata to organize NotebookExecutionJobs.
`boolean`	`equals(Object obj)`
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`NotebookExecutionJob.CustomEnvironmentSpec`	`getCustomEnvironmentSpec()` The custom compute configuration for an execution job.
`NotebookExecutionJob.CustomEnvironmentSpecOrBuilder`	`getCustomEnvironmentSpecOrBuilder()` The custom compute configuration for an execution job.
`NotebookExecutionJob.DataformRepositorySource`	`getDataformRepositorySource()` The Dataform Repository pointing to a single file notebook repository.
`NotebookExecutionJob.DataformRepositorySourceOrBuilder`	`getDataformRepositorySourceOrBuilder()` The Dataform Repository pointing to a single file notebook repository.
`static NotebookExecutionJob`	`getDefaultInstance()`
`NotebookExecutionJob`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`NotebookExecutionJob.DirectNotebookSource`	`getDirectNotebookSource()` The contents of an input notebook file.
`NotebookExecutionJob.DirectNotebookSourceOrBuilder`	`getDirectNotebookSourceOrBuilder()` The contents of an input notebook file.
`String`	`getDisplayName()` The display name of the NotebookExecutionJob.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` The display name of the NotebookExecutionJob.
`EncryptionSpec`	`getEncryptionSpec()` Customer-managed encryption key spec for the notebook execution job.
`EncryptionSpecOrBuilder`	`getEncryptionSpecOrBuilder()` Customer-managed encryption key spec for the notebook execution job.
`NotebookExecutionJob.EnvironmentSpecCase`	`getEnvironmentSpecCase()`
`NotebookExecutionJob.ExecutionIdentityCase`	`getExecutionIdentityCase()`
`NotebookExecutionJob.ExecutionSinkCase`	`getExecutionSinkCase()`
`com.google.protobuf.Duration`	`getExecutionTimeout()` Max running time of the execution job in seconds (default 86400s / 24 hrs).
`com.google.protobuf.DurationOrBuilder`	`getExecutionTimeoutOrBuilder()` Max running time of the execution job in seconds (default 86400s / 24 hrs).
`String`	`getExecutionUser()` The user email to run the execution as.
`com.google.protobuf.ByteString`	`getExecutionUserBytes()` The user email to run the execution as.
`NotebookExecutionJob.GcsNotebookSource`	`getGcsNotebookSource()` The Cloud Storage url pointing to the ipynb file.
`NotebookExecutionJob.GcsNotebookSourceOrBuilder`	`getGcsNotebookSourceOrBuilder()` The Cloud Storage url pointing to the ipynb file.
`String`	`getGcsOutputUri()` The Cloud Storage location to upload the result to.
`com.google.protobuf.ByteString`	`getGcsOutputUriBytes()` The Cloud Storage location to upload the result to.
`JobState`	`getJobState()` Output only.
`int`	`getJobStateValue()` Output only.
`String`	`getKernelName()` The name of the kernel to use during notebook execution.
`com.google.protobuf.ByteString`	`getKernelNameBytes()` The name of the kernel to use during notebook execution.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` The labels with user-defined metadata to organize NotebookExecutionJobs.
`Map<String,String>`	`getLabelsMap()` The labels with user-defined metadata to organize NotebookExecutionJobs.
`String`	`getLabelsOrDefault(String key, String defaultValue)` The labels with user-defined metadata to organize NotebookExecutionJobs.
`String`	`getLabelsOrThrow(String key)` The labels with user-defined metadata to organize NotebookExecutionJobs.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`String`	`getNotebookRuntimeTemplateResourceName()` The NotebookRuntimeTemplate to source compute configuration from.
`com.google.protobuf.ByteString`	`getNotebookRuntimeTemplateResourceNameBytes()` The NotebookRuntimeTemplate to source compute configuration from.
`NotebookExecutionJob.NotebookSourceCase`	`getNotebookSourceCase()`
`com.google.protobuf.Parser<NotebookExecutionJob>`	`getParserForType()`
`NotebookExecutionJob.RuntimeEnvironmentCase`	`getRuntimeEnvironmentCase()`
`String`	`getScheduleResourceName()` Output only.
`com.google.protobuf.ByteString`	`getScheduleResourceNameBytes()` Output only.
`int`	`getSerializedSize()`
`String`	`getServiceAccount()` The service account to run the execution as.
`com.google.protobuf.ByteString`	`getServiceAccountBytes()` The service account to run the execution as.
`com.google.rpc.Status`	`getStatus()` Output only.
`com.google.rpc.StatusOrBuilder`	`getStatusOrBuilder()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`NotebookExecutionJob.WorkbenchRuntime`	`getWorkbenchRuntime()` The Workbench runtime configuration to use for the notebook execution.
`NotebookExecutionJob.WorkbenchRuntimeOrBuilder`	`getWorkbenchRuntimeOrBuilder()` The Workbench runtime configuration to use for the notebook execution.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasCustomEnvironmentSpec()` The custom compute configuration for an execution job.
`boolean`	`hasDataformRepositorySource()` The Dataform Repository pointing to a single file notebook repository.
`boolean`	`hasDirectNotebookSource()` The contents of an input notebook file.
`boolean`	`hasEncryptionSpec()` Customer-managed encryption key spec for the notebook execution job.
`boolean`	`hasExecutionTimeout()` Max running time of the execution job in seconds (default 86400s / 24 hrs).
`boolean`	`hasExecutionUser()` The user email to run the execution as.
`boolean`	`hasGcsNotebookSource()` The Cloud Storage url pointing to the ipynb file.
`boolean`	`hasGcsOutputUri()` The Cloud Storage location to upload the result to.
`int`	`hashCode()`
`boolean`	`hasNotebookRuntimeTemplateResourceName()` The NotebookRuntimeTemplate to source compute configuration from.
`boolean`	`hasServiceAccount()` The service account to run the execution as.
`boolean`	`hasStatus()` Output only.
`boolean`	`hasUpdateTime()` Output only.
`boolean`	`hasWorkbenchRuntime()` The Workbench runtime configuration to use for the notebook execution.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static NotebookExecutionJob.Builder`	`newBuilder()`
`static NotebookExecutionJob.Builder`	`newBuilder(NotebookExecutionJob prototype)`
`NotebookExecutionJob.Builder`	`newBuilderForType()`
`protected NotebookExecutionJob.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static NotebookExecutionJob`	`parseDelimitedFrom(InputStream input)`
`static NotebookExecutionJob`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotebookExecutionJob`	`parseFrom(byte[] data)`
`static NotebookExecutionJob`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotebookExecutionJob`	`parseFrom(ByteBuffer data)`
`static NotebookExecutionJob`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotebookExecutionJob`	`parseFrom(com.google.protobuf.ByteString data)`
`static NotebookExecutionJob`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotebookExecutionJob`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static NotebookExecutionJob`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static NotebookExecutionJob`	`parseFrom(InputStream input)`
`static NotebookExecutionJob`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<NotebookExecutionJob>`	`parser()`
`NotebookExecutionJob.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER
```
public static final int DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GCS_NOTEBOOK_SOURCE_FIELD_NUMBER
```
public static final int GCS_NOTEBOOK_SOURCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIRECT_NOTEBOOK_SOURCE_FIELD_NUMBER
```
public static final int DIRECT_NOTEBOOK_SOURCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER
```
public static final int NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUSTOM_ENVIRONMENT_SPEC_FIELD_NUMBER
```
public static final int CUSTOM_ENVIRONMENT_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GCS_OUTPUT_URI_FIELD_NUMBER
```
public static final int GCS_OUTPUT_URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXECUTION_USER_FIELD_NUMBER
```
public static final int EXECUTION_USER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVICE_ACCOUNT_FIELD_NUMBER
```
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WORKBENCH_RUNTIME_FIELD_NUMBER
```
public static final int WORKBENCH_RUNTIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXECUTION_TIMEOUT_FIELD_NUMBER
```
public static final int EXECUTION_TIMEOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SCHEDULE_RESOURCE_NAME_FIELD_NUMBER
```
public static final int SCHEDULE_RESOURCE_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- JOB_STATE_FIELD_NUMBER
```
public static final int JOB_STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATUS_FIELD_NUMBER
```
public static final int STATUS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KERNEL_NAME_FIELD_NUMBER
```
public static final int KERNEL_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENCRYPTION_SPEC_FIELD_NUMBER
```
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getNotebookSourceCase
```
public NotebookExecutionJob.NotebookSourceCase getNotebookSourceCase()
```
Specified by:

getNotebookSourceCase in interface NotebookExecutionJobOrBuilder

getEnvironmentSpecCase
```
public NotebookExecutionJob.EnvironmentSpecCase getEnvironmentSpecCase()
```
Specified by:

getEnvironmentSpecCase in interface NotebookExecutionJobOrBuilder

getExecutionSinkCase
```
public NotebookExecutionJob.ExecutionSinkCase getExecutionSinkCase()
```
Specified by:

getExecutionSinkCase in interface NotebookExecutionJobOrBuilder

getExecutionIdentityCase
```
public NotebookExecutionJob.ExecutionIdentityCase getExecutionIdentityCase()
```
Specified by:

getExecutionIdentityCase in interface NotebookExecutionJobOrBuilder

getRuntimeEnvironmentCase
```
public NotebookExecutionJob.RuntimeEnvironmentCase getRuntimeEnvironmentCase()
```
Specified by:

getRuntimeEnvironmentCase in interface NotebookExecutionJobOrBuilder

hasDataformRepositorySource
```
public boolean hasDataformRepositorySource()
```
```
 The Dataform Repository pointing to a single file notebook repository.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
Specified by:

hasDataformRepositorySource in interface NotebookExecutionJobOrBuilder

Returns:

Whether the dataformRepositorySource field is set.

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;
Specified by:

getDataformRepositorySource in interface NotebookExecutionJobOrBuilder

Returns:

The dataformRepositorySource.

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;
Specified by:

getDataformRepositorySourceOrBuilder in interface NotebookExecutionJobOrBuilder

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;
Specified by:

hasGcsNotebookSource in interface NotebookExecutionJobOrBuilder

Returns:

Whether the gcsNotebookSource field is set.

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;
Specified by:

getGcsNotebookSource in interface NotebookExecutionJobOrBuilder

Returns:

The gcsNotebookSource.

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;
Specified by:

getGcsNotebookSourceOrBuilder in interface NotebookExecutionJobOrBuilder

hasDirectNotebookSource
```
public boolean hasDirectNotebookSource()
```
```
 The contents of an input notebook file.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
Specified by:

hasDirectNotebookSource in interface NotebookExecutionJobOrBuilder

Returns:

Whether the directNotebookSource field is set.

getDirectNotebookSource
```
public NotebookExecutionJob.DirectNotebookSource getDirectNotebookSource()
```
```
 The contents of an input notebook file.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
Specified by:

getDirectNotebookSource in interface NotebookExecutionJobOrBuilder

Returns:

The directNotebookSource.

getDirectNotebookSourceOrBuilder
```
public NotebookExecutionJob.DirectNotebookSourceOrBuilder getDirectNotebookSourceOrBuilder()
```
```
 The contents of an input notebook file.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
Specified by:

getDirectNotebookSourceOrBuilder in interface NotebookExecutionJobOrBuilder

hasNotebookRuntimeTemplateResourceName
```
public boolean hasNotebookRuntimeTemplateResourceName()
```
```
 The NotebookRuntimeTemplate to source compute configuration from.
 
```
string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
Specified by:

hasNotebookRuntimeTemplateResourceName in interface NotebookExecutionJobOrBuilder

Returns:

Whether the notebookRuntimeTemplateResourceName field is set.

getNotebookRuntimeTemplateResourceName
```
public String getNotebookRuntimeTemplateResourceName()
```
```
 The NotebookRuntimeTemplate to source compute configuration from.
 
```
string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
Specified by:

getNotebookRuntimeTemplateResourceName in interface NotebookExecutionJobOrBuilder

Returns:

The notebookRuntimeTemplateResourceName.

getNotebookRuntimeTemplateResourceNameBytes
```
public com.google.protobuf.ByteString getNotebookRuntimeTemplateResourceNameBytes()
```
```
 The NotebookRuntimeTemplate to source compute configuration from.
 
```
string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
Specified by:

getNotebookRuntimeTemplateResourceNameBytes in interface NotebookExecutionJobOrBuilder

Returns:

The bytes for notebookRuntimeTemplateResourceName.

hasCustomEnvironmentSpec
```
public boolean hasCustomEnvironmentSpec()
```
```
 The custom compute configuration for an execution job.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
Specified by:

hasCustomEnvironmentSpec in interface NotebookExecutionJobOrBuilder

Returns:

Whether the customEnvironmentSpec field is set.

getCustomEnvironmentSpec
```
public NotebookExecutionJob.CustomEnvironmentSpec getCustomEnvironmentSpec()
```
```
 The custom compute configuration for an execution job.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
Specified by:

getCustomEnvironmentSpec in interface NotebookExecutionJobOrBuilder

Returns:

The customEnvironmentSpec.

getCustomEnvironmentSpecOrBuilder
```
public NotebookExecutionJob.CustomEnvironmentSpecOrBuilder getCustomEnvironmentSpecOrBuilder()
```
```
 The custom compute configuration for an execution job.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
Specified by:

getCustomEnvironmentSpecOrBuilder in interface NotebookExecutionJobOrBuilder

hasGcsOutputUri
```
public boolean hasGcsOutputUri()
```
```
 The Cloud Storage location to upload the result to. Format:
 `gs://bucket-name`
 
```
string gcs_output_uri = 8;
Specified by:

hasGcsOutputUri in interface NotebookExecutionJobOrBuilder

Returns:

Whether the gcsOutputUri field is set.

getGcsOutputUri
```
public String getGcsOutputUri()
```
```
 The Cloud Storage location to upload the result to. Format:
 `gs://bucket-name`
 
```
string gcs_output_uri = 8;
Specified by:

getGcsOutputUri in interface NotebookExecutionJobOrBuilder

Returns:

The gcsOutputUri.

getGcsOutputUriBytes
```
public com.google.protobuf.ByteString getGcsOutputUriBytes()
```
```
 The Cloud Storage location to upload the result to. Format:
 `gs://bucket-name`
 
```
string gcs_output_uri = 8;
Specified by:

getGcsOutputUriBytes in interface NotebookExecutionJobOrBuilder

Returns:

The bytes for gcsOutputUri.

hasExecutionUser
```
public boolean hasExecutionUser()
```
```
 The user email to run the execution as. Only supported by Colab runtimes.
 
```
string execution_user = 9;
Specified by:

hasExecutionUser in interface NotebookExecutionJobOrBuilder

Returns:

Whether the executionUser field is set.

getExecutionUser
```
public String getExecutionUser()
```
```
 The user email to run the execution as. Only supported by Colab runtimes.
 
```
string execution_user = 9;
Specified by:

getExecutionUser in interface NotebookExecutionJobOrBuilder

Returns:

The executionUser.

getExecutionUserBytes
```
public com.google.protobuf.ByteString getExecutionUserBytes()
```
```
 The user email to run the execution as. Only supported by Colab runtimes.
 
```
string execution_user = 9;
Specified by:

getExecutionUserBytes in interface NotebookExecutionJobOrBuilder

Returns:

The bytes for executionUser.

hasServiceAccount
```
public boolean hasServiceAccount()
```
```
 The service account to run the execution as.
 
```
string service_account = 18;
Specified by:

hasServiceAccount in interface NotebookExecutionJobOrBuilder

Returns:

Whether the serviceAccount field is set.

getServiceAccount
```
public String getServiceAccount()
```
```
 The service account to run the execution as.
 
```
string service_account = 18;
Specified by:

getServiceAccount in interface NotebookExecutionJobOrBuilder

Returns:

The serviceAccount.

getServiceAccountBytes
```
public com.google.protobuf.ByteString getServiceAccountBytes()
```
```
 The service account to run the execution as.
 
```
string service_account = 18;
Specified by:

getServiceAccountBytes in interface NotebookExecutionJobOrBuilder

Returns:

The bytes for serviceAccount.

hasWorkbenchRuntime
```
public boolean hasWorkbenchRuntime()
```
```
 The Workbench runtime configuration to use for the notebook execution.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
Specified by:

hasWorkbenchRuntime in interface NotebookExecutionJobOrBuilder

Returns:

Whether the workbenchRuntime field is set.

getWorkbenchRuntime
```
public NotebookExecutionJob.WorkbenchRuntime getWorkbenchRuntime()
```
```
 The Workbench runtime configuration to use for the notebook execution.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
Specified by:

getWorkbenchRuntime in interface NotebookExecutionJobOrBuilder

Returns:

The workbenchRuntime.

getWorkbenchRuntimeOrBuilder
```
public NotebookExecutionJob.WorkbenchRuntimeOrBuilder getWorkbenchRuntimeOrBuilder()
```
```
 The Workbench runtime configuration to use for the notebook execution.
 
```
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
Specified by:

getWorkbenchRuntimeOrBuilder in interface NotebookExecutionJobOrBuilder

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

Specified by:: getName in interface NotebookExecutionJobOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.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];

Specified by:: getNameBytes in interface NotebookExecutionJobOrBuilder
Returns:: The bytes for name.

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;

Specified by:: getDisplayName in interface NotebookExecutionJobOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.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;

Specified by:: getDisplayNameBytes in interface NotebookExecutionJobOrBuilder
Returns:: The bytes for displayName.

hasExecutionTimeout
```
public boolean hasExecutionTimeout()
```
```
 Max running time of the execution job in seconds (default 86400s / 24 hrs).
 
```
.google.protobuf.Duration execution_timeout = 5;
Specified by:

hasExecutionTimeout in interface NotebookExecutionJobOrBuilder

Returns:

Whether the executionTimeout field is set.

getExecutionTimeout
```
public com.google.protobuf.Duration getExecutionTimeout()
```
```
 Max running time of the execution job in seconds (default 86400s / 24 hrs).
 
```
.google.protobuf.Duration execution_timeout = 5;
Specified by:

getExecutionTimeout in interface NotebookExecutionJobOrBuilder

Returns:

The executionTimeout.

getExecutionTimeoutOrBuilder

public com.google.protobuf.DurationOrBuilder getExecutionTimeoutOrBuilder()

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

.google.protobuf.Duration execution_timeout = 5;

Specified by:: getExecutionTimeoutOrBuilder in interface NotebookExecutionJobOrBuilder

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) = { ... }
Specified by:

getScheduleResourceName in interface NotebookExecutionJobOrBuilder

Returns:

The scheduleResourceName.

getScheduleResourceNameBytes
```
public com.google.protobuf.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) = { ... }
Specified by:

getScheduleResourceNameBytes in interface NotebookExecutionJobOrBuilder

Returns:

The bytes for scheduleResourceName.

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];
Specified by:

getJobStateValue in interface NotebookExecutionJobOrBuilder

Returns:

The enum numeric value on the wire for jobState.

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];
Specified by:

getJobState in interface NotebookExecutionJobOrBuilder

Returns:

The jobState.

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];
Specified by:

hasStatus in interface NotebookExecutionJobOrBuilder

Returns:

Whether the status field is set.

getStatus

public com.google.rpc.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];

Specified by:: getStatus in interface NotebookExecutionJobOrBuilder
Returns:: The status.

getStatusOrBuilder

public com.google.rpc.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];

Specified by:: getStatusOrBuilder in interface NotebookExecutionJobOrBuilder

hasCreateTime
```
public boolean hasCreateTime()
```
```
 Output only. Timestamp when this NotebookExecutionJob was created.
 
```
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasCreateTime in interface NotebookExecutionJobOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime
```
public com.google.protobuf.Timestamp getCreateTime()
```
```
 Output only. Timestamp when this NotebookExecutionJob was created.
 
```
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTime in interface NotebookExecutionJobOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 Output only. Timestamp when this NotebookExecutionJob was created.
 
```
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTimeOrBuilder in interface NotebookExecutionJobOrBuilder

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];
Specified by:

hasUpdateTime in interface NotebookExecutionJobOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime
```
public com.google.protobuf.Timestamp getUpdateTime()
```
```
 Output only. Timestamp when this NotebookExecutionJob was most recently
 updated.
 
```
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTime in interface NotebookExecutionJobOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
```
```
 Output only. Timestamp when this NotebookExecutionJob was most recently
 updated.
 
```
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTimeOrBuilder in interface NotebookExecutionJobOrBuilder