com.google.cloud.aiplatform.v1beta1

Interface NotebookExecutionJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

NotebookExecutionJob, NotebookExecutionJob.Builder

public interface NotebookExecutionJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
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.
String	getDisplayName() The display name of the NotebookExecutionJob.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name of the NotebookExecutionJob.
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	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()
String	getScheduleResourceName() Output only.
com.google.protobuf.ByteString	getScheduleResourceNameBytes() Output only.
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.
boolean	hasCreateTime() Output only.
boolean	hasDataformRepositorySource() The Dataform Repository pointing to a single file notebook repository.
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.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasDataformRepositorySource

boolean hasDataformRepositorySource()

 The Dataform Repository pointing to a single file notebook repository.
 

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

Returns:

Whether the dataformRepositorySource field is set.

getDataformRepositorySource

NotebookExecutionJob.DataformRepositorySource getDataformRepositorySource()

 The Dataform Repository pointing to a single file notebook repository.
 

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

Returns:

The dataformRepositorySource.

getDataformRepositorySourceOrBuilder

NotebookExecutionJob.DataformRepositorySourceOrBuilder getDataformRepositorySourceOrBuilder()

 The Dataform Repository pointing to a single file notebook repository.
 

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

hasGcsNotebookSource

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:

Whether the gcsNotebookSource field is set.

getGcsNotebookSource

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:

The gcsNotebookSource.

getGcsNotebookSourceOrBuilder

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;

hasNotebookRuntimeTemplateResourceName

boolean hasNotebookRuntimeTemplateResourceName()

 The NotebookRuntimeTemplate to source compute configuration from.
 

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

Returns:

Whether the notebookRuntimeTemplateResourceName field is set.

getNotebookRuntimeTemplateResourceName

String getNotebookRuntimeTemplateResourceName()

 The NotebookRuntimeTemplate to source compute configuration from.
 

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

Returns:

The notebookRuntimeTemplateResourceName.

getNotebookRuntimeTemplateResourceNameBytes

com.google.protobuf.ByteString getNotebookRuntimeTemplateResourceNameBytes()

 The NotebookRuntimeTemplate to source compute configuration from.
 

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

Returns:

The bytes for notebookRuntimeTemplateResourceName.

hasGcsOutputUri

boolean hasGcsOutputUri()

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

string gcs_output_uri = 8;

Returns:

Whether the gcsOutputUri field is set.

getGcsOutputUri

String getGcsOutputUri()

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

string gcs_output_uri = 8;

Returns:

The gcsOutputUri.

getGcsOutputUriBytes

com.google.protobuf.ByteString getGcsOutputUriBytes()

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

string gcs_output_uri = 8;

Returns:

The bytes for gcsOutputUri.

hasExecutionUser

boolean hasExecutionUser()

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

string execution_user = 9;

Returns:

Whether the executionUser field is set.

getExecutionUser

String getExecutionUser()

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

string execution_user = 9;

Returns:

The executionUser.

getExecutionUserBytes

com.google.protobuf.ByteString getExecutionUserBytes()

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

string execution_user = 9;

Returns:

The bytes for executionUser.

hasServiceAccount

boolean hasServiceAccount()

 The service account to run the execution as.
 

string service_account = 18;

Returns:

Whether the serviceAccount field is set.

getServiceAccount

String getServiceAccount()

 The service account to run the execution as.
 

string service_account = 18;

Returns:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.ByteString getServiceAccountBytes()

 The service account to run the execution as.
 

string service_account = 18;

Returns:

The bytes for serviceAccount.

getName

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:

The name.

getNameBytes

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

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;

Returns:

The bytes for displayName.

hasExecutionTimeout

boolean hasExecutionTimeout()

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

.google.protobuf.Duration execution_timeout = 5;

Returns:

Whether the executionTimeout field is set.

getExecutionTimeout

com.google.protobuf.Duration getExecutionTimeout()

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

.google.protobuf.Duration execution_timeout = 5;

Returns:

The executionTimeout.

getExecutionTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getExecutionTimeoutOrBuilder()

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

.google.protobuf.Duration execution_timeout = 5;

getScheduleResourceName

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:

The scheduleResourceName.

getScheduleResourceNameBytes

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

Returns:

The bytes for scheduleResourceName.

getJobStateValue

int getJobStateValue()

 Output only. The state of the NotebookExecutionJob.
 

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

Returns:

The enum numeric value on the wire for jobState.

getJobState

JobState getJobState()

 Output only. The state of the NotebookExecutionJob.
 

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

Returns:

The jobState.

hasStatus

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:

Whether the status field is set.

getStatus

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

Returns:

The status.

getStatusOrBuilder

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

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this NotebookExecutionJob was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

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

Returns:

The createTime.

getCreateTimeOrBuilder

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

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

getNotebookSourceCase

NotebookExecutionJob.NotebookSourceCase getNotebookSourceCase()

getEnvironmentSpecCase

NotebookExecutionJob.EnvironmentSpecCase getEnvironmentSpecCase()

getExecutionSinkCase

NotebookExecutionJob.ExecutionSinkCase getExecutionSinkCase()

getExecutionIdentityCase

NotebookExecutionJob.ExecutionIdentityCase getExecutionIdentityCase()