Google Cloud Chronicle V1 Client - Class DataTableColumnInfo (0.4.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DataTableColumnInfo.

DataTableColumnInfo represents the column metadata of the datatable. The column_index represents the ordering of the values in DataTableRow.

Generated from protobuf message google.cloud.chronicle.v1.DataTableColumnInfo

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ mapped_column_path
string

Entity proto field path that the column is mapped to

↳ column_type
int

Column type can be STRING, CIDR (Ex- 10.1.1.0/24), REGEX

↳ column_index
int

Required. Column Index. 0,1,2...

↳ original_column
string

Required. Original column name of the Data Table (present in the CSV header in case of creation of data tables using file uploads). It must satisfy the following requirements: - Starts with letter. - Contains only letters, numbers and underscore. - Must be unique and has length < 256.

↳ key_column
bool

Optional. Whether to include this column in the calculation of the row ID. If no columns have key_column = true, all columns will be included in the calculation of the row ID.

↳ repeated_values
bool

Optional. Whether the column is a repeated values column.

getMappedColumnPath

Entity proto field path that the column is mapped to

Returns
Type
Description
string

hasMappedColumnPath

setMappedColumnPath

Entity proto field path that the column is mapped to

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getColumnType

Column type can be STRING, CIDR (Ex- 10.1.1.0/24), REGEX

Returns
Type
Description
int
Enum of type DataTableColumnType .

hasColumnType

setColumnType

Column type can be STRING, CIDR (Ex- 10.1.1.0/24), REGEX

Parameter
Name
Description
var
int

Enum of type DataTableColumnType .

Returns
Type
Description
$this

getColumnIndex

Required. Column Index. 0,1,2...

Generated from protobuf field int32 column_index = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description
int

setColumnIndex

Required. Column Index. 0,1,2...

Generated from protobuf field int32 column_index = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getOriginalColumn

Required. Original column name of the Data Table (present in the CSV header in case of creation of data tables using file uploads). It must satisfy the following requirements:

  • Starts with letter.

  • Contains only letters, numbers and underscore.

  • Must be unique and has length < 256.
Returns
Type
Description
string

setOriginalColumn

Required. Original column name of the Data Table (present in the CSV header in case of creation of data tables using file uploads). It must satisfy the following requirements:

  • Starts with letter.

  • Contains only letters, numbers and underscore.

  • Must be unique and has length < 256.
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getKeyColumn

Optional. Whether to include this column in the calculation of the row ID.

If no columns have key_column = true, all columns will be included in the calculation of the row ID.

Returns
Type
Description
bool

setKeyColumn

Optional. Whether to include this column in the calculation of the row ID.

If no columns have key_column = true, all columns will be included in the calculation of the row ID.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getRepeatedValues

Optional. Whether the column is a repeated values column.

Returns
Type
Description
bool

setRepeatedValues

Optional. Whether the column is a repeated values column.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getPathOrType

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: