Class Schema (1.94.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-object>__. 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" for STRING type: "email", "byte", etc
title str
Optional. The title of the Schema.
description str
Optional. The description of the data.
nullable bool
Optional. Indicates if the value may be null.
default google.protobuf.struct_pb2.Value
Optional. Default value of the data.
items google.cloud.aiplatform_v1.types.Schema
Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
min_items int
Optional. Minimum number of the elements for Type.ARRAY.
max_items int
Optional. Maximum number of the elements for Type.ARRAY.
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"]}
properties MutableMapping[str, google.cloud.aiplatform_v1.types.Schema]
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
property_ordering MutableSequence[str]
Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
required MutableSequence[str]
Optional. Required properties of Type.OBJECT.
min_properties int
Optional. Minimum number of the properties for Type.OBJECT.
max_properties int
Optional. Maximum number of the properties for Type.OBJECT.
minimum float
Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
maximum float
Optional. Maximum value of the Type.INTEGER and Type.NUMBER
min_length int
Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
max_length int
Optional. Maximum length of the Type.STRING
pattern str
Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
example google.protobuf.struct_pb2.Value
Optional. Example of the object. Will only populated when the object is the root.
any_of MutableSequence[google.cloud.aiplatform_v1.types.Schema]
Optional. The value should be validated against any (one or more) of the subschemas in the list.
additional_properties google.protobuf.struct_pb2.Value
Optional. Can either be a boolean or an object; controls the presence of additional properties.
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.aiplatform_v1.types.Schema]
Optional. A map of definitions for use by ref Only allowed at the root of the schema.

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.

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-object>__. More fields may be added in the future as needed.