Struct google_classroom1::CourseCourseWorkPatchCall

pub struct CourseCourseWorkPatchCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Updates one or more fields of a course work.

See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them.

This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item.

This method returns the following error codes:

• PERMISSION_DENIED if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors.
• INVALID_ARGUMENT if the request is malformed.
• FAILED_PRECONDITION if the requested course work has already been deleted.
• NOT_FOUND if the requested course, course work, or student submission does not exist.

A builder for the courseWork.patch method supported by a course resource. It is not used directly, but through a CourseMethods instance.

Example

Instantiate a resource method builder

use classroom1::CourseWork;
 
// 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 = CourseWork::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.courses().course_work_patch(req, "courseId", "id")
             .update_mask("sit")
             .doit();

Implementations

impl<'a, C, A> CourseCourseWorkPatchCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken, 

pub fn doit(self) -> Result<(Response, CourseWork)>

Perform the operation you have build so far.

pub fn request(
    self,
    new_value: CourseWork
) -> CourseCourseWorkPatchCall<'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 course_id(self, new_value: &str) -> CourseCourseWorkPatchCall<'a, C, A>

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Sets the course 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.

pub fn id(self, new_value: &str) -> CourseCourseWorkPatchCall<'a, C, A>

Identifier of the course work.

Sets the 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.

pub fn update_mask(self, new_value: &str) -> CourseCourseWorkPatchCall<'a, C, A>

Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an INVALID_ARGUMENT error is returned.

The following fields may be specified by teachers:

• title
• description
• state
• due_date
• due_time
• max_points
• scheduled_time
• submission_modification_mode
• topic_id

Sets the update mask query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> CourseCourseWorkPatchCall<'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) -> CourseCourseWorkPatchCall<'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 parameters 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) -> CourseCourseWorkPatchCall<'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::CourseworkStudent.

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 CourseCourseWorkPatchCall<'a, C, A>