- 1.68.0 (latest)
- 1.67.1
- 1.66.0
- 1.65.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
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_v1beta1.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_v1beta1.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 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_v1beta1.types.Schema]
Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. |
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. |
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,
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 |
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.