Class Schema.Builder (3.56.0) 

public static final class Schema.Builder extends 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. More fields may be added in the future as needed.

Protobuf type google.cloud.aiplatform.v1.Schema

Inheritance

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

Implements

SchemaOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAnyOf(Iterable<? extends Schema> values)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.Schema>
Returns
Type Description
Schema.Builder

addAllEnum(Iterable<String> values)

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

Parameter
Name Description
values Iterable<String>

The enum to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addAllPropertyOrdering(Iterable<String> values)

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

Parameter
Name Description
values Iterable<String>

The propertyOrdering to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addAllRequired(Iterable<String> values)

public Schema.Builder addAllRequired(Iterable<String> values)

Optional. Required properties of Type.OBJECT.

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

Parameter
Name Description
values Iterable<String>

The required to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addAnyOf(Schema value)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema
Returns
Type Description
Schema.Builder

addAnyOf(Schema.Builder builderForValue)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Schema.Builder
Returns
Type Description
Schema.Builder

addAnyOf(int index, Schema value)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Schema
Returns
Type Description
Schema.Builder

addAnyOf(int index, Schema.Builder builderForValue)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Schema.Builder
Returns
Type Description
Schema.Builder

addAnyOfBuilder()

public Schema.Builder addAnyOfBuilder()

Optional. The value should be validated against any (one or more) of the subschemas in the list.

repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

addAnyOfBuilder(int index)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.Builder

addEnum(String value)

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

Parameter
Name Description
value String

The enum to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addEnumBytes(ByteString value)

public Schema.Builder addEnumBytes(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];

Parameter
Name Description
value ByteString

The bytes of the enum to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addPropertyOrdering(String value)

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

Parameter
Name Description
value String

The propertyOrdering to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addPropertyOrderingBytes(ByteString value)

public Schema.Builder addPropertyOrderingBytes(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];

Parameter
Name Description
value ByteString

The bytes of the propertyOrdering to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Schema.Builder
Overrides

addRequired(String value)

public Schema.Builder addRequired(String value)

Optional. Required properties of Type.OBJECT.

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

Parameter
Name Description
value String

The required to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addRequiredBytes(ByteString value)

public Schema.Builder addRequiredBytes(ByteString value)

Optional. Required properties of Type.OBJECT.

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

Parameter
Name Description
value ByteString

The bytes of the required to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

build()

public Schema build()
Returns
Type Description
Schema

buildPartial()

public Schema buildPartial()
Returns
Type Description
Schema

clear()

public Schema.Builder clear()
Returns
Type Description
Schema.Builder
Overrides

clearAnyOf()

public Schema.Builder clearAnyOf()

Optional. The value should be validated against any (one or more) of the subschemas in the list.

repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

clearDefault()

public Schema.Builder clearDefault()

Optional. Default value of the data.

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

Returns
Type Description
Schema.Builder

clearDescription()

public Schema.Builder clearDescription()

Optional. The description of the data.

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearEnum()

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearExample()

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

Returns
Type Description
Schema.Builder

clearField(Descriptors.FieldDescriptor field)

public Schema.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Schema.Builder
Overrides

clearFormat()

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearItems()

public Schema.Builder clearItems()

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

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

Returns
Type Description
Schema.Builder

clearMaxItems()

public Schema.Builder clearMaxItems()

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

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMaxLength()

public Schema.Builder clearMaxLength()

Optional. Maximum length of the Type.STRING

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMaxProperties()

public Schema.Builder clearMaxProperties()

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

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMaximum()

public Schema.Builder clearMaximum()

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

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMinItems()

public Schema.Builder clearMinItems()

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

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMinLength()

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMinProperties()

public Schema.Builder clearMinProperties()

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

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMinimum()

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearNullable()

public Schema.Builder clearNullable()

Optional. Indicates if the value may be null.

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Schema.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Schema.Builder
Overrides

clearPattern()

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearProperties()

public Schema.Builder clearProperties()
Returns
Type Description
Schema.Builder

clearPropertyOrdering()

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearRequired()

public Schema.Builder clearRequired()

Optional. Required properties of Type.OBJECT.

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearTitle()

public Schema.Builder clearTitle()

Optional. The title of the Schema.

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearType()

public Schema.Builder clearType()

Optional. The type of the data.

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clone()

public Schema.Builder clone()
Returns
Type Description
Schema.Builder
Overrides

containsProperties(String key)

public boolean containsProperties(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnyOf(int index)

public Schema getAnyOf(int index)

Optional. The value should be validated against any (one or more) of the subschemas in the list.

repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema

getAnyOfBuilder(int index)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.Builder

getAnyOfBuilderList()

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getAnyOfCount()

public int getAnyOfCount()

Optional. The value should be validated against any (one or more) of the subschemas in the list.

repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAnyOfList()

public List<Schema> getAnyOfList()

Optional. The value should be validated against any (one or more) of the subschemas in the list.

repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Schema>

getAnyOfOrBuilder(int index)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SchemaOrBuilder

getAnyOfOrBuilderList()

public List<? extends SchemaOrBuilder> getAnyOfOrBuilderList()

Optional. The value should be validated against any (one or more) of the subschemas in the list.

repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.SchemaOrBuilder>

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.

getDefaultBuilder()

public Value.Builder getDefaultBuilder()

Optional. Default value of the data.

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

Returns
Type Description
Builder

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

Returns
Type Description
ValueOrBuilder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnum(int index)

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

Returns
Type Description
ProtocolStringList

A list containing the enum.

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.

getExampleBuilder()

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

Returns
Type Description
Builder

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

Returns
Type Description
ValueOrBuilder

getFormat()

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.

getFormatBytes()

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

public Schema getItems()

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

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

Returns
Type Description
Schema

The items.

getItemsBuilder()

public Schema.Builder getItemsBuilder()

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

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

Returns
Type Description
Schema.Builder

getItemsOrBuilder()

public SchemaOrBuilder getItemsOrBuilder()

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

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

Returns
Type Description
SchemaOrBuilder

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.

getMutableProperties() (deprecated)

public Map<String,Schema> getMutableProperties()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Schema>

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.

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

Use #getPropertiesMap() instead.

Returns
Type Description
Map<String,Schema>

getPropertiesCount()

public int getPropertiesCount()

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

map<string, .google.cloud.aiplatform.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.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Schema>

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.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue Schema
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.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Schema

getPropertyOrdering(int index)

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

Returns
Type Description
ProtocolStringList

A list containing the propertyOrdering.

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

Returns
Type Description
ProtocolStringList

A list containing the required.

getTitle()

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

public Type getType()

Optional. The type of the data.

.google.cloud.aiplatform.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.aiplatform.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.aiplatform.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the items field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDefault(Value value)

public Schema.Builder mergeDefault(Value value)

Optional. Default value of the data.

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

Parameter
Name Description
value Value
Returns
Type Description
Schema.Builder

mergeExample(Value value)

public Schema.Builder mergeExample(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];

Parameter
Name Description
value Value
Returns
Type Description
Schema.Builder

mergeFrom(Schema other)

public Schema.Builder mergeFrom(Schema other)
Parameter
Name Description
other Schema
Returns
Type Description
Schema.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Schema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Schema.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Schema.Builder
Overrides

mergeItems(Schema value)

public Schema.Builder mergeItems(Schema value)

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

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

Parameter
Name Description
value Schema
Returns
Type Description
Schema.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Schema.Builder
Overrides

putAllProperties(Map<String,Schema> values)

public Schema.Builder putAllProperties(Map<String,Schema> values)

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

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

Parameter
Name Description
values Map<String,Schema>
Returns
Type Description
Schema.Builder

putProperties(String key, Schema value)

public Schema.Builder putProperties(String key, Schema value)

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

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

Parameters
Name Description
key String
value Schema
Returns
Type Description
Schema.Builder

putPropertiesBuilderIfAbsent(String key)

public Schema.Builder putPropertiesBuilderIfAbsent(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
Schema.Builder

removeAnyOf(int index)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.Builder

removeProperties(String key)

public Schema.Builder removeProperties(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
Schema.Builder

setAnyOf(int index, Schema value)

public 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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Schema
Returns
Type Description
Schema.Builder

setAnyOf(int index, Schema.Builder builderForValue)

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.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Schema.Builder
Returns
Type Description
Schema.Builder

setDefault(Value value)

public Schema.Builder setDefault(Value value)

Optional. Default value of the data.

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

Parameter
Name Description
value Value
Returns
Type Description
Schema.Builder

setDefault(Value.Builder builderForValue)

public Schema.Builder setDefault(Value.Builder builderForValue)

Optional. Default value of the data.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Schema.Builder

setDescription(String value)

public Schema.Builder setDescription(String value)

Optional. The description of the data.

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

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Schema.Builder setDescriptionBytes(ByteString value)

Optional. The description of the data.

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

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setEnum(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.
value String

The enum to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setExample(Value value)

public Schema.Builder setExample(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];

Parameter
Name Description
value Value
Returns
Type Description
Schema.Builder

setExample(Value.Builder builderForValue)

public Schema.Builder setExample(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Schema.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Schema.Builder
Overrides

setFormat(String value)

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

Parameter
Name Description
value String

The format to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setFormatBytes(ByteString value)

public Schema.Builder setFormatBytes(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];

Parameter
Name Description
value ByteString

The bytes for format to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setItems(Schema value)

public Schema.Builder setItems(Schema value)

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

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

Parameter
Name Description
value Schema
Returns
Type Description
Schema.Builder

setItems(Schema.Builder builderForValue)

public Schema.Builder setItems(Schema.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Schema.Builder
Returns
Type Description
Schema.Builder

setMaxItems(long value)

public Schema.Builder setMaxItems(long value)

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

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

Parameter
Name Description
value long

The maxItems to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMaxLength(long value)

public Schema.Builder setMaxLength(long value)

Optional. Maximum length of the Type.STRING

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

Parameter
Name Description
value long

The maxLength to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMaxProperties(long value)

public Schema.Builder setMaxProperties(long value)

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

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

Parameter
Name Description
value long

The maxProperties to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMaximum(double value)

public Schema.Builder setMaximum(double value)

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

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

Parameter
Name Description
value double

The maximum to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMinItems(long value)

public Schema.Builder setMinItems(long value)

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

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

Parameter
Name Description
value long

The minItems to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMinLength(long value)

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

Parameter
Name Description
value long

The minLength to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMinProperties(long value)

public Schema.Builder setMinProperties(long value)

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

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

Parameter
Name Description
value long

The minProperties to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMinimum(double value)

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

Parameter
Name Description
value double

The minimum to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setNullable(boolean value)

public Schema.Builder setNullable(boolean value)

Optional. Indicates if the value may be null.

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

Parameter
Name Description
value boolean

The nullable to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setPattern(String value)

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

Parameter
Name Description
value String

The pattern to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setPatternBytes(ByteString value)

public Schema.Builder setPatternBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for pattern to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setPropertyOrdering(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.
value String

The propertyOrdering to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Schema.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Schema.Builder
Overrides

setRequired(int index, String value)

public Schema.Builder setRequired(int index, String value)

Optional. Required properties of Type.OBJECT.

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

Parameters
Name Description
index int

The index to set the value at.
value String

The required to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setTitle(String value)

public Schema.Builder setTitle(String value)

Optional. The title of the Schema.

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

Parameter
Name Description
value String

The title to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public Schema.Builder setTitleBytes(ByteString value)

Optional. The title of the Schema.

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

Parameter
Name Description
value ByteString

The bytes for title to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setType(Type value)

public Schema.Builder setType(Type value)

Optional. The type of the data.

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

Parameter
Name Description
value Type

The type to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setTypeValue(int value)

public Schema.Builder setTypeValue(int value)

Optional. The type of the data.

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Schema.Builder
Overrides