public interface NotebookExecutionJobOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
The labels with user-defined metadata to organize NotebookExecutionJobs.
|
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.
|
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() |
NotebookExecutionJob.RuntimeEnvironmentCase |
getRuntimeEnvironmentCase() |
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.
|
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.
|
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.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofboolean hasDataformRepositorySource()
The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
NotebookExecutionJob.DataformRepositorySource getDataformRepositorySource()
The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
NotebookExecutionJob.DataformRepositorySourceOrBuilder getDataformRepositorySourceOrBuilder()
The Dataform Repository pointing to a single file notebook repository.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
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;
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;
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;
boolean hasDirectNotebookSource()
The contents of an input notebook file.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
NotebookExecutionJob.DirectNotebookSource getDirectNotebookSource()
The contents of an input notebook file.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
NotebookExecutionJob.DirectNotebookSourceOrBuilder getDirectNotebookSourceOrBuilder()
The contents of an input notebook file.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
boolean hasNotebookRuntimeTemplateResourceName()
The NotebookRuntimeTemplate to source compute configuration from.
string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
String getNotebookRuntimeTemplateResourceName()
The NotebookRuntimeTemplate to source compute configuration from.
string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
com.google.protobuf.ByteString getNotebookRuntimeTemplateResourceNameBytes()
The NotebookRuntimeTemplate to source compute configuration from.
string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
boolean hasCustomEnvironmentSpec()
The custom compute configuration for an execution job.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
NotebookExecutionJob.CustomEnvironmentSpec getCustomEnvironmentSpec()
The custom compute configuration for an execution job.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
NotebookExecutionJob.CustomEnvironmentSpecOrBuilder getCustomEnvironmentSpecOrBuilder()
The custom compute configuration for an execution job.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
boolean hasGcsOutputUri()
The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
string gcs_output_uri = 8;String getGcsOutputUri()
The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
string gcs_output_uri = 8;com.google.protobuf.ByteString getGcsOutputUriBytes()
The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
string gcs_output_uri = 8;boolean hasExecutionUser()
The user email to run the execution as. Only supported by Colab runtimes.
string execution_user = 9;String getExecutionUser()
The user email to run the execution as. Only supported by Colab runtimes.
string execution_user = 9;com.google.protobuf.ByteString getExecutionUserBytes()
The user email to run the execution as. Only supported by Colab runtimes.
string execution_user = 9;boolean hasServiceAccount()
The service account to run the execution as.
string service_account = 18;String getServiceAccount()
The service account to run the execution as.
string service_account = 18;com.google.protobuf.ByteString getServiceAccountBytes()
The service account to run the execution as.
string service_account = 18;boolean hasWorkbenchRuntime()
The Workbench runtime configuration to use for the notebook execution.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
NotebookExecutionJob.WorkbenchRuntime getWorkbenchRuntime()
The Workbench runtime configuration to use for the notebook execution.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
NotebookExecutionJob.WorkbenchRuntimeOrBuilder getWorkbenchRuntimeOrBuilder()
The Workbench runtime configuration to use for the notebook execution.
.google.cloud.aiplatform.v1beta1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
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];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];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;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;boolean hasExecutionTimeout()
Max running time of the execution job in seconds (default 86400s / 24 hrs).
.google.protobuf.Duration execution_timeout = 5;com.google.protobuf.Duration getExecutionTimeout()
Max running time of the execution job in seconds (default 86400s / 24 hrs).
.google.protobuf.Duration execution_timeout = 5;com.google.protobuf.DurationOrBuilder getExecutionTimeoutOrBuilder()
Max running time of the execution job in seconds (default 86400s / 24 hrs).
.google.protobuf.Duration execution_timeout = 5;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) = { ... }
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) = { ... }
int getJobStateValue()
Output only. The state of the NotebookExecutionJob.
.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
JobState getJobState()
Output only. The state of the NotebookExecutionJob.
.google.cloud.aiplatform.v1beta1.JobState job_state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];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];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];boolean hasCreateTime()
Output only. Timestamp when this NotebookExecutionJob was created.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
boolean hasUpdateTime()
Output only. Timestamp when this NotebookExecutionJob was most recently updated.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
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;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;@Deprecated Map<String,String> getLabels()
getLabelsMap() instead.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;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;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;String getKernelName()
The name of the kernel to use during notebook execution. If unset, the default kernel is used.
string kernel_name = 20;com.google.protobuf.ByteString getKernelNameBytes()
The name of the kernel to use during notebook execution. If unset, the default kernel is used.
string kernel_name = 20;boolean hasEncryptionSpec()
Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookRuntimeTemplate][google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate] has an encryption spec.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;EncryptionSpec getEncryptionSpec()
Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookRuntimeTemplate][google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate] has an encryption spec.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the [NotebookRuntimeTemplate][google.cloud.aiplatform.v1beta1.NotebookRuntimeTemplate] has an encryption spec.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 22;NotebookExecutionJob.NotebookSourceCase getNotebookSourceCase()
NotebookExecutionJob.EnvironmentSpecCase getEnvironmentSpecCase()
NotebookExecutionJob.ExecutionSinkCase getExecutionSinkCase()
NotebookExecutionJob.ExecutionIdentityCase getExecutionIdentityCase()
NotebookExecutionJob.RuntimeEnvironmentCase getRuntimeEnvironmentCase()
Copyright © 2025 Google LLC. All rights reserved.