Package com.google.cloud.aiplatform.v1

Class BatchPredictionJob.OutputConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig
All Implemented Interfaces:
BatchPredictionJob.OutputConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
BatchPredictionJob
public static final class BatchPredictionJob.OutputConfig extends com.google.protobuf.GeneratedMessage implements BatchPredictionJob.OutputConfigOrBuilder
 Configures the output of
 [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. See
 [Model.supported_output_storage_formats][google.cloud.aiplatform.v1.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
See Also:

  • Field Details

    • GCS_DESTINATION_FIELD_NUMBER

      public static final int GCS_DESTINATION_FIELD_NUMBER
      See Also:

    • BIGQUERY_DESTINATION_FIELD_NUMBER

      public static final int BIGQUERY_DESTINATION_FIELD_NUMBER
      See Also:

    • VERTEX_MULTIMODAL_DATASET_DESTINATION_FIELD_NUMBER

      public static final int VERTEX_MULTIMODAL_DATASET_DESTINATION_FIELD_NUMBER
      See Also:

    • PREDICTIONS_FORMAT_FIELD_NUMBER

      public static final int PREDICTIONS_FORMAT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDestinationCase

      public BatchPredictionJob.OutputConfig.DestinationCase getDestinationCase()
      Specified by:
      getDestinationCase in interface BatchPredictionJob.OutputConfigOrBuilder

    • 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][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format],
 and N may equal 0001 and depends on the total number of successfully
 predicted instances. If the Model has both
 [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
 schemata defined then each such file contains predictions as per the
 [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.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][google.rpc.Status]
 containing only `code` and `message` fields.
      .google.cloud.aiplatform.v1.GcsDestination gcs_destination = 2;
      Specified by:
      hasGcsDestination in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      Whether the gcsDestination field is set.

    • 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][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format],
 and N may equal 0001 and depends on the total number of successfully
 predicted instances. If the Model has both
 [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
 schemata defined then each such file contains predictions as per the
 [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.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][google.rpc.Status]
 containing only `code` and `message` fields.
      .google.cloud.aiplatform.v1.GcsDestination gcs_destination = 2;
      Specified by:
      getGcsDestination in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      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][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.predictions_format],
 and N may equal 0001 and depends on the total number of successfully
 predicted instances. If the Model has both
 [instance][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
 schemata defined then each such file contains predictions as per the
 [predictions_format][google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig.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][google.rpc.Status]
 containing only `code` and `message` fields.
      .google.cloud.aiplatform.v1.GcsDestination gcs_destination = 2;
      Specified by:
      getGcsDestinationOrBuilder in interface BatchPredictionJob.OutputConfigOrBuilder

    • 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][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
 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][google.rpc.Status]
 represented as a STRUCT, and containing only `code` and `message`.
      .google.cloud.aiplatform.v1.BigQueryDestination bigquery_destination = 3;
      Specified by:
      hasBigqueryDestination in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      Whether the bigqueryDestination field is set.

    • 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][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
 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][google.rpc.Status]
 represented as a STRUCT, and containing only `code` and `message`.
      .google.cloud.aiplatform.v1.BigQueryDestination bigquery_destination = 3;
      Specified by:
      getBigqueryDestination in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      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][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri]
 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][google.rpc.Status]
 represented as a STRUCT, and containing only `code` and `message`.
      .google.cloud.aiplatform.v1.BigQueryDestination bigquery_destination = 3;
      Specified by:
      getBigqueryDestinationOrBuilder in interface BatchPredictionJob.OutputConfigOrBuilder

    • hasVertexMultimodalDatasetDestination

      public boolean hasVertexMultimodalDatasetDestination()
       The details for a Vertex Multimodal Dataset that will be created for
 the output.
      .google.cloud.aiplatform.v1.VertexMultimodalDatasetDestination vertex_multimodal_dataset_destination = 6;
      Specified by:
      hasVertexMultimodalDatasetDestination in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      Whether the vertexMultimodalDatasetDestination field is set.

    • getVertexMultimodalDatasetDestination

      public VertexMultimodalDatasetDestination getVertexMultimodalDatasetDestination()
       The details for a Vertex Multimodal Dataset that will be created for
 the output.
      .google.cloud.aiplatform.v1.VertexMultimodalDatasetDestination vertex_multimodal_dataset_destination = 6;
      Specified by:
      getVertexMultimodalDatasetDestination in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      The vertexMultimodalDatasetDestination.

    • getVertexMultimodalDatasetDestinationOrBuilder

      public VertexMultimodalDatasetDestinationOrBuilder getVertexMultimodalDatasetDestinationOrBuilder()
       The details for a Vertex Multimodal Dataset that will be created for
 the output.
      .google.cloud.aiplatform.v1.VertexMultimodalDatasetDestination vertex_multimodal_dataset_destination = 6;
      Specified by:
      getVertexMultimodalDatasetDestinationOrBuilder in interface BatchPredictionJob.OutputConfigOrBuilder

    • getPredictionsFormat

      public String getPredictionsFormat()
       Required. The format in which Vertex AI gives the predictions, must be
 one of the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
      string predictions_format = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPredictionsFormat in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      The predictionsFormat.

    • getPredictionsFormatBytes

      public com.google.protobuf.ByteString getPredictionsFormatBytes()
       Required. The format in which Vertex AI gives the predictions, must be
 one of the [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
      string predictions_format = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPredictionsFormatBytes in interface BatchPredictionJob.OutputConfigOrBuilder
      Returns:
      The bytes for predictionsFormat.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchPredictionJob.OutputConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchPredictionJob.OutputConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchPredictionJob.OutputConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public BatchPredictionJob.OutputConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BatchPredictionJob.OutputConfig.Builder newBuilder()

    • newBuilder

      public static BatchPredictionJob.OutputConfig.Builder newBuilder(BatchPredictionJob.OutputConfig prototype)

    • toBuilder

      public BatchPredictionJob.OutputConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BatchPredictionJob.OutputConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BatchPredictionJob.OutputConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BatchPredictionJob.OutputConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<BatchPredictionJob.OutputConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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