Interface SchemaOrBuilder (1.36.0) 

public interface SchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsProperties(String key)

public abstract 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
Returns
Type Description
boolean

getAnyOf(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Schema

getAnyOfCount()

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

Returns
Type Description
int

getAnyOfList()

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

Returns
Type Description
List<Schema>

getAnyOfOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
SchemaOrBuilder

getAnyOfOrBuilderList()

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

Returns
Type Description
List<? extends com.google.cloud.vertexai.api.SchemaOrBuilder>

getDefault()

public abstract Value getDefault()

Optional. Default value of the data.

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

Returns
Type Description
Value

The default.

getDefaultOrBuilder()

public abstract ValueOrBuilder getDefaultOrBuilder()

Optional. Default value of the data.

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

Returns
Type Description
ValueOrBuilder

getDescription()

public abstract String getDescription()

Optional. The description of the data.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

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

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

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

Returns
Type Description
int

The count of enum.

getEnumList()

public abstract List<String> 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];

Returns
Type Description
List<String>

A list containing the enum.

getExample()

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

Returns
Type Description
ValueOrBuilder

getFormat()

public abstract 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.

getFormatBytes()

public abstract 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()

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

Returns
Type Description
Schema

The items.

getItemsOrBuilder()

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

Returns
Type Description
SchemaOrBuilder

getMaxItems()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean getNullable()

Optional. Indicates if the value may be null.

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

Returns
Type Description
boolean

The nullable.

getPattern()

public abstract 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 abstract 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 abstract Map<String,Schema> getProperties()

Use #getPropertiesMap() instead.

Returns
Type Description
Map<String,Schema>

getPropertiesCount()

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

Returns
Type Description
Map<String,Schema>

getPropertiesOrDefault(String key, Schema defaultValue)

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

Parameters
Name Description
key String
defaultValue Schema
Returns
Type Description
Schema

getPropertiesOrThrow(String key)

public abstract 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

getPropertyOrdering(int index)

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

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The propertyOrdering at the given index.

getPropertyOrderingBytes(int index)

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

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the propertyOrdering at the given index.

getPropertyOrderingCount()

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

Returns
Type Description
int

The count of propertyOrdering.

getPropertyOrderingList()

public abstract List<String> 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];

Returns
Type Description
List<String>

A list containing the propertyOrdering.

getRequired(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> getRequiredList()

Optional. Required properties of Type.OBJECT.

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

Returns
Type Description
List<String>

A list containing the required.

getTitle()

public abstract String getTitle()

Optional. The title of the Schema.

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

Returns
Type Description
String

The title.

getTitleBytes()

public abstract 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()

public abstract Type 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 abstract 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 abstract 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 abstract 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 abstract 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.