Cloud AutoML V1beta1 Client - Class DataType (1.4.17)

Reference documentation and code samples for the Cloud AutoML V1beta1 Client class DataType.

Indicated the type of data that can be stored in a structured data entity (e.g. a table).

Generated from protobuf message google.cloud.automl.v1beta1.DataType

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ list_element_type`	`Google\Cloud\AutoMl\V1beta1\DataType` If type_code == ARRAY, then `list_element_type` is the type of the elements.
`↳ struct_type`	`Google\Cloud\AutoMl\V1beta1\StructType` If type_code == STRUCT, then `struct_type` provides type information for the struct's fields.
`↳ time_format`	`string` If type_code == TIMESTAMP then `time_format` provides the format in which that time field is expressed. The time_format must either be one of: * `UNIX_SECONDS` * `UNIX_MILLISECONDS` * `UNIX_MICROSECONDS` * `UNIX_NANOSECONDS` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format as described on the type_code is used.
`↳ type_code`	`int` Required. The TypeCode for this type.
`↳ nullable`	`bool` If true, this DataType can also be `NULL`. In .CSV files `NULL` value is expressed as an empty string.

getListElementType

If type_code == ARRAY, then list_element_type is the type of the elements.

Returns
Type	Description
`Google\Cloud\AutoMl\V1beta1\DataType\|null`

hasListElementType

setListElementType

If type_code == ARRAY, then list_element_type is the type of the elements.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1beta1\DataType`

Returns
Type	Description
`$this`

getStructType

If type_code == STRUCT, then struct_type provides type information for the struct's fields.

Returns
Type	Description
`Google\Cloud\AutoMl\V1beta1\StructType\|null`

hasStructType

setStructType

If type_code == STRUCT, then struct_type provides type information for the struct's fields.

Parameter
Name	Description
`var`	`Google\Cloud\AutoMl\V1beta1\StructType`

Returns
Type	Description
`$this`

getTimeFormat

If type_code == TIMESTAMP then time_format provides the format in which that time field is expressed. The time_format must either be one of:

UNIX_SECONDS
UNIX_MILLISECONDS
UNIX_MICROSECONDS
UNIX_NANOSECONDS (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in strftime syntax. If time_format is not set, then the default format as described on the type_code is used.

Returns
Type	Description
`string`

hasTimeFormat

setTimeFormat

If type_code == TIMESTAMP then time_format provides the format in which that time field is expressed. The time_format must either be one of:

UNIX_SECONDS
UNIX_MILLISECONDS
UNIX_MICROSECONDS
UNIX_NANOSECONDS (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in strftime syntax. If time_format is not set, then the default format as described on the type_code is used.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTypeCode

Required. The TypeCode for this type.

Returns
Type	Description
`int`

setTypeCode

Required. The TypeCode for this type.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getNullable

If true, this DataType can also be NULL. In .CSV files NULL value is expressed as an empty string.

Returns
Type	Description
`bool`

setNullable

If true, this DataType can also be NULL. In .CSV files NULL value is expressed as an empty string.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDetails

Returns
Type	Description
`string`