AdminMethods

Struct AdminMethods 

Source
pub struct AdminMethods<'a, C>
where C: 'a,
{ /* private fields */ }
Expand description

A builder providing access to all methods supported on admin resources. It is not used directly, but through the PubsubLite hub.

§Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_pubsublite1 as pubsublite1;

use pubsublite1::{PubsubLite, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

let secret: yup_oauth2::ApplicationSecret = Default::default();
let connector = hyper_rustls::HttpsConnectorBuilder::new()
    .with_native_roots()
    .unwrap()
    .https_only()
    .enable_http2()
    .build();

let executor = hyper_util::rt::TokioExecutor::new();
let auth = yup_oauth2::InstalledFlowAuthenticator::with_client(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    yup_oauth2::client::CustomHyperClientBuilder::from(
        hyper_util::client::legacy::Client::builder(executor).build(connector),
    ),
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http2()
        .build()
);
let mut hub = PubsubLite::new(client, auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `projects_locations_operations_cancel(...)`, `projects_locations_operations_delete(...)`, `projects_locations_operations_get(...)`, `projects_locations_operations_list(...)`, `projects_locations_reservations_create(...)`, `projects_locations_reservations_delete(...)`, `projects_locations_reservations_get(...)`, `projects_locations_reservations_list(...)`, `projects_locations_reservations_patch(...)`, `projects_locations_reservations_topics_list(...)`, `projects_locations_subscriptions_create(...)`, `projects_locations_subscriptions_delete(...)`, `projects_locations_subscriptions_get(...)`, `projects_locations_subscriptions_list(...)`, `projects_locations_subscriptions_patch(...)`, `projects_locations_subscriptions_seek(...)`, `projects_locations_topics_create(...)`, `projects_locations_topics_delete(...)`, `projects_locations_topics_get(...)`, `projects_locations_topics_get_partitions(...)`, `projects_locations_topics_list(...)`, `projects_locations_topics_patch(...)` and `projects_locations_topics_subscriptions_list(...)`
// to build up your call.
let rb = hub.admin();

Implementations§

Source§

impl<'a, C> AdminMethods<'a, C>

Source

pub fn projects_locations_operations_cancel( &self, request: CancelOperationRequest, name: &str, ) -> AdminProjectLocationOperationCancelCall<'a, C>

Create a builder to help you perform the following task:

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

§Arguments
  • request - No description provided.
  • name - The name of the operation resource to be cancelled.
Source

pub fn projects_locations_operations_delete( &self, name: &str, ) -> AdminProjectLocationOperationDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

§Arguments
  • name - The name of the operation resource to be deleted.
Source

pub fn projects_locations_operations_get( &self, name: &str, ) -> AdminProjectLocationOperationGetCall<'a, C>

Create a builder to help you perform the following task:

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

§Arguments
  • name - The name of the operation resource.
Source

pub fn projects_locations_operations_list( &self, name: &str, ) -> AdminProjectLocationOperationListCall<'a, C>

Create a builder to help you perform the following task:

Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.

§Arguments
  • name - The name of the operation’s parent resource.
Source

pub fn projects_locations_reservations_topics_list( &self, name: &str, ) -> AdminProjectLocationReservationTopicListCall<'a, C>

Create a builder to help you perform the following task:

Lists the topics attached to the specified reservation.

§Arguments
  • name - Required. The name of the reservation whose topics to list. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
Source

pub fn projects_locations_reservations_create( &self, request: Reservation, parent: &str, ) -> AdminProjectLocationReservationCreateCall<'a, C>

Create a builder to help you perform the following task:

Creates a new reservation.

§Arguments
  • request - No description provided.
  • parent - Required. The parent location in which to create the reservation. Structured like projects/{project_number}/locations/{location}.
Source

pub fn projects_locations_reservations_delete( &self, name: &str, ) -> AdminProjectLocationReservationDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes the specified reservation.

§Arguments
  • name - Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
Source

pub fn projects_locations_reservations_get( &self, name: &str, ) -> AdminProjectLocationReservationGetCall<'a, C>

Create a builder to help you perform the following task:

Returns the reservation configuration.

§Arguments
  • name - Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
Source

pub fn projects_locations_reservations_list( &self, parent: &str, ) -> AdminProjectLocationReservationListCall<'a, C>

Create a builder to help you perform the following task:

Returns the list of reservations for the given project.

§Arguments
  • parent - Required. The parent whose reservations are to be listed. Structured like projects/{project_number}/locations/{location}.
Source

pub fn projects_locations_reservations_patch( &self, request: Reservation, name: &str, ) -> AdminProjectLocationReservationPatchCall<'a, C>

Create a builder to help you perform the following task:

Updates properties of the specified reservation.

§Arguments
  • request - No description provided.
  • name - The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
Source

pub fn projects_locations_subscriptions_create( &self, request: Subscription, parent: &str, ) -> AdminProjectLocationSubscriptionCreateCall<'a, C>

Create a builder to help you perform the following task:

Creates a new subscription.

§Arguments
  • request - No description provided.
  • parent - Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.
Source

pub fn projects_locations_subscriptions_delete( &self, name: &str, ) -> AdminProjectLocationSubscriptionDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes the specified subscription.

§Arguments
  • name - Required. The name of the subscription to delete.
Source

pub fn projects_locations_subscriptions_get( &self, name: &str, ) -> AdminProjectLocationSubscriptionGetCall<'a, C>

Create a builder to help you perform the following task:

Returns the subscription configuration.

§Arguments
  • name - Required. The name of the subscription whose configuration to return.
Source

pub fn projects_locations_subscriptions_list( &self, parent: &str, ) -> AdminProjectLocationSubscriptionListCall<'a, C>

Create a builder to help you perform the following task:

Returns the list of subscriptions for the given project.

§Arguments
  • parent - Required. The parent whose subscriptions are to be listed. Structured like projects/{project_number}/locations/{location}.
Source

pub fn projects_locations_subscriptions_patch( &self, request: Subscription, name: &str, ) -> AdminProjectLocationSubscriptionPatchCall<'a, C>

Create a builder to help you perform the following task:

Updates properties of the specified subscription.

§Arguments
  • request - No description provided.
  • name - The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
Source

pub fn projects_locations_subscriptions_seek( &self, request: SeekSubscriptionRequest, name: &str, ) -> AdminProjectLocationSubscriptionSeekCall<'a, C>

Create a builder to help you perform the following task:

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.

§Arguments
  • request - No description provided.
  • name - Required. The name of the subscription to seek.
Source

pub fn projects_locations_topics_subscriptions_list( &self, name: &str, ) -> AdminProjectLocationTopicSubscriptionListCall<'a, C>

Create a builder to help you perform the following task:

Lists the subscriptions attached to the specified topic.

§Arguments
  • name - Required. The name of the topic whose subscriptions to list.
Source

pub fn projects_locations_topics_create( &self, request: Topic, parent: &str, ) -> AdminProjectLocationTopicCreateCall<'a, C>

Create a builder to help you perform the following task:

Creates a new topic.

§Arguments
  • request - No description provided.
  • parent - Required. The parent location in which to create the topic. Structured like projects/{project_number}/locations/{location}.
Source

pub fn projects_locations_topics_delete( &self, name: &str, ) -> AdminProjectLocationTopicDeleteCall<'a, C>

Create a builder to help you perform the following task:

Deletes the specified topic.

§Arguments
  • name - Required. The name of the topic to delete.
Source

pub fn projects_locations_topics_get( &self, name: &str, ) -> AdminProjectLocationTopicGetCall<'a, C>

Create a builder to help you perform the following task:

Returns the topic configuration.

§Arguments
  • name - Required. The name of the topic whose configuration to return.
Source

pub fn projects_locations_topics_get_partitions( &self, name: &str, ) -> AdminProjectLocationTopicGetPartitionCall<'a, C>

Create a builder to help you perform the following task:

Returns the partition information for the requested topic.

§Arguments
  • name - Required. The topic whose partition information to return.
Source

pub fn projects_locations_topics_list( &self, parent: &str, ) -> AdminProjectLocationTopicListCall<'a, C>

Create a builder to help you perform the following task:

Returns the list of topics for the given project.

§Arguments
  • parent - Required. The parent whose topics are to be listed. Structured like projects/{project_number}/locations/{location}.
Source

pub fn projects_locations_topics_patch( &self, request: Topic, name: &str, ) -> AdminProjectLocationTopicPatchCall<'a, C>

Create a builder to help you perform the following task:

Updates properties of the specified topic.

§Arguments
  • request - No description provided.
  • name - The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

Trait Implementations§

Source§

impl<'a, C> MethodsBuilder for AdminMethods<'a, C>

Auto Trait Implementations§

§

impl<'a, C> Freeze for AdminMethods<'a, C>

§

impl<'a, C> !RefUnwindSafe for AdminMethods<'a, C>

§

impl<'a, C> Send for AdminMethods<'a, C>
where C: Sync,

§

impl<'a, C> Sync for AdminMethods<'a, C>
where C: Sync,

§

impl<'a, C> Unpin for AdminMethods<'a, C>

§

impl<'a, C> !UnwindSafe for AdminMethods<'a, C>

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.

Source§

impl<T> Instrument for T

Source§

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

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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