| 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.Redis
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- redis.projects.locations.get
- redis.projects.locations.instances.create
- redis.projects.locations.instances.delete
- redis.projects.locations.instances.get
- redis.projects.locations.instances.list
- redis.projects.locations.instances.patch
- redis.projects.locations.list
- redis.projects.locations.operations.cancel
- redis.projects.locations.operations.delete
- redis.projects.locations.operations.get
- redis.projects.locations.operations.list
- Types
- InstanceLabels
- Status
- ListLocationsResponse
- ListOperationsResponse
- Location
- GoogleCloudRedisV1ZoneMetadata
- Operation
- Empty
- InstanceTier
- StatusDetailsItem
- GoogleCloudRedisV1LocationMetadata
- GoogleCloudRedisV1OperationMetadata
- InstanceRedisConfigs
- GoogleCloudRedisV1LocationMetadataAvailableZones
- Xgafv
- LocationLabels
- LocationMetadata
- OperationMetadata
- ListInstancesResponse
- InstanceState
- OperationResponse
- Instance
Description
Creates and manages Redis instances on the Google Cloud Platform.
Synopsis
- redisService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type RedisAPI = ProjectsLocationsInstancesListResource :<|> (ProjectsLocationsInstancesPatchResource :<|> (ProjectsLocationsInstancesGetResource :<|> (ProjectsLocationsInstancesCreateResource :<|> (ProjectsLocationsInstancesDeleteResource :<|> (ProjectsLocationsOperationsListResource :<|> (ProjectsLocationsOperationsGetResource :<|> (ProjectsLocationsOperationsCancelResource :<|> (ProjectsLocationsOperationsDeleteResource :<|> (ProjectsLocationsListResource :<|> ProjectsLocationsGetResource)))))))))
- module Network.Google.Resource.Redis.Projects.Locations.Get
- module Network.Google.Resource.Redis.Projects.Locations.Instances.Create
- module Network.Google.Resource.Redis.Projects.Locations.Instances.Delete
- module Network.Google.Resource.Redis.Projects.Locations.Instances.Get
- module Network.Google.Resource.Redis.Projects.Locations.Instances.List
- module Network.Google.Resource.Redis.Projects.Locations.Instances.Patch
- module Network.Google.Resource.Redis.Projects.Locations.List
- module Network.Google.Resource.Redis.Projects.Locations.Operations.Cancel
- module Network.Google.Resource.Redis.Projects.Locations.Operations.Delete
- module Network.Google.Resource.Redis.Projects.Locations.Operations.Get
- module Network.Google.Resource.Redis.Projects.Locations.Operations.List
- data InstanceLabels
- instanceLabels :: HashMap Text Text -> InstanceLabels
- ilAddtional :: Lens' InstanceLabels (HashMap Text Text)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data ListLocationsResponse
- listLocationsResponse :: ListLocationsResponse
- llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text)
- llrLocations :: Lens' ListLocationsResponse [Location]
- data ListOperationsResponse
- listOperationsResponse :: ListOperationsResponse
- lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)
- lorOperations :: Lens' ListOperationsResponse [Operation]
- data Location
- location :: Location
- lName :: Lens' Location (Maybe Text)
- lMetadata :: Lens' Location (Maybe LocationMetadata)
- lDisplayName :: Lens' Location (Maybe Text)
- lLabels :: Lens' Location (Maybe LocationLabels)
- lLocationId :: Lens' Location (Maybe Text)
- data GoogleCloudRedisV1ZoneMetadata
- googleCloudRedisV1ZoneMetadata :: GoogleCloudRedisV1ZoneMetadata
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data Empty
- empty :: Empty
- data InstanceTier
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data GoogleCloudRedisV1LocationMetadata
- googleCloudRedisV1LocationMetadata :: GoogleCloudRedisV1LocationMetadata
- gcrvlmAvailableZones :: Lens' GoogleCloudRedisV1LocationMetadata (Maybe GoogleCloudRedisV1LocationMetadataAvailableZones)
- data GoogleCloudRedisV1OperationMetadata
- googleCloudRedisV1OperationMetadata :: GoogleCloudRedisV1OperationMetadata
- gcrvomAPIVersion :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text)
- gcrvomEndTime :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe UTCTime)
- gcrvomStatusDetail :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text)
- gcrvomVerb :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text)
- gcrvomCancelRequested :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Bool)
- gcrvomTarget :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text)
- gcrvomCreateTime :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe UTCTime)
- data InstanceRedisConfigs
- instanceRedisConfigs :: HashMap Text Text -> InstanceRedisConfigs
- ircAddtional :: Lens' InstanceRedisConfigs (HashMap Text Text)
- data GoogleCloudRedisV1LocationMetadataAvailableZones
- googleCloudRedisV1LocationMetadataAvailableZones :: HashMap Text GoogleCloudRedisV1ZoneMetadata -> GoogleCloudRedisV1LocationMetadataAvailableZones
- gcrvlmazAddtional :: Lens' GoogleCloudRedisV1LocationMetadataAvailableZones (HashMap Text GoogleCloudRedisV1ZoneMetadata)
- data Xgafv
- data LocationLabels
- locationLabels :: HashMap Text Text -> LocationLabels
- llAddtional :: Lens' LocationLabels (HashMap Text Text)
- data LocationMetadata
- locationMetadata :: HashMap Text JSONValue -> LocationMetadata
- lmAddtional :: Lens' LocationMetadata (HashMap Text JSONValue)
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data ListInstancesResponse
- listInstancesResponse :: ListInstancesResponse
- lirNextPageToken :: Lens' ListInstancesResponse (Maybe Text)
- lirUnreachable :: Lens' ListInstancesResponse [Text]
- lirInstances :: Lens' ListInstancesResponse [Instance]
- data InstanceState
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data Instance
- instance' :: Instance
- iState :: Lens' Instance (Maybe InstanceState)
- iAuthorizedNetwork :: Lens' Instance (Maybe Text)
- iMemorySizeGb :: Lens' Instance (Maybe Int32)
- iName :: Lens' Instance (Maybe Text)
- iStatusMessage :: Lens' Instance (Maybe Text)
- iAlternativeLocationId :: Lens' Instance (Maybe Text)
- iReservedIPRange :: Lens' Instance (Maybe Text)
- iTier :: Lens' Instance (Maybe InstanceTier)
- iDisplayName :: Lens' Instance (Maybe Text)
- iLabels :: Lens' Instance (Maybe InstanceLabels)
- iLocationId :: Lens' Instance (Maybe Text)
- iHost :: Lens' Instance (Maybe Text)
- iRedisConfigs :: Lens' Instance (Maybe InstanceRedisConfigs)
- iRedisVersion :: Lens' Instance (Maybe Text)
- iCreateTime :: Lens' Instance (Maybe UTCTime)
- iPort :: Lens' Instance (Maybe Int32)
- iCurrentLocationId :: Lens' Instance (Maybe Text)
Service Configuration
redisService :: ServiceConfig Source #
Default request referring to version v1 of the Google Cloud Memorystore for Redis API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type RedisAPI = ProjectsLocationsInstancesListResource :<|> (ProjectsLocationsInstancesPatchResource :<|> (ProjectsLocationsInstancesGetResource :<|> (ProjectsLocationsInstancesCreateResource :<|> (ProjectsLocationsInstancesDeleteResource :<|> (ProjectsLocationsOperationsListResource :<|> (ProjectsLocationsOperationsGetResource :<|> (ProjectsLocationsOperationsCancelResource :<|> (ProjectsLocationsOperationsDeleteResource :<|> (ProjectsLocationsListResource :<|> ProjectsLocationsGetResource))))))))) Source #
Represents the entirety of the methods and resources available for the Google Cloud Memorystore for Redis API service.
Resources
redis.projects.locations.get
redis.projects.locations.instances.create
redis.projects.locations.instances.delete
redis.projects.locations.instances.get
redis.projects.locations.instances.list
redis.projects.locations.instances.patch
redis.projects.locations.list
redis.projects.locations.operations.cancel
redis.projects.locations.operations.delete
redis.projects.locations.operations.get
redis.projects.locations.operations.list
Types
InstanceLabels
data InstanceLabels Source #
Resource labels to represent user provided metadata
See: instanceLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> InstanceLabels |
Creates a value of InstanceLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status smart constructor.
Instances
| Eq Status Source # | |
| Data Status Source # | |
Defined in Network.Google.Redis.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
| Show Status Source # | |
| Generic Status Source # | |
| ToJSON Status Source # | |
Defined in Network.Google.Redis.Types.Product | |
| FromJSON Status Source # | |
| type Rep Status Source # | |
Defined in Network.Google.Redis.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.Redis.Types.Product" "gogol-redis-0.4.0-JeQ7whRgDRe4ZrcQhhVPNa" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
ListLocationsResponse
data ListLocationsResponse Source #
The response message for Locations.ListLocations.
See: listLocationsResponse smart constructor.
Instances
listLocationsResponse :: ListLocationsResponse Source #
Creates a value of ListLocationsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text) Source #
The standard List next-page token.
llrLocations :: Lens' ListLocationsResponse [Location] Source #
A list of locations that matches the specified filter in the request.
ListOperationsResponse
data ListOperationsResponse Source #
The response message for Operations.ListOperations.
See: listOperationsResponse smart constructor.
Instances
listOperationsResponse :: ListOperationsResponse Source #
Creates a value of ListOperationsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text) Source #
The standard List next-page token.
lorOperations :: Lens' ListOperationsResponse [Operation] Source #
A list of operations that matches the specified filter in the request.
Location
A resource that represents Google Cloud Platform location.
See: location smart constructor.
Instances
Creates a value of Location with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lName :: Lens' Location (Maybe Text) Source #
Full resource name for the region. For example: "projects/example-project/locations/us-east1".
lMetadata :: Lens' Location (Maybe LocationMetadata) Source #
Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
lDisplayName :: Lens' Location (Maybe Text) Source #
The friendly name for this location, typically a nearby city name. For example, "Tokyo".
lLabels :: Lens' Location (Maybe LocationLabels) Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
lLocationId :: Lens' Location (Maybe Text) Source #
Resource ID for the region. For example: "us-east1".
GoogleCloudRedisV1ZoneMetadata
data GoogleCloudRedisV1ZoneMetadata Source #
Defines specific information for a particular zone. Currently empty and reserved for future use only.
See: googleCloudRedisV1ZoneMetadata smart constructor.
Instances
googleCloudRedisV1ZoneMetadata :: GoogleCloudRedisV1ZoneMetadata Source #
Creates a value of GoogleCloudRedisV1ZoneMetadata with the minimum fields required to make a request.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation smart constructor.
Instances
oDone :: Lens' Operation (Maybe Bool) Source #
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure or cancellation.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
oName :: Lens' Operation (Maybe Text) Source #
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
{ `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
See: empty smart constructor.
Instances
| Eq Empty Source # | |
| Data Empty Source # | |
Defined in Network.Google.Redis.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
| Show Empty Source # | |
| Generic Empty Source # | |
| ToJSON Empty Source # | |
Defined in Network.Google.Redis.Types.Product | |
| FromJSON Empty Source # | |
| type Rep Empty Source # | |
InstanceTier
data InstanceTier Source #
Required. The service tier of the instance.
Constructors
| TierUnspecified |
|
| Basic |
|
| StandardHa |
|
Instances
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> StatusDetailsItem |
Creates a value of StatusDetailsItem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
GoogleCloudRedisV1LocationMetadata
data GoogleCloudRedisV1LocationMetadata Source #
This location metadata represents additional configuration options for a given location where a Redis instance may be created. All fields are output only. It is returned as content of the `google.cloud.location.Location.metadata` field.
See: googleCloudRedisV1LocationMetadata smart constructor.
Instances
googleCloudRedisV1LocationMetadata :: GoogleCloudRedisV1LocationMetadata Source #
Creates a value of GoogleCloudRedisV1LocationMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gcrvlmAvailableZones :: Lens' GoogleCloudRedisV1LocationMetadata (Maybe GoogleCloudRedisV1LocationMetadataAvailableZones) Source #
Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
GoogleCloudRedisV1OperationMetadata
data GoogleCloudRedisV1OperationMetadata Source #
Represents the v1 metadata of the long-running operation.
See: googleCloudRedisV1OperationMetadata smart constructor.
Instances
googleCloudRedisV1OperationMetadata :: GoogleCloudRedisV1OperationMetadata Source #
Creates a value of GoogleCloudRedisV1OperationMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gcrvomAPIVersion :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text) Source #
API version.
gcrvomEndTime :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe UTCTime) Source #
End timestamp.
gcrvomStatusDetail :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text) Source #
Operation status details.
gcrvomVerb :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text) Source #
Operation verb.
gcrvomCancelRequested :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Bool) Source #
Specifies if cancellation was requested for the operation.
gcrvomTarget :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe Text) Source #
Operation target.
gcrvomCreateTime :: Lens' GoogleCloudRedisV1OperationMetadata (Maybe UTCTime) Source #
Creation timestamp.
InstanceRedisConfigs
data InstanceRedisConfigs Source #
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: * maxmemory-policy * notify-keyspace-events
See: instanceRedisConfigs smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> InstanceRedisConfigs |
Creates a value of InstanceRedisConfigs with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
GoogleCloudRedisV1LocationMetadataAvailableZones
data GoogleCloudRedisV1LocationMetadataAvailableZones Source #
Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
See: googleCloudRedisV1LocationMetadataAvailableZones smart constructor.
Instances
googleCloudRedisV1LocationMetadataAvailableZones Source #
Arguments
| :: HashMap Text GoogleCloudRedisV1ZoneMetadata | |
| -> GoogleCloudRedisV1LocationMetadataAvailableZones |
Creates a value of GoogleCloudRedisV1LocationMetadataAvailableZones with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gcrvlmazAddtional :: Lens' GoogleCloudRedisV1LocationMetadataAvailableZones (HashMap Text GoogleCloudRedisV1ZoneMetadata) Source #
Xgafv
V1 error format.
Instances
| Enum Xgafv Source # | |
Defined in Network.Google.Redis.Types.Sum | |
| Eq Xgafv Source # | |
| Data Xgafv Source # | |
Defined in Network.Google.Redis.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 # | |
Defined in Network.Google.Redis.Types.Sum | |
| ToJSON Xgafv Source # | |
Defined in Network.Google.Redis.Types.Sum | |
| FromJSON Xgafv Source # | |
| FromHttpApiData Xgafv Source # | |
Defined in Network.Google.Redis.Types.Sum | |
| ToHttpApiData Xgafv Source # | |
Defined in Network.Google.Redis.Types.Sum Methods toUrlPiece :: Xgafv -> Text # toEncodedUrlPiece :: Xgafv -> Builder # toHeader :: Xgafv -> ByteString # toQueryParam :: Xgafv -> Text # | |
| type Rep Xgafv Source # | |
LocationLabels
data LocationLabels Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
See: locationLabels smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> LocationLabels |
Creates a value of LocationLabels with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
LocationMetadata
data LocationMetadata Source #
Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
See: locationMetadata smart constructor.
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> LocationMetadata |
Creates a value of LocationMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmAddtional :: Lens' LocationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
OperationMetadata
data OperationMetadata Source #
{ `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
See: operationMetadata smart constructor.
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> OperationMetadata |
Creates a value of OperationMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
ListInstancesResponse
data ListInstancesResponse Source #
Response for ListInstances.
See: listInstancesResponse smart constructor.
Instances
listInstancesResponse :: ListInstancesResponse Source #
Creates a value of ListInstancesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lirNextPageToken :: Lens' ListInstancesResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results in the list.
lirUnreachable :: Lens' ListInstancesResponse [Text] Source #
Locations that could not be reached.
lirInstances :: Lens' ListInstancesResponse [Instance] Source #
A list of Redis instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the "name" field set to a value of the form projects/{project_id}/locations/{location_id}/instances/- and the "status" field set to ERROR and "status_message" field set to "location not available for ListInstances".
InstanceState
data InstanceState Source #
Output only. The current state of this instance.
Constructors
| StateUnspecified |
|
| Creating |
|
| Ready |
|
| Updating |
|
| Deleting |
|
| Repairing |
|
| Maintenance |
|
Instances
OperationResponse
data OperationResponse Source #
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
See: operationResponse smart constructor.
Instances
Arguments
| :: HashMap Text JSONValue | |
| -> OperationResponse |
Creates a value of OperationResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
Instance
A Google Cloud Redis instance.
See: instance' smart constructor.
Instances
instance' :: Instance Source #
Creates a value of Instance with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iState :: Lens' Instance (Maybe InstanceState) Source #
Output only. The current state of this instance.
iAuthorizedNetwork :: Lens' Instance (Maybe Text) Source #
Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the `default` network will be used.
iName :: Lens' Instance (Maybe Text) Source #
Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details.
iStatusMessage :: Lens' Instance (Maybe Text) Source #
Output only. Additional information about the current status of this instance, if available.
iAlternativeLocationId :: Lens' Instance (Maybe Text) Source #
Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id].
iReservedIPRange :: Lens' Instance (Maybe Text) Source #
Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
iDisplayName :: Lens' Instance (Maybe Text) Source #
An arbitrary and optional user-provided name for the instance.
iLabels :: Lens' Instance (Maybe InstanceLabels) Source #
Resource labels to represent user provided metadata
iLocationId :: Lens' Instance (Maybe Text) Source #
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternative_location_id] is also provided, it must be different from [location_id].
iHost :: Lens' Instance (Maybe Text) Source #
Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
iRedisConfigs :: Lens' Instance (Maybe InstanceRedisConfigs) Source #
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: * maxmemory-policy * notify-keyspace-events
iRedisVersion :: Lens' Instance (Maybe Text) Source #
Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are `REDIS_3_2` for Redis 3.2.
iCreateTime :: Lens' Instance (Maybe UTCTime) Source #
Output only. The time the instance was created.
iPort :: Lens' Instance (Maybe Int32) Source #
Output only. The port number of the exposed Redis endpoint.
iCurrentLocationId :: Lens' Instance (Maybe Text) Source #
Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the [location_id] provided by the user at creation time. For Standard Tier instances, this can be either [location_id] or [alternative_location_id] and can change after a failover event.