Network.Google.Resource.Classroom.Courses.Topics.Patch

Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist

See: Google Classroom API Reference for classroom.courses.topics.patch.

REST Resource

type CoursesTopicsPatchResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("topics" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Topic :> Patch '[JSON] Topic))))))))))))

A resource alias for classroom.courses.topics.patch method which the CoursesTopicsPatch request conforms to.

Creating a Request

coursesTopicsPatch

Arguments

:: Text

ctpCourseId

-> Topic

ctpPayload

-> Text

ctpId

-> CoursesTopicsPatch

Creates a value of CoursesTopicsPatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ctpXgafv
• ctpUploadProtocol
• ctpUpdateMask
• ctpCourseId
• ctpAccessToken
• ctpUploadType
• ctpPayload
• ctpId
• ctpCallback

data CoursesTopicsPatch

Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist

See: coursesTopicsPatch smart constructor.

Instances

Eq CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

Methods

(==) :: CoursesTopicsPatch -> CoursesTopicsPatch -> Bool

(/=) :: CoursesTopicsPatch -> CoursesTopicsPatch -> Bool

Data CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesTopicsPatch -> c CoursesTopicsPatch

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesTopicsPatch

toConstr :: CoursesTopicsPatch -> Constr

dataTypeOf :: CoursesTopicsPatch -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesTopicsPatch)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesTopicsPatch)

gmapT :: (forall b. Data b => b -> b) -> CoursesTopicsPatch -> CoursesTopicsPatch

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesTopicsPatch -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesTopicsPatch -> r

gmapQ :: (forall d. Data d => d -> u) -> CoursesTopicsPatch -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesTopicsPatch -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesTopicsPatch -> m CoursesTopicsPatch

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesTopicsPatch -> m CoursesTopicsPatch

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesTopicsPatch -> m CoursesTopicsPatch

Show CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

Methods

showsPrec :: Int -> CoursesTopicsPatch -> ShowS

show :: CoursesTopicsPatch -> String

showList :: [CoursesTopicsPatch] -> ShowS

Generic CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

Associated Types

type Rep CoursesTopicsPatch :: Type -> Type

Methods

from :: CoursesTopicsPatch -> Rep CoursesTopicsPatch x

to :: Rep CoursesTopicsPatch x -> CoursesTopicsPatch

GoogleRequest CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

Associated Types

type Rs CoursesTopicsPatch :: Type

type Scopes CoursesTopicsPatch :: [Symbol]

Methods

requestClient :: CoursesTopicsPatch -> GClient (Rs CoursesTopicsPatch)

type Rep CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

type Rep CoursesTopicsPatch = D1 (MetaData "CoursesTopicsPatch" "Network.Google.Resource.Classroom.Courses.Topics.Patch" "gogol-classroom-0.5.0-Dil3ZfW4IuD9vJQ6Q2970g" False) (C1 (MetaCons "CoursesTopicsPatch'" PrefixI True) (((S1 (MetaSel (Just "_ctpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_ctpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ctpUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :*: S1 (MetaSel (Just "_ctpCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_ctpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ctpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Topic) :*: (S1 (MetaSel (Just "_ctpId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ctpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

type Scopes CoursesTopicsPatch = "https://www.googleapis.com/auth/classroom.topics" ': ([] :: [Symbol])

type Rs CoursesTopicsPatch

Defined in Network.Google.Resource.Classroom.Courses.Topics.Patch

type Rs CoursesTopicsPatch = Topic

Request Lenses

ctpXgafv :: Lens' CoursesTopicsPatch (Maybe Xgafv)

V1 error format.

ctpUploadProtocol :: Lens' CoursesTopicsPatch (Maybe Text)

Upload protocol for media (e.g. "raw", "multipart").

ctpUpdateMask :: Lens' CoursesTopicsPatch (Maybe GFieldMask)

Mask that identifies which fields on the topic 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 Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified: * `name`

ctpCourseId :: Lens' CoursesTopicsPatch Text

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

ctpAccessToken :: Lens' CoursesTopicsPatch (Maybe Text)

OAuth access token.

ctpUploadType :: Lens' CoursesTopicsPatch (Maybe Text)

Legacy upload protocol for media (e.g. "media", "multipart").

ctpPayload :: Lens' CoursesTopicsPatch Topic

Multipart request metadata.

ctpId :: Lens' CoursesTopicsPatch Text

Identifier of the topic.

ctpCallback :: Lens' CoursesTopicsPatch (Maybe Text)

JSONP