Package com.google.cloud.aiplatform.v1

Interface CustomJobOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CustomJob, CustomJob.Builder
@Generated public interface CustomJobOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Resource name of a CustomJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of a CustomJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getDisplayName

      String getDisplayName()
       Required. The display name of the CustomJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the CustomJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • hasJobSpec

      boolean hasJobSpec()
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the jobSpec field is set.

    • getJobSpec

      CustomJobSpec getJobSpec()
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The jobSpec.

    • getJobSpecOrBuilder

      CustomJobSpecOrBuilder getJobSpecOrBuilder()
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

    • getStateValue

      int getStateValue()
       Output only. The detailed state of the job.
      .google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      JobState getState()
       Output only. The detailed state of the job.
      .google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Time when the CustomJob was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Time when the CustomJob was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time when the CustomJob was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasStartTime

      boolean hasStartTime()
       Output only. Time when the CustomJob for the first time entered the
 `JOB_STATE_RUNNING` state.
      .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       Output only. Time when the CustomJob for the first time entered the
 `JOB_STATE_RUNNING` state.
      .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Output only. Time when the CustomJob for the first time entered the
 `JOB_STATE_RUNNING` state.
      .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasEndTime

      boolean hasEndTime()
       Output only. Time when the CustomJob entered any of the following states:
 `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
      .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the endTime field is set.

    • getEndTime

      com.google.protobuf.Timestamp getEndTime()
       Output only. Time when the CustomJob entered any of the following states:
 `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
      .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       Output only. Time when the CustomJob entered any of the following states:
 `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
      .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Time when the CustomJob was most recently updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Time when the CustomJob was most recently updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Time when the CustomJob was most recently updated.
      .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasError

      boolean hasError()
       Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the error field is set.

    • getError

      Status getError()
       Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The error.

    • getErrorOrBuilder

      StatusOrBuilder getErrorOrBuilder()
       Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getLabelsCount

      int getLabelsCount()
       The labels with user-defined metadata to organize CustomJobs.

 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.
      map<string, string> labels = 11;

    • containsLabels

      boolean containsLabels(String key)
       The labels with user-defined metadata to organize CustomJobs.

 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.
      map<string, string> labels = 11;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       The labels with user-defined metadata to organize CustomJobs.

 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.
      map<string, string> labels = 11;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       The labels with user-defined metadata to organize CustomJobs.

 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.
      map<string, string> labels = 11;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       The labels with user-defined metadata to organize CustomJobs.

 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.
      map<string, string> labels = 11;

    • hasEncryptionSpec

      boolean hasEncryptionSpec()
       Customer-managed encryption key options for a CustomJob. If this is set,
 then all resources created by the CustomJob will be encrypted with the
 provided encryption key.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;
      Returns:
      Whether the encryptionSpec field is set.

    • getEncryptionSpec

      EncryptionSpec getEncryptionSpec()
       Customer-managed encryption key options for a CustomJob. If this is set,
 then all resources created by the CustomJob will be encrypted with the
 provided encryption key.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;
      Returns:
      The encryptionSpec.

    • getEncryptionSpecOrBuilder

      EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
       Customer-managed encryption key options for a CustomJob. If this is set,
 then all resources created by the CustomJob will be encrypted with the
 provided encryption key.
      .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;

    • getWebAccessUrisCount

      int getWebAccessUrisCount()
       Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if
 [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 is `true`.

 The keys are names of each node in the training job; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
      map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • containsWebAccessUris

      boolean containsWebAccessUris(String key)
       Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if
 [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 is `true`.

 The keys are names of each node in the training job; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
      map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getWebAccessUris

      @Deprecated Map<String,String> getWebAccessUris()
      Deprecated.
      Use getWebAccessUrisMap() instead.

    • getWebAccessUrisMap

      Map<String,String> getWebAccessUrisMap()
       Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if
 [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 is `true`.

 The keys are names of each node in the training job; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
      map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getWebAccessUrisOrDefault

      String getWebAccessUrisOrDefault(String key, String defaultValue)
       Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if
 [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 is `true`.

 The keys are names of each node in the training job; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
      map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getWebAccessUrisOrThrow

      String getWebAccessUrisOrThrow(String key)
       Output only. URIs for accessing [interactive
 shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 (one URI for each training node). Only available if
 [job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
 is `true`.

 The keys are names of each node in the training job; for example,
 `workerpool0-0` for the primary node, `workerpool1-0` for the first node in
 the second worker pool, and `workerpool1-1` for the second node in the
 second worker pool.

 The values are the URIs for each node's interactive shell.
      map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzs.

    • getSatisfiesPzi

      boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzi.