Class Schema (0.3.0) 

Schema(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a select subset of an OpenAPI 3.0 schema object.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
type_ google.cloud.ces_v1.types.Schema.Type
Required. The type of the data.
properties MutableMapping[str, google.cloud.ces_v1.types.Schema]
Optional. Properties of Type.OBJECT.
required MutableSequence[str]
Optional. Required properties of Type.OBJECT.
description str
Optional. The description of the data.
items google.cloud.ces_v1.types.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 MutableSequence[google.cloud.ces_v1.types.Schema]
Optional. Schemas of initial elements of Type.ARRAY.
additional_properties google.cloud.ces_v1.types.Schema
Optional. Can either be a boolean or an object, controls the presence of additional properties.
any_of MutableSequence[google.cloud.ces_v1.types.Schema]
Optional. The value should be validated against any (one or more) of the subschemas in the list.
enum MutableSequence[str]
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.struct_pb2.Value
Optional. Default value of the data.
ref str
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 MutableMapping[str, google.cloud.ces_v1.types.Schema]
Optional. A map of definitions for use by ref. Only allowed at the root of the schema.
title str
Optional. The title of the schema.
min_items int
Optional. Minimum number of the elements for Type.ARRAY.
max_items int
Optional. Maximum number of the elements for Type.ARRAY.
minimum float
Optional. Minimum value for Type.INTEGER and Type.NUMBER. This field is a member of oneof_ _minimum.
maximum float
Optional. Maximum value for Type.INTEGER and Type.NUMBER. This field is a member of oneof_ _maximum.

Classes

DefsEntry

DefsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

PropertiesEntry

PropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Type

Type(value)

OpenAPI data types.