Package com.google.cloud.aiplatform.v1

Class CustomJob.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<CustomJob.Builder>
com.google.cloud.aiplatform.v1.CustomJob.Builder
All Implemented Interfaces:
CustomJobOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CustomJob
public static final class CustomJob.Builder extends com.google.protobuf.GeneratedMessage.Builder<CustomJob.Builder> implements CustomJobOrBuilder
 Represents a job that runs custom workloads such as a Docker container or a
 Python package. A CustomJob can have multiple worker pools and each worker
 pool can have its own machine and input spec. A CustomJob will be cleaned up
 once the job enters terminal state (failed or succeeded).
Protobuf type google.cloud.aiplatform.v1.CustomJob

  • 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.Builder<CustomJob.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<CustomJob.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<CustomJob.Builder>

    • clear

      public CustomJob.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<CustomJob.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<CustomJob.Builder>

    • getDefaultInstanceForType

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

    • build

      public CustomJob build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public CustomJob buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public CustomJob.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJob.Builder>

    • mergeFrom

      public CustomJob.Builder mergeFrom(CustomJob other)

    • isInitialized

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

    • mergeFrom

      public CustomJob.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomJob.Builder>
      Throws:
      IOException

    • getName

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

    • getNameBytes

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

    • setName

      public CustomJob.Builder setName(String value)
       Output only. Resource name of a CustomJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public CustomJob.Builder clearName()
       Output only. Resource name of a CustomJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setNameBytes

      public CustomJob.Builder setNameBytes(com.google.protobuf.ByteString value)
       Output only. Resource name of a CustomJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public 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];
      Specified by:
      getDisplayName in interface CustomJobOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

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

    • setDisplayName

      public CustomJob.Builder setDisplayName(String value)
       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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public CustomJob.Builder clearDisplayName()
       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:
      This builder for chaining.

    • setDisplayNameBytes

      public CustomJob.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • hasJobSpec

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

    • getJobSpec

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

    • setJobSpec

      public CustomJob.Builder setJobSpec(CustomJobSpec value)
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

    • setJobSpec

      public CustomJob.Builder setJobSpec(CustomJobSpec.Builder builderForValue)
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

    • mergeJobSpec

      public CustomJob.Builder mergeJobSpec(CustomJobSpec value)
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

    • clearJobSpec

      public CustomJob.Builder clearJobSpec()
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

    • getJobSpecBuilder

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

    • getJobSpecOrBuilder

      public CustomJobSpecOrBuilder getJobSpecOrBuilder()
       Required. Job spec.
      .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getJobSpecOrBuilder in interface CustomJobOrBuilder

    • getStateValue

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

    • setStateValue

      public CustomJob.Builder setStateValue(int value)
       Output only. The detailed state of the job.
      .google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.

    • getState

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

    • setState

      public CustomJob.Builder setState(JobState value)
       Output only. The detailed state of the job.
      .google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • clearState

      public CustomJob.Builder clearState()
       Output only. The detailed state of the job.
      .google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasCreateTime

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

    • getCreateTime

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

    • setCreateTime

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

    • setCreateTime

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

    • mergeCreateTime

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

    • clearCreateTime

      public CustomJob.Builder clearCreateTime()
       Output only. Time when the CustomJob was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getCreateTimeBuilder

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

    • getCreateTimeOrBuilder

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

    • hasStartTime

      public 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];
      Specified by:
      hasStartTime in interface CustomJobOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public 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];
      Specified by:
      getStartTime in interface CustomJobOrBuilder
      Returns:
      The startTime.

    • setStartTime

      public CustomJob.Builder setStartTime(com.google.protobuf.Timestamp value)
       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];

    • setStartTime

      public CustomJob.Builder setStartTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeStartTime

      public CustomJob.Builder mergeStartTime(com.google.protobuf.Timestamp value)
       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];

    • clearStartTime

      public CustomJob.Builder clearStartTime()
       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];

    • getStartTimeBuilder

      public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()
       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];

    • getStartTimeOrBuilder

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

    • hasEndTime

      public 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];
      Specified by:
      hasEndTime in interface CustomJobOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public 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];
      Specified by:
      getEndTime in interface CustomJobOrBuilder
      Returns:
      The endTime.

    • setEndTime

      public CustomJob.Builder setEndTime(com.google.protobuf.Timestamp value)
       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];

    • setEndTime

      public CustomJob.Builder setEndTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeEndTime

      public CustomJob.Builder mergeEndTime(com.google.protobuf.Timestamp value)
       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];

    • clearEndTime

      public CustomJob.Builder clearEndTime()
       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];

    • getEndTimeBuilder

      public com.google.protobuf.Timestamp.Builder getEndTimeBuilder()
       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];

    • getEndTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTime

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

    • setUpdateTime

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

    • setUpdateTime

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

    • mergeUpdateTime

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

    • clearUpdateTime

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

    • getUpdateTimeBuilder

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

    • getUpdateTimeOrBuilder

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

    • hasError

      public 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];
      Specified by:
      hasError in interface CustomJobOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public 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];
      Specified by:
      getError in interface CustomJobOrBuilder
      Returns:
      The error.

    • setError

      public CustomJob.Builder setError(Status value)
       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];

    • setError

      public CustomJob.Builder setError(Status.Builder builderForValue)
       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];

    • mergeError

      public CustomJob.Builder mergeError(Status value)
       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];

    • clearError

      public CustomJob.Builder clearError()
       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];

    • getErrorBuilder

      public Status.Builder getErrorBuilder()
       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];

    • getErrorOrBuilder

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

    • getLabelsCount

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

    • containsLabels

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

    • getLabels

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

    • getLabelsMap

      public 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;
      Specified by:
      getLabelsMap in interface CustomJobOrBuilder

    • getLabelsOrDefault

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

    • getLabelsOrThrow

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

    • clearLabels

      public CustomJob.Builder clearLabels()

    • removeLabels

      public CustomJob.Builder removeLabels(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;

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      public CustomJob.Builder putLabels(String key, String value)
       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;

    • putAllLabels

      public CustomJob.Builder putAllLabels(Map<String,String> values)
       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

      public 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;
      Specified by:
      hasEncryptionSpec in interface CustomJobOrBuilder
      Returns:
      Whether the encryptionSpec field is set.

    • getEncryptionSpec

      public 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;
      Specified by:
      getEncryptionSpec in interface CustomJobOrBuilder
      Returns:
      The encryptionSpec.

    • setEncryptionSpec

      public CustomJob.Builder setEncryptionSpec(EncryptionSpec value)
       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;

    • setEncryptionSpec

      public CustomJob.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)
       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;

    • mergeEncryptionSpec

      public CustomJob.Builder mergeEncryptionSpec(EncryptionSpec value)
       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;

    • clearEncryptionSpec

      public CustomJob.Builder clearEncryptionSpec()
       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;

    • getEncryptionSpecBuilder

      public EncryptionSpec.Builder getEncryptionSpecBuilder()
       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;

    • getEncryptionSpecOrBuilder

      public 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;
      Specified by:
      getEncryptionSpecOrBuilder in interface CustomJobOrBuilder

    • getWebAccessUrisCount

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

    • containsWebAccessUris

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

    • getWebAccessUris

      @Deprecated public Map<String,String> getWebAccessUris()
      Deprecated.
      Use getWebAccessUrisMap() instead.
      Specified by:
      getWebAccessUris in interface CustomJobOrBuilder

    • getWebAccessUrisMap

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

    • getWebAccessUrisOrDefault

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

    • getWebAccessUrisOrThrow

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

    • clearWebAccessUris

      public CustomJob.Builder clearWebAccessUris()

    • removeWebAccessUris

      public CustomJob.Builder removeWebAccessUris(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];

    • getMutableWebAccessUris

      @Deprecated public Map<String,String> getMutableWebAccessUris()
      Deprecated.
      Use alternate mutation accessors instead.

    • putWebAccessUris

      public CustomJob.Builder putWebAccessUris(String key, String value)
       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];

    • putAllWebAccessUris

      public CustomJob.Builder putAllWebAccessUris(Map<String,String> values)
       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

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

    • setSatisfiesPzs

      public CustomJob.Builder setSatisfiesPzs(boolean value)
       Output only. Reserved for future use.
      bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzs to set.
      Returns:
      This builder for chaining.

    • clearSatisfiesPzs

      public CustomJob.Builder clearSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getSatisfiesPzi

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

    • setSatisfiesPzi

      public CustomJob.Builder setSatisfiesPzi(boolean value)
       Output only. Reserved for future use.
      bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzi to set.
      Returns:
      This builder for chaining.

    • clearSatisfiesPzi

      public CustomJob.Builder clearSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.