public final class Schema extends 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. 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
DEFAULT_FIELD_NUMBER
public static final int DEFAULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENUM_FIELD_NUMBER
public static final int ENUM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXAMPLE_FIELD_NUMBER
public static final int EXAMPLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ITEMS_FIELD_NUMBER
public static final int ITEMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAXIMUM_FIELD_NUMBER
public static final int MAXIMUM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_ITEMS_FIELD_NUMBER
public static final int MAX_ITEMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_LENGTH_FIELD_NUMBER
public static final int MAX_LENGTH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_PROPERTIES_FIELD_NUMBER
public static final int MAX_PROPERTIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MINIMUM_FIELD_NUMBER
public static final int MINIMUM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MIN_ITEMS_FIELD_NUMBER
public static final int MIN_ITEMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MIN_LENGTH_FIELD_NUMBER
public static final int MIN_LENGTH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MIN_PROPERTIES_FIELD_NUMBER
public static final int MIN_PROPERTIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NULLABLE_FIELD_NUMBER
public static final int NULLABLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PATTERN_FIELD_NUMBER
public static final int PATTERN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROPERTIES_FIELD_NUMBER
public static final int PROPERTIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUIRED_FIELD_NUMBER
public static final int REQUIRED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Schema getDefaultInstance()
| Returns |
| Type |
Description |
Schema |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Schema.Builder newBuilder()
newBuilder(Schema prototype)
public static Schema.Builder newBuilder(Schema prototype)
| Parameter |
| Name |
Description |
prototype |
Schema
|
public static Schema parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Schema |
|
public static Schema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Schema |
|
parseFrom(byte[] data)
public static Schema parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Schema |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Schema |
|
parseFrom(ByteString data)
public static Schema parseFrom(ByteString data)
| Returns |
| Type |
Description |
Schema |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Schema |
|
public static Schema parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Schema |
|
public static Schema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Schema |
|
public static Schema parseFrom(InputStream input)
| Returns |
| Type |
Description |
Schema |
|
public static Schema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Schema |
|
parseFrom(ByteBuffer data)
public static Schema parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Schema |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Schema |
|
parser()
public static Parser<Schema> parser()
Methods
containsProperties(String key)
public boolean containsProperties(String key)
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefault()
public Value getDefault()
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Value |
The default.
|
getDefaultInstanceForType()
public Schema getDefaultInstanceForType()
| Returns |
| Type |
Description |
Schema |
|
getDefaultOrBuilder()
public ValueOrBuilder getDefaultOrBuilder()
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
getDescription()
public String getDescription()
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
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)
public 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];
| 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)
public 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];
| 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()
public 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];
| Returns |
| Type |
Description |
int |
The count of enum.
|
getEnumList()
public 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];
getExample()
public 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];
| Returns |
| Type |
Description |
Value |
The example.
|
getExampleOrBuilder()
public 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];
public String getFormat()
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.
|
public ByteString getFormatBytes()
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()
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()
public SchemaOrBuilder getItemsOrBuilder()
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];
getMaxItems()
public long getMaxItems()
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()
public long getMaxLength()
Optional. Maximum length of the Type.STRING
int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
long |
The maxLength.
|
getMaxProperties()
public long getMaxProperties()
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()
public double getMaximum()
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()
public long getMinItems()
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()
public long getMinLength()
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()
public long getMinProperties()
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()
public double getMinimum()
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()
public boolean getNullable()
Optional. Indicates if the value may be null.
bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The nullable.
|
getParserForType()
public Parser<Schema> getParserForType()
Overrides
getPattern()
public String getPattern()
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()
public ByteString getPatternBytes()
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)
public Map<String,Schema> getProperties()
getPropertiesCount()
public int getPropertiesCount()
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()
public Map<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];
getPropertiesOrDefault(String key, Schema defaultValue)
public Schema getPropertiesOrDefault(String key, Schema defaultValue)
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 |
Schema |
|
getPropertiesOrThrow(String key)
public Schema getPropertiesOrThrow(String key)
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)
public String getRequired(int index)
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)
public ByteString getRequiredBytes(int index)
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()
public int getRequiredCount()
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of required.
|
getRequiredList()
public ProtocolStringList getRequiredList()
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTitle()
Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The title.
|
getTitleBytes()
public ByteString getTitleBytes()
Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for title.
|
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()
public int 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.
|
hasDefault()
public boolean hasDefault()
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()
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];
| Returns |
| Type |
Description |
boolean |
Whether the example field is set.
|
hasItems()
public boolean hasItems()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Schema.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Schema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Schema.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
