Class PredictSchemata (3.41.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.v1beta1.PredictSchemata

Static Fields

INSTANCE_SCHEMA_URI_FIELD_NUMBER

public static final int INSTANCE_SCHEMA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_SCHEMA_URI_FIELD_NUMBER

public static final int PARAMETERS_SCHEMA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

PREDICTION_SCHEMA_URI_FIELD_NUMBER

public static final int PREDICTION_SCHEMA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PredictSchemata getDefaultInstance()
Returns
TypeDescription
PredictSchemata

getDescriptor()

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

newBuilder()

public static PredictSchemata.Builder newBuilder()
Returns
TypeDescription
PredictSchemata.Builder

newBuilder(PredictSchemata prototype)

public static PredictSchemata.Builder newBuilder(PredictSchemata prototype)
Parameter
NameDescription
prototypePredictSchemata
Returns
TypeDescription
PredictSchemata.Builder

parseDelimitedFrom(InputStream input)

public static PredictSchemata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PredictSchemata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static PredictSchemata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PredictSchemata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static PredictSchemata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PredictSchemata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static PredictSchemata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PredictSchemata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static PredictSchemata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PredictSchemata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<PredictSchemata> parser()
Returns
TypeDescription
Parser<PredictSchemata>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PredictSchemata getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parametersSchemaUri.

getParserForType()

public Parser<PredictSchemata> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for predictionSchemaUri.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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 PredictSchemata.Builder newBuilderForType()
Returns
TypeDescription
PredictSchemata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public PredictSchemata.Builder toBuilder()
Returns
TypeDescription
PredictSchemata.Builder

writeTo(CodedOutputStream output)

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