Class ManagedKafkaClient (2.28.0)

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.

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

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.cloud.managedkafka.v1.Cluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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.cloud.managedkafka.v1.ListClustersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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.cloud.managedkafka.v1.Cluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The name of the cluster whose configuration to return.

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

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

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.cloud.managedkafka.v1.GetClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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

Required. The parent region in which to create the cluster. Structured like projects/{project}/locations/{location}.

Required. Configuration of the cluster to create. Its name field is ignored.

Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? to comply with RFC 1035.
This value is structured like: my-cluster-id.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedkafka.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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.cloud.managedkafka.v1.CreateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedkafka.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

Required. The cluster to update. Its name field must be populated.

Required. Field mask is used to specify the fields to be overwritten in the cluster 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.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedkafka.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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.cloud.managedkafka.v1.UpdateClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedkafka.v1.Cluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

Required. The name of the cluster to delete.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedkafka.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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.cloud.managedkafka.v1.DeleteClusterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.managedkafka.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

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

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.cloud.managedkafka.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.

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.cloud.managedkafka.v1.ListTopicsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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.cloud.managedkafka.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.

Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.

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

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

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.cloud.managedkafka.v1.GetTopicRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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

Required. The parent cluster in which to create the topic. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

Required. Configuration of the topic to create. Its name field is ignored.

Required. The ID to use for the topic, which will become the final component of the topic's name.
This value is structured like: my-topic-name.

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

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

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.cloud.managedkafka.v1.CreateTopicRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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

Required. The topic to update. Its name field must be populated.

Required. Field mask is used to specify the fields to be overwritten in the Topic 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.

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

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

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.cloud.managedkafka.v1.UpdateTopicRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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

Required. The name of the topic to delete. projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.

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

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

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.cloud.managedkafka.v1.DeleteTopicRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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

Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

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

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.cloud.managedkafka.v1.ConsumerGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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.cloud.managedkafka.v1.ListConsumerGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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.cloud.managedkafka.v1.ConsumerGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

Required. The name of the consumer group whose configuration to return. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.

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

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

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.cloud.managedkafka.v1.GetConsumerGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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

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

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.

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

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

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.cloud.managedkafka.v1.UpdateConsumerGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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

Required. The name of the consumer group to delete. projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}.

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

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

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.cloud.managedkafka.v1.DeleteConsumerGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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

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