Cloud PubSub V1 Client - Class UpdateTopicRequest (2.4.0)

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

Request for the UpdateTopic method.

Generated from protobuf message google.pubsub.v1.UpdateTopicRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ topic Google\Cloud\PubSub\V1\Topic

Required. The updated topic object.
↳ update_mask Google\Protobuf\FieldMask

Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" but the message_storage_policy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level.

getTopic

Required. The updated topic object.

Returns
Type Description
Google\Cloud\PubSub\V1\Topic|null

hasTopic

clearTopic

setTopic

Required. The updated topic object.

Parameter
Name Description
var Google\Cloud\PubSub\V1\Topic
Returns
Type Description
$this

getUpdateMask

Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" but the message_storage_policy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" but the message_storage_policy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level.

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

static::build

Parameters
Name Description
topic Google\Cloud\PubSub\V1\Topic

Required. The updated topic object.
updateMask Google\Protobuf\FieldMask

Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" but the message_storage_policy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level.
Returns
Type Description
Google\Cloud\PubSub\V1\UpdateTopicRequest