Class Schema (0.1.0)

public final class Schema extends GeneratedMessage implements SchemaOrBuilder

Represents a select subset of an OpenAPI 3.0 schema object.

Protobuf type google.cloud.ces.v1.Schema

Implements

SchemaOrBuilder

Static Fields

ADDITIONAL_PROPERTIES_FIELD_NUMBER

public static final int ADDITIONAL_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

ANY_OF_FIELD_NUMBER

public static final int ANY_OF_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_FIELD_NUMBER

public static final int DEFAULT_FIELD_NUMBER
Field Value
Type Description
int

DEFS_FIELD_NUMBER

public static final int DEFS_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENUM_FIELD_NUMBER

public static final int ENUM_FIELD_NUMBER
Field Value
Type Description
int

ITEMS_FIELD_NUMBER

public static final int ITEMS_FIELD_NUMBER
Field Value
Type Description
int

MAXIMUM_FIELD_NUMBER

public static final int MAXIMUM_FIELD_NUMBER
Field Value
Type Description
int

MAX_ITEMS_FIELD_NUMBER

public static final int MAX_ITEMS_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_FIELD_NUMBER

public static final int MINIMUM_FIELD_NUMBER
Field Value
Type Description
int

MIN_ITEMS_FIELD_NUMBER

public static final int MIN_ITEMS_FIELD_NUMBER
Field Value
Type Description
int

NULLABLE_FIELD_NUMBER

public static final int NULLABLE_FIELD_NUMBER
Field Value
Type Description
int

PREFIX_ITEMS_FIELD_NUMBER

public static final int PREFIX_ITEMS_FIELD_NUMBER
Field Value
Type Description
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

REF_FIELD_NUMBER

public static final int REF_FIELD_NUMBER
Field Value
Type Description
int

REQUIRED_FIELD_NUMBER

public static final int REQUIRED_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UNIQUE_ITEMS_FIELD_NUMBER

public static final int UNIQUE_ITEMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Schema getDefaultInstance()
Returns
Type Description
Schema

getDescriptor()

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

newBuilder()

public static Schema.Builder newBuilder()
Returns
Type Description
Schema.Builder

newBuilder(Schema prototype)

public static Schema.Builder newBuilder(Schema prototype)
Parameter
Name Description
prototype Schema
Returns
Type Description
Schema.Builder

parseDelimitedFrom(InputStream input)

public static Schema parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Schema
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Schema parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Schema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Schema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Schema parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Schema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Schema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Schema parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Schema
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Schema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Schema parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Schema
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Schema parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Schema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Schema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Schema> parser()
Returns
Type Description
Parser<Schema>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

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.

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.

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.

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.

getParserForType()

public Parser<Schema> getParserForType()
Returns
Type Description
Parser<Schema>
Overrides

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Schema.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Schema.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException