public final class Schema extends com.google.protobuf.GeneratedMessageV3 implements SchemaOrBuilder
Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.Protobuf type
google.cloud.aiplatform.v1beta1.Schema| Modifier and Type | Class and Description |
|---|---|
static class |
Schema.Builder
Schema is used to define the format of input/output data.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
ENUM_FIELD_NUMBER |
static int |
EXAMPLE_FIELD_NUMBER |
static int |
FORMAT_FIELD_NUMBER |
static int |
ITEMS_FIELD_NUMBER |
static int |
NULLABLE_FIELD_NUMBER |
static int |
PROPERTIES_FIELD_NUMBER |
static int |
REQUIRED_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsProperties(String key)
Optional.
|
boolean |
equals(Object obj) |
static Schema |
getDefaultInstance() |
Schema |
getDefaultInstanceForType() |
String |
getDescription()
Optional.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Optional.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEnum(int index)
Optional.
|
com.google.protobuf.ByteString |
getEnumBytes(int index)
Optional.
|
int |
getEnumCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getEnumList()
Optional.
|
com.google.protobuf.Value |
getExample()
Optional.
|
com.google.protobuf.ValueOrBuilder |
getExampleOrBuilder()
Optional.
|
String |
getFormat()
Optional.
|
com.google.protobuf.ByteString |
getFormatBytes()
Optional.
|
Schema |
getItems()
Optional.
|
SchemaOrBuilder |
getItemsOrBuilder()
Optional.
|
boolean |
getNullable()
Optional.
|
com.google.protobuf.Parser<Schema> |
getParserForType() |
Map<String,Schema> |
getProperties()
Deprecated.
|
int |
getPropertiesCount()
Optional.
|
Map<String,Schema> |
getPropertiesMap()
Optional.
|
Schema |
getPropertiesOrDefault(String key,
Schema defaultValue)
Optional.
|
Schema |
getPropertiesOrThrow(String key)
Optional.
|
String |
getRequired(int index)
Optional.
|
com.google.protobuf.ByteString |
getRequiredBytes(int index)
Optional.
|
int |
getRequiredCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getRequiredList()
Optional.
|
int |
getSerializedSize() |
Type |
getType()
Optional.
|
int |
getTypeValue()
Optional.
|
boolean |
hasExample()
Optional.
|
int |
hashCode() |
boolean |
hasItems()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static Schema.Builder |
newBuilder() |
static Schema.Builder |
newBuilder(Schema prototype) |
Schema.Builder |
newBuilderForType() |
protected Schema.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Schema |
parseDelimitedFrom(InputStream input) |
static Schema |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Schema |
parseFrom(byte[] data) |
static Schema |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Schema |
parseFrom(ByteBuffer data) |
static Schema |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Schema |
parseFrom(com.google.protobuf.ByteString data) |
static Schema |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Schema |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Schema |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Schema |
parseFrom(InputStream input) |
static Schema |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Schema> |
parser() |
Schema.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TYPE_FIELD_NUMBER
public static final int FORMAT_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int NULLABLE_FIELD_NUMBER
public static final int ITEMS_FIELD_NUMBER
public static final int ENUM_FIELD_NUMBER
public static final int PROPERTIES_FIELD_NUMBER
public static final int REQUIRED_FIELD_NUMBER
public static final int EXAMPLE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public int getTypeValue()
Optional. The type of the data.
.google.cloud.aiplatform.v1beta1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
getTypeValue in interface SchemaOrBuilderpublic Type getType()
Optional. The type of the data.
.google.cloud.aiplatform.v1beta1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
getType in interface SchemaOrBuilderpublic String getFormat()
Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64
string format = 7 [(.google.api.field_behavior) = OPTIONAL];getFormat in interface SchemaOrBuilderpublic com.google.protobuf.ByteString getFormatBytes()
Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64
string format = 7 [(.google.api.field_behavior) = OPTIONAL];getFormatBytes in interface SchemaOrBuilderpublic String getDescription()
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];getDescription in interface SchemaOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];getDescriptionBytes in interface SchemaOrBuilderpublic boolean getNullable()
Optional. Indicates if the value may be null.
bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];getNullable in interface SchemaOrBuilderpublic boolean hasItems()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1beta1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
hasItems in interface SchemaOrBuilderpublic Schema getItems()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1beta1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
getItems in interface SchemaOrBuilderpublic SchemaOrBuilder getItemsOrBuilder()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1beta1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
getItemsOrBuilder in interface SchemaOrBuilderpublic com.google.protobuf.ProtocolStringList getEnumList()
Optional. Possible values of the element of Type.STRING with enum format.
For example we can define an Enum Direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];getEnumList in interface SchemaOrBuilderpublic int getEnumCount()
Optional. Possible values of the element of Type.STRING with enum format.
For example we can define an Enum Direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];getEnumCount in interface SchemaOrBuilderpublic String getEnum(int index)
Optional. Possible values of the element of Type.STRING with enum format.
For example we can define an Enum Direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];getEnum in interface SchemaOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getEnumBytes(int index)
Optional. Possible values of the element of Type.STRING with enum format.
For example we can define an Enum Direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];getEnumBytes in interface SchemaOrBuilderindex - The index of the value to return.public int getPropertiesCount()
SchemaOrBuilderOptional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
getPropertiesCount in interface SchemaOrBuilderpublic boolean containsProperties(String key)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
containsProperties in interface SchemaOrBuilder@Deprecated public Map<String,Schema> getProperties()
getPropertiesMap() instead.getProperties in interface SchemaOrBuilderpublic Map<String,Schema> getPropertiesMap()
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
getPropertiesMap in interface SchemaOrBuilderpublic Schema getPropertiesOrDefault(String key, Schema defaultValue)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
getPropertiesOrDefault in interface SchemaOrBuilderpublic Schema getPropertiesOrThrow(String key)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
getPropertiesOrThrow in interface SchemaOrBuilderpublic com.google.protobuf.ProtocolStringList getRequiredList()
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];getRequiredList in interface SchemaOrBuilderpublic int getRequiredCount()
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];getRequiredCount in interface SchemaOrBuilderpublic String getRequired(int index)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];getRequired in interface SchemaOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getRequiredBytes(int index)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];getRequiredBytes in interface SchemaOrBuilderindex - The index of the value to return.public boolean hasExample()
Optional. Example of the object. Will only populated when the object is the root.
.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];hasExample in interface SchemaOrBuilderpublic com.google.protobuf.Value getExample()
Optional. Example of the object. Will only populated when the object is the root.
.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];getExample in interface SchemaOrBuilderpublic com.google.protobuf.ValueOrBuilder getExampleOrBuilder()
Optional. Example of the object. Will only populated when the object is the root.
.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];getExampleOrBuilder in interface SchemaOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Schema parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Schema parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Schema parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Schema parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Schema parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Schema parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Schema parseFrom(InputStream input) throws IOException
IOExceptionpublic static Schema parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Schema parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Schema parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Schema parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Schema parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Schema.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Schema.Builder newBuilder()
public static Schema.Builder newBuilder(Schema prototype)
public Schema.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Schema.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Schema getDefaultInstance()
public static com.google.protobuf.Parser<Schema> parser()
public com.google.protobuf.Parser<Schema> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Schema getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.