Class Schema (1.39.0)

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

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object <https://spec.openapis.org/oas/v3.0.3#schema>__. More fields may be added in the future as needed.

Attributes
Name Description
type_ google.cloud.aiplatform_v1.types.Type
Optional. The type of the data.
format_ str
Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64
description str
Optional. The description of the data.
nullable bool
Optional. Indicates if the value may be null.
items google.cloud.aiplatform_v1.types.Schema
Optional. Schema of the elements of Type.ARRAY.
enum MutableSequence[str]
Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
properties MutableMapping[str, google.cloud.aiplatform_v1.types.Schema]
Optional. Properties of Type.OBJECT.
required MutableSequence[str]
Optional. Required properties of Type.OBJECT.
example google.protobuf.struct_pb2.Value
Optional. Example of the object. Will only populated when the object is the root.

Classes

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.

Methods

Schema

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

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object <https://spec.openapis.org/oas/v3.0.3#schema>__. More fields may be added in the future as needed.