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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
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 |
publicstaticfinalintFORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
ITEMS_FIELD_NUMBER
publicstaticfinalintITEMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NULLABLE_FIELD_NUMBER
publicstaticfinalintNULLABLE_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 |
TYPE_FIELD_NUMBER
publicstaticfinalintTYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticSchemagetDefaultInstance()
| Returns |
| Type |
Description |
Schema |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticSchema.BuildernewBuilder()
newBuilder(Schema prototype)
publicstaticSchema.BuildernewBuilder(Schemaprototype)
| Parameter |
| Name |
Description |
prototype |
Schema
|
publicstaticSchemaparseDelimitedFrom(InputStreaminput)
| Returns |
| Type |
Description |
Schema |
publicstaticSchemaparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Schema |
parseFrom(byte[] data)
publicstaticSchemaparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Schema |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticSchemaparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Schema |
parseFrom(ByteString data)
publicstaticSchemaparseFrom(ByteStringdata)
| Returns |
| Type |
Description |
Schema |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticSchemaparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Schema |
publicstaticSchemaparseFrom(CodedInputStreaminput)
| Returns |
| Type |
Description |
Schema |
publicstaticSchemaparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Schema |
publicstaticSchemaparseFrom(InputStreaminput)
| Returns |
| Type |
Description |
Schema |
publicstaticSchemaparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Schema |
parseFrom(ByteBuffer data)
publicstaticSchemaparseFrom(ByteBufferdata)
| Returns |
| Type |
Description |
Schema |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticSchemaparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Schema |
parser()
publicstaticParser<Schema>parser()
Methods
containsProperties(String key)
publicbooleancontainsProperties(Stringkey)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
publicSchemagetDefaultInstanceForType()
| Returns |
| Type |
Description |
Schema |
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()
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];
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];
| 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];
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];
| Returns |
| Type |
Description |
String |
The format.
|
publicByteStringgetFormatBytes()
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];
| Returns |
| Type |
Description |
ByteString |
The bytes for format.
|
getItems()
Optional. 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 of the elements of Type.ARRAY.
.google.cloud.vertexai.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
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()
Overrides
getProperties() (deprecated)
publicMap<String,Schema>getProperties()
getPropertiesCount()
publicintgetPropertiesCount()
Optional. 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. Properties of Type.OBJECT.
map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
getPropertiesOrDefault(String key, Schema defaultValue)
publicSchemagetPropertiesOrDefault(Stringkey,SchemadefaultValue)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Schema |
getPropertiesOrThrow(String key)
publicSchemagetPropertiesOrThrow(Stringkey)
Optional. 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];
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getType()
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()
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.
|
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()
Optional. 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()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicSchema.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedSchema.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicSchema.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides