Class BatchPredictionJob.OutputConfig (3.30.0)

public static final class BatchPredictionJob.OutputConfig extends GeneratedMessageV3 implements BatchPredictionJob.OutputConfigOrBuilder

Configures the output of BatchPredictionJob. See Model.supported_output_storage_formats for supported output formats, and how predictions are expressed via any of them.

Protobuf type google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchPredictionJob.OutputConfig

Static Fields

BIGQUERY_DESTINATION_FIELD_NUMBER

public static final int BIGQUERY_DESTINATION_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTIONS_FORMAT_FIELD_NUMBER

public static final int PREDICTIONS_FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchPredictionJob.OutputConfig getDefaultInstance()
Returns
TypeDescription
BatchPredictionJob.OutputConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BatchPredictionJob.OutputConfig.Builder newBuilder()
Returns
TypeDescription
BatchPredictionJob.OutputConfig.Builder

newBuilder(BatchPredictionJob.OutputConfig prototype)

public static BatchPredictionJob.OutputConfig.Builder newBuilder(BatchPredictionJob.OutputConfig prototype)
Parameter
NameDescription
prototypeBatchPredictionJob.OutputConfig
Returns
TypeDescription
BatchPredictionJob.OutputConfig.Builder

parseDelimitedFrom(InputStream input)

public static BatchPredictionJob.OutputConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.OutputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BatchPredictionJob.OutputConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.OutputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchPredictionJob.OutputConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.OutputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchPredictionJob.OutputConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.OutputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BatchPredictionJob.OutputConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.OutputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BatchPredictionJob.OutputConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.OutputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchPredictionJob.OutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BatchPredictionJob.OutputConfig> parser()
Returns
TypeDescription
Parser<OutputConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBigqueryDestination()

public BigQueryDestination getBigqueryDestination()

The BigQuery project or dataset location where the output is to be written to. If project is provided, a new dataset is created with name prediction_<model-display-name>_<job-create-time> where <model-display-name> is made BigQuery-dataset-name compatible (for example, most special characters become underscores), and timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset two tables will be created, predictions, and errors. If the Model has both instance and prediction schemata defined then the tables have columns as follows: The predictions table contains instances for which the prediction succeeded, it has columns as per a concatenation of the Model's instance and prediction schemata. The errors table contains rows for which the prediction has failed, it has instance columns, as per the instance schema, followed by a single "errors" column, which as values has google.rpc.Status represented as a STRUCT, and containing only code and message.

.google.cloud.aiplatform.v1.BigQueryDestination bigquery_destination = 3;

Returns
TypeDescription
BigQueryDestination

The bigqueryDestination.

getBigqueryDestinationOrBuilder()

public BigQueryDestinationOrBuilder getBigqueryDestinationOrBuilder()

The BigQuery project or dataset location where the output is to be written to. If project is provided, a new dataset is created with name prediction_<model-display-name>_<job-create-time> where <model-display-name> is made BigQuery-dataset-name compatible (for example, most special characters become underscores), and timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset two tables will be created, predictions, and errors. If the Model has both instance and prediction schemata defined then the tables have columns as follows: The predictions table contains instances for which the prediction succeeded, it has columns as per a concatenation of the Model's instance and prediction schemata. The errors table contains rows for which the prediction has failed, it has instance columns, as per the instance schema, followed by a single "errors" column, which as values has google.rpc.Status represented as a STRUCT, and containing only code and message.

.google.cloud.aiplatform.v1.BigQueryDestination bigquery_destination = 3;

Returns
TypeDescription
BigQueryDestinationOrBuilder

getDefaultInstanceForType()

public BatchPredictionJob.OutputConfig getDefaultInstanceForType()
Returns
TypeDescription
BatchPredictionJob.OutputConfig

getDestinationCase()

public BatchPredictionJob.OutputConfig.DestinationCase getDestinationCase()
Returns
TypeDescription
BatchPredictionJob.OutputConfig.DestinationCase

getGcsDestination()

public GcsDestination getGcsDestination()

The Cloud Storage location of the directory where the output is to be written to. In the given directory a new directory is created. Its name is prediction-<model-display-name>-<job-create-time>, where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files predictions_0001.<extension>, predictions_0002.<extension>, ..., predictions_N.<extension> are created where <extension> depends on chosen predictions_format, and N may equal 0001 and depends on the total number of successfully predicted instances. If the Model has both instance and prediction schemata defined then each such file contains predictions as per the predictions_format. If prediction for any instance failed (partially or completely), then an additional errors_0001.<extension>, errors_0002.<extension>,..., errors_N.<extension> files are created (N depends on total number of failed predictions). These files contain the failed instances, as per their schema, followed by an additional error field which as value has google.rpc.Status containing only code and message fields.

.google.cloud.aiplatform.v1.GcsDestination gcs_destination = 2;

Returns
TypeDescription
GcsDestination

The gcsDestination.

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Cloud Storage location of the directory where the output is to be written to. In the given directory a new directory is created. Its name is prediction-<model-display-name>-<job-create-time>, where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files predictions_0001.<extension>, predictions_0002.<extension>, ..., predictions_N.<extension> are created where <extension> depends on chosen predictions_format, and N may equal 0001 and depends on the total number of successfully predicted instances. If the Model has both instance and prediction schemata defined then each such file contains predictions as per the predictions_format. If prediction for any instance failed (partially or completely), then an additional errors_0001.<extension>, errors_0002.<extension>,..., errors_N.<extension> files are created (N depends on total number of failed predictions). These files contain the failed instances, as per their schema, followed by an additional error field which as value has google.rpc.Status containing only code and message fields.

.google.cloud.aiplatform.v1.GcsDestination gcs_destination = 2;

Returns
TypeDescription
GcsDestinationOrBuilder

getParserForType()

public Parser<BatchPredictionJob.OutputConfig> getParserForType()
Returns
TypeDescription
Parser<OutputConfig>
Overrides

getPredictionsFormat()

public String getPredictionsFormat()

Required. The format in which Vertex AI gives the predictions, must be one of the Model's supported_output_storage_formats.

string predictions_format = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The predictionsFormat.

getPredictionsFormatBytes()

public ByteString getPredictionsFormatBytes()

Required. The format in which Vertex AI gives the predictions, must be one of the Model's supported_output_storage_formats.

string predictions_format = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for predictionsFormat.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasBigqueryDestination()

public boolean hasBigqueryDestination()

The BigQuery project or dataset location where the output is to be written to. If project is provided, a new dataset is created with name prediction_<model-display-name>_<job-create-time> where <model-display-name> is made BigQuery-dataset-name compatible (for example, most special characters become underscores), and timestamp is in YYYY_MM_DDThh_mm_ss_sssZ "based on ISO-8601" format. In the dataset two tables will be created, predictions, and errors. If the Model has both instance and prediction schemata defined then the tables have columns as follows: The predictions table contains instances for which the prediction succeeded, it has columns as per a concatenation of the Model's instance and prediction schemata. The errors table contains rows for which the prediction has failed, it has instance columns, as per the instance schema, followed by a single "errors" column, which as values has google.rpc.Status represented as a STRUCT, and containing only code and message.

.google.cloud.aiplatform.v1.BigQueryDestination bigquery_destination = 3;

Returns
TypeDescription
boolean

Whether the bigqueryDestination field is set.

hasGcsDestination()

public boolean hasGcsDestination()

The Cloud Storage location of the directory where the output is to be written to. In the given directory a new directory is created. Its name is prediction-<model-display-name>-<job-create-time>, where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files predictions_0001.<extension>, predictions_0002.<extension>, ..., predictions_N.<extension> are created where <extension> depends on chosen predictions_format, and N may equal 0001 and depends on the total number of successfully predicted instances. If the Model has both instance and prediction schemata defined then each such file contains predictions as per the predictions_format. If prediction for any instance failed (partially or completely), then an additional errors_0001.<extension>, errors_0002.<extension>,..., errors_N.<extension> files are created (N depends on total number of failed predictions). These files contain the failed instances, as per their schema, followed by an additional error field which as value has google.rpc.Status containing only code and message fields.

.google.cloud.aiplatform.v1.GcsDestination gcs_destination = 2;

Returns
TypeDescription
boolean

Whether the gcsDestination field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BatchPredictionJob.OutputConfig.Builder newBuilderForType()
Returns
TypeDescription
BatchPredictionJob.OutputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchPredictionJob.OutputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BatchPredictionJob.OutputConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BatchPredictionJob.OutputConfig.Builder toBuilder()
Returns
TypeDescription
BatchPredictionJob.OutputConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException