Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface SchemaOrBuilder (0.1.0)

public interface SchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDefs(String key)

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

getAdditionalPropertiesOrBuilder()

public abstract 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 abstract Schema getAnyOf(int index)

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Schema`

getAnyOfCount()

public abstract int getAnyOfCount()

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

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

Returns
Type	Description
`int`

getAnyOfList()

public abstract List<Schema> getAnyOfList()

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

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

Returns
Type	Description
`List<Schema>`

getAnyOfOrBuilder(int index)

public abstract SchemaOrBuilder getAnyOfOrBuilder(int index)

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SchemaOrBuilder`

getAnyOfOrBuilderList()

public abstract List<? extends SchemaOrBuilder> getAnyOfOrBuilderList()

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

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

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

getDefault()

public abstract Value getDefault()

Optional. Default value of the data.

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

Returns
Type	Description
`Value`	The default.

getDefaultOrBuilder()

public abstract ValueOrBuilder getDefaultOrBuilder()

Optional. Default value of the data.

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

Returns
Type	Description
`ValueOrBuilder`

getDefs() (deprecated)

public abstract Map<String,Schema> getDefs()

Use #getDefsMap() instead.

Returns
Type	Description
`Map<String,Schema>`

getDefsCount()

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

Optional. The description of the data.

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

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The description of the data.

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

Returns
Type	Description
`ByteString`	The bytes for description.

getEnum(int index)

public abstract String getEnum(int index)

Optional. Possible values of the element of primitive type with enum format. Examples:

We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
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 abstract ByteString getEnumBytes(int index)

Optional. Possible values of the element of primitive type with enum format. Examples:

We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
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 abstract int getEnumCount()

Optional. Possible values of the element of primitive type with enum format. Examples:

We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
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 abstract List<String> getEnumList()

Optional. Possible values of the element of primitive type with enum format. Examples:

We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
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
`List<String>`	A list containing the enum.

getItems()

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

getItemsOrBuilder()

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

getNullable()

public abstract boolean getNullable()

Optional. Indicates if the value may be null.

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

Returns
Type	Description
`boolean`	The nullable.

getPrefixItems(int index)

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

getPrefixItemsCount()

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

Use #getPropertiesMap() instead.

Returns
Type	Description
`Map<String,Schema>`

getPropertiesCount()

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

Optional. Required properties of Type.OBJECT.

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

Returns
Type	Description
`List<String>`	A list containing the required.

getTitle()

public abstract String getTitle()

Optional. The title of the schema.

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

Returns
Type	Description
`String`	The title.

getTitleBytes()

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