public final class NotebookExecutionJob extends GeneratedMessageV3 implements NotebookExecutionJobOrBuilder
NotebookExecutionJob represents an instance of a notebook execution.
Protobuf type google.cloud.aiplatform.v1beta1.NotebookExecutionJob
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXECUTION_TIMEOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXECUTION_USER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GCS_NOTEBOOK_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GCS_OUTPUT_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int JOB_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SCHEDULE_RESOURCE_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static NotebookExecutionJob getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static NotebookExecutionJob.Builder newBuilder()
public static NotebookExecutionJob.Builder newBuilder(NotebookExecutionJob prototype)
public static NotebookExecutionJob parseDelimitedFrom(InputStream input)
public static NotebookExecutionJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static NotebookExecutionJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(ByteString data)
public static NotebookExecutionJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(CodedInputStream input)
public static NotebookExecutionJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(InputStream input)
public static NotebookExecutionJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NotebookExecutionJob parseFrom(ByteBuffer data)
public static NotebookExecutionJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<NotebookExecutionJob> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this NotebookExecutionJob was created.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public NotebookExecutionJob.DataformRepositorySource getDataformRepositorySource()
The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
public NotebookExecutionJob.DataformRepositorySourceOrBuilder getDataformRepositorySourceOrBuilder()
The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
public NotebookExecutionJob getDefaultInstanceForType()
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.
|
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.
|
public NotebookExecutionJob.EnvironmentSpecCase getEnvironmentSpecCase()
public NotebookExecutionJob.ExecutionIdentityCase getExecutionIdentityCase()
public NotebookExecutionJob.ExecutionSinkCase getExecutionSinkCase()
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.
|
public DurationOrBuilder getExecutionTimeoutOrBuilder()
Max running time of the execution job in seconds (default 86400s / 24 hrs).
.google.protobuf.Duration execution_timeout = 5;
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.
|
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.
|
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;
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;
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
public NotebookExecutionJob.NotebookSourceCase getNotebookSourceCase()
public Parser<NotebookExecutionJob> getParserForType()
Overrides
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.
|
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.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public String getServiceAccount()
The service account to run the execution as.
string service_account = 18;
| Returns |
| Type |
Description |
String |
The serviceAccount.
|
public ByteString getServiceAccountBytes()
The service account to run the execution as.
string service_account = 18;
| Returns |
| Type |
Description |
ByteString |
The bytes for serviceAccount.
|
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.
|
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 |
|
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.
|
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];
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public NotebookExecutionJob.Builder newBuilderForType()
protected NotebookExecutionJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public NotebookExecutionJob.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
