gogol-monitoring-0.4.0: Google Stackdriver Monitoring SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

Contents

Description

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

See: Stackdriver Monitoring API Reference for monitoring.projects.notificationChannels.getVerificationCode.

Synopsis

REST Resource

type ProjectsNotificationChannelsGetVerificationCodeResource = "v3" :> (CaptureMode "name" "getVerificationCode" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GetNotificationChannelVerificationCodeRequest :> Post '[JSON] GetNotificationChannelVerificationCodeResponse)))))))) Source #

A resource alias for monitoring.projects.notificationChannels.getVerificationCode method which the ProjectsNotificationChannelsGetVerificationCode request conforms to.

Creating a Request

data ProjectsNotificationChannelsGetVerificationCode Source #

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

See: projectsNotificationChannelsGetVerificationCode smart constructor.

Instances
Eq ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

Data ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

Methods

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

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

toConstr :: ProjectsNotificationChannelsGetVerificationCode -> Constr #

dataTypeOf :: ProjectsNotificationChannelsGetVerificationCode -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ProjectsNotificationChannelsGetVerificationCode -> ProjectsNotificationChannelsGetVerificationCode #

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

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

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

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

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

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

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

Show ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

Generic ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

GoogleRequest ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

type Rep ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

type Rep ProjectsNotificationChannelsGetVerificationCode = D1 (MetaData "ProjectsNotificationChannelsGetVerificationCode" "Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode" "gogol-monitoring-0.4.0-2c26UZAXxP5IDqve62RFQh" False) (C1 (MetaCons "ProjectsNotificationChannelsGetVerificationCode'" PrefixI True) ((S1 (MetaSel (Just "_pncgvcXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_pncgvcUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pncgvcAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pncgvcUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pncgvcPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GetNotificationChannelVerificationCodeRequest)) :*: (S1 (MetaSel (Just "_pncgvcName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pncgvcCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

type Scopes ProjectsNotificationChannelsGetVerificationCode = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/monitoring" ': ([] :: [Symbol]))
type Rs ProjectsNotificationChannelsGetVerificationCode Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode

Request Lenses

pncgvcUploadProtocol :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text) Source #

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

pncgvcUploadType :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text) Source #

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

pncgvcName :: Lens' ProjectsNotificationChannelsGetVerificationCode Text Source #

The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.