Google Cloud Ai Platform V1 Client - Class Schema (1.12.0)

Version 1.12.0

• 1.13.0 (latest)
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Schema.

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.

Generated from protobuf message google.cloud.aiplatform.v1.Schema

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ type	int Optional. The type of the data.
↳ format	string 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	string Optional. The title of the Schema.
↳ description	string Optional. The description of the data.
↳ nullable	bool Optional. Indicates if the value may be null.
↳ default	Google\Protobuf\Value Optional. Default value of the data.
↳ items	Schema Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
↳ 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.
↳ 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"]}
↳ properties	array|Google\Protobuf\Internal\MapField Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
↳ property_ordering	array Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
↳ required	array Optional. Required properties of Type.OBJECT.
↳ min_properties	int|string Optional. Minimum number of the properties for Type.OBJECT.
↳ max_properties	int|string 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|string Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
↳ max_length	int|string Optional. Maximum length of the Type.STRING
↳ pattern	string Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
↳ example	Google\Protobuf\Value Optional. Example of the object. Will only populated when the object is the root.
↳ any_of	array<Schema> Optional. The value should be validated against any (one or more) of the subschemas in the list.

getType

Optional. The type of the data.

Returns
Type	Description
int

setType

Optional. The type of the data.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getFormat

Optional. The format of the data.

Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc

Returns
Type	Description
string

setFormat

Optional. The format of the data.

Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTitle

Optional. The title of the Schema.

Returns
Type	Description
string

setTitle

Optional. The title of the Schema.

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

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

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

getItems

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

Returns
Type	Description
Schema|null

hasItems

clearItems

setItems

Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.

Parameter
Name	Description
var	Schema

Returns
Type	Description
$this

getMinItems

Optional. Minimum number of the elements for Type.ARRAY.

Returns
Type	Description
int|string

setMinItems

Optional. Minimum number of the elements for Type.ARRAY.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getMaxItems

Optional. Maximum number of the elements for Type.ARRAY.

Returns
Type	Description
int|string

setMaxItems

Optional. Maximum number of the elements for Type.ARRAY.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getEnum

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

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setEnum

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

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getProperties

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setProperties

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.

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

Returns
Type	Description
$this

getPropertyOrdering

Optional. The order of the properties.

Not a standard field in open api spec. Only used to support the order of the properties.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPropertyOrdering

Optional. The order of the properties.

Not a standard field in open api spec. Only used to support the order of the properties.

Parameter
Name	Description
var	string[]

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

getMinProperties

Optional. Minimum number of the properties for Type.OBJECT.

Returns
Type	Description
int|string

setMinProperties

Optional. Minimum number of the properties for Type.OBJECT.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getMaxProperties

Optional. Maximum number of the properties for Type.OBJECT.

Returns
Type	Description
int|string

setMaxProperties

Optional. Maximum number of the properties for Type.OBJECT.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getMinimum

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

Returns
Type	Description
float

setMinimum

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getMaximum

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

Returns
Type	Description
float

setMaximum

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

Parameter
Name	Description
var	float

Returns
Type	Description
$this

getMinLength

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

Returns
Type	Description
int|string

setMinLength

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getMaxLength

Optional. Maximum length of the Type.STRING

Returns
Type	Description
int|string

setMaxLength

Optional. Maximum length of the Type.STRING

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getPattern

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

Returns
Type	Description
string

setPattern

Optional. Pattern of the Type.STRING to restrict a string to a regular expression.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getExample

Optional. Example of the object. Will only populated when the object is the root.

Returns
Type	Description
Google\Protobuf\Value|null

hasExample

clearExample

setExample

Optional. Example of the object. Will only populated when the object is the root.

Parameter
Name	Description
var	Google\Protobuf\Value

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