Google Cloud Asset V1 Client - Class TableFieldSchema (1.12.2)

Reference documentation and code samples for the Google Cloud Asset V1 Client class TableFieldSchema.

A field in TableSchema.

Generated from protobuf message google.cloud.asset.v1.TableFieldSchema

Namespace

Google \ Cloud \ Asset \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ field`	`string` The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
`↳ type`	`string` The field data type. Possible values include * STRING * BYTES * INTEGER * FLOAT * BOOLEAN * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY, * NUMERIC, * BIGNUMERIC, * RECORD (where RECORD indicates that the field contains a nested schema).
`↳ mode`	`string` The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
`↳ fields`	`array<Google\Cloud\Asset\V1\TableFieldSchema>` Describes the nested schema fields if the type property is set to RECORD.

getField

The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

Returns
Type	Description
`string`

setField

The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

The field data type. Possible values include

STRING
BYTES
INTEGER
FLOAT
BOOLEAN
TIMESTAMP
DATE
TIME
DATETIME
GEOGRAPHY,
NUMERIC,
BIGNUMERIC,
RECORD (where RECORD indicates that the field contains a nested schema).

Returns
Type	Description
`string`

setType

The field data type. Possible values include

STRING
BYTES
INTEGER
FLOAT
BOOLEAN
TIMESTAMP
DATE
TIME
DATETIME
GEOGRAPHY,
NUMERIC,
BIGNUMERIC,
RECORD (where RECORD indicates that the field contains a nested schema).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMode

The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

Returns
Type	Description
`string`

setMode

The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFields

Describes the nested schema fields if the type property is set to RECORD.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setFields

Describes the nested schema fields if the type property is set to RECORD.

Parameter
Name	Description
`var`	`array<Google\Cloud\Asset\V1\TableFieldSchema>`

Returns
Type	Description
`$this`