Struct google_pubsub1::api::ProjectSnapshotCreateCall
source · pub struct ProjectSnapshotCreateCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Creates a snapshot from the requested subscription. 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. If the snapshot already exists, returns ALREADY_EXISTS
. If the requested subscription doesn’t exist, returns NOT_FOUND
. If the backlog in the subscription is too old – and the resulting snapshot would expire in less than 1 hour – then FAILED_PRECONDITION
is returned. See also the Snapshot.expire_time
field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.
A builder for the snapshots.create method supported by a project resource.
It is not used directly, but through a ProjectMethods
instance.
§Example
Instantiate a resource method builder
use pubsub1::api::CreateSnapshotRequest;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = CreateSnapshotRequest::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().snapshots_create(req, "name")
.doit().await;
Implementations§
source§impl<'a, S> ProjectSnapshotCreateCall<'a, S>
impl<'a, S> ProjectSnapshotCreateCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, Snapshot)>
pub async fn doit(self) -> Result<(Response<Body>, Snapshot)>
Perform the operation you have build so far.
sourcepub fn request(
self,
new_value: CreateSnapshotRequest,
) -> ProjectSnapshotCreateCall<'a, S>
pub fn request( self, new_value: CreateSnapshotRequest, ) -> ProjectSnapshotCreateCall<'a, S>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn name(self, new_value: &str) -> ProjectSnapshotCreateCall<'a, S>
pub fn name(self, new_value: &str) -> ProjectSnapshotCreateCall<'a, S>
Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is projects/{project}/snapshots/{snap}
.
Sets the name path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate,
) -> ProjectSnapshotCreateCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate, ) -> ProjectSnapshotCreateCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> ProjectSnapshotCreateCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> ProjectSnapshotCreateCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> ProjectSnapshotCreateCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> ProjectSnapshotCreateCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope
variant
Scope::CloudPlatform
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> ProjectSnapshotCreateCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> ProjectSnapshotCreateCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> ProjectSnapshotCreateCall<'a, S>
pub fn clear_scopes(self) -> ProjectSnapshotCreateCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key
parameter (see Self::param()
for details).
Trait Implementations§
impl<'a, S> CallBuilder for ProjectSnapshotCreateCall<'a, S>
Auto Trait Implementations§
impl<'a, S> Freeze for ProjectSnapshotCreateCall<'a, S>
impl<'a, S> !RefUnwindSafe for ProjectSnapshotCreateCall<'a, S>
impl<'a, S> Send for ProjectSnapshotCreateCall<'a, S>where
S: Sync,
impl<'a, S> !Sync for ProjectSnapshotCreateCall<'a, S>
impl<'a, S> Unpin for ProjectSnapshotCreateCall<'a, S>
impl<'a, S> !UnwindSafe for ProjectSnapshotCreateCall<'a, S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more