Class PredictSchemata (3.42.0)

public final class PredictSchemata extends GeneratedMessageV3 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 Fields

INSTANCE_SCHEMA_URI_FIELD_NUMBER

public static final int INSTANCE_SCHEMA_URI_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_SCHEMA_URI_FIELD_NUMBER

public static final int PARAMETERS_SCHEMA_URI_FIELD_NUMBER
Field Value
Type Description
int

PREDICTION_SCHEMA_URI_FIELD_NUMBER

public static final int PREDICTION_SCHEMA_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PredictSchemata getDefaultInstance()
Returns
Type Description
PredictSchemata

getDescriptor()

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

newBuilder()

public static PredictSchemata.Builder newBuilder()
Returns
Type Description
PredictSchemata.Builder

newBuilder(PredictSchemata prototype)

public static PredictSchemata.Builder newBuilder(PredictSchemata prototype)
Parameter
Name Description
prototype PredictSchemata
Returns
Type Description
PredictSchemata.Builder

parseDelimitedFrom(InputStream input)

public static PredictSchemata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PredictSchemata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictSchemata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictSchemata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PredictSchemata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PredictSchemata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PredictSchemata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictSchemata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PredictSchemata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PredictSchemata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PredictSchemata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictSchemata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PredictSchemata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PredictSchemata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictSchemata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictSchemata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PredictSchemata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PredictSchemata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictSchemata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictSchemata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PredictSchemata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PredictSchemata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PredictSchemata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictSchemata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PredictSchemata> parser()
Returns
Type Description
Parser<PredictSchemata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PredictSchemata getDefaultInstanceForType()
Returns
Type Description
PredictSchemata

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.

getParserForType()

public Parser<PredictSchemata> getParserForType()
Returns
Type Description
Parser<PredictSchemata>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PredictSchemata.Builder newBuilderForType()
Returns
Type Description
PredictSchemata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PredictSchemata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PredictSchemata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PredictSchemata.Builder toBuilder()
Returns
Type Description
PredictSchemata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException