public static final class Schema.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder> 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-object). More fields may be added in the future as needed.Protobuf type
google.cloud.vertexai.v1.Schema| Modifier and Type | Method and Description |
|---|---|
Schema.Builder |
addAllAnyOf(Iterable<? extends Schema> values)
Optional.
|
Schema.Builder |
addAllEnum(Iterable<String> values)
Optional.
|
Schema.Builder |
addAllPropertyOrdering(Iterable<String> values)
Optional.
|
Schema.Builder |
addAllRequired(Iterable<String> values)
Optional.
|
Schema.Builder |
addAnyOf(int index,
Schema.Builder builderForValue)
Optional.
|
Schema.Builder |
addAnyOf(int index,
Schema value)
Optional.
|
Schema.Builder |
addAnyOf(Schema.Builder builderForValue)
Optional.
|
Schema.Builder |
addAnyOf(Schema value)
Optional.
|
Schema.Builder |
addAnyOfBuilder()
Optional.
|
Schema.Builder |
addAnyOfBuilder(int index)
Optional.
|
Schema.Builder |
addEnum(String value)
Optional.
|
Schema.Builder |
addEnumBytes(com.google.protobuf.ByteString value)
Optional.
|
Schema.Builder |
addPropertyOrdering(String value)
Optional.
|
Schema.Builder |
addPropertyOrderingBytes(com.google.protobuf.ByteString value)
Optional.
|
Schema.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Schema.Builder |
addRequired(String value)
Optional.
|
Schema.Builder |
addRequiredBytes(com.google.protobuf.ByteString value)
Optional.
|
Schema |
build() |
Schema |
buildPartial() |
Schema.Builder |
clear() |
Schema.Builder |
clearAnyOf()
Optional.
|
Schema.Builder |
clearDefault()
Optional.
|
Schema.Builder |
clearDescription()
Optional.
|
Schema.Builder |
clearEnum()
Optional.
|
Schema.Builder |
clearExample()
Optional.
|
Schema.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Schema.Builder |
clearFormat()
Optional.
|
Schema.Builder |
clearItems()
Optional.
|
Schema.Builder |
clearMaximum()
Optional.
|
Schema.Builder |
clearMaxItems()
Optional.
|
Schema.Builder |
clearMaxLength()
Optional.
|
Schema.Builder |
clearMaxProperties()
Optional.
|
Schema.Builder |
clearMinimum()
Optional.
|
Schema.Builder |
clearMinItems()
Optional.
|
Schema.Builder |
clearMinLength()
Optional.
|
Schema.Builder |
clearMinProperties()
Optional.
|
Schema.Builder |
clearNullable()
Optional.
|
Schema.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Schema.Builder |
clearPattern()
Optional.
|
Schema.Builder |
clearProperties() |
Schema.Builder |
clearPropertyOrdering()
Optional.
|
Schema.Builder |
clearRequired()
Optional.
|
Schema.Builder |
clearTitle()
Optional.
|
Schema.Builder |
clearType()
Optional.
|
Schema.Builder |
clone() |
boolean |
containsProperties(String key)
Optional.
|
Schema |
getAnyOf(int index)
Optional.
|
Schema.Builder |
getAnyOfBuilder(int index)
Optional.
|
List<Schema.Builder> |
getAnyOfBuilderList()
Optional.
|
int |
getAnyOfCount()
Optional.
|
List<Schema> |
getAnyOfList()
Optional.
|
SchemaOrBuilder |
getAnyOfOrBuilder(int index)
Optional.
|
List<? extends SchemaOrBuilder> |
getAnyOfOrBuilderList()
Optional.
|
com.google.protobuf.Value |
getDefault()
Optional.
|
com.google.protobuf.Value.Builder |
getDefaultBuilder()
Optional.
|
Schema |
getDefaultInstanceForType() |
com.google.protobuf.ValueOrBuilder |
getDefaultOrBuilder()
Optional.
|
String |
getDescription()
Optional.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Optional.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.Value.Builder |
getExampleBuilder()
Optional.
|
com.google.protobuf.ValueOrBuilder |
getExampleOrBuilder()
Optional.
|
String |
getFormat()
Optional.
|
com.google.protobuf.ByteString |
getFormatBytes()
Optional.
|
Schema |
getItems()
Optional.
|
Schema.Builder |
getItemsBuilder()
Optional.
|
SchemaOrBuilder |
getItemsOrBuilder()
Optional.
|
double |
getMaximum()
Optional.
|
long |
getMaxItems()
Optional.
|
long |
getMaxLength()
Optional.
|
long |
getMaxProperties()
Optional.
|
double |
getMinimum()
Optional.
|
long |
getMinItems()
Optional.
|
long |
getMinLength()
Optional.
|
long |
getMinProperties()
Optional.
|
Map<String,Schema> |
getMutableProperties()
Deprecated.
|
boolean |
getNullable()
Optional.
|
String |
getPattern()
Optional.
|
com.google.protobuf.ByteString |
getPatternBytes()
Optional.
|
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 |
getPropertyOrdering(int index)
Optional.
|
com.google.protobuf.ByteString |
getPropertyOrderingBytes(int index)
Optional.
|
int |
getPropertyOrderingCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getPropertyOrderingList()
Optional.
|
String |
getRequired(int index)
Optional.
|
com.google.protobuf.ByteString |
getRequiredBytes(int index)
Optional.
|
int |
getRequiredCount()
Optional.
|
com.google.protobuf.ProtocolStringList |
getRequiredList()
Optional.
|
String |
getTitle()
Optional.
|
com.google.protobuf.ByteString |
getTitleBytes()
Optional.
|
Type |
getType()
Optional.
|
int |
getTypeValue()
Optional.
|
boolean |
hasDefault()
Optional.
|
boolean |
hasExample()
Optional.
|
boolean |
hasItems()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number) |
boolean |
isInitialized() |
Schema.Builder |
mergeDefault(com.google.protobuf.Value value)
Optional.
|
Schema.Builder |
mergeExample(com.google.protobuf.Value value)
Optional.
|
Schema.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Schema.Builder |
mergeFrom(com.google.protobuf.Message other) |
Schema.Builder |
mergeFrom(Schema other) |
Schema.Builder |
mergeItems(Schema value)
Optional.
|
Schema.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Schema.Builder |
putAllProperties(Map<String,Schema> values)
Optional.
|
Schema.Builder |
putProperties(String key,
Schema value)
Optional.
|
Schema.Builder |
putPropertiesBuilderIfAbsent(String key)
Optional.
|
Schema.Builder |
removeAnyOf(int index)
Optional.
|
Schema.Builder |
removeProperties(String key)
Optional.
|
Schema.Builder |
setAnyOf(int index,
Schema.Builder builderForValue)
Optional.
|
Schema.Builder |
setAnyOf(int index,
Schema value)
Optional.
|
Schema.Builder |
setDefault(com.google.protobuf.Value.Builder builderForValue)
Optional.
|
Schema.Builder |
setDefault(com.google.protobuf.Value value)
Optional.
|
Schema.Builder |
setDescription(String value)
Optional.
|
Schema.Builder |
setDescriptionBytes(com.google.protobuf.ByteString value)
Optional.
|
Schema.Builder |
setEnum(int index,
String value)
Optional.
|
Schema.Builder |
setExample(com.google.protobuf.Value.Builder builderForValue)
Optional.
|
Schema.Builder |
setExample(com.google.protobuf.Value value)
Optional.
|
Schema.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Schema.Builder |
setFormat(String value)
Optional.
|
Schema.Builder |
setFormatBytes(com.google.protobuf.ByteString value)
Optional.
|
Schema.Builder |
setItems(Schema.Builder builderForValue)
Optional.
|
Schema.Builder |
setItems(Schema value)
Optional.
|
Schema.Builder |
setMaximum(double value)
Optional.
|
Schema.Builder |
setMaxItems(long value)
Optional.
|
Schema.Builder |
setMaxLength(long value)
Optional.
|
Schema.Builder |
setMaxProperties(long value)
Optional.
|
Schema.Builder |
setMinimum(double value)
Optional.
|
Schema.Builder |
setMinItems(long value)
Optional.
|
Schema.Builder |
setMinLength(long value)
Optional.
|
Schema.Builder |
setMinProperties(long value)
Optional.
|
Schema.Builder |
setNullable(boolean value)
Optional.
|
Schema.Builder |
setPattern(String value)
Optional.
|
Schema.Builder |
setPatternBytes(com.google.protobuf.ByteString value)
Optional.
|
Schema.Builder |
setPropertyOrdering(int index,
String value)
Optional.
|
Schema.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Schema.Builder |
setRequired(int index,
String value)
Optional.
|
Schema.Builder |
setTitle(String value)
Optional.
|
Schema.Builder |
setTitleBytes(com.google.protobuf.ByteString value)
Optional.
|
Schema.Builder |
setType(Type value)
Optional.
|
Schema.Builder |
setTypeValue(int value)
Optional.
|
Schema.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Schema build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Schema buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Schema.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Schema.Builder>public Schema.Builder mergeFrom(Schema other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public Schema.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Schema.Builder>IOExceptionpublic int getTypeValue()
Optional. The type of the data.
.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
getTypeValue in interface SchemaOrBuilderpublic Schema.Builder setTypeValue(int value)
Optional. The type of the data.
.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
value - The enum numeric value on the wire for type to set.public Type getType()
Optional. The type of the data.
.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
getType in interface SchemaOrBuilderpublic Schema.Builder setType(Type value)
Optional. The type of the data.
.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
value - The type to set.public Schema.Builder clearType()
Optional. The type of the data.
.google.cloud.vertexai.v1.Type type = 1 [(.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];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" for STRING type: "email", "byte", etc
string format = 7 [(.google.api.field_behavior) = OPTIONAL];getFormatBytes in interface SchemaOrBuilderpublic Schema.Builder setFormat(String value)
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];value - The format to set.public Schema.Builder clearFormat()
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];public Schema.Builder setFormatBytes(com.google.protobuf.ByteString value)
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];value - The bytes for format to set.public String getTitle()
Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];getTitle in interface SchemaOrBuilderpublic com.google.protobuf.ByteString getTitleBytes()
Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];getTitleBytes in interface SchemaOrBuilderpublic Schema.Builder setTitle(String value)
Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];value - The title to set.public Schema.Builder clearTitle()
Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder setTitleBytes(com.google.protobuf.ByteString value)
Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for title to set.public 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 Schema.Builder setDescription(String value)
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];value - The description to set.public Schema.Builder clearDescription()
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for description to set.public boolean getNullable()
Optional. Indicates if the value may be null.
bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];getNullable in interface SchemaOrBuilderpublic Schema.Builder setNullable(boolean value)
Optional. Indicates if the value may be null.
bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];value - The nullable to set.public Schema.Builder clearNullable()
Optional. Indicates if the value may be null.
bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];public boolean hasDefault()
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];hasDefault in interface SchemaOrBuilderpublic com.google.protobuf.Value getDefault()
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];getDefault in interface SchemaOrBuilderpublic Schema.Builder setDefault(com.google.protobuf.Value value)
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder setDefault(com.google.protobuf.Value.Builder builderForValue)
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder mergeDefault(com.google.protobuf.Value value)
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder clearDefault()
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];public com.google.protobuf.Value.Builder getDefaultBuilder()
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];public com.google.protobuf.ValueOrBuilder getDefaultOrBuilder()
Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];getDefaultOrBuilder in interface SchemaOrBuilderpublic 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];
hasItems in interface SchemaOrBuilderpublic Schema 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];
getItems in interface SchemaOrBuilderpublic Schema.Builder setItems(Schema value)
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];
public Schema.Builder setItems(Schema.Builder builderForValue)
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];
public Schema.Builder mergeItems(Schema value)
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];
public Schema.Builder clearItems()
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];
public Schema.Builder getItemsBuilder()
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];
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];
getItemsOrBuilder in interface SchemaOrBuilderpublic long getMinItems()
Optional. Minimum number of the elements for Type.ARRAY.
int64 min_items = 21 [(.google.api.field_behavior) = OPTIONAL];getMinItems in interface SchemaOrBuilderpublic Schema.Builder setMinItems(long value)
Optional. Minimum number of the elements for Type.ARRAY.
int64 min_items = 21 [(.google.api.field_behavior) = OPTIONAL];value - The minItems to set.public Schema.Builder clearMinItems()
Optional. Minimum number of the elements for Type.ARRAY.
int64 min_items = 21 [(.google.api.field_behavior) = OPTIONAL];public long getMaxItems()
Optional. Maximum number of the elements for Type.ARRAY.
int64 max_items = 22 [(.google.api.field_behavior) = OPTIONAL];getMaxItems in interface SchemaOrBuilderpublic Schema.Builder setMaxItems(long value)
Optional. Maximum number of the elements for Type.ARRAY.
int64 max_items = 22 [(.google.api.field_behavior) = OPTIONAL];value - The maxItems to set.public Schema.Builder clearMaxItems()
Optional. Maximum number of the elements for Type.ARRAY.
int64 max_items = 22 [(.google.api.field_behavior) = OPTIONAL];public com.google.protobuf.ProtocolStringList getEnumList()
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];getEnumList in interface SchemaOrBuilderpublic int getEnumCount()
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];getEnumCount in interface SchemaOrBuilderpublic String getEnum(int index)
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
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 primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];getEnumBytes in interface SchemaOrBuilderindex - The index of the value to return.public Schema.Builder setEnum(int index, String value)
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];index - The index to set the value at.value - The enum to set.public Schema.Builder addEnum(String value)
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];value - The enum to add.public Schema.Builder addAllEnum(Iterable<String> values)
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];values - The enum to add.public Schema.Builder clearEnum()
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder addEnumBytes(com.google.protobuf.ByteString value)
Optional. Possible values of the element of primitive type with enum
format. Examples:
1. We can define direction as :
{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
2. We can define apartment number as :
{type:INTEGER, format:enum, enum:["101", "201", "301"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];value - The bytes of the enum to add.public int getPropertiesCount()
SchemaOrBuilderOptional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
getPropertiesCount in interface SchemaOrBuilderpublic 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];
containsProperties in interface SchemaOrBuilder@Deprecated public Map<String,Schema> getProperties()
getPropertiesMap() instead.getProperties in interface SchemaOrBuilderpublic 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];
getPropertiesMap in interface SchemaOrBuilderpublic 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];
getPropertiesOrDefault in interface SchemaOrBuilderpublic 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];
getPropertiesOrThrow in interface SchemaOrBuilderpublic Schema.Builder clearProperties()
public Schema.Builder removeProperties(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];
@Deprecated public Map<String,Schema> getMutableProperties()
public Schema.Builder putProperties(String key, Schema value)
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder putAllProperties(Map<String,Schema> values)
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder putPropertiesBuilderIfAbsent(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];
public com.google.protobuf.ProtocolStringList getPropertyOrderingList()
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
getPropertyOrderingList in interface SchemaOrBuilderpublic int getPropertyOrderingCount()
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
getPropertyOrderingCount in interface SchemaOrBuilderpublic String getPropertyOrdering(int index)
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
getPropertyOrdering in interface SchemaOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getPropertyOrderingBytes(int index)
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
getPropertyOrderingBytes in interface SchemaOrBuilderindex - The index of the value to return.public Schema.Builder setPropertyOrdering(int index, String value)
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
index - The index to set the value at.value - The propertyOrdering to set.public Schema.Builder addPropertyOrdering(String value)
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
value - The propertyOrdering to add.public Schema.Builder addAllPropertyOrdering(Iterable<String> values)
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
values - The propertyOrdering to add.public Schema.Builder clearPropertyOrdering()
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder addPropertyOrderingBytes(com.google.protobuf.ByteString value)
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];
value - The bytes of the propertyOrdering to add.public 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 Schema.Builder setRequired(int index, String value)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];index - The index to set the value at.value - The required to set.public Schema.Builder addRequired(String value)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];value - The required to add.public Schema.Builder addAllRequired(Iterable<String> values)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];values - The required to add.public Schema.Builder clearRequired()
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder addRequiredBytes(com.google.protobuf.ByteString value)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];value - The bytes of the required to add.public long getMinProperties()
Optional. Minimum number of the properties for Type.OBJECT.
int64 min_properties = 14 [(.google.api.field_behavior) = OPTIONAL];getMinProperties in interface SchemaOrBuilderpublic Schema.Builder setMinProperties(long value)
Optional. Minimum number of the properties for Type.OBJECT.
int64 min_properties = 14 [(.google.api.field_behavior) = OPTIONAL];value - The minProperties to set.public Schema.Builder clearMinProperties()
Optional. Minimum number of the properties for Type.OBJECT.
int64 min_properties = 14 [(.google.api.field_behavior) = OPTIONAL];public long getMaxProperties()
Optional. Maximum number of the properties for Type.OBJECT.
int64 max_properties = 15 [(.google.api.field_behavior) = OPTIONAL];getMaxProperties in interface SchemaOrBuilderpublic Schema.Builder setMaxProperties(long value)
Optional. Maximum number of the properties for Type.OBJECT.
int64 max_properties = 15 [(.google.api.field_behavior) = OPTIONAL];value - The maxProperties to set.public Schema.Builder clearMaxProperties()
Optional. Maximum number of the properties for Type.OBJECT.
int64 max_properties = 15 [(.google.api.field_behavior) = OPTIONAL];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];getMinimum in interface SchemaOrBuilderpublic Schema.Builder setMinimum(double value)
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];value - The minimum to set.public Schema.Builder clearMinimum()
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];public double getMaximum()
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
double maximum = 17 [(.google.api.field_behavior) = OPTIONAL];getMaximum in interface SchemaOrBuilderpublic Schema.Builder setMaximum(double value)
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
double maximum = 17 [(.google.api.field_behavior) = OPTIONAL];value - The maximum to set.public Schema.Builder clearMaximum()
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
double maximum = 17 [(.google.api.field_behavior) = OPTIONAL];public long getMinLength()
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
int64 min_length = 18 [(.google.api.field_behavior) = OPTIONAL];getMinLength in interface SchemaOrBuilderpublic Schema.Builder setMinLength(long value)
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
int64 min_length = 18 [(.google.api.field_behavior) = OPTIONAL];value - The minLength to set.public Schema.Builder clearMinLength()
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
int64 min_length = 18 [(.google.api.field_behavior) = OPTIONAL];public long getMaxLength()
Optional. Maximum length of the Type.STRING
int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];getMaxLength in interface SchemaOrBuilderpublic Schema.Builder setMaxLength(long value)
Optional. Maximum length of the Type.STRING
int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];value - The maxLength to set.public Schema.Builder clearMaxLength()
Optional. Maximum length of the Type.STRING
int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];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];getPattern in interface SchemaOrBuilderpublic com.google.protobuf.ByteString getPatternBytes()
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];getPatternBytes in interface SchemaOrBuilderpublic Schema.Builder setPattern(String value)
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];value - The pattern to set.public Schema.Builder clearPattern()
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];public Schema.Builder setPatternBytes(com.google.protobuf.ByteString value)
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for pattern to set.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 Schema.Builder setExample(com.google.protobuf.Value value)
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 Schema.Builder setExample(com.google.protobuf.Value.Builder builderForValue)
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 Schema.Builder mergeExample(com.google.protobuf.Value value)
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 Schema.Builder clearExample()
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 com.google.protobuf.Value.Builder getExampleBuilder()
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 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 List<Schema> getAnyOfList()
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
getAnyOfList in interface SchemaOrBuilderpublic int getAnyOfCount()
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
getAnyOfCount in interface SchemaOrBuilderpublic Schema getAnyOf(int index)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
getAnyOf in interface SchemaOrBuilderpublic Schema.Builder setAnyOf(int index, Schema value)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder setAnyOf(int index, Schema.Builder builderForValue)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder addAnyOf(Schema value)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder addAnyOf(int index, Schema value)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder addAnyOf(Schema.Builder builderForValue)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder addAnyOf(int index, Schema.Builder builderForValue)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder addAllAnyOf(Iterable<? extends Schema> values)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder clearAnyOf()
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder removeAnyOf(int index)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder getAnyOfBuilder(int index)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public SchemaOrBuilder getAnyOfOrBuilder(int index)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
getAnyOfOrBuilder in interface SchemaOrBuilderpublic List<? extends SchemaOrBuilder> getAnyOfOrBuilderList()
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
getAnyOfOrBuilderList in interface SchemaOrBuilderpublic Schema.Builder addAnyOfBuilder()
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public Schema.Builder addAnyOfBuilder(int index)
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public List<Schema.Builder> getAnyOfBuilderList()
Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
public final Schema.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>public final Schema.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Schema.Builder>Copyright © 2025 Google LLC. All rights reserved.