Class PredictSchemata.Builder (3.54.0)

public static final class PredictSchemata.Builder extends GeneratedMessageV3.Builder<PredictSchemata.Builder> implements PredictSchemataOrBuilder

Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.

Protobuf type google.cloud.aiplatform.v1.PredictSchemata

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PredictSchemata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictSchemata.Builder
Overrides

build()

public PredictSchemata build()
Returns
Type Description
PredictSchemata

buildPartial()

public PredictSchemata buildPartial()
Returns
Type Description
PredictSchemata

clear()

public PredictSchemata.Builder clear()
Returns
Type Description
PredictSchemata.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PredictSchemata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PredictSchemata.Builder
Overrides

clearInstanceSchemaUri()

public PredictSchemata.Builder clearInstanceSchemaUri()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PredictSchemata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PredictSchemata.Builder
Overrides

clearParametersSchemaUri()

public PredictSchemata.Builder clearParametersSchemaUri()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

clearPredictionSchemaUri()

public PredictSchemata.Builder clearPredictionSchemaUri()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

clone()

public PredictSchemata.Builder clone()
Returns
Type Description
PredictSchemata.Builder
Overrides

getDefaultInstanceForType()

public PredictSchemata getDefaultInstanceForType()
Returns
Type Description
PredictSchemata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInstanceSchemaUri()

public String getInstanceSchemaUri()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The instanceSchemaUri.

getInstanceSchemaUriBytes()

public ByteString getInstanceSchemaUriBytes()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for instanceSchemaUri.

getParametersSchemaUri()

public String getParametersSchemaUri()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The parametersSchemaUri.

getParametersSchemaUriBytes()

public ByteString getParametersSchemaUriBytes()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for parametersSchemaUri.

getPredictionSchemaUri()

public String getPredictionSchemaUri()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The predictionSchemaUri.

getPredictionSchemaUriBytes()

public ByteString getPredictionSchemaUriBytes()

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for predictionSchemaUri.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PredictSchemata other)

public PredictSchemata.Builder mergeFrom(PredictSchemata other)
Parameter
Name Description
other PredictSchemata
Returns
Type Description
PredictSchemata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PredictSchemata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictSchemata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PredictSchemata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PredictSchemata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictSchemata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PredictSchemata.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PredictSchemata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictSchemata.Builder
Overrides

setInstanceSchemaUri(String value)

public PredictSchemata.Builder setInstanceSchemaUri(String value)

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The instanceSchemaUri to set.

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

setInstanceSchemaUriBytes(ByteString value)

public PredictSchemata.Builder setInstanceSchemaUriBytes(ByteString value)

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for instanceSchemaUri to set.

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

setParametersSchemaUri(String value)

public PredictSchemata.Builder setParametersSchemaUri(String value)

Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The parametersSchemaUri to set.

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

setParametersSchemaUriBytes(ByteString value)

public PredictSchemata.Builder setParametersSchemaUriBytes(ByteString value)

Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for parametersSchemaUri to set.

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

setPredictionSchemaUri(String value)

public PredictSchemata.Builder setPredictionSchemaUri(String value)

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The predictionSchemaUri to set.

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

setPredictionSchemaUriBytes(ByteString value)

public PredictSchemata.Builder setPredictionSchemaUriBytes(ByteString value)

Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for predictionSchemaUri to set.

Returns
Type Description
PredictSchemata.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PredictSchemata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PredictSchemata.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PredictSchemata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PredictSchemata.Builder
Overrides