| Copyright | (c) 2015-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.Monitoring.Projects.NotificationChannels.GetVerificationCode
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
- 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))))))))
- projectsNotificationChannelsGetVerificationCode :: GetNotificationChannelVerificationCodeRequest -> Text -> ProjectsNotificationChannelsGetVerificationCode
- data ProjectsNotificationChannelsGetVerificationCode
- pncgvcXgafv :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Xgafv)
- pncgvcUploadProtocol :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text)
- pncgvcAccessToken :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text)
- pncgvcUploadType :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text)
- pncgvcPayload :: Lens' ProjectsNotificationChannelsGetVerificationCode GetNotificationChannelVerificationCodeRequest
- pncgvcName :: Lens' ProjectsNotificationChannelsGetVerificationCode Text
- pncgvcCallback :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text)
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
projectsNotificationChannelsGetVerificationCode Source #
Arguments
| :: GetNotificationChannelVerificationCodeRequest | |
| -> Text | |
| -> ProjectsNotificationChannelsGetVerificationCode |
Creates a value of ProjectsNotificationChannelsGetVerificationCode with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
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
Request Lenses
pncgvcXgafv :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Xgafv) Source #
V1 error format.
pncgvcUploadProtocol :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
pncgvcAccessToken :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text) Source #
OAuth access token.
pncgvcUploadType :: Lens' ProjectsNotificationChannelsGetVerificationCode (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
pncgvcPayload :: Lens' ProjectsNotificationChannelsGetVerificationCode GetNotificationChannelVerificationCodeRequest Source #
Multipart request metadata.
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.