Class Schema (1.3.0)

publicfinalclass SchemaextendsGeneratedMessageV3implementsSchemaOrBuilder

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.

Protobuf type google.cloud.vertexai.v1.Schema

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Schema

Implements

SchemaOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.notify()

Object.wait()

Object.wait(long,int)

Static Fields

DEFAULT_FIELD_NUMBER

publicstaticfinalintDEFAULT_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

ENUM_FIELD_NUMBER

publicstaticfinalintENUM_FIELD_NUMBER

Field Value
Type	Description
`int`

EXAMPLE_FIELD_NUMBER

publicstaticfinalintEXAMPLE_FIELD_NUMBER

Field Value
Type	Description
`int`

FORMAT_FIELD_NUMBER

publicstaticfinalintFORMAT_FIELD_NUMBER

Field Value
Type	Description
`int`

ITEMS_FIELD_NUMBER

publicstaticfinalintITEMS_FIELD_NUMBER

Field Value
Type	Description
`int`

MAXIMUM_FIELD_NUMBER

publicstaticfinalintMAXIMUM_FIELD_NUMBER

Field Value
Type	Description
`int`

MAX_ITEMS_FIELD_NUMBER

publicstaticfinalintMAX_ITEMS_FIELD_NUMBER

Field Value
Type	Description
`int`

MAX_LENGTH_FIELD_NUMBER

publicstaticfinalintMAX_LENGTH_FIELD_NUMBER

Field Value
Type	Description
`int`

MAX_PROPERTIES_FIELD_NUMBER

publicstaticfinalintMAX_PROPERTIES_FIELD_NUMBER

Field Value
Type	Description
`int`

MINIMUM_FIELD_NUMBER

publicstaticfinalintMINIMUM_FIELD_NUMBER

Field Value
Type	Description
`int`

MIN_ITEMS_FIELD_NUMBER

publicstaticfinalintMIN_ITEMS_FIELD_NUMBER

Field Value
Type	Description
`int`

MIN_LENGTH_FIELD_NUMBER

publicstaticfinalintMIN_LENGTH_FIELD_NUMBER

Field Value
Type	Description
`int`

MIN_PROPERTIES_FIELD_NUMBER

publicstaticfinalintMIN_PROPERTIES_FIELD_NUMBER

Field Value
Type	Description
`int`

NULLABLE_FIELD_NUMBER

publicstaticfinalintNULLABLE_FIELD_NUMBER

Field Value
Type	Description
`int`

PATTERN_FIELD_NUMBER

publicstaticfinalintPATTERN_FIELD_NUMBER

Field Value
Type	Description
`int`

PROPERTIES_FIELD_NUMBER

publicstaticfinalintPROPERTIES_FIELD_NUMBER

Field Value
Type	Description
`int`

REQUIRED_FIELD_NUMBER

publicstaticfinalintREQUIRED_FIELD_NUMBER

Field Value
Type	Description
`int`

TITLE_FIELD_NUMBER

publicstaticfinalintTITLE_FIELD_NUMBER

Field Value
Type	Description
`int`

TYPE_FIELD_NUMBER

publicstaticfinalintTYPE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

publicstaticSchemagetDefaultInstance()

Returns
Type	Description
`Schema`

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

publicstaticSchema.BuildernewBuilder()

Returns
Type	Description
`Schema.Builder`

newBuilder(Schema prototype)

publicstaticSchema.BuildernewBuilder(Schemaprototype)

Parameter
Name	Description
`prototype`	`Schema`

Returns
Type	Description
`Schema.Builder`

parseDelimitedFrom(InputStream input)

publicstaticSchemaparseDelimitedFrom(InputStreaminput)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSchemaparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

publicstaticSchemaparseFrom(byte[]data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticSchemaparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

publicstaticSchemaparseFrom(ByteStringdata)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticSchemaparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

publicstaticSchemaparseFrom(CodedInputStreaminput)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSchemaparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

publicstaticSchemaparseFrom(InputStreaminput)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSchemaparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

publicstaticSchemaparseFrom(ByteBufferdata)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticSchemaparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Schema`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

publicstaticParser<Schema>parser()

Returns
Type	Description
`Parser<Schema>`

Methods

containsProperties(String key)

publicbooleancontainsProperties(Stringkey)

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

equals(Object obj)

publicbooleanequals(Objectobj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefault()

publicValuegetDefault()

Optional. Default value of the data.

.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Value`	The default.

getDefaultInstanceForType()

publicSchemagetDefaultInstanceForType()

Returns
Type	Description
`Schema`

getDefaultOrBuilder()

publicValueOrBuildergetDefaultOrBuilder()

Optional. Default value of the data.

.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ValueOrBuilder`

getDescription()

publicStringgetDescription()

Optional. The description of the data.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

publicByteStringgetDescriptionBytes()

Optional. The description of the data.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for description.

getEnum(int index)

publicStringgetEnum(intindex)

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];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The enum at the given index.

getEnumBytes(int index)

publicByteStringgetEnumBytes(intindex)

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];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the enum at the given index.

getEnumCount()

publicintgetEnumCount()

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];

Returns
Type	Description
`int`	The count of enum.

getEnumList()

publicProtocolStringListgetEnumList()

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];

Returns
Type	Description
`ProtocolStringList`	A list containing the enum.

getExample()

publicValuegetExample()

Optional. Example of the object. Will only populated when the object is the root.

.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Value`	The example.

getExampleOrBuilder()

publicValueOrBuildergetExampleOrBuilder()

Optional. Example of the object. Will only populated when the object is the root.

.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ValueOrBuilder`

getFormat()

publicStringgetFormat()

Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The format.

getFormatBytes()

publicByteStringgetFormatBytes()

Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for format.

getItems()

publicSchemagetItems()

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

.google.cloud.vertexai.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Schema`	The items.

getItemsOrBuilder()

publicSchemaOrBuildergetItemsOrBuilder()

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

.google.cloud.vertexai.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SchemaOrBuilder`

getMaxItems()

publiclonggetMaxItems()

Optional. Maximum number of the elements for Type.ARRAY.

int64 max_items = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The maxItems.

getMaxLength()

publiclonggetMaxLength()

Optional. Maximum length of the Type.STRING

int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The maxLength.

getMaxProperties()

publiclonggetMaxProperties()

Optional. Maximum number of the properties for Type.OBJECT.

int64 max_properties = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The maxProperties.

getMaximum()

publicdoublegetMaximum()

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

double maximum = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`double`	The maximum.

getMinItems()

publiclonggetMinItems()

Optional. Minimum number of the elements for Type.ARRAY.

int64 min_items = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The minItems.

getMinLength()

publiclonggetMinLength()

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

int64 min_length = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The minLength.

getMinProperties()

publiclonggetMinProperties()

Optional. Minimum number of the properties for Type.OBJECT.

int64 min_properties = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`long`	The minProperties.

getMinimum()

publicdoublegetMinimum()

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

double minimum = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`double`	The minimum.

getNullable()

publicbooleangetNullable()

Optional. Indicates if the value may be null.

bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The nullable.

getParserForType()

publicParser<Schema>getParserForType()

Returns
Type	Description
`Parser<Schema>`

Overrides

GeneratedMessageV3.getParserForType()

getPattern()

publicStringgetPattern()

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The pattern.

getPatternBytes()

publicByteStringgetPatternBytes()

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for pattern.

getProperties() (deprecated)

publicMap<String,Schema>getProperties()

Use #getPropertiesMap() instead.

Returns
Type	Description
`Map<String,Schema>`

getPropertiesCount()

publicintgetPropertiesCount()

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getPropertiesMap()

publicMap<String,Schema>getPropertiesMap()

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,Schema>`

getPropertiesOrDefault(String key, Schema defaultValue)

publicSchemagetPropertiesOrDefault(Stringkey,SchemadefaultValue)

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`Schema`

Returns
Type	Description
`Schema`

getPropertiesOrThrow(String key)

publicSchemagetPropertiesOrThrow(Stringkey)

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Schema`

getRequired(int index)

publicStringgetRequired(intindex)

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The required at the given index.

getRequiredBytes(int index)

publicByteStringgetRequiredBytes(intindex)

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the required at the given index.

getRequiredCount()

publicintgetRequiredCount()

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of required.

getRequiredList()

publicProtocolStringListgetRequiredList()

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ProtocolStringList`	A list containing the required.

getSerializedSize()

publicintgetSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTitle()

publicStringgetTitle()

Optional. The title of the Schema.

string title = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The title.

getTitleBytes()

publicByteStringgetTitleBytes()

Optional. The title of the Schema.

string title = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for title.

getType()

publicTypegetType()

Optional. The type of the data.

.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Type`	The type.

getTypeValue()

publicintgetTypeValue()

Optional. The type of the data.

.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for type.

hasDefault()

publicbooleanhasDefault()

Optional. Default value of the data.

.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the default field is set.

hasExample()

publicbooleanhasExample()

Optional. Example of the object. Will only populated when the object is the root.

.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the example field is set.

hasItems()

publicbooleanhasItems()

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

.google.cloud.vertexai.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the items field is set.

hashCode()

publicinthashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

publicfinalbooleanisInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

publicSchema.BuildernewBuilderForType()

Returns
Type	Description
`Schema.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedSchema.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Schema.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

publicSchema.BuildertoBuilder()

Returns
Type	Description
`Schema.Builder`

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`

Class Schema (1.3.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Fields

DEFAULT_FIELD_NUMBER

DESCRIPTION_FIELD_NUMBER

ENUM_FIELD_NUMBER

EXAMPLE_FIELD_NUMBER

FORMAT_FIELD_NUMBER

ITEMS_FIELD_NUMBER

MAXIMUM_FIELD_NUMBER

MAX_ITEMS_FIELD_NUMBER

MAX_LENGTH_FIELD_NUMBER

MAX_PROPERTIES_FIELD_NUMBER

MINIMUM_FIELD_NUMBER

MIN_ITEMS_FIELD_NUMBER

MIN_LENGTH_FIELD_NUMBER

MIN_PROPERTIES_FIELD_NUMBER

NULLABLE_FIELD_NUMBER

PATTERN_FIELD_NUMBER

PROPERTIES_FIELD_NUMBER

REQUIRED_FIELD_NUMBER

TITLE_FIELD_NUMBER

TYPE_FIELD_NUMBER

Static Methods

getDefaultInstance()

getDescriptor()

newBuilder()

newBuilder(Schema prototype)

parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

Methods

containsProperties(String key)

equals(Object obj)

getDefault()

getDefaultInstanceForType()

getDefaultOrBuilder()

getDescription()

getDescriptionBytes()

getEnum(int index)

getEnumBytes(int index)

getEnumCount()

getEnumList()

getExample()

getExampleOrBuilder()

getFormat()

getFormatBytes()

getItems()

getItemsOrBuilder()

getMaxItems()

getMaxLength()

getMaxProperties()

getMaximum()

getMinItems()

getMinLength()

getMinProperties()

getMinimum()

getNullable()

getParserForType()

getPattern()

getPatternBytes()

getProperties() (deprecated)

getPropertiesCount()

getPropertiesMap()

getPropertiesOrDefault(String key, Schema defaultValue)

getPropertiesOrThrow(String key)

getRequired(int index)

getRequiredBytes(int index)

Class Schema (1.3.0)