Class TopicAdminClient (2.20.0-rc)

A service to manipulate topics.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

TopicAdminClient(TopicAdminClient const &)

Copy and move support

Parameter
NameDescription
TopicAdminClient const &

TopicAdminClient(TopicAdminClient &&)

Copy and move support

Parameter
NameDescription
TopicAdminClient &&

TopicAdminClient(std::shared_ptr< TopicAdminConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< TopicAdminConnection >
opts Options

Operators

operator=(TopicAdminClient const &)

Copy and move support

Parameter
NameDescription
TopicAdminClient const &
Returns
TypeDescription
TopicAdminClient &

operator=(TopicAdminClient &&)

Copy and move support

Parameter
NameDescription
TopicAdminClient &&
Returns
TypeDescription
TopicAdminClient &

Functions

CreateTopic(std::string const &, Options)

Creates the given topic with the given name.

Parameters
NameDescription
name std::string const &

Required. The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::pubsub::v1::Topic >

the result of the RPC. The response message type (google.pubsub.v1.Topic) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTopic(google::pubsub::v1::Topic const &, Options)

Creates the given topic with the given name.

Parameters
NameDescription
request google::pubsub::v1::Topic const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.Topic. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::pubsub::v1::Topic >

the result of the RPC. The response message type (google.pubsub.v1.Topic) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTopic(google::pubsub::v1::Topic const &, google::protobuf::FieldMask const &, Options)

Updates an existing topic.

Note that certain properties of a topic are not modifiable.

Parameters
NameDescription
topic google::pubsub::v1::Topic const &

Required. The updated topic object.

update_mask google::protobuf::FieldMask const &

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.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::pubsub::v1::Topic >

the result of the RPC. The response message type (google.pubsub.v1.Topic) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateTopic(google::pubsub::v1::UpdateTopicRequest const &, Options)

Updates an existing topic.

Note that certain properties of a topic are not modifiable.

Parameters
NameDescription
request google::pubsub::v1::UpdateTopicRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.UpdateTopicRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::pubsub::v1::Topic >

the result of the RPC. The response message type (google.pubsub.v1.Topic) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTopic(std::string const &, Options)

Gets the configuration of a topic.

Parameters
NameDescription
topic std::string const &

Required. The name of the topic to get. Format is projects/{project}/topics/{topic}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::pubsub::v1::Topic >

the result of the RPC. The response message type (google.pubsub.v1.Topic) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTopic(google::pubsub::v1::GetTopicRequest const &, Options)

Gets the configuration of a topic.

Parameters
NameDescription
request google::pubsub::v1::GetTopicRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.GetTopicRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::pubsub::v1::Topic >

the result of the RPC. The response message type (google.pubsub.v1.Topic) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListTopics(std::string const &, Options)

Lists matching topics.

Parameters
NameDescription
project std::string const &

Required. The name of the project in which to list topics. Format is projects/{project-id}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::pubsub::v1::Topic >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.pubsub.v1.Topic, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTopics(google::pubsub::v1::ListTopicsRequest, Options)

Lists matching topics.

Parameters
NameDescription
request google::pubsub::v1::ListTopicsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.ListTopicsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< google::pubsub::v1::Topic >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.pubsub.v1.Topic, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTopicSubscriptions(std::string const &, Options)

Lists the names of the attached subscriptions on this topic.

Parameters
NameDescription
topic std::string const &

Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< std::string >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains a std::string.

ListTopicSubscriptions(google::pubsub::v1::ListTopicSubscriptionsRequest, Options)

Lists the names of the attached subscriptions on this topic.

Parameters
NameDescription
request google::pubsub::v1::ListTopicSubscriptionsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.ListTopicSubscriptionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< std::string >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains a std::string.

ListTopicSnapshots(std::string const &, Options)

Lists the names of the snapshots on this topic.

Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Parameters
NameDescription
topic std::string const &

Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< std::string >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains a std::string.

ListTopicSnapshots(google::pubsub::v1::ListTopicSnapshotsRequest, Options)

Lists the names of the snapshots on this topic.

Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Parameters
NameDescription
request google::pubsub::v1::ListTopicSnapshotsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.ListTopicSnapshotsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StreamRange< std::string >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains a std::string.

DeleteTopic(std::string const &, Options)

Deletes the topic with the given name.

Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic field is set to _deleted-topic_.

Parameters
NameDescription
topic std::string const &

Required. Name of the topic to delete. Format is projects/{project}/topics/{topic}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteTopic(google::pubsub::v1::DeleteTopicRequest const &, Options)

Deletes the topic with the given name.

Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their topic field is set to _deleted-topic_.

Parameters
NameDescription
request google::pubsub::v1::DeleteTopicRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.DeleteTopicRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
Status

a Status object. If the request failed, the status contains the details of the failure.

DetachSubscription(google::pubsub::v1::DetachSubscriptionRequest const &, Options)

Detaches a subscription from this topic.

All messages retained in the subscription are dropped. Subsequent Pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

Parameters
NameDescription
request google::pubsub::v1::DetachSubscriptionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.pubsub.v1.DetachSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::pubsub::v1::DetachSubscriptionResponse >

the result of the RPC. The response message type (google.pubsub.v1.DetachSubscriptionResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.