pub struct EnterprisePullNotificationSetCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
A builder for the pullNotificationSet method supported by a enterprise resource.
It is not used directly, but through a EnterpriseMethods instance.
§Example
Instantiate a resource method builder
// 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.enterprises().pull_notification_set()
.request_mode("labore")
.doit().await;Implementations§
source§impl<'a, S> EnterprisePullNotificationSetCall<'a, S>
impl<'a, S> EnterprisePullNotificationSetCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, NotificationSet)>
pub async fn doit(self) -> Result<(Response<Body>, NotificationSet)>
Perform the operation you have build so far.
sourcepub fn request_mode(
self,
new_value: &str
) -> EnterprisePullNotificationSetCall<'a, S>
pub fn request_mode( self, new_value: &str ) -> EnterprisePullNotificationSetCall<'a, S>
The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.
Sets the request mode query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> EnterprisePullNotificationSetCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> EnterprisePullNotificationSetCall<'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
) -> EnterprisePullNotificationSetCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> EnterprisePullNotificationSetCall<'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
) -> EnterprisePullNotificationSetCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> EnterprisePullNotificationSetCall<'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::Full.
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
) -> EnterprisePullNotificationSetCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> EnterprisePullNotificationSetCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> EnterprisePullNotificationSetCall<'a, S>
pub fn clear_scopes(self) -> EnterprisePullNotificationSetCall<'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).