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 |
- Service Configuration
- OAuth Scopes
- InstanceLabels
- Status
- OperationSchema
- ListLocationsResponse
- ListOperationsResponse
- CancelOperationRequest
- Location
- Operation
- Empty
- InstanceTier
- StatusDetailsItem
- FileShareConfig
- NetworkConfig
- Xgafv
- LocationLabels
- LocationMetadata
- OperationMetadata
- ListInstancesResponse
- InstanceState
- OperationResponse
- Instance
Synopsis
- fileService :: ServiceConfig
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- 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 OperationSchema
- operationSchema :: HashMap Text JSONValue -> OperationSchema
- osAddtional :: Lens' OperationSchema (HashMap Text JSONValue)
- 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 CancelOperationRequest
- cancelOperationRequest :: CancelOperationRequest
- 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 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 OperationSchema)
- data Empty
- empty :: Empty
- data InstanceTier
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data FileShareConfig
- fileShareConfig :: FileShareConfig
- fscName :: Lens' FileShareConfig (Maybe Text)
- fscCapacityGb :: Lens' FileShareConfig (Maybe Int64)
- data NetworkConfig
- networkConfig :: NetworkConfig
- ncModes :: Lens' NetworkConfig [Text]
- ncNetwork :: Lens' NetworkConfig (Maybe Text)
- ncReservedIPRange :: Lens' NetworkConfig (Maybe Text)
- ncIPAddresses :: Lens' NetworkConfig [Text]
- 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 :: OperationMetadata
- omAPIVersion :: Lens' OperationMetadata (Maybe Text)
- omEndTime :: Lens' OperationMetadata (Maybe UTCTime)
- omStatusDetail :: Lens' OperationMetadata (Maybe Text)
- omVerb :: Lens' OperationMetadata (Maybe Text)
- omCancelRequested :: Lens' OperationMetadata (Maybe Bool)
- omTarget :: Lens' OperationMetadata (Maybe Text)
- omCreateTime :: Lens' OperationMetadata (Maybe UTCTime)
- 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
- iEtag :: Lens' Instance (Maybe Text)
- iState :: Lens' Instance (Maybe InstanceState)
- iNetworks :: Lens' Instance [NetworkConfig]
- iFileShares :: Lens' Instance [FileShareConfig]
- iName :: Lens' Instance (Maybe Text)
- iStatusMessage :: Lens' Instance (Maybe Text)
- iTier :: Lens' Instance (Maybe InstanceTier)
- iLabels :: Lens' Instance (Maybe InstanceLabels)
- iDescription :: Lens' Instance (Maybe Text)
- iCreateTime :: Lens' Instance (Maybe UTCTime)
Service Configuration
fileService :: ServiceConfig Source #
Default request referring to version v1beta1
of the Cloud Filestore 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
InstanceLabels
data InstanceLabels Source #
Resource labels to represent user provided metadata.
See: instanceLabels
smart constructor.
Instances
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.File.Types.Product 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.File.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.File.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.File.Types.Product" "gogol-file-0.4.0-9fk2PL5JEmGAVGvmRg4nZ" 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.
OperationSchema
data OperationSchema Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
See: operationSchema
smart constructor.
Instances
Creates a value of OperationSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osAddtional :: Lens' OperationSchema (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
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.
CancelOperationRequest
data CancelOperationRequest Source #
The request message for Operations.CancelOperation.
See: cancelOperationRequest
smart constructor.
Instances
cancelOperationRequest :: CancelOperationRequest Source #
Creates a value of CancelOperationRequest
with the minimum fields required to make a 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 #
Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
lMetadata :: Lens' Location (Maybe LocationMetadata) Source #
Service-specific metadata. For example the available capacity at the given location.
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 #
The canonical id for this location. For example: `"us-east1"`.
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 OperationSchema) Source #
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
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.File.Types.Product 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.File.Types.Product | |
FromJSON Empty Source # | |
type Rep Empty Source # | |
InstanceTier
data InstanceTier Source #
The service tier of the instance.
TierUnspecified |
|
Standard |
|
Premium |
|
Instances
StatusDetailsItem
data StatusDetailsItem Source #
Instances
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.
FileShareConfig
data FileShareConfig Source #
File share configuration for the instance.
See: fileShareConfig
smart constructor.
fileShareConfig :: FileShareConfig Source #
Creates a value of FileShareConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fscName :: Lens' FileShareConfig (Maybe Text) Source #
The name of the file share (must be 16 characters or less).
fscCapacityGb :: Lens' FileShareConfig (Maybe Int64) Source #
File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
NetworkConfig
data NetworkConfig Source #
Network configuration for the instance.
See: networkConfig
smart constructor.
Instances
networkConfig :: NetworkConfig Source #
Creates a value of NetworkConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ncModes :: Lens' NetworkConfig [Text] Source #
Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
ncNetwork :: Lens' NetworkConfig (Maybe Text) Source #
The name of the Google Compute Engine VPC network to which the instance is connected.
ncReservedIPRange :: Lens' NetworkConfig (Maybe Text) Source #
A /29 CIDR block in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
ncIPAddresses :: Lens' NetworkConfig [Text] Source #
Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
Xgafv
V1 error format.
Instances
LocationLabels
data LocationLabels Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
See: locationLabels
smart constructor.
Instances
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 #
Service-specific metadata. For example the available capacity at the given location.
See: locationMetadata
smart constructor.
Instances
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 #
Represents the metadata of the long-running operation.
See: operationMetadata
smart constructor.
Instances
operationMetadata :: OperationMetadata Source #
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:
omAPIVersion :: Lens' OperationMetadata (Maybe Text) Source #
- Output only
- API version used to start the operation.
omEndTime :: Lens' OperationMetadata (Maybe UTCTime) Source #
- Output only
- The time the operation finished running.
omStatusDetail :: Lens' OperationMetadata (Maybe Text) Source #
- Output only
- Human-readable status of the operation, if any.
omVerb :: Lens' OperationMetadata (Maybe Text) Source #
- Output only
- Name of the verb executed by the operation.
omCancelRequested :: Lens' OperationMetadata (Maybe Bool) Source #
- Output only
- 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`.
omTarget :: Lens' OperationMetadata (Maybe Text) Source #
- Output only
- Server-defined resource path for the target of the operation.
omCreateTime :: Lens' OperationMetadata (Maybe UTCTime) Source #
- Output only
- The time the operation was created.
ListInstancesResponse
data ListInstancesResponse Source #
ListInstancesResponse is the result of ListInstancesRequest.
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 #
The token you can use to retrieve the next page of results. Not returned 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 instances in the project for the specified location. If the {location} value in the request is "-", the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the "unreachable" field will be populated with a list of unreachable locations.
InstanceState
data InstanceState Source #
Output only. The instance state.
StateUnspecified |
|
Creating |
|
Ready |
|
Repairing |
|
Deleting |
|
Error' |
|
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
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 Cloud Filestore 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:
iEtag :: Lens' Instance (Maybe Text) Source #
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
iNetworks :: Lens' Instance [NetworkConfig] Source #
VPC networks to which the instance is connected. For this version, only a single network is supported.
iFileShares :: Lens' Instance [FileShareConfig] Source #
File system shares on the instance. For this version, only a single file share is supported.
iName :: Lens' Instance (Maybe Text) Source #
Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
iStatusMessage :: Lens' Instance (Maybe Text) Source #
Output only. Additional information about the instance state, if available.
iLabels :: Lens' Instance (Maybe InstanceLabels) Source #
Resource labels to represent user provided metadata.