pub struct AdminServiceClient<T> { /* private fields */ }
Expand description

The service that a client application uses to manage topics and subscriptions, such creating, listing, and deleting topics and subscriptions.

Implementations§

source§

impl<T> AdminServiceClient<T>
where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

source

pub fn new(inner: T) -> Self

source

pub fn with_origin(inner: T, origin: Uri) -> Self

source

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> AdminServiceClient<InterceptedService<T, F>>
where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

source

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

source

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

source

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

source

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

source

pub async fn create_topic( &mut self, request: impl IntoRequest<CreateTopicRequest> ) -> Result<Response<Topic>, Status>

Creates a new topic.

source

pub async fn get_topic( &mut self, request: impl IntoRequest<GetTopicRequest> ) -> Result<Response<Topic>, Status>

Returns the topic configuration.

source

pub async fn get_topic_partitions( &mut self, request: impl IntoRequest<GetTopicPartitionsRequest> ) -> Result<Response<TopicPartitions>, Status>

Returns the partition information for the requested topic.

source

pub async fn list_topics( &mut self, request: impl IntoRequest<ListTopicsRequest> ) -> Result<Response<ListTopicsResponse>, Status>

Returns the list of topics for the given project.

source

pub async fn update_topic( &mut self, request: impl IntoRequest<UpdateTopicRequest> ) -> Result<Response<Topic>, Status>

Updates properties of the specified topic.

source

pub async fn delete_topic( &mut self, request: impl IntoRequest<DeleteTopicRequest> ) -> Result<Response<()>, Status>

Deletes the specified topic.

source

pub async fn list_topic_subscriptions( &mut self, request: impl IntoRequest<ListTopicSubscriptionsRequest> ) -> Result<Response<ListTopicSubscriptionsResponse>, Status>

Lists the subscriptions attached to the specified topic.

source

pub async fn create_subscription( &mut self, request: impl IntoRequest<CreateSubscriptionRequest> ) -> Result<Response<Subscription>, Status>

Creates a new subscription.

source

pub async fn get_subscription( &mut self, request: impl IntoRequest<GetSubscriptionRequest> ) -> Result<Response<Subscription>, Status>

Returns the subscription configuration.

source

pub async fn list_subscriptions( &mut self, request: impl IntoRequest<ListSubscriptionsRequest> ) -> Result<Response<ListSubscriptionsResponse>, Status>

Returns the list of subscriptions for the given project.

source

pub async fn update_subscription( &mut self, request: impl IntoRequest<UpdateSubscriptionRequest> ) -> Result<Response<Subscription>, Status>

Updates properties of the specified subscription.

source

pub async fn delete_subscription( &mut self, request: impl IntoRequest<DeleteSubscriptionRequest> ) -> Result<Response<()>, Status>

Deletes the specified subscription.

source

pub async fn seek_subscription( &mut self, request: impl IntoRequest<SeekSubscriptionRequest> ) -> Result<Response<Operation>, Status>

Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors.

If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients.

If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online.

If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.

source

pub async fn create_reservation( &mut self, request: impl IntoRequest<CreateReservationRequest> ) -> Result<Response<Reservation>, Status>

Creates a new reservation.

source

pub async fn get_reservation( &mut self, request: impl IntoRequest<GetReservationRequest> ) -> Result<Response<Reservation>, Status>

Returns the reservation configuration.

source

pub async fn list_reservations( &mut self, request: impl IntoRequest<ListReservationsRequest> ) -> Result<Response<ListReservationsResponse>, Status>

Returns the list of reservations for the given project.

source

pub async fn update_reservation( &mut self, request: impl IntoRequest<UpdateReservationRequest> ) -> Result<Response<Reservation>, Status>

Updates properties of the specified reservation.

source

pub async fn delete_reservation( &mut self, request: impl IntoRequest<DeleteReservationRequest> ) -> Result<Response<()>, Status>

Deletes the specified reservation.

source

pub async fn list_reservation_topics( &mut self, request: impl IntoRequest<ListReservationTopicsRequest> ) -> Result<Response<ListReservationTopicsResponse>, Status>

Lists the topics attached to the specified reservation.

Trait Implementations§

source§

impl<T: Clone> Clone for AdminServiceClient<T>

source§

fn clone(&self) -> AdminServiceClient<T>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<T: Debug> Debug for AdminServiceClient<T>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for AdminServiceClient<T>

§

impl<T> RefUnwindSafe for AdminServiceClient<T>
where T: RefUnwindSafe,

§

impl<T> Send for AdminServiceClient<T>
where T: Send,

§

impl<T> Sync for AdminServiceClient<T>
where T: Sync,

§

impl<T> Unpin for AdminServiceClient<T>
where T: Unpin,

§

impl<T> UnwindSafe for AdminServiceClient<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more