- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static interface BatchPredictionJob.OutputConfigOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getBigqueryDestination()
public abstract 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.v1beta1.BigQueryDestination bigquery_destination = 3;
Returns | |
---|---|
Type | Description |
BigQueryDestination |
The bigqueryDestination. |
getBigqueryDestinationOrBuilder()
public abstract 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.v1beta1.BigQueryDestination bigquery_destination = 3;
Returns | |
---|---|
Type | Description |
BigQueryDestinationOrBuilder |
getDestinationCase()
public abstract BatchPredictionJob.OutputConfig.DestinationCase getDestinationCase()
Returns | |
---|---|
Type | Description |
BatchPredictionJob.OutputConfig.DestinationCase |
getGcsDestination()
public abstract 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.v1beta1.GcsDestination gcs_destination = 2;
Returns | |
---|---|
Type | Description |
GcsDestination |
The gcsDestination. |
getGcsDestinationOrBuilder()
public abstract 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.v1beta1.GcsDestination gcs_destination = 2;
Returns | |
---|---|
Type | Description |
GcsDestinationOrBuilder |
getPredictionsFormat()
public abstract 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 | |
---|---|
Type | Description |
String |
The predictionsFormat. |
getPredictionsFormatBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString |
The bytes for predictionsFormat. |
hasBigqueryDestination()
public abstract 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.v1beta1.BigQueryDestination bigquery_destination = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the bigqueryDestination field is set. |
hasGcsDestination()
public abstract 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.v1beta1.GcsDestination gcs_destination = 2;
Returns | |
---|---|
Type | Description |
boolean |
Whether the gcsDestination field is set. |