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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SchemaImplements
SchemaOrBuilderStatic Fields
ADDITIONAL_PROPERTIES_FIELD_NUMBER
public
static
final
int
ADDITIONAL_PROPERTIES_FIELD_NUMBER
ANY_OF_FIELD_NUMBER
public
static
final
int
ANY_OF_FIELD_NUMBER
DEFAULT_FIELD_NUMBER
public
static
final
int
DEFAULT_FIELD_NUMBER
DEFS_FIELD_NUMBER
public
static
final
int
DEFS_FIELD_NUMBER
DESCRIPTION_FIELD_NUMBER
public
static
final
int
DESCRIPTION_FIELD_NUMBER
ENUM_FIELD_NUMBER
public
static
final
int
ENUM_FIELD_NUMBER
ITEMS_FIELD_NUMBER
public
static
final
int
ITEMS_FIELD_NUMBER
MAXIMUM_FIELD_NUMBER
public
static
final
int
MAXIMUM_FIELD_NUMBER
MAX_ITEMS_FIELD_NUMBER
public
static
final
int
MAX_ITEMS_FIELD_NUMBER
MINIMUM_FIELD_NUMBER
public
static
final
int
MINIMUM_FIELD_NUMBER
MIN_ITEMS_FIELD_NUMBER
public
static
final
int
MIN_ITEMS_FIELD_NUMBER
NULLABLE_FIELD_NUMBER
public
static
final
int
NULLABLE_FIELD_NUMBER
PREFIX_ITEMS_FIELD_NUMBER
public
static
final
int
PREFIX_ITEMS_FIELD_NUMBER
PROPERTIES_FIELD_NUMBER
public
static
final
int
PROPERTIES_FIELD_NUMBER
REF_FIELD_NUMBER
public
static
final
int
REF_FIELD_NUMBER
REQUIRED_FIELD_NUMBER
public
static
final
int
REQUIRED_FIELD_NUMBER
TITLE_FIELD_NUMBER
public
static
final
int
TITLE_FIELD_NUMBER
TYPE_FIELD_NUMBER
public
static
final
int
TYPE_FIELD_NUMBER
UNIQUE_ITEMS_FIELD_NUMBER
public
static
final
int
UNIQUE_ITEMS_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Schema
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Schema
.
Builder
newBuilder
()
newBuilder(Schema prototype)
public
static
Schema
.
Builder
newBuilder
(
Schema
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Schema
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Schema
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Schema
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Schema
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Schema
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Schema
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Schema
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Schema
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Schema
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Schema
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Schema
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Schema
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Schema>
parser
()
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];
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];
equals(Object obj)
public
boolean
equals
(
Object
obj
)
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];
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];
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];
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];
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];
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];
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];
getDefault()
public
Value
getDefault
()
Optional. Default value of the data.
.google.protobuf.Value default = 12 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public
Schema
getDefaultInstanceForType
()
getDefaultOrBuilder()
public
ValueOrBuilder
getDefaultOrBuilder
()
Optional. Default value of the data.
.google.protobuf.Value default = 12 [(.google.api.field_behavior) = OPTIONAL];
getDefs() (deprecated)
public
Map<String
,
Schema
>
getDefs
()
Use #getDefsMap() instead.
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];
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];
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];
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];
getDescription()
public
String
getDescription
()
Optional. The description of the data.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
getDescriptionBytes()
public
ByteString
getDescriptionBytes
()
Optional. The description of the data.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
getEnum(int index)
public
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];
getEnumBytes(int index)
public
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];
getEnumCount()
public
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];
getEnumList()
public
ProtocolStringList
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];
getItems()
public
Schema
getItems
()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.ces.v1.Schema items = 5 [(.google.api.field_behavior) = OPTIONAL];
getItemsOrBuilder()
public
SchemaOrBuilder
getItemsOrBuilder
()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.ces.v1.Schema items = 5 [(.google.api.field_behavior) = OPTIONAL];
getMaxItems()
public
long
getMaxItems
()
Optional. Maximum number of the elements for Type.ARRAY.
int64 max_items = 17 [(.google.api.field_behavior) = OPTIONAL];
getMaximum()
public
double
getMaximum
()
Optional. Maximum value for Type.INTEGER and Type.NUMBER.
optional double maximum = 19 [(.google.api.field_behavior) = OPTIONAL];
getMinItems()
public
long
getMinItems
()
Optional. Minimum number of the elements for Type.ARRAY.
int64 min_items = 16 [(.google.api.field_behavior) = OPTIONAL];
getMinimum()
public
double
getMinimum
()
Optional. Minimum value for Type.INTEGER and Type.NUMBER.
optional double minimum = 18 [(.google.api.field_behavior) = OPTIONAL];
getNullable()
public
boolean
getNullable
()
Optional. Indicates if the value may be null.
bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public
Parser<Schema>
getParserForType
()
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];
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];
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];
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];
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];
getProperties() (deprecated)
public
Map<String
,
Schema
>
getProperties
()
Use #getPropertiesMap() instead.
getPropertiesCount()
public
int
getPropertiesCount
()
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.ces.v1.Schema> properties = 2 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
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];
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];
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];
getRequired(int index)
public
String
getRequired
(
int
index
)
Optional. Required properties of Type.OBJECT.
repeated string required = 3 [(.google.api.field_behavior) = OPTIONAL];
getRequiredBytes(int index)
public
ByteString
getRequiredBytes
(
int
index
)
Optional. Required properties of Type.OBJECT.
repeated string required = 3 [(.google.api.field_behavior) = OPTIONAL];
getRequiredCount()
public
int
getRequiredCount
()
Optional. Required properties of Type.OBJECT.
repeated string required = 3 [(.google.api.field_behavior) = OPTIONAL];
getRequiredList()
public
ProtocolStringList
getRequiredList
()
Optional. Required properties of Type.OBJECT.
repeated string required = 3 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public
int
getSerializedSize
()
getTitle()
public
String
getTitle
()
Optional. The title of the schema.
string title = 15 [(.google.api.field_behavior) = OPTIONAL];
getTitleBytes()
public
ByteString
getTitleBytes
()
Optional. The title of the schema.
string title = 15 [(.google.api.field_behavior) = OPTIONAL];
getType()
public
Schema
.
Type
getType
()
Required. The type of the data.
.google.cloud.ces.v1.Schema.Type type = 1 [(.google.api.field_behavior) = REQUIRED];
getTypeValue()
public
int
getTypeValue
()
Required. The type of the data.
.google.cloud.ces.v1.Schema.Type type = 1 [(.google.api.field_behavior) = REQUIRED];
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];
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];
hasDefault()
public
boolean
hasDefault
()
Optional. Default value of the data.
.google.protobuf.Value default = 12 [(.google.api.field_behavior) = OPTIONAL];
hasItems()
public
boolean
hasItems
()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.ces.v1.Schema items = 5 [(.google.api.field_behavior) = OPTIONAL];
hasMaximum()
public
boolean
hasMaximum
()
Optional. Maximum value for Type.INTEGER and Type.NUMBER.
optional double maximum = 19 [(.google.api.field_behavior) = OPTIONAL];
hasMinimum()
public
boolean
hasMinimum
()
Optional. Minimum value for Type.INTEGER and Type.NUMBER.
optional double minimum = 18 [(.google.api.field_behavior) = OPTIONAL];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessage
.
FieldAccessorTable
internalGetFieldAccessorTable
()
internalGetMapFieldReflection(int number)
protected
MapFieldReflectionAccessor
internalGetMapFieldReflection
(
int
number
)
com.google.protobuf.MapFieldReflectionAccessor
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Schema
.
Builder
newBuilderForType
()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected
Schema
.
Builder
newBuilderForType
(
AbstractMessage
.
BuilderParent
parent
)
toBuilder()
public
Schema
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
