Struct google_classroom1::UserProfileGuardianGetCall
[−]
[src]
pub struct UserProfileGuardianGetCall<'a, C, A> where
C: 'a,
A: 'a, { /* fields omitted */ }
Returns a specific guardian.
This method returns the following error codes:
PERMISSION_DENIED
if no user that matches the providedstudent_id
is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by thestudent_id
, if guardians are not enabled for the domain in question, or for other access errors.INVALID_ARGUMENT
if astudent_id
is specified, but its format cannot be recognized (it is not an email address, nor astudent_id
from the API, nor the literal stringme
).NOT_FOUND
if the requesting user is permitted to view guardians for the requestedstudent_id
, but noGuardian
record exists for that student that matches the providedguardian_id
.
A builder for the guardians.get method supported by a userProfile resource.
It is not used directly, but through a UserProfileMethods
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.user_profiles().guardians_get("studentId", "guardianId") .doit();
Methods
impl<'a, C, A> UserProfileGuardianGetCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
C: BorrowMut<Client>,
A: GetToken,
fn doit(self) -> Result<(Response, Guardian)>
Perform the operation you have build so far.
fn student_id(self, new_value: &str) -> UserProfileGuardianGetCall<'a, C, A>
The student whose guardian is being requested. One of the following:
- the numeric identifier for the user
- the email address of the user
- the string literal
"me"
, indicating the requesting user
Sets the student id 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.
fn guardian_id(self, new_value: &str) -> UserProfileGuardianGetCall<'a, C, A>
The id
field from a Guardian
.
Sets the guardian id 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.
fn delegate(
self,
new_value: &'a mut Delegate
) -> UserProfileGuardianGetCall<'a, C, A>
self,
new_value: &'a mut Delegate
) -> UserProfileGuardianGetCall<'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.
fn param<T>(self, name: T, value: T) -> UserProfileGuardianGetCall<'a, C, A> where
T: AsRef<str>,
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").
- pp (query-boolean) - Pretty-print response.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- bearer_token (query-string) - OAuth bearer token.
- access_token (query-string) - OAuth access token.
- uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
- 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.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- alt (query-string) - Data format for response.
- $.xgafv (query-string) - V1 error format.