Cloud PubSub V1 Client - Class DelimitedKey (2.23.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class DelimitedKey.

Row key definition based on fields from the message.

Generated from protobuf message google.pubsub.v1.BigtableConfig.ColumnFamilyMapping.DelimitedKey

Namespace

Google \ Cloud \ PubSub \ V1 \ BigtableConfig \ ColumnFamilyMapping

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ key_fields string[]

Required. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects.
↳ delimiter string

Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters.

getKeyFields

Required. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setKeyFields

Required. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDelimiter

Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters.

Returns
Type Description
string

setDelimiter

Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters.

Parameter
Name Description
var string
Returns
Type Description
$this