Class Schema.Builder (3.41.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.v1beta1.Schema

Implements

SchemaOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllEnum(Iterable<String> values)

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

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesIterable<String>

The enum to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The required to add.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

addEnum(String value)

public Schema.Builder addEnum(String value)

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The enum to add.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

addEnumBytes(ByteString value)

public Schema.Builder addEnumBytes(ByteString value)

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes of the enum to add.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The required to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the required to add.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

build()

public Schema build()
Returns
TypeDescription
Schema

buildPartial()

public Schema buildPartial()
Returns
TypeDescription
Schema

clear()

public Schema.Builder clear()
Returns
TypeDescription
Schema.Builder
Overrides

clearDescription()

public Schema.Builder clearDescription()

Optional. The description of the data.

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

Returns
TypeDescription
Schema.Builder

This builder for chaining.

clearEnum()

public Schema.Builder clearEnum()

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
Schema.Builder

clearField(Descriptors.FieldDescriptor field)

public Schema.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Schema.Builder

This builder for chaining.

clearItems()

public Schema.Builder clearItems()

Optional. Schema of the elements of Type.ARRAY.

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

Returns
TypeDescription
Schema.Builder

clearNullable()

public Schema.Builder clearNullable()

Optional. Indicates if the value may be null.

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

Returns
TypeDescription
Schema.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Schema.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Schema.Builder
Overrides

clearProperties()

public Schema.Builder clearProperties()
Returns
TypeDescription
Schema.Builder

clearRequired()

public Schema.Builder clearRequired()

Optional. Required properties of Type.OBJECT.

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

Returns
TypeDescription
Schema.Builder

This builder for chaining.

clearType()

public Schema.Builder clearType()

Optional. The type of the data.

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

Returns
TypeDescription
Schema.Builder

This builder for chaining.

clone()

public Schema.Builder clone()
Returns
TypeDescription
Schema.Builder
Overrides

containsProperties(String key)

public boolean containsProperties(String key)

Optional. Properties of Type.OBJECT.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public Schema getDefaultInstanceForType()
Returns
TypeDescription
Schema

getDescription()

public String getDescription()

Optional. The description of the data.

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

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the data.

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

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnum(int index)

public String getEnum(int index)

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The enum at the given index.

getEnumBytes(int index)

public ByteString getEnumBytes(int index)

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the enum at the given index.

getEnumCount()

public int getEnumCount()

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of enum.

getEnumList()

public ProtocolStringList getEnumList()

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ValueOrBuilder

getFormat()

public String getFormat()

Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for format.

getItems()

public Schema getItems()

Optional. Schema of the elements of Type.ARRAY.

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

Returns
TypeDescription
Schema

The items.

getItemsBuilder()

public Schema.Builder getItemsBuilder()

Optional. Schema of the elements of Type.ARRAY.

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

Returns
TypeDescription
Schema.Builder

getItemsOrBuilder()

public SchemaOrBuilder getItemsOrBuilder()

Optional. Schema of the elements of Type.ARRAY.

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

Returns
TypeDescription
SchemaOrBuilder

getMutableProperties() (deprecated)

public Map<String,Schema> getMutableProperties()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Schema>

getNullable()

public boolean getNullable()

Optional. Indicates if the value may be null.

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

Returns
TypeDescription
boolean

The nullable.

getProperties() (deprecated)

public Map<String,Schema> getProperties()

Use #getPropertiesMap() instead.

Returns
TypeDescription
Map<String,Schema>

getPropertiesCount()

public int getPropertiesCount()

Optional. Properties of Type.OBJECT.

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

Returns
TypeDescription
int

getPropertiesMap()

public Map<String,Schema> getPropertiesMap()

Optional. Properties of Type.OBJECT.

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

Returns
TypeDescription
Map<String,Schema>

getPropertiesOrDefault(String key, Schema defaultValue)

public Schema getPropertiesOrDefault(String key, Schema defaultValue)

Optional. Properties of Type.OBJECT.

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

Parameters
NameDescription
keyString
defaultValueSchema
Returns
TypeDescription
Schema

getPropertiesOrThrow(String key)

public Schema getPropertiesOrThrow(String key)

Optional. Properties of Type.OBJECT.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Schema

getRequired(int index)

public String getRequired(int index)

Optional. Required properties of Type.OBJECT.

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the required.

getType()

public Type getType()

Optional. The type of the data.

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

Returns
TypeDescription
Type

The type.

getTypeValue()

public int getTypeValue()

Optional. The type of the data.

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

Returns
TypeDescription
int

The enum numeric value on the wire for type.

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
TypeDescription
boolean

Whether the example field is set.

hasItems()

public boolean hasItems()

Optional. Schema of the elements of Type.ARRAY.

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

Returns
TypeDescription
boolean

Whether the items field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueValue
Returns
TypeDescription
Schema.Builder

mergeFrom(Schema other)

public Schema.Builder mergeFrom(Schema other)
Parameter
NameDescription
otherSchema
Returns
TypeDescription
Schema.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Schema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schema.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Schema.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Schema.Builder
Overrides

mergeItems(Schema value)

public Schema.Builder mergeItems(Schema value)

Optional. Schema of the elements of Type.ARRAY.

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

Parameter
NameDescription
valueSchema
Returns
TypeDescription
Schema.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Schema.Builder
Overrides

putAllProperties(Map<String,Schema> values)

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

Optional. Properties of Type.OBJECT.

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

Parameter
NameDescription
valuesMap<String,Schema>
Returns
TypeDescription
Schema.Builder

putProperties(String key, Schema value)

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

Optional. Properties of Type.OBJECT.

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

Parameters
NameDescription
keyString
valueSchema
Returns
TypeDescription
Schema.Builder

putPropertiesBuilderIfAbsent(String key)

public Schema.Builder putPropertiesBuilderIfAbsent(String key)

Optional. Properties of Type.OBJECT.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Schema.Builder

removeProperties(String key)

public Schema.Builder removeProperties(String key)

Optional. Properties of Type.OBJECT.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueString

The description to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
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 Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The enum to set.

Returns
TypeDescription
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
NameDescription
valueValue
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Schema.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The format to set.

Returns
TypeDescription
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

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for format to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setItems(Schema value)

public Schema.Builder setItems(Schema value)

Optional. Schema of the elements of Type.ARRAY.

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

Parameter
NameDescription
valueSchema
Returns
TypeDescription
Schema.Builder

setItems(Schema.Builder builderForValue)

public Schema.Builder setItems(Schema.Builder builderForValue)

Optional. Schema of the elements of Type.ARRAY.

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

Parameter
NameDescription
builderForValueSchema.Builder
Returns
TypeDescription
Schema.Builder

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
NameDescription
valueboolean

The nullable to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The required to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setType(Type value)

public Schema.Builder setType(Type value)

Optional. The type of the data.

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

Parameter
NameDescription
valueType

The type to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setTypeValue(int value)

public Schema.Builder setTypeValue(int value)

Optional. The type of the data.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Schema.Builder
Overrides