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
Name	Description
`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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

Required. The type of data in this index.

Returns
Type	Description
`int`

setType

Required. The type of data in this index.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`