| 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.FirebaseRemoteConfig
Description
Firebase Remote Config API allows the 3P clients to manage Remote Config conditions and parameters for Firebase applications.
Synopsis
- firebaseRemoteConfigService :: ServiceConfig
- type FirebaseRemoteConfigAPI = ProjectsUpdateRemoteConfigResource :<|> ProjectsGetRemoteConfigResource
- module Network.Google.Resource.FirebaseRemoteConfig.Projects.GetRemoteConfig
- module Network.Google.Resource.FirebaseRemoteConfig.Projects.UpdateRemoteConfig
- data RemoteConfigParameterValue
- remoteConfigParameterValue :: RemoteConfigParameterValue
- rcpvValue :: Lens' RemoteConfigParameterValue (Maybe Text)
- rcpvUseInAppDefault :: Lens' RemoteConfigParameterValue (Maybe Bool)
- data RemoteConfigParameterConditionalValues
- remoteConfigParameterConditionalValues :: HashMap Text RemoteConfigParameterValue -> RemoteConfigParameterConditionalValues
- rcpcvAddtional :: Lens' RemoteConfigParameterConditionalValues (HashMap Text RemoteConfigParameterValue)
- data RemoteConfigParameters
- remoteConfigParameters :: HashMap Text RemoteConfigParameter -> RemoteConfigParameters
- rcpAddtional :: Lens' RemoteConfigParameters (HashMap Text RemoteConfigParameter)
- data RemoteConfigParameter
- remoteConfigParameter :: RemoteConfigParameter
- rcpDefaultValue :: Lens' RemoteConfigParameter (Maybe RemoteConfigParameterValue)
- rcpDescription :: Lens' RemoteConfigParameter (Maybe Text)
- rcpConditionalValues :: Lens' RemoteConfigParameter (Maybe RemoteConfigParameterConditionalValues)
- data Xgafv
- data RemoteConfigConditionTagColor
- data RemoteConfigCondition
- remoteConfigCondition :: RemoteConfigCondition
- rccTagColor :: Lens' RemoteConfigCondition (Maybe RemoteConfigConditionTagColor)
- rccName :: Lens' RemoteConfigCondition (Maybe Text)
- rccExpression :: Lens' RemoteConfigCondition (Maybe Text)
- rccDescription :: Lens' RemoteConfigCondition (Maybe Text)
- data RemoteConfig
- remoteConfig :: RemoteConfig
- rcParameters :: Lens' RemoteConfig (Maybe RemoteConfigParameters)
- rcConditions :: Lens' RemoteConfig [RemoteConfigCondition]
Service Configuration
firebaseRemoteConfigService :: ServiceConfig Source #
Default request referring to version v1 of the Firebase Remote Config API. This contains the host and root path used as a starting point for constructing service requests.
API Declaration
type FirebaseRemoteConfigAPI = ProjectsUpdateRemoteConfigResource :<|> ProjectsGetRemoteConfigResource Source #
Represents the entirety of the methods and resources available for the Firebase Remote Config API service.
Resources
firebaseremoteconfig.projects.getRemoteConfig
firebaseremoteconfig.projects.updateRemoteConfig
Types
RemoteConfigParameterValue
data RemoteConfigParameterValue Source #
A RemoteConfigParameter's "value" (either the default value, or the
value associated with a condition name) is either a string, or the
"use_in_app_default" indicator (which means to leave out the parameter
from the returned map that is the output of the parameter fetch). We
represent the "use_in_app_default" as a bool, but (when using the
boolean instead of the string) it should always be true.
See: remoteConfigParameterValue smart constructor.
Instances
remoteConfigParameterValue :: RemoteConfigParameterValue Source #
Creates a value of RemoteConfigParameterValue with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcpvValue :: Lens' RemoteConfigParameterValue (Maybe Text) Source #
the string to set the parameter to
rcpvUseInAppDefault :: Lens' RemoteConfigParameterValue (Maybe Bool) Source #
if true, omit the parameter from the map of fetched parameter values
RemoteConfigParameterConditionalValues
data RemoteConfigParameterConditionalValues Source #
Optional - a map of (condition_name, value). The condition_name of the highest priority (the one listed first in the conditions array) determines the value of this parameter.
See: remoteConfigParameterConditionalValues smart constructor.
Instances
remoteConfigParameterConditionalValues Source #
Creates a value of RemoteConfigParameterConditionalValues with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcpcvAddtional :: Lens' RemoteConfigParameterConditionalValues (HashMap Text RemoteConfigParameterValue) Source #
RemoteConfigParameters
data RemoteConfigParameters Source #
Map of parameter keys to their optional default values and optional submap of (condition name : value). Order doesn't affect semantics, and so is sorted by the server. The 'key' values of the params must be unique.
See: remoteConfigParameters smart constructor.
Instances
remoteConfigParameters Source #
Arguments
| :: HashMap Text RemoteConfigParameter | |
| -> RemoteConfigParameters |
Creates a value of RemoteConfigParameters with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RemoteConfigParameter
data RemoteConfigParameter Source #
While default_value and conditional_values are each optional, at least one of the two is required - otherwise, the parameter is meaningless (and an exception will be thrown by the validation logic).
See: remoteConfigParameter smart constructor.
Instances
remoteConfigParameter :: RemoteConfigParameter Source #
Creates a value of RemoteConfigParameter with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcpDefaultValue :: Lens' RemoteConfigParameter (Maybe RemoteConfigParameterValue) Source #
Optional - value to set the parameter to, when none of the named
conditions evaluate to true.
rcpDescription :: Lens' RemoteConfigParameter (Maybe Text) Source #
Optional. A description for this Parameter. Length must be less than or equal to 100 characters (or more precisely, unicode code points, which is defined in java/com/google/wireless/android/config/ConstsExporter.java). A description may contain any Unicode characters
rcpConditionalValues :: Lens' RemoteConfigParameter (Maybe RemoteConfigParameterConditionalValues) Source #
Optional - a map of (condition_name, value). The condition_name of the highest priority (the one listed first in the conditions array) determines the value of this parameter.
Xgafv
V1 error format.
Instances
| Enum Xgafv Source # | |
| Eq Xgafv Source # | |
| Data Xgafv Source # | |
Defined in Network.Google.FirebaseRemoteConfig.Types.Sum Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Xgafv -> c Xgafv # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Xgafv # dataTypeOf :: Xgafv -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Xgafv) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Xgafv) # gmapT :: (forall b. Data b => b -> b) -> Xgafv -> Xgafv # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Xgafv -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Xgafv -> r # gmapQ :: (forall d. Data d => d -> u) -> Xgafv -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Xgafv -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Xgafv -> m Xgafv # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Xgafv -> m Xgafv # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Xgafv -> m Xgafv # | |
| Ord Xgafv Source # | |
| Read Xgafv Source # | |
| Show Xgafv Source # | |
| Generic Xgafv Source # | |
| Hashable Xgafv Source # | |
| ToJSON Xgafv Source # | |
| FromJSON Xgafv Source # | |
| FromHttpApiData Xgafv Source # | |
| ToHttpApiData Xgafv Source # | |
Defined in Network.Google.FirebaseRemoteConfig.Types.Sum Methods toUrlPiece :: Xgafv -> Text # toEncodedUrlPiece :: Xgafv -> Builder # toHeader :: Xgafv -> ByteString # toQueryParam :: Xgafv -> Text # | |
| type Rep Xgafv Source # | |
RemoteConfigConditionTagColor
data RemoteConfigConditionTagColor Source #
Optional. The display (tag) color of this condition. This serves as part of a tag (in the future, we may add tag text as well as tag color, but that is not yet implemented in the UI). This value has no affect on the semantics of the delivered config and it is ignored by the backend, except for passing it through write/read requests. Not having this value or having the "CONDITION_DISPLAY_COLOR_UNSPECIFIED" value (0) have the same meaning: Let the UI choose any valid color when displaying the condition.
Constructors
| ConditionDisplayColorUnspecified | CONDITION_DISPLAY_COLOR_UNSPECIFIED |
| Blue |
|
| Brown |
|
| Cyan |
|
| DeepOrange |
|
| Green |
|
| Indigo |
|
| Lime |
|
| Orange |
|
| Pink |
|
| Purple |
|
| Teal |
|
Instances
RemoteConfigCondition
data RemoteConfigCondition Source #
A single RemoteConfig Condition. A list of these (because order matters) are part of a single RemoteConfig template.
See: remoteConfigCondition smart constructor.
Instances
remoteConfigCondition :: RemoteConfigCondition Source #
Creates a value of RemoteConfigCondition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rccTagColor :: Lens' RemoteConfigCondition (Maybe RemoteConfigConditionTagColor) Source #
Optional. The display (tag) color of this condition. This serves as part of a tag (in the future, we may add tag text as well as tag color, but that is not yet implemented in the UI). This value has no affect on the semantics of the delivered config and it is ignored by the backend, except for passing it through write/read requests. Not having this value or having the "CONDITION_DISPLAY_COLOR_UNSPECIFIED" value (0) have the same meaning: Let the UI choose any valid color when displaying the condition.
rccName :: Lens' RemoteConfigCondition (Maybe Text) Source #
Required. A non empty and unique name of this condition.
rccExpression :: Lens' RemoteConfigCondition (Maybe Text) Source #
Required.
rccDescription :: Lens' RemoteConfigCondition (Maybe Text) Source #
DO NOT USE. Implementation removed and will not be added unless requested. A description for this Condition. Length must be less than or equal to 100 characters (or more precisely, unicode code points, which is defined in java/com/google/wireless/android/config/ConstsExporter.java). A description may contain any Unicode characters
RemoteConfig
data RemoteConfig Source #
- The RemoteConfig consists of a list of conditions (which can be thought of as named "if" statements) and a map of parameters (parameter key to a structure containing an optional default value, as well as a optional submap of (condition name to value when that condition is true).
See: remoteConfig smart constructor.
Instances
remoteConfig :: RemoteConfig Source #
Creates a value of RemoteConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcParameters :: Lens' RemoteConfig (Maybe RemoteConfigParameters) Source #
Map of parameter keys to their optional default values and optional submap of (condition name : value). Order doesn't affect semantics, and so is sorted by the server. The 'key' values of the params must be unique.
rcConditions :: Lens' RemoteConfig [RemoteConfigCondition] Source #
The list of named conditions. The order *does* affect the semantics. The
condition_name values of these entries must be unique. The resolved
value of a config parameter P is determined as follow: * Let Y be the
set of values from the submap of P that refer to conditions that
evaluate to true. * If Y is non empty, the value is taken from the
specific submap in Y whose condition_name is the earliest in this
condition list. * Else, if P has a default value option (condition_name
is empty) then the value is taken from that option. * Else, parameter P
has no value and is omitted from the config result. Example: parameter
key "p1", default value "v1", submap specified as {"c1": v2,
"c2": v3} where "c1" and "c2" are names of conditions in the
condition list (where "c1" in this example appears before "c2"). The
value of p1 would be v2 as long as c1 is true. Otherwise, if c2 is true,
p1 would evaluate to v3, and if c1 and c2 are both false, p1 would
evaluate to v1. If no default value was specified, and c1 and c2 were
both false, no value for p1 would be generated.