com.google.cloud.aiplatform.v1

Class PredictSchemata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.PredictSchemata

All Implemented Interfaces:

PredictSchemataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PredictSchemata
extends com.google.protobuf.GeneratedMessageV3
implements PredictSchemataOrBuilder

 Contains the schemata used in Model's predictions and explanations via
 [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict],
 [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]
 and [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
 

Protobuf type google.cloud.aiplatform.v1.PredictSchemata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredictSchemata.Builder Contains the schemata used in Model's predictions and explanations via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict], [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain] and [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	INSTANCE_SCHEMA_URI_FIELD_NUMBER
static int	PARAMETERS_SCHEMA_URI_FIELD_NUMBER
static int	PREDICTION_SCHEMA_URI_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static PredictSchemata	getDefaultInstance()
PredictSchemata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getInstanceSchemaUri() Immutable.
com.google.protobuf.ByteString	getInstanceSchemaUriBytes() Immutable.
String	getParametersSchemaUri() Immutable.
com.google.protobuf.ByteString	getParametersSchemaUriBytes() Immutable.
com.google.protobuf.Parser<PredictSchemata>	getParserForType()
String	getPredictionSchemaUri() Immutable.
com.google.protobuf.ByteString	getPredictionSchemaUriBytes() Immutable.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PredictSchemata.Builder	newBuilder()
static PredictSchemata.Builder	newBuilder(PredictSchemata prototype)
PredictSchemata.Builder	newBuilderForType()
protected PredictSchemata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PredictSchemata	parseDelimitedFrom(InputStream input)
static PredictSchemata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictSchemata	parseFrom(byte[] data)
static PredictSchemata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictSchemata	parseFrom(ByteBuffer data)
static PredictSchemata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictSchemata	parseFrom(com.google.protobuf.ByteString data)
static PredictSchemata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictSchemata	parseFrom(com.google.protobuf.CodedInputStream input)
static PredictSchemata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictSchemata	parseFrom(InputStream input)
static PredictSchemata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PredictSchemata>	parser()
PredictSchemata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INSTANCE_SCHEMA_URI_FIELD_NUMBER

public static final int INSTANCE_SCHEMA_URI_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETERS_SCHEMA_URI_FIELD_NUMBER

public static final int PARAMETERS_SCHEMA_URI_FIELD_NUMBER

See Also:

Constant Field Values

PREDICTION_SCHEMA_URI_FIELD_NUMBER

public static final int PREDICTION_SCHEMA_URI_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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][google.cloud.aiplatform.v1.PredictRequest.instances],
 [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
 and
 [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];

Specified by:

getInstanceSchemaUri in interface PredictSchemataOrBuilder

Returns:

The instanceSchemaUri.

getInstanceSchemaUriBytes

public com.google.protobuf.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][google.cloud.aiplatform.v1.PredictRequest.instances],
 [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
 and
 [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];

Specified by:

getInstanceSchemaUriBytes in interface PredictSchemataOrBuilder

Returns:

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][google.cloud.aiplatform.v1.PredictRequest.parameters],
 [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
 and
 [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];

Specified by:

getParametersSchemaUri in interface PredictSchemataOrBuilder

Returns:

The parametersSchemaUri.

getParametersSchemaUriBytes

public com.google.protobuf.ByteString getParametersSchemaUriBytes()

 Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the parameters of prediction and explanation via
 [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
 [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
 and
 [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];

Specified by:

getParametersSchemaUriBytes in interface PredictSchemataOrBuilder

Returns:

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][google.cloud.aiplatform.v1.PredictResponse.predictions],
 [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
 and
 [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];

Specified by:

getPredictionSchemaUri in interface PredictSchemataOrBuilder

Returns:

The predictionSchemaUri.

getPredictionSchemaUriBytes

public com.google.protobuf.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][google.cloud.aiplatform.v1.PredictResponse.predictions],
 [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
 and
 [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];

Specified by:

getPredictionSchemaUriBytes in interface PredictSchemataOrBuilder

Returns:

The bytes for predictionSchemaUri.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 PredictSchemata parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictSchemata parseFrom(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictSchemata parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictSchemata parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictSchemata parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictSchemata parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictSchemata parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static PredictSchemata parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictSchemata parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictSchemata parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static PredictSchemata parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static PredictSchemata parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public PredictSchemata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PredictSchemata.Builder newBuilder()

newBuilder

public static PredictSchemata.Builder newBuilder(PredictSchemata prototype)

toBuilder

public PredictSchemata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PredictSchemata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PredictSchemata getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<PredictSchemata> 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.GeneratedMessageV3

getDefaultInstanceForType

public PredictSchemata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder