Struct google_classroom1::api::RegistrationCreateCall
source · pub struct RegistrationCreateCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Creates a Registration, causing Classroom to start sending notifications from the provided feed to the destination provided in cloudPubSubTopic. Returns the created Registration. Currently, this will be the same as the argument, but with server-assigned fields such as expiry_time and id filled in. Note that any value specified for the expiry_time or id fields will be ignored. While Classroom may validate the cloudPubSubTopic and return errors on a best effort basis, it is the caller’s responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * PERMISSION_DENIED if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. * INVALID_ARGUMENT if: * no cloudPubsubTopic is specified, or the specified cloudPubsubTopic is not valid; or * no feed is specified, or the specified feed is not valid. * NOT_FOUND if: * the specified feed cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified cloudPubsubTopic cannot be located, or Classroom has not been granted permission to publish to it.
A builder for the create method supported by a registration resource.
It is not used directly, but through a RegistrationMethods instance.
Example
Instantiate a resource method builder
use classroom1::api::Registration;
// 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 = Registration::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.registrations().create(req)
.doit().await;Implementations§
source§impl<'a, S> RegistrationCreateCall<'a, S>where
S: Service<Uri> + Clone + Send + Sync + 'static,
S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
impl<'a, S> RegistrationCreateCall<'a, S>where
S: Service<Uri> + Clone + Send + Sync + 'static,
S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static,
S::Future: Send + Unpin + 'static,
S::Error: Into<Box<dyn StdError + Send + Sync>>,
sourcepub async fn doit(self) -> Result<(Response<Body>, Registration)>
pub async fn doit(self) -> Result<(Response<Body>, Registration)>
Perform the operation you have build so far.
sourcepub fn request(self, new_value: Registration) -> RegistrationCreateCall<'a, S>
pub fn request(self, new_value: Registration) -> RegistrationCreateCall<'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 delegate(
self,
new_value: &'a mut dyn Delegate
) -> RegistrationCreateCall<'a, S>
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> RegistrationCreateCall<'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) -> RegistrationCreateCall<'a, S>where
T: AsRef<str>,
pub fn param<T>(self, name: T, value: T) -> RegistrationCreateCall<'a, S>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 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) -> RegistrationCreateCall<'a, S>where
St: AsRef<str>,
pub fn add_scope<St>(self, scope: St) -> RegistrationCreateCall<'a, S>where
St: AsRef<str>,
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::PushNotification.
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) -> RegistrationCreateCall<'a, S>where
I: IntoIterator<Item = St>,
St: AsRef<str>,
pub fn add_scopes<I, St>(self, scopes: I) -> RegistrationCreateCall<'a, S>where
I: IntoIterator<Item = St>,
St: AsRef<str>,
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> RegistrationCreateCall<'a, S>
pub fn clear_scopes(self) -> RegistrationCreateCall<'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).