Network.Google.Resource.Classroom.Registrations.Create

Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the credential provided does not include the appropriate scope for the requested feed. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.

See: Google Classroom API Reference for classroom.registrations.create.

REST Resource

type RegistrationsCreateResource = "v1" :> ("registrations" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Registration :> Post '[JSON] Registration))))))))

A resource alias for classroom.registrations.create method which the RegistrationsCreate request conforms to.

Creating a Request

registrationsCreate

Arguments

:: Registration

rcPayload

-> RegistrationsCreate

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

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

• rcXgafv
• rcUploadProtocol
• rcAccessToken
• rcUploadType
• rcPayload
• rcCallback

data RegistrationsCreate

Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: * `PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the credential provided does not include the appropriate scope for the requested feed. * another access error is encountered. * `INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it.

See: registrationsCreate smart constructor.

Instances

Eq RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

Methods

(==) :: RegistrationsCreate -> RegistrationsCreate -> Bool

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

Data RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

Methods

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

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

toConstr :: RegistrationsCreate -> Constr

dataTypeOf :: RegistrationsCreate -> DataType

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

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

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

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

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

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

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

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

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

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

Show RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

Methods

showsPrec :: Int -> RegistrationsCreate -> ShowS

show :: RegistrationsCreate -> String

showList :: [RegistrationsCreate] -> ShowS

Generic RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

Associated Types

type Rep RegistrationsCreate :: Type -> Type

Methods

from :: RegistrationsCreate -> Rep RegistrationsCreate x

to :: Rep RegistrationsCreate x -> RegistrationsCreate

GoogleRequest RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

Associated Types

type Rs RegistrationsCreate :: Type

type Scopes RegistrationsCreate :: [Symbol]

Methods

requestClient :: RegistrationsCreate -> GClient (Rs RegistrationsCreate)

type Rep RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

type Rep RegistrationsCreate = D1 (MetaData "RegistrationsCreate" "Network.Google.Resource.Classroom.Registrations.Create" "gogol-classroom-0.5.0-Dil3ZfW4IuD9vJQ6Q2970g" False) (C1 (MetaCons "RegistrationsCreate'" PrefixI True) ((S1 (MetaSel (Just "_rcXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_rcUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rcAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_rcUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_rcPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Registration) :*: S1 (MetaSel (Just "_rcCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

type Scopes RegistrationsCreate = "https://www.googleapis.com/auth/classroom.push-notifications" ': ([] :: [Symbol])

type Rs RegistrationsCreate

Defined in Network.Google.Resource.Classroom.Registrations.Create

type Rs RegistrationsCreate = Registration

Request Lenses

rcXgafv :: Lens' RegistrationsCreate (Maybe Xgafv)

V1 error format.

rcUploadProtocol :: Lens' RegistrationsCreate (Maybe Text)

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

rcAccessToken :: Lens' RegistrationsCreate (Maybe Text)

OAuth access token.

rcUploadType :: Lens' RegistrationsCreate (Maybe Text)

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

rcPayload :: Lens' RegistrationsCreate Registration

Multipart request metadata.

rcCallback :: Lens' RegistrationsCreate (Maybe Text)

JSONP