Struct google_pubsub1::ProjectSnapshotCreateCall [−][src]
pub struct ProjectSnapshotCreateCall<'a, C, A> where
C: 'a,
A: 'a, { /* fields omitted */ }
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.
BETA: This feature is part of a beta release. This API might be
changed in backward-incompatible ways and is not recommended for production
use. It is not subject to any SLA or deprecation policy.
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.
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::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();
Methods
impl<'a, C, A> ProjectSnapshotCreateCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
impl<'a, C, A> ProjectSnapshotCreateCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, Snapshot)>
[src]
pub fn doit(self) -> Result<(Response, Snapshot)>
Perform the operation you have build so far.
pub fn request(
self,
new_value: CreateSnapshotRequest
) -> ProjectSnapshotCreateCall<'a, C, A>
[src]
pub fn request(
self,
new_value: CreateSnapshotRequest
) -> ProjectSnapshotCreateCall<'a, C, A>
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.
pub fn name(self, new_value: &str) -> ProjectSnapshotCreateCall<'a, C, A>
[src]
pub fn name(self, new_value: &str) -> ProjectSnapshotCreateCall<'a, C, A>
Optional 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.
pub fn delegate(
self,
new_value: &'a mut Delegate
) -> ProjectSnapshotCreateCall<'a, C, A>
[src]
pub fn delegate(
self,
new_value: &'a mut Delegate
) -> ProjectSnapshotCreateCall<'a, C, A>
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.
pub fn param<T>(self, name: T, value: T) -> ProjectSnapshotCreateCall<'a, C, A> where
T: AsRef<str>,
[src]
pub fn param<T>(self, name: T, value: T) -> ProjectSnapshotCreateCall<'a, C, A> where
T: AsRef<str>,
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 paramters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- access_token (query-string) - OAuth access token.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- 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.
- callback (query-string) - JSONP
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- 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.
- uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
- alt (query-string) - Data format for response.
- $.xgafv (query-string) - V1 error format.
pub fn add_scope<T, S>(self, scope: T) -> ProjectSnapshotCreateCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
pub fn add_scope<T, S>(self, scope: T) -> ProjectSnapshotCreateCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead 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.
If None
is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key
parameter (see the param()
function for details).
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.
Trait Implementations
impl<'a, C, A> CallBuilder for ProjectSnapshotCreateCall<'a, C, A>
[src]
impl<'a, C, A> CallBuilder for ProjectSnapshotCreateCall<'a, C, A>
Auto Trait Implementations
impl<'a, C, A> !Send for ProjectSnapshotCreateCall<'a, C, A>
impl<'a, C, A> !Send for ProjectSnapshotCreateCall<'a, C, A>
impl<'a, C, A> !Sync for ProjectSnapshotCreateCall<'a, C, A>
impl<'a, C, A> !Sync for ProjectSnapshotCreateCall<'a, C, A>