Package com.google.cloud.aiplatform.v1

Class NotebookExecutionJob

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.NotebookExecutionJob
All Implemented Interfaces:
NotebookExecutionJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class NotebookExecutionJob extends com.google.protobuf.GeneratedMessage implements NotebookExecutionJobOrBuilder
 NotebookExecutionJob represents an instance of a notebook execution.
Protobuf type google.cloud.aiplatform.v1.NotebookExecutionJob
See Also:

  • Field Details

    • DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER

      public static final int DATAFORM_REPOSITORY_SOURCE_FIELD_NUMBER
      See Also:

    • GCS_NOTEBOOK_SOURCE_FIELD_NUMBER

      public static final int GCS_NOTEBOOK_SOURCE_FIELD_NUMBER
      See Also:

    • DIRECT_NOTEBOOK_SOURCE_FIELD_NUMBER

      public static final int DIRECT_NOTEBOOK_SOURCE_FIELD_NUMBER
      See Also:

    • NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER

      public static final int NOTEBOOK_RUNTIME_TEMPLATE_RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • CUSTOM_ENVIRONMENT_SPEC_FIELD_NUMBER

      public static final int CUSTOM_ENVIRONMENT_SPEC_FIELD_NUMBER
      See Also:

    • GCS_OUTPUT_URI_FIELD_NUMBER

      public static final int GCS_OUTPUT_URI_FIELD_NUMBER
      See Also:

    • EXECUTION_USER_FIELD_NUMBER

      public static final int EXECUTION_USER_FIELD_NUMBER
      See Also:

    • SERVICE_ACCOUNT_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_FIELD_NUMBER
      See Also:

    • WORKBENCH_RUNTIME_FIELD_NUMBER

      public static final int WORKBENCH_RUNTIME_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • EXECUTION_TIMEOUT_FIELD_NUMBER

      public static final int EXECUTION_TIMEOUT_FIELD_NUMBER
      See Also:

    • SCHEDULE_RESOURCE_NAME_FIELD_NUMBER

      public static final int SCHEDULE_RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • JOB_STATE_FIELD_NUMBER

      public static final int JOB_STATE_FIELD_NUMBER
      See Also:

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • KERNEL_NAME_FIELD_NUMBER

      public static final int KERNEL_NAME_FIELD_NUMBER
      See Also:

    • ENCRYPTION_SPEC_FIELD_NUMBER

      public static final int ENCRYPTION_SPEC_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getNotebookSourceCase

      public NotebookExecutionJob.NotebookSourceCase getNotebookSourceCase()
      Specified by:
      getNotebookSourceCase in interface NotebookExecutionJobOrBuilder

    • getEnvironmentSpecCase

      public NotebookExecutionJob.EnvironmentSpecCase getEnvironmentSpecCase()
      Specified by:
      getEnvironmentSpecCase in interface NotebookExecutionJobOrBuilder

    • getExecutionSinkCase

      public NotebookExecutionJob.ExecutionSinkCase getExecutionSinkCase()
      Specified by:
      getExecutionSinkCase in interface NotebookExecutionJobOrBuilder

    • getExecutionIdentityCase

      public NotebookExecutionJob.ExecutionIdentityCase getExecutionIdentityCase()
      Specified by:
      getExecutionIdentityCase in interface NotebookExecutionJobOrBuilder

    • getRuntimeEnvironmentCase

      public NotebookExecutionJob.RuntimeEnvironmentCase getRuntimeEnvironmentCase()
      Specified by:
      getRuntimeEnvironmentCase in interface NotebookExecutionJobOrBuilder

    • hasDataformRepositorySource

      public boolean hasDataformRepositorySource()
       The Dataform Repository pointing to a single file notebook repository.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.DataformRepositorySource dataform_repository_source = 3;
      Specified by:
      hasDataformRepositorySource in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the dataformRepositorySource field is set.

    • 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;
      Specified by:
      getDataformRepositorySource in interface NotebookExecutionJobOrBuilder
      Returns:
      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;
      Specified by:
      getDataformRepositorySourceOrBuilder in interface NotebookExecutionJobOrBuilder

    • 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;
      Specified by:
      hasGcsNotebookSource in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the gcsNotebookSource field is set.

    • 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;
      Specified by:
      getGcsNotebookSource in interface NotebookExecutionJobOrBuilder
      Returns:
      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;
      Specified by:
      getGcsNotebookSourceOrBuilder in interface NotebookExecutionJobOrBuilder

    • hasDirectNotebookSource

      public boolean hasDirectNotebookSource()
       The contents of an input notebook file.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
      Specified by:
      hasDirectNotebookSource in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the directNotebookSource field is set.

    • getDirectNotebookSource

      public NotebookExecutionJob.DirectNotebookSource getDirectNotebookSource()
       The contents of an input notebook file.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
      Specified by:
      getDirectNotebookSource in interface NotebookExecutionJobOrBuilder
      Returns:
      The directNotebookSource.

    • getDirectNotebookSourceOrBuilder

      public NotebookExecutionJob.DirectNotebookSourceOrBuilder getDirectNotebookSourceOrBuilder()
       The contents of an input notebook file.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.DirectNotebookSource direct_notebook_source = 17;
      Specified by:
      getDirectNotebookSourceOrBuilder in interface NotebookExecutionJobOrBuilder

    • hasNotebookRuntimeTemplateResourceName

      public boolean hasNotebookRuntimeTemplateResourceName()
       The NotebookRuntimeTemplate to source compute configuration from.
      string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      hasNotebookRuntimeTemplateResourceName in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the notebookRuntimeTemplateResourceName field is set.

    • getNotebookRuntimeTemplateResourceName

      public String getNotebookRuntimeTemplateResourceName()
       The NotebookRuntimeTemplate to source compute configuration from.
      string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getNotebookRuntimeTemplateResourceName in interface NotebookExecutionJobOrBuilder
      Returns:
      The notebookRuntimeTemplateResourceName.

    • getNotebookRuntimeTemplateResourceNameBytes

      public com.google.protobuf.ByteString getNotebookRuntimeTemplateResourceNameBytes()
       The NotebookRuntimeTemplate to source compute configuration from.
      string notebook_runtime_template_resource_name = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getNotebookRuntimeTemplateResourceNameBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for notebookRuntimeTemplateResourceName.

    • hasCustomEnvironmentSpec

      public boolean hasCustomEnvironmentSpec()
       The custom compute configuration for an execution job.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
      Specified by:
      hasCustomEnvironmentSpec in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the customEnvironmentSpec field is set.

    • getCustomEnvironmentSpec

      public NotebookExecutionJob.CustomEnvironmentSpec getCustomEnvironmentSpec()
       The custom compute configuration for an execution job.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.CustomEnvironmentSpec custom_environment_spec = 16;
      Specified by:
      getCustomEnvironmentSpec in interface NotebookExecutionJobOrBuilder
      Returns:
      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;
      Specified by:
      getCustomEnvironmentSpecOrBuilder in interface NotebookExecutionJobOrBuilder

    • hasGcsOutputUri

      public boolean hasGcsOutputUri()
       The Cloud Storage location to upload the result to. Format:
 `gs://bucket-name`
      string gcs_output_uri = 8;
      Specified by:
      hasGcsOutputUri in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the gcsOutputUri field is set.

    • getGcsOutputUri

      public String getGcsOutputUri()
       The Cloud Storage location to upload the result to. Format:
 `gs://bucket-name`
      string gcs_output_uri = 8;
      Specified by:
      getGcsOutputUri in interface NotebookExecutionJobOrBuilder
      Returns:
      The gcsOutputUri.

    • getGcsOutputUriBytes

      public com.google.protobuf.ByteString getGcsOutputUriBytes()
       The Cloud Storage location to upload the result to. Format:
 `gs://bucket-name`
      string gcs_output_uri = 8;
      Specified by:
      getGcsOutputUriBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for gcsOutputUri.

    • hasExecutionUser

      public boolean hasExecutionUser()
       The user email to run the execution as. Only supported by Colab runtimes.
      string execution_user = 9;
      Specified by:
      hasExecutionUser in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the executionUser field is set.

    • getExecutionUser

      public String getExecutionUser()
       The user email to run the execution as. Only supported by Colab runtimes.
      string execution_user = 9;
      Specified by:
      getExecutionUser in interface NotebookExecutionJobOrBuilder
      Returns:
      The executionUser.

    • getExecutionUserBytes

      public com.google.protobuf.ByteString getExecutionUserBytes()
       The user email to run the execution as. Only supported by Colab runtimes.
      string execution_user = 9;
      Specified by:
      getExecutionUserBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for executionUser.

    • hasServiceAccount

      public boolean hasServiceAccount()
       The service account to run the execution as.
      string service_account = 18;
      Specified by:
      hasServiceAccount in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the serviceAccount field is set.

    • getServiceAccount

      public String getServiceAccount()
       The service account to run the execution as.
      string service_account = 18;
      Specified by:
      getServiceAccount in interface NotebookExecutionJobOrBuilder
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      public com.google.protobuf.ByteString getServiceAccountBytes()
       The service account to run the execution as.
      string service_account = 18;
      Specified by:
      getServiceAccountBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for serviceAccount.

    • hasWorkbenchRuntime

      public boolean hasWorkbenchRuntime()
       The Workbench runtime configuration to use for the notebook execution.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
      Specified by:
      hasWorkbenchRuntime in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the workbenchRuntime field is set.

    • getWorkbenchRuntime

      public NotebookExecutionJob.WorkbenchRuntime getWorkbenchRuntime()
       The Workbench runtime configuration to use for the notebook execution.
      .google.cloud.aiplatform.v1.NotebookExecutionJob.WorkbenchRuntime workbench_runtime = 23;
      Specified by:
      getWorkbenchRuntime in interface NotebookExecutionJobOrBuilder
      Returns:
      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;
      Specified by:
      getWorkbenchRuntimeOrBuilder in interface NotebookExecutionJobOrBuilder

    • 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];
      Specified by:
      getName in interface NotebookExecutionJobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for name.

    • 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;
      Specified by:
      getDisplayName in interface NotebookExecutionJobOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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;
      Specified by:
      getDisplayNameBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for displayName.

    • hasExecutionTimeout

      public boolean hasExecutionTimeout()
       Max running time of the execution job in seconds (default 86400s / 24 hrs).
      .google.protobuf.Duration execution_timeout = 5;
      Specified by:
      hasExecutionTimeout in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the executionTimeout field is set.

    • getExecutionTimeout

      public com.google.protobuf.Duration getExecutionTimeout()
       Max running time of the execution job in seconds (default 86400s / 24 hrs).
      .google.protobuf.Duration execution_timeout = 5;
      Specified by:
      getExecutionTimeout in interface NotebookExecutionJobOrBuilder
      Returns:
      The executionTimeout.

    • getExecutionTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getExecutionTimeoutOrBuilder()
       Max running time of the execution job in seconds (default 86400s / 24 hrs).
      .google.protobuf.Duration execution_timeout = 5;
      Specified by:
      getExecutionTimeoutOrBuilder in interface NotebookExecutionJobOrBuilder

    • getScheduleResourceName

      public String getScheduleResourceName()
       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.resource_reference) = { ... }
      Specified by:
      getScheduleResourceName in interface NotebookExecutionJobOrBuilder
      Returns:
      The scheduleResourceName.

    • getScheduleResourceNameBytes

      public com.google.protobuf.ByteString getScheduleResourceNameBytes()
       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.resource_reference) = { ... }
      Specified by:
      getScheduleResourceNameBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for scheduleResourceName.

    • 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];
      Specified by:
      getJobStateValue in interface NotebookExecutionJobOrBuilder
      Returns:
      The enum numeric value on the wire for jobState.

    • 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];
      Specified by:
      getJobState in interface NotebookExecutionJobOrBuilder
      Returns:
      The jobState.

    • 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];
      Specified by:
      hasStatus in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the status field is set.

    • 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];
      Specified by:
      getStatus in interface NotebookExecutionJobOrBuilder
      Returns:
      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];
      Specified by:
      getStatusOrBuilder in interface NotebookExecutionJobOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this NotebookExecutionJob was created.
      .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface NotebookExecutionJobOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface NotebookExecutionJobOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface NotebookExecutionJobOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface NotebookExecutionJobOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: NotebookExecutionJobOrBuilder
       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;
      Specified by:
      getLabelsCount in interface NotebookExecutionJobOrBuilder

    • containsLabels

      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;
      Specified by:
      containsLabels in interface NotebookExecutionJobOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface NotebookExecutionJobOrBuilder

    • 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;
      Specified by:
      getLabelsMap in interface NotebookExecutionJobOrBuilder

    • getLabelsOrDefault

      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;
      Specified by:
      getLabelsOrDefault in interface NotebookExecutionJobOrBuilder

    • getLabelsOrThrow

      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;
      Specified by:
      getLabelsOrThrow in interface NotebookExecutionJobOrBuilder

    • 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;
      Specified by:
      getKernelName in interface NotebookExecutionJobOrBuilder
      Returns:
      The kernelName.

    • getKernelNameBytes

      public 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;
      Specified by:
      getKernelNameBytes in interface NotebookExecutionJobOrBuilder
      Returns:
      The bytes for kernelName.

    • hasEncryptionSpec

      public boolean hasEncryptionSpec()
       Customer-managed encryption key spec for the notebook execution job.
 This field is auto-populated if the
 [NotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookRuntimeTemplate]
 has an encryption spec.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 22;
      Specified by:
      hasEncryptionSpec in interface NotebookExecutionJobOrBuilder
      Returns:
      Whether the encryptionSpec field is set.

    • getEncryptionSpec

      public EncryptionSpec getEncryptionSpec()
       Customer-managed encryption key spec for the notebook execution job.
 This field is auto-populated if the
 [NotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookRuntimeTemplate]
 has an encryption spec.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 22;
      Specified by:
      getEncryptionSpec in interface NotebookExecutionJobOrBuilder
      Returns:
      The encryptionSpec.

    • getEncryptionSpecOrBuilder

      public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
       Customer-managed encryption key spec for the notebook execution job.
 This field is auto-populated if the
 [NotebookRuntimeTemplate][google.cloud.aiplatform.v1.NotebookRuntimeTemplate]
 has an encryption spec.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 22;
      Specified by:
      getEncryptionSpecOrBuilder in interface NotebookExecutionJobOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static NotebookExecutionJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NotebookExecutionJob parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NotebookExecutionJob parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NotebookExecutionJob parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NotebookExecutionJob parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NotebookExecutionJob parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NotebookExecutionJob parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NotebookExecutionJob parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NotebookExecutionJob parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NotebookExecutionJob parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NotebookExecutionJob parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NotebookExecutionJob parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public NotebookExecutionJob.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static NotebookExecutionJob.Builder newBuilder()

    • newBuilder

      public static NotebookExecutionJob.Builder newBuilder(NotebookExecutionJob prototype)

    • toBuilder

      public NotebookExecutionJob.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected NotebookExecutionJob.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static NotebookExecutionJob getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<NotebookExecutionJob> parser()

    • getParserForType

      public com.google.protobuf.Parser<NotebookExecutionJob> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public NotebookExecutionJob getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder