- 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 interface NotebookExecutionJobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)The labels with user-defined metadata to organize NotebookExecutionJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
map<string, string> labels = 19;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreateTime()
public abstract 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 abstract 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 abstract NotebookExecutionJob.CustomEnvironmentSpec getCustomEnvironmentSpec()The custom compute configuration for an execution job.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.CustomEnvironmentSpec |
The customEnvironmentSpec. |
getCustomEnvironmentSpecOrBuilder()
public abstract NotebookExecutionJob.CustomEnvironmentSpecOrBuilder getCustomEnvironmentSpecOrBuilder()The custom compute configuration for an execution job.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.CustomEnvironmentSpecOrBuilder |
|
getDataformRepositorySource()
public abstract NotebookExecutionJob.DataformRepositorySource getDataformRepositorySource()The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.DataformRepositorySource |
The dataformRepositorySource. |
getDataformRepositorySourceOrBuilder()
public abstract NotebookExecutionJob.DataformRepositorySourceOrBuilder getDataformRepositorySourceOrBuilder()The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.DataformRepositorySourceOrBuilder |
|
getDirectNotebookSource()
public abstract NotebookExecutionJob.DirectNotebookSource getDirectNotebookSource()The contents of an input notebook file.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.DirectNotebookSource |
The directNotebookSource. |
getDirectNotebookSourceOrBuilder()
public abstract NotebookExecutionJob.DirectNotebookSourceOrBuilder getDirectNotebookSourceOrBuilder()The contents of an input notebook file.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.DirectNotebookSourceOrBuilder |
|
getDisplayName()
public abstract 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 abstract 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 abstract EncryptionSpec getEncryptionSpec()Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpec |
The encryptionSpec. |
getEncryptionSpecOrBuilder()
public abstract EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder |
|
getEnvironmentSpecCase()
public abstract NotebookExecutionJob.EnvironmentSpecCase getEnvironmentSpecCase()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.EnvironmentSpecCase |
|
getExecutionIdentityCase()
public abstract NotebookExecutionJob.ExecutionIdentityCase getExecutionIdentityCase()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.ExecutionIdentityCase |
|
getExecutionSinkCase()
public abstract NotebookExecutionJob.ExecutionSinkCase getExecutionSinkCase()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.ExecutionSinkCase |
|
getExecutionTimeout()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract NotebookExecutionJob.GcsNotebookSource getGcsNotebookSource() The Cloud Storage url pointing to the ipynb file. Format:
gs://bucket/notebook_file.ipynb
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.GcsNotebookSource |
The gcsNotebookSource. |
getGcsNotebookSourceOrBuilder()
public abstract NotebookExecutionJob.GcsNotebookSourceOrBuilder getGcsNotebookSourceOrBuilder() The Cloud Storage url pointing to the ipynb file. Format:
gs://bucket/notebook_file.ipynb
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.GcsNotebookSourceOrBuilder |
|
getGcsOutputUri()
public abstract 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 abstract 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 abstract JobState getJobState()Output only. The state of the NotebookExecutionJob.
.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
JobState |
The jobState. |
getJobStateValue()
public abstract int getJobStateValue()Output only. The state of the NotebookExecutionJob.
.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for jobState. |
getKernelName()
public abstract 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 abstract 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 abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract NotebookExecutionJob.NotebookSourceCase getNotebookSourceCase()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.NotebookSourceCase |
|
getRuntimeEnvironmentCase()
public abstract NotebookExecutionJob.RuntimeEnvironmentCase getRuntimeEnvironmentCase()| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.RuntimeEnvironmentCase |
|
getScheduleResourceName()
public abstract 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 abstract ByteString getScheduleResourceNameBytes() Output only. The Schedule resource name if this job is triggered by one.
Format:
projects/{project_id}/locations/{location}/schedules/{schedule_id}
string schedule_resource_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for scheduleResourceName. |
getServiceAccount()
public abstract String getServiceAccount()The service account to run the execution as.
string service_account = 18;
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccount. |
getServiceAccountBytes()
public abstract ByteString getServiceAccountBytes()The service account to run the execution as.
string service_account = 18;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccount. |
getStatus()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract NotebookExecutionJob.WorkbenchRuntime getWorkbenchRuntime()The Workbench runtime configuration to use for the notebook execution.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.WorkbenchRuntime |
The workbenchRuntime. |
getWorkbenchRuntimeOrBuilder()
public abstract NotebookExecutionJob.WorkbenchRuntimeOrBuilder getWorkbenchRuntimeOrBuilder()The Workbench runtime configuration to use for the notebook execution.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
| Returns | |
|---|---|
| Type | Description |
NotebookExecutionJob.WorkbenchRuntimeOrBuilder |
|
hasCreateTime()
public abstract 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 abstract boolean hasCustomEnvironmentSpec()The custom compute configuration for an execution job.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customEnvironmentSpec field is set. |
hasDataformRepositorySource()
public abstract boolean hasDataformRepositorySource()The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the dataformRepositorySource field is set. |
hasDirectNotebookSource()
public abstract boolean hasDirectNotebookSource()The contents of an input notebook file.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the directNotebookSource field is set. |
hasEncryptionSpec()
public abstract boolean hasEncryptionSpec()Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionSpec field is set. |
hasExecutionTimeout()
public abstract 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 abstract 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 abstract boolean hasGcsNotebookSource() The Cloud Storage url pointing to the ipynb file. Format:
gs://bucket/notebook_file.ipynb
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.GcsNotebookSource gcs_notebook_source = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the gcsNotebookSource field is set. |
hasGcsOutputUri()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasWorkbenchRuntime()The Workbench runtime configuration to use for the notebook execution.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the workbenchRuntime field is set. |