pub struct CourseAnnouncementPatchCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Updates one or more fields of an announcement. This method returns the following error codes: * PERMISSION_DENIED if the requesting developer project did not create the corresponding announcement or for access errors. * INVALID_ARGUMENT if the request is malformed. * FAILED_PRECONDITION if the requested announcement has already been deleted. * NOT_FOUND if the requested course or announcement does not exist
A builder for the announcements.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::api::Announcement;
// 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 = Announcement::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().announcements_patch(req, "courseId", "id")
.update_mask(&Default::default())
.doit().await;Implementations§
source§impl<'a, S> CourseAnnouncementPatchCall<'a, S>
impl<'a, S> CourseAnnouncementPatchCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, Announcement)>
pub async fn doit(self) -> Result<(Response<Body>, Announcement)>
Perform the operation you have build so far.
sourcepub fn request(
self,
new_value: Announcement
) -> CourseAnnouncementPatchCall<'a, S>
pub fn request( self, new_value: Announcement ) -> CourseAnnouncementPatchCall<'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 course_id(self, new_value: &str) -> CourseAnnouncementPatchCall<'a, S>
pub fn course_id(self, new_value: &str) -> CourseAnnouncementPatchCall<'a, S>
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.
sourcepub fn id(self, new_value: &str) -> CourseAnnouncementPatchCall<'a, S>
pub fn id(self, new_value: &str) -> CourseAnnouncementPatchCall<'a, S>
Identifier of the announcement.
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.
sourcepub fn update_mask(
self,
new_value: FieldMask
) -> CourseAnnouncementPatchCall<'a, S>
pub fn update_mask( self, new_value: FieldMask ) -> CourseAnnouncementPatchCall<'a, S>
Mask that identifies which fields on the announcement 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 Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an INVALID_ARGUMENT error is returned. The following fields may be specified by teachers: * text * state * scheduled_time
Sets the update mask query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> CourseAnnouncementPatchCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> CourseAnnouncementPatchCall<'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) -> CourseAnnouncementPatchCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> CourseAnnouncementPatchCall<'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) -> CourseAnnouncementPatchCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> CourseAnnouncementPatchCall<'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::Announcement.
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) -> CourseAnnouncementPatchCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> CourseAnnouncementPatchCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> CourseAnnouncementPatchCall<'a, S>
pub fn clear_scopes(self) -> CourseAnnouncementPatchCall<'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).