google-genai/com.google.genai.types/BatchJob

BatchJob

public abstract class BatchJob extends JsonSerializable

Config for batches.create return value.

Constructors

Link copied to clipboard
public void BatchJob()

Types

Link copied to clipboard
public abstract class Builder
Builder for BatchJob.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public static BatchJob.Builder builder()
Instantiates a builder for BatchJob.
Link copied to clipboard
public abstract Optional<CompletionStats> completionStats()
Statistics on completed and failed prediction instances.
Link copied to clipboard
public abstract Optional<Instant> createTime()
The time when the BatchJob was created.
Link copied to clipboard
public abstract Optional<BatchJobDestination> dest()
Configuration for the output data.
Link copied to clipboard
public abstract Optional<String> displayName()
The display name of the BatchJob.
Link copied to clipboard
public abstract Optional<Instant> endTime()
The time when the BatchJob was completed.
Link copied to clipboard
public abstract Optional<JobError> error()
Output only.
Link copied to clipboard
public static BatchJob fromJson(String jsonString)
Deserializes a JSON string to a BatchJob object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public abstract Optional<String> model()
The name of the model that produces the predictions via the BatchJob.
Link copied to clipboard
public abstract Optional<String> name()
The resource name of the BatchJob.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<BatchJobOutputInfo> outputInfo()
Information further describing the output of this job.
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public abstract Optional<BatchJobSource> src()
Configuration for the input data.
Link copied to clipboard
public abstract Optional<Instant> startTime()
Output only.
Link copied to clipboard
public abstract Optional<JobState> state()
The state of the BatchJob.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract BatchJob.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<Instant> updateTime()
The time when the BatchJob was last updated.