Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ColumnMetadata.
Metadata of the column.
Generated from protobuf message google.cloud.chronicle.v1.ColumnMetadata
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ column |
string
Name of the column. |
↳ field_path |
string
Field path of the queried field, if any. |
↳ function_name |
string
Name of the function used to query the field, if any. |
↳ function_module |
string
Module of the function used to query the field, if any. |
↳ data_source |
int
Data source queried. |
↳ timestamp_metadata |
TimestampMetadata
Timestamp Metadata |
↳ longitude |
bool
Whether the column is a longitude field. |
↳ latitude |
bool
Whether the column is a latitude field. |
↳ selected |
bool
Whether the column is selected in the final response. |
↳ unselected |
bool
Whether the column is unselected in the final response. |
getColumn
Name of the column.
| Returns | |
|---|---|
| Type | Description |
string |
|
setColumn
Name of the column.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFieldPath
Field path of the queried field, if any.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFieldPath
Field path of the queried field, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFunctionName
Name of the function used to query the field, if any.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFunctionName
Name of the function used to query the field, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFunctionModule
Module of the function used to query the field, if any.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFunctionModule
Module of the function used to query the field, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataSource
Data source queried.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DataSource. |
setDataSource
Data source queried.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type DataSource. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTimestampMetadata
Timestamp Metadata
| Returns | |
|---|---|
| Type | Description |
TimestampMetadata|null |
|
hasTimestampMetadata
clearTimestampMetadata
setTimestampMetadata
Timestamp Metadata
| Parameter | |
|---|---|
| Name | Description |
var |
TimestampMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLongitude
Whether the column is a longitude field.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setLongitude
Whether the column is a longitude field.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLatitude
Whether the column is a latitude field.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setLatitude
Whether the column is a latitude field.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelected
Whether the column is selected in the final response.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSelected
Whether the column is selected in the final response.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnselected
Whether the column is unselected in the final response.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setUnselected
Whether the column is unselected in the final response.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|