Stackdriver Logging V2 Client - Class BigQueryOptions (1.24.10)

Reference documentation and code samples for the Stackdriver Logging V2 Client class BigQueryOptions.

Options that change functionality of a sink exporting data to BigQuery.

Generated from protobuf message google.logging.v2.BigQueryOptions

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ use_partitioned_tables bool

Optional. Whether to use BigQuery's partition tables. By default, Cloud Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

↳ uses_timestamp_column_partitioning bool

Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.

getUsePartitionedTables

Optional. Whether to use BigQuery's partition tables. By default, Cloud Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

Generated from protobuf field bool use_partitioned_tables = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
bool

setUsePartitionedTables

Optional. Whether to use BigQuery's partition tables. By default, Cloud Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone.

Generated from protobuf field bool use_partitioned_tables = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getUsesTimestampColumnPartitioning

Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use.

All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.

Generated from protobuf field bool uses_timestamp_column_partitioning = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
bool

setUsesTimestampColumnPartitioning

Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use.

All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.

Generated from protobuf field bool uses_timestamp_column_partitioning = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var bool
Returns
TypeDescription
$this