Google Cloud Ces V1 Client - Class Schema (0.1.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ type`	`int` Required. The type of the data.
`↳ properties`	`array\|Google\Protobuf\Internal\MapField` Optional. Properties of Type.OBJECT.
`↳ required`	`array` Optional. Required properties of Type.OBJECT.
`↳ description`	`string` Optional. The description of the data.
`↳ items`	`Schema` Optional. Schema of the elements of Type.ARRAY.
`↳ 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`	`array<Schema>` Optional. Schemas of initial elements of Type.ARRAY.
`↳ 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`	`array` 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`	`Google\Protobuf\Value` Optional. Default value of the data.
`↳ 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.

Returns
Type	Description
`int`	Enum of type Type.

setType

Required. The type of the data.

Parameter
Name	Description
`var`	`int` Enum of type Type.

Returns
Type	Description
`$this`

getProperties

Optional. Properties of Type.OBJECT.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setProperties

Optional. Properties of Type.OBJECT.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getRequired

Optional. Required properties of Type.OBJECT.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setRequired

Optional. Required properties of Type.OBJECT.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDescription

Optional. The description of the data.

Returns
Type	Description
`string`

setDescription

Optional. The description of the data.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getItems

Optional. Schema of the elements of Type.ARRAY.

Returns
Type	Description
`Schema\|null`

hasItems

clearItems

setItems

Optional. Schema of the elements of Type.ARRAY.

Parameter
Name	Description
`var`	`Schema`

Returns
Type	Description
`$this`

getNullable

Optional. Indicates if the value may be null.

Returns
Type	Description
`bool`

setNullable

Optional. Indicates if the value may be null.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getUniqueItems

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

Returns
Type	Description
`bool`

setUniqueItems

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPrefixItems

Optional. Schemas of initial elements of Type.ARRAY.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPrefixItems

Optional. Schemas of initial elements of Type.ARRAY.

Parameter
Name	Description
`var`	`array<Schema>`

Returns
Type	Description
`$this`

getAdditionalProperties

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

Returns
Type	Description
`Schema\|null`

hasAdditionalProperties

clearAdditionalProperties

setAdditionalProperties

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

Parameter
Name	Description
`var`	`Schema`

Returns
Type	Description
`$this`

getAnyOf

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAnyOf

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

Parameter
Name	Description
`var`	`array<Schema>`

Returns
Type	Description
`$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"]}

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

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"]}

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDefault

Optional. Default value of the data.

Returns
Type	Description
`Google\Protobuf\Value\|null`

hasDefault

clearDefault

setDefault

Optional. Default value of the data.

Parameter
Name	Description
`var`	`Google\Protobuf\Value`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

setRef