Class BatchJob.Builder

java.lang.Object
com.google.genai.types.BatchJob.Builder
Enclosing class:
BatchJob

public abstract static class BatchJob.Builder extends Object
Builder for BatchJob.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • name

      public abstract BatchJob.Builder name(String name)
      Setter for name.

      name: The resource name of the BatchJob. Output only.".

    • clearName

      @CanIgnoreReturnValue public BatchJob.Builder clearName()
      Clears the value of name field.
    • displayName

      public abstract BatchJob.Builder displayName(String displayName)
      Setter for displayName.

      displayName: The display name of the BatchJob.

    • clearDisplayName

      @CanIgnoreReturnValue public BatchJob.Builder clearDisplayName()
      Clears the value of displayName field.
    • state

      public abstract BatchJob.Builder state(JobState state)
      Setter for state.

      state: The state of the BatchJob.

    • clearState

      @CanIgnoreReturnValue public BatchJob.Builder clearState()
      Clears the value of state field.
    • state

      @CanIgnoreReturnValue public BatchJob.Builder state(JobState.Known knownType)
      Setter for state given a known enum.

      state: The state of the BatchJob.

    • state

      @CanIgnoreReturnValue public BatchJob.Builder state(String state)
      Setter for state given a string.

      state: The state of the BatchJob.

    • error

      public abstract BatchJob.Builder error(JobError error)
      Setter for error.

      error: Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

    • error

      @CanIgnoreReturnValue public BatchJob.Builder error(JobError.Builder errorBuilder)
      Setter for error builder.

      error: Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

    • clearError

      @CanIgnoreReturnValue public BatchJob.Builder clearError()
      Clears the value of error field.
    • createTime

      public abstract BatchJob.Builder createTime(Instant createTime)
      Setter for createTime.

      createTime: The time when the BatchJob was created.

    • clearCreateTime

      @CanIgnoreReturnValue public BatchJob.Builder clearCreateTime()
      Clears the value of createTime field.
    • startTime

      public abstract BatchJob.Builder startTime(Instant startTime)
      Setter for startTime.

      startTime: Output only. Time when the Job for the first time entered the `JOB_STATE_RUNNING` state.

    • clearStartTime

      @CanIgnoreReturnValue public BatchJob.Builder clearStartTime()
      Clears the value of startTime field.
    • endTime

      public abstract BatchJob.Builder endTime(Instant endTime)
      Setter for endTime.

      endTime: The time when the BatchJob was completed. This field is for Vertex AI only.

    • clearEndTime

      @CanIgnoreReturnValue public BatchJob.Builder clearEndTime()
      Clears the value of endTime field.
    • updateTime

      public abstract BatchJob.Builder updateTime(Instant updateTime)
      Setter for updateTime.

      updateTime: The time when the BatchJob was last updated.

    • clearUpdateTime

      @CanIgnoreReturnValue public BatchJob.Builder clearUpdateTime()
      Clears the value of updateTime field.
    • model

      public abstract BatchJob.Builder model(String model)
      Setter for model.

      model: The name of the model that produces the predictions via the BatchJob.

    • clearModel

      @CanIgnoreReturnValue public BatchJob.Builder clearModel()
      Clears the value of model field.
    • src

      public abstract BatchJob.Builder src(BatchJobSource src)
      Setter for src.

      src: Configuration for the input data. This field is for Vertex AI only.

    • src

      @CanIgnoreReturnValue public BatchJob.Builder src(BatchJobSource.Builder srcBuilder)
      Setter for src builder.

      src: Configuration for the input data. This field is for Vertex AI only.

    • clearSrc

      @CanIgnoreReturnValue public BatchJob.Builder clearSrc()
      Clears the value of src field.
    • dest

      public abstract BatchJob.Builder dest(BatchJobDestination dest)
      Setter for dest.

      dest: Configuration for the output data.

    • dest

      @CanIgnoreReturnValue public BatchJob.Builder dest(BatchJobDestination.Builder destBuilder)
      Setter for dest builder.

      dest: Configuration for the output data.

    • clearDest

      @CanIgnoreReturnValue public BatchJob.Builder clearDest()
      Clears the value of dest field.
    • completionStats

      public abstract BatchJob.Builder completionStats(CompletionStats completionStats)
      Setter for completionStats.

      completionStats: Statistics on completed and failed prediction instances. This field is for Vertex AI only.

    • completionStats

      @CanIgnoreReturnValue public BatchJob.Builder completionStats(CompletionStats.Builder completionStatsBuilder)
      Setter for completionStats builder.

      completionStats: Statistics on completed and failed prediction instances. This field is for Vertex AI only.

    • clearCompletionStats

      @CanIgnoreReturnValue public BatchJob.Builder clearCompletionStats()
      Clears the value of completionStats field.
    • build

      public abstract BatchJob build()