Stackdriver Logging V2 Client - Class IndexConfig (1.27.1)

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

Configuration for an indexed field.

Generated from protobuf message google.logging.v2.IndexConfig

Namespace

Google \ Cloud \ Logging \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ field_path string

Required. The LogEntry field path to index. Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details. For example: jsonPayload.request.status

↳ type int

Required. The type of data in this index.

↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when the index was last modified. This is used to return the timestamp, and will be ignored if supplied during update.

getFieldPath

Required. The LogEntry field path to index.

Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details. For example: jsonPayload.request.status

Returns
TypeDescription
string

setFieldPath

Required. The LogEntry field path to index.

Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation for details. For example: jsonPayload.request.status

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. The type of data in this index.

Returns
TypeDescription
int

setType

Required. The type of data in this index.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

Output only. The timestamp when the index was last modified.

This is used to return the timestamp, and will be ignored if supplied during update.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the index was last modified.

This is used to return the timestamp, and will be ignored if supplied during update.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this