- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public final class NotebookExecutionJob extends GeneratedMessageV3 implements NotebookExecutionJobOrBuilderNotebookExecutionJob represents an instance of a notebook execution.
Protobuf type google.cloud.aiplatform.v1.NotebookExecutionJob
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NotebookExecutionJobImplements
NotebookExecutionJobOrBuilderStatic Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CUSTOM_ENVIRONMENT_SPEC_FIELD_NUMBER
public static final int CUSTOM_ENVIRONMENT_SPEC_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER
public static final int DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DIRECT_NOTEBOOK_SOURCE_FIELD_NUMBER
public static final int DIRECT_NOTEBOOK_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXECUTION_TIMEOUT_FIELD_NUMBER
public static final int EXECUTION_TIMEOUT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXECUTION_USER_FIELD_NUMBER
public static final int EXECUTION_USER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GCS_NOTEBOOK_SOURCE_FIELD_NUMBER
public static final int GCS_NOTEBOOK_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GCS_OUTPUT_URI_FIELD_NUMBER
public static final int GCS_OUTPUT_URI_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
JOB_STATE_FIELD_NUMBER
public static final int JOB_STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
KERNEL_NAME_FIELD_NUMBER
public static final int KERNEL_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER
public static final int NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SCHEDULE_RESOURCE_NAME_FIELD_NUMBER
public static final int SCHEDULE_RESOURCE_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
WORKBENCH_RUNTIME_FIELD_NUMBER
public static final int WORKBENCH_RUNTIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static NotebookExecutionJob getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static NotebookExecutionJob.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.Builder |
|
newBuilder(NotebookExecutionJob prototype)
public static NotebookExecutionJob.Builder newBuilder(NotebookExecutionJob prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
NotebookExecutionJob |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.Builder |
|
parseDelimitedFrom(InputStream input)
public static NotebookExecutionJob parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static NotebookExecutionJob parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static NotebookExecutionJob parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static NotebookExecutionJob parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static NotebookExecutionJob parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static NotebookExecutionJob parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<NotebookExecutionJob> parser()| Returns | |
|---|---|
| Type | Description |
Parser<NotebookExecutionJob> |
|
Methods
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 |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| 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. |
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.v1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.CustomEnvironmentSpec |
The customEnvironmentSpec. |
getCustomEnvironmentSpecOrBuilder()
public NotebookExecutionJob.CustomEnvironmentSpecOrBuilder getCustomEnvironmentSpecOrBuilder()The custom compute configuration for an execution job.
.google.cloud.aiplatform.v1.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.v1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.DataformRepositorySource |
The dataformRepositorySource. |
getDataformRepositorySourceOrBuilder()
public NotebookExecutionJob.DataformRepositorySourceOrBuilder getDataformRepositorySourceOrBuilder()The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.DataformRepositorySourceOrBuilder |
|
getDefaultInstanceForType()
public NotebookExecutionJob getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob |
|
getDirectNotebookSource()
public NotebookExecutionJob.DirectNotebookSource getDirectNotebookSource()The contents of an input notebook file.
.google.cloud.aiplatform.v1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.DirectNotebookSource |
The directNotebookSource. |
getDirectNotebookSourceOrBuilder()
public NotebookExecutionJob.DirectNotebookSourceOrBuilder getDirectNotebookSourceOrBuilder()The contents of an input notebook file.
.google.cloud.aiplatform.v1.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.v1.EncryptionSpec encryption_spec = 22;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpec |
The encryptionSpec. |
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.v1.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. |
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.v1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.GcsNotebookSource |
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.v1.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.v1.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.v1.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 |
|
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 |
|
getParserForType()
public Parser<NotebookExecutionJob> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<NotebookExecutionJob> |
|
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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
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. |
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.v1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.WorkbenchRuntime |
The workbenchRuntime. |
getWorkbenchRuntimeOrBuilder()
public NotebookExecutionJob.WorkbenchRuntimeOrBuilder getWorkbenchRuntimeOrBuilder()The Workbench runtime configuration to use for the notebook execution.
.google.cloud.aiplatform.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the workbenchRuntime field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public NotebookExecutionJob.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NotebookExecutionJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public NotebookExecutionJob.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|