Class Schema.Builder (0.1.0) 

public static final class Schema.Builder extends GeneratedMessage.Builder<Schema.Builder> implements SchemaOrBuilder

Represents a select subset of an OpenAPI 3.0 schema object.

Protobuf type google.cloud.ces.v1.Schema

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.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.ces.v1.Schema any_of = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.ces.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 = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The enum to add.
Returns
Type Description
Schema.Builder

This builder for chaining.

addAllPrefixItems(Iterable<? extends Schema> values)

public Schema.Builder addAllPrefixItems(Iterable<? extends Schema> values)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

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

addAllRequired(Iterable<String> values)

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

Optional. Required properties of Type.OBJECT.

repeated string required = 3 [(.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.ces.v1.Schema any_of = 10 [(.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.ces.v1.Schema any_of = 10 [(.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.ces.v1.Schema any_of = 10 [(.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.ces.v1.Schema any_of = 10 [(.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.ces.v1.Schema any_of = 10 [(.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.ces.v1.Schema any_of = 10 [(.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 = 11 [(.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 = 11 [(.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.

addPrefixItems(Schema value)

public Schema.Builder addPrefixItems(Schema value)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema
Returns
Type Description
Schema.Builder

addPrefixItems(Schema.Builder builderForValue)

public Schema.Builder addPrefixItems(Schema.Builder builderForValue)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

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

addPrefixItems(int index, Schema value)

public Schema.Builder addPrefixItems(int index, Schema value)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

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

addPrefixItems(int index, Schema.Builder builderForValue)

public Schema.Builder addPrefixItems(int index, Schema.Builder builderForValue)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

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

addPrefixItemsBuilder()

public Schema.Builder addPrefixItemsBuilder()

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

addPrefixItemsBuilder(int index)

public Schema.Builder addPrefixItemsBuilder(int index)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.Builder

addRequired(String value)

public Schema.Builder addRequired(String value)

Optional. Required properties of Type.OBJECT.

repeated string required = 3 [(.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 = 3 [(.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

clearAdditionalProperties()

public Schema.Builder clearAdditionalProperties()

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

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

Returns
Type Description
Schema.Builder

clearDefs()

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

clearDescription()

public Schema.Builder clearDescription()

Optional. The description of the data.

string description = 4 [(.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 = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

This builder for chaining.

clearItems()

public Schema.Builder clearItems()

Optional. Schema of the elements of Type.ARRAY.

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

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMaximum()

public Schema.Builder clearMaximum()

Optional. Maximum value for Type.INTEGER and Type.NUMBER.

optional double maximum = 19 [(.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 = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

This builder for chaining.

clearMinimum()

public Schema.Builder clearMinimum()

Optional. Minimum value for Type.INTEGER and Type.NUMBER.

optional double minimum = 18 [(.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.

clearPrefixItems()

public Schema.Builder clearPrefixItems()

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

clearProperties()

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

clearRef()

public Schema.Builder clearRef()

Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root defs.

For example, the following schema defines a reference to a schema node named "Pet":

<code><code> type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string </code></code>

The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.

string ref = 13 [(.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 = 3 [(.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 = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

This builder for chaining.

clearType()

public Schema.Builder clearType()

Required. The type of the data.

.google.cloud.ces.v1.Schema.Type type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Schema.Builder

This builder for chaining.

clearUniqueItems()

public Schema.Builder clearUniqueItems()

Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.

bool unique_items = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

This builder for chaining.

containsDefs(String key)

public boolean containsDefs(String key)

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsProperties(String key)

public boolean containsProperties(String key)

Optional. Properties of Type.OBJECT.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getAdditionalProperties()

public Schema getAdditionalProperties()

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema

The additionalProperties.

getAdditionalPropertiesBuilder()

public Schema.Builder getAdditionalPropertiesBuilder()

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

getAdditionalPropertiesOrBuilder()

public SchemaOrBuilder getAdditionalPropertiesOrBuilder()

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SchemaOrBuilder

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

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

getDefault()

public Value getDefault()

Optional. Default value of the data.

.google.protobuf.Value default = 12 [(.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 = 12 [(.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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ValueOrBuilder

getDefs() (deprecated)

public Map<String,Schema> getDefs()

Use #getDefsMap() instead.

Returns
Type Description
Map<String,Schema>

getDefsCount()

public int getDefsCount()

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDefsMap()

public Map<String,Schema> getDefsMap()

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,Schema>

getDefsOrDefault(String key, Schema defaultValue)

public Schema getDefsOrDefault(String key, Schema defaultValue)

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue Schema
Returns
Type Description
Schema

getDefsOrThrow(String key)

public Schema getDefsOrThrow(String key)

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Schema

getDescription()

public String getDescription()

Optional. The description of the data.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the data.

string description = 4 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.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 = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the enum.

getItems()

public Schema getItems()

Optional. Schema of the elements of Type.ARRAY.

.google.cloud.ces.v1.Schema items = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema

The items.

getItemsBuilder()

public Schema.Builder getItemsBuilder()

Optional. Schema of the elements of Type.ARRAY.

.google.cloud.ces.v1.Schema items = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Schema.Builder

getItemsOrBuilder()

public SchemaOrBuilder getItemsOrBuilder()

Optional. Schema of the elements of Type.ARRAY.

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

Returns
Type Description
long

The maxItems.

getMaximum()

public double getMaximum()

Optional. Maximum value for Type.INTEGER and Type.NUMBER.

optional double maximum = 19 [(.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 = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
long

The minItems.

getMinimum()

public double getMinimum()

Optional. Minimum value for Type.INTEGER and Type.NUMBER.

optional double minimum = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The minimum.

getMutableDefs() (deprecated)

public Map<String,Schema> getMutableDefs()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Schema>

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.

getPrefixItems(int index)

public Schema getPrefixItems(int index)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema

getPrefixItemsBuilder(int index)

public Schema.Builder getPrefixItemsBuilder(int index)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Schema.Builder

getPrefixItemsBuilderList()

public List<Schema.Builder> getPrefixItemsBuilderList()

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getPrefixItemsCount()

public int getPrefixItemsCount()

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPrefixItemsList()

public List<Schema> getPrefixItemsList()

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Schema>

getPrefixItemsOrBuilder(int index)

public SchemaOrBuilder getPrefixItemsOrBuilder(int index)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SchemaOrBuilder

getPrefixItemsOrBuilderList()

public List<? extends SchemaOrBuilder> getPrefixItemsOrBuilderList()

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

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

getProperties() (deprecated)

public Map<String,Schema> getProperties()

Use #getPropertiesMap() instead.

Returns
Type Description
Map<String,Schema>

getPropertiesCount()

public int getPropertiesCount()

Optional. Properties of Type.OBJECT.

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

Returns
Type Description
int

getPropertiesMap()

public Map<String,Schema> getPropertiesMap()

Optional. Properties of Type.OBJECT.

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

Returns
Type Description
Map<String,Schema>

getPropertiesOrDefault(String key, Schema defaultValue)

public Schema getPropertiesOrDefault(String key, Schema defaultValue)

Optional. Properties of Type.OBJECT.

map<string, .google.cloud.ces.v1.Schema> properties = 2 [(.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. Properties of Type.OBJECT.

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

Parameter
Name Description
key String
Returns
Type Description
Schema

getRef()

public String getRef()

Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root defs.

For example, the following schema defines a reference to a schema node named "Pet":

<code><code> type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string </code></code>

The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.

string ref = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ref.

getRefBytes()

public ByteString getRefBytes()

Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root defs.

For example, the following schema defines a reference to a schema node named "Pet":

<code><code> type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string </code></code>

The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.

string ref = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ref.

getRequired(int index)

public String getRequired(int index)

Optional. Required properties of Type.OBJECT.

repeated string required = 3 [(.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 = 3 [(.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 = 3 [(.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 = 3 [(.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 = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Optional. The title of the schema.

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

Returns
Type Description
ByteString

The bytes for title.

getType()

public Schema.Type getType()

Required. The type of the data.

.google.cloud.ces.v1.Schema.Type type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Schema.Type

The type.

getTypeValue()

public int getTypeValue()

Required. The type of the data.

.google.cloud.ces.v1.Schema.Type type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUniqueItems()

public boolean getUniqueItems()

Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.

bool unique_items = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The uniqueItems.

hasAdditionalProperties()

public boolean hasAdditionalProperties()

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the additionalProperties field is set.

hasDefault()

public boolean hasDefault()

Optional. Default value of the data.

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

Returns
Type Description
boolean

Whether the default field is set.

hasItems()

public boolean hasItems()

Optional. Schema of the elements of Type.ARRAY.

.google.cloud.ces.v1.Schema items = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the items field is set.

hasMaximum()

public boolean hasMaximum()

Optional. Maximum value for Type.INTEGER and Type.NUMBER.

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

Returns
Type Description
boolean

Whether the maximum field is set.

hasMinimum()

public boolean hasMinimum()

Optional. Minimum value for Type.INTEGER and Type.NUMBER.

optional double minimum = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the minimum field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdditionalProperties(Schema value)

public Schema.Builder mergeAdditionalProperties(Schema value)

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema
Returns
Type Description
Schema.Builder

mergeDefault(Value value)

public Schema.Builder mergeDefault(Value value)

Optional. Default value of the data.

.google.protobuf.Value default = 12 [(.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 of the elements of Type.ARRAY.

.google.cloud.ces.v1.Schema items = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema
Returns
Type Description
Schema.Builder

putAllDefs(Map<String,Schema> values)

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

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

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

putAllProperties(Map<String,Schema> values)

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

Optional. Properties of Type.OBJECT.

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

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

putDefs(String key, Schema value)

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

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

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

putDefsBuilderIfAbsent(String key)

public Schema.Builder putDefsBuilderIfAbsent(String key)

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Schema.Builder

putProperties(String key, Schema value)

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

Optional. Properties of Type.OBJECT.

map<string, .google.cloud.ces.v1.Schema> properties = 2 [(.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. Properties of Type.OBJECT.

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

Parameter
Name Description
index int
Returns
Type Description
Schema.Builder

removeDefs(String key)

public Schema.Builder removeDefs(String key)

Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

map<string, .google.cloud.ces.v1.Schema> defs = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Schema.Builder

removePrefixItems(int index)

public Schema.Builder removePrefixItems(int index)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.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. Properties of Type.OBJECT.

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

Parameter
Name Description
key String
Returns
Type Description
Schema.Builder

setAdditionalProperties(Schema value)

public Schema.Builder setAdditionalProperties(Schema value)

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Schema
Returns
Type Description
Schema.Builder

setAdditionalProperties(Schema.Builder builderForValue)

public Schema.Builder setAdditionalProperties(Schema.Builder builderForValue)

Optional. Can either be a boolean or an object, controls the presence of additional properties.

.google.cloud.ces.v1.Schema additional_properties = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Schema.Builder
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.ces.v1.Schema any_of = 10 [(.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.ces.v1.Schema any_of = 10 [(.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 = 12 [(.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 = 12 [(.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 = 4 [(.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 = 4 [(.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 = 11 [(.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.

setItems(Schema value)

public Schema.Builder setItems(Schema value)

Optional. Schema of the elements of Type.ARRAY.

.google.cloud.ces.v1.Schema items = 5 [(.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 of the elements of Type.ARRAY.

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

Parameter
Name Description
value long

The maxItems to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMaximum(double value)

public Schema.Builder setMaximum(double value)

Optional. Maximum value for Type.INTEGER and Type.NUMBER.

optional double maximum = 19 [(.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 = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value long

The minItems to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setMinimum(double value)

public Schema.Builder setMinimum(double value)

Optional. Minimum value for Type.INTEGER and Type.NUMBER.

optional double minimum = 18 [(.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.

setPrefixItems(int index, Schema value)

public Schema.Builder setPrefixItems(int index, Schema value)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

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

setPrefixItems(int index, Schema.Builder builderForValue)

public Schema.Builder setPrefixItems(int index, Schema.Builder builderForValue)

Optional. Schemas of initial elements of Type.ARRAY.

repeated .google.cloud.ces.v1.Schema prefix_items = 8 [(.google.api.field_behavior) = OPTIONAL];

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

setRef(String value)

public Schema.Builder setRef(String value)

Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root defs.

For example, the following schema defines a reference to a schema node named "Pet":

<code><code> type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string </code></code>

The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.

string ref = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The ref to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setRefBytes(ByteString value)

public Schema.Builder setRefBytes(ByteString value)

Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root defs.

For example, the following schema defines a reference to a schema node named "Pet":

<code><code> type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string </code></code>

The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.

string ref = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setRequired(int index, String value)

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

Optional. Required properties of Type.OBJECT.

repeated string required = 3 [(.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 = 15 [(.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 = 15 [(.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(Schema.Type value)

public Schema.Builder setType(Schema.Type value)

Required. The type of the data.

.google.cloud.ces.v1.Schema.Type type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Schema.Type

The type to set.
Returns
Type Description
Schema.Builder

This builder for chaining.

setTypeValue(int value)

public Schema.Builder setTypeValue(int value)

Required. The type of the data.

.google.cloud.ces.v1.Schema.Type type = 1 [(.google.api.field_behavior) = REQUIRED];

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.

setUniqueItems(boolean value)

public Schema.Builder setUniqueItems(boolean value)

Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.

bool unique_items = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The uniqueItems to set.
Returns
Type Description
Schema.Builder

This builder for chaining.