Google Cloud Managed Kafka V1 Client - Class UpdateConsumerGroupRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class UpdateConsumerGroupRequest.

Request for UpdateConsumerGroup.

Generated from protobuf message google.cloud.managedkafka.v1.UpdateConsumerGroupRequest

Namespace

Google \ Cloud \ ManagedKafka \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ update_mask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

↳ consumer_group Google\Cloud\ManagedKafka\V1\ConsumerGroup

Required. The consumer group to update. Its name field must be populated.

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getConsumerGroup

Required. The consumer group to update. Its name field must be populated.

Returns
Type Description
Google\Cloud\ManagedKafka\V1\ConsumerGroup|null

hasConsumerGroup

clearConsumerGroup

setConsumerGroup

Required. The consumer group to update. Its name field must be populated.

Parameter
Name Description
var Google\Cloud\ManagedKafka\V1\ConsumerGroup
Returns
Type Description
$this

static::build

Parameters
Name Description
consumerGroup Google\Cloud\ManagedKafka\V1\ConsumerGroup

Required. The consumer group to update. Its name field must be populated.

updateMask Google\Protobuf\FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

Returns
Type Description
Google\Cloud\ManagedKafka\V1\UpdateConsumerGroupRequest