Network.Google.Resource.Classroom.Courses.Topics.Get

Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or 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.get.

REST Resource

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

A resource alias for classroom.courses.topics.get method which the CoursesTopicsGet request conforms to.

Creating a Request

coursesTopicsGet

Arguments

:: Text

ctgCourseId

-> Text

ctgId

-> CoursesTopicsGet

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

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

• ctgXgafv
• ctgUploadProtocol
• ctgCourseId
• ctgAccessToken
• ctgUploadType
• ctgId
• ctgCallback

data CoursesTopicsGet

Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.

See: coursesTopicsGet smart constructor.

Instances

Eq CoursesTopicsGet

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

Methods

(==) :: CoursesTopicsGet -> CoursesTopicsGet -> Bool

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

Data CoursesTopicsGet

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

Methods

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

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

toConstr :: CoursesTopicsGet -> Constr

dataTypeOf :: CoursesTopicsGet -> DataType

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

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

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

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

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

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

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

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

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

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

Show CoursesTopicsGet

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

Methods

showsPrec :: Int -> CoursesTopicsGet -> ShowS

show :: CoursesTopicsGet -> String

showList :: [CoursesTopicsGet] -> ShowS

Generic CoursesTopicsGet

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

Associated Types

type Rep CoursesTopicsGet :: Type -> Type

Methods

from :: CoursesTopicsGet -> Rep CoursesTopicsGet x

to :: Rep CoursesTopicsGet x -> CoursesTopicsGet

GoogleRequest CoursesTopicsGet

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

Associated Types

type Rs CoursesTopicsGet :: Type

type Scopes CoursesTopicsGet :: [Symbol]

Methods

requestClient :: CoursesTopicsGet -> GClient (Rs CoursesTopicsGet)

type Rep CoursesTopicsGet

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

type Rep CoursesTopicsGet = D1 (MetaData "CoursesTopicsGet" "Network.Google.Resource.Classroom.Courses.Topics.Get" "gogol-classroom-0.5.0-Dil3ZfW4IuD9vJQ6Q2970g" False) (C1 (MetaCons "CoursesTopicsGet'" PrefixI True) ((S1 (MetaSel (Just "_ctgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_ctgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctgCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_ctgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ctgId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ctgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes CoursesTopicsGet

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

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

type Rs CoursesTopicsGet

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

type Rs CoursesTopicsGet = Topic

Request Lenses

ctgXgafv :: Lens' CoursesTopicsGet (Maybe Xgafv)

V1 error format.

ctgUploadProtocol :: Lens' CoursesTopicsGet (Maybe Text)

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

ctgCourseId :: Lens' CoursesTopicsGet Text

Identifier of the course.

ctgAccessToken :: Lens' CoursesTopicsGet (Maybe Text)

OAuth access token.

ctgUploadType :: Lens' CoursesTopicsGet (Maybe Text)

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

ctgId :: Lens' CoursesTopicsGet Text

Identifier of the topic.

ctgCallback :: Lens' CoursesTopicsGet (Maybe Text)

JSONP