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 |
Update a RemoteConfig. We treat this as an always-existing resource (when it is not found in our data store, we treat it as version 0, a template with zero conditions and zero parameters). Hence there are no Create or Delete operations. Returns the updated template when successful (and the updated eTag as a response header), or an error if things go wrong. Possible error messages: * VALIDATION_ERROR (HTTP status 400) with additional details if the template being passed in can not be validated. * AUTHENTICATION_ERROR (HTTP status 401) if the request can not be authenticate (e.g. no access token, or invalid access token). * AUTHORIZATION_ERROR (HTTP status 403) if the request can not be authorized (e.g. the user has no access to the specified project id). * VERSION_MISMATCH (HTTP status 412) when trying to update when the expected eTag (passed in via the "If-match" header) is not specified, or is specified but does does not match the current eTag. * Internal error (HTTP status 500) for Database problems or other internal errors.
See: Firebase Remote Config API Reference for firebaseremoteconfig.projects.updateRemoteConfig
.
Synopsis
- type ProjectsUpdateRemoteConfigResource = "v1" :> (Capture "project" Text :> ("remoteConfig" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "validateOnly" Bool :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RemoteConfig :> Put '[JSON] RemoteConfig))))))))))))
- projectsUpdateRemoteConfig :: Text -> RemoteConfig -> ProjectsUpdateRemoteConfig
- data ProjectsUpdateRemoteConfig
- purcXgafv :: Lens' ProjectsUpdateRemoteConfig (Maybe Xgafv)
- purcValidateOnly :: Lens' ProjectsUpdateRemoteConfig (Maybe Bool)
- purcUploadProtocol :: Lens' ProjectsUpdateRemoteConfig (Maybe Text)
- purcProject :: Lens' ProjectsUpdateRemoteConfig Text
- purcPp :: Lens' ProjectsUpdateRemoteConfig Bool
- purcAccessToken :: Lens' ProjectsUpdateRemoteConfig (Maybe Text)
- purcUploadType :: Lens' ProjectsUpdateRemoteConfig (Maybe Text)
- purcPayload :: Lens' ProjectsUpdateRemoteConfig RemoteConfig
- purcBearerToken :: Lens' ProjectsUpdateRemoteConfig (Maybe Text)
- purcCallback :: Lens' ProjectsUpdateRemoteConfig (Maybe Text)
REST Resource
type ProjectsUpdateRemoteConfigResource = "v1" :> (Capture "project" Text :> ("remoteConfig" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "validateOnly" Bool :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] RemoteConfig :> Put '[JSON] RemoteConfig)))))))))))) Source #
A resource alias for firebaseremoteconfig.projects.updateRemoteConfig
method which the
ProjectsUpdateRemoteConfig
request conforms to.
Creating a Request
projectsUpdateRemoteConfig Source #
Creates a value of ProjectsUpdateRemoteConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ProjectsUpdateRemoteConfig Source #
Update a RemoteConfig. We treat this as an always-existing resource (when it is not found in our data store, we treat it as version 0, a template with zero conditions and zero parameters). Hence there are no Create or Delete operations. Returns the updated template when successful (and the updated eTag as a response header), or an error if things go wrong. Possible error messages: * VALIDATION_ERROR (HTTP status 400) with additional details if the template being passed in can not be validated. * AUTHENTICATION_ERROR (HTTP status 401) if the request can not be authenticate (e.g. no access token, or invalid access token). * AUTHORIZATION_ERROR (HTTP status 403) if the request can not be authorized (e.g. the user has no access to the specified project id). * VERSION_MISMATCH (HTTP status 412) when trying to update when the expected eTag (passed in via the "If-match" header) is not specified, or is specified but does does not match the current eTag. * Internal error (HTTP status 500) for Database problems or other internal errors.
See: projectsUpdateRemoteConfig
smart constructor.
Instances
Request Lenses
purcValidateOnly :: Lens' ProjectsUpdateRemoteConfig (Maybe Bool) Source #
Optional. Defaults to false
(UpdateRemoteConfig call should update the
backend if there are no validation/interal errors). May be set to
true
to indicate that, should no validation errors occur, the call
should return a "200 OK" instead of performing the update. Note that
other error messages (500 Internal Error, 412 Version Mismatch, etc) may
still result after flipping to false
, even if getting a "200 OK"
when calling with true
.
purcUploadProtocol :: Lens' ProjectsUpdateRemoteConfig (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
purcProject :: Lens' ProjectsUpdateRemoteConfig Text Source #
The GMP project identifier. Required. See note at the beginning of this file regarding project ids.
purcAccessToken :: Lens' ProjectsUpdateRemoteConfig (Maybe Text) Source #
OAuth access token.
purcUploadType :: Lens' ProjectsUpdateRemoteConfig (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
purcPayload :: Lens' ProjectsUpdateRemoteConfig RemoteConfig Source #
Multipart request metadata.
purcBearerToken :: Lens' ProjectsUpdateRemoteConfig (Maybe Text) Source #
OAuth bearer token.
purcCallback :: Lens' ProjectsUpdateRemoteConfig (Maybe Text) Source #
JSONP