Reference documentation and code samples for the Google Cloud Ces V1 Client class Schema.
Represents a select subset of an OpenAPI 3.0 schema object.
Generated from protobuf message google.cloud.ces.v1.Schema
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ type
int
Required. The type of the data.
↳ properties
↳ required
string[]
Optional. Required properties of Type.OBJECT.
↳ description
string
Optional. The description of the data.
↳ items
↳ nullable
bool
Optional. Indicates if the value may be null.
↳ unique_items
bool
Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
↳ prefix_items
↳ additional_properties
Schema
Optional. Can either be a boolean or an object, controls the presence of additional properties.
↳ any_of
array< Schema
>
Optional. The value should be validated against any (one or more) of the subschemas in the list.
↳ enum
string[]
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"]}
↳ default
↳ ref
string
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": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string
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
.
↳ defs
array| Google\Protobuf\Internal\MapField
Optional. A map of definitions for use by ref
. Only allowed at the root of the schema.
↳ title
string
Optional. The title of the schema.
↳ min_items
int|string
Optional. Minimum number of the elements for Type.ARRAY.
↳ max_items
int|string
Optional. Maximum number of the elements for Type.ARRAY.
↳ minimum
float
Optional. Minimum value for Type.INTEGER and Type.NUMBER.
↳ maximum
float
Optional. Maximum value for Type.INTEGER and Type.NUMBER.
getType
Required. The type of the data.
setType
Required. The type of the data.
$this
getProperties
Optional. Properties of Type.OBJECT.
setProperties
Optional. Properties of Type.OBJECT.
$this
getRequired
Optional. Required properties of Type.OBJECT.
setRequired
Optional. Required properties of Type.OBJECT.
var
string[]
$this
getDescription
Optional. The description of the data.
string
setDescription
Optional. The description of the data.
var
string
$this
getItems
Optional. Schema of the elements of Type.ARRAY.
hasItems
clearItems
setItems
Optional. Schema of the elements of Type.ARRAY.
$this
getNullable
Optional. Indicates if the value may be null.
bool
setNullable
Optional. Indicates if the value may be null.
var
bool
$this
getUniqueItems
Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
bool
setUniqueItems
Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
var
bool
$this
getPrefixItems
Optional. Schemas of initial elements of Type.ARRAY.
setPrefixItems
Optional. Schemas of initial elements of Type.ARRAY.
$this
getAdditionalProperties
Optional. Can either be a boolean or an object, controls the presence of additional properties.
hasAdditionalProperties
clearAdditionalProperties
setAdditionalProperties
Optional. Can either be a boolean or an object, controls the presence of additional properties.
$this
getAnyOf
Optional. The value should be validated against any (one or more) of the subschemas in the list.
setAnyOf
Optional. The value should be validated against any (one or more) of the subschemas in the list.
$this
getEnum
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"]}
setEnum
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"]}
var
string[]
$this
getDefault
Optional. Default value of the data.
hasDefault
clearDefault
setDefault
Optional. Default value of the data.
$this
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":
type: object
properties:
pet:
ref: #/defs/Pet
defs:
Pet:
type: object
properties:
name:
type: string
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
setRef
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":
type: object
properties:
pet:
ref: #/defs/Pet
defs:
Pet:
type: object
properties:
name:
type: string
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 .
var
string
$this
getDefs
Optional. A map of definitions for use by ref
. Only allowed at the root
of the schema.
setDefs
Optional. A map of definitions for use by ref
. Only allowed at the root
of the schema.
$this
getTitle
Optional. The title of the schema.
string
setTitle
Optional. The title of the schema.
var
string
$this
getMinItems
Optional. Minimum number of the elements for Type.ARRAY.
int|string
setMinItems
Optional. Minimum number of the elements for Type.ARRAY.
var
int|string
$this
getMaxItems
Optional. Maximum number of the elements for Type.ARRAY.
int|string
setMaxItems
Optional. Maximum number of the elements for Type.ARRAY.
var
int|string
$this
getMinimum
Optional. Minimum value for Type.INTEGER and Type.NUMBER.
float
hasMinimum
clearMinimum
setMinimum
Optional. Minimum value for Type.INTEGER and Type.NUMBER.
var
float
$this
getMaximum
Optional. Maximum value for Type.INTEGER and Type.NUMBER.
float
hasMaximum
clearMaximum
setMaximum
Optional. Maximum value for Type.INTEGER and Type.NUMBER.
var
float
$this
