Copyright | (c) 2015 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
- Status
- OperationSchema
- TrafficSplit
- ScriptHandler
- URLMap
- Library
- ListOperationsResponse
- HealthCheck
- APIConfigHandler
- VersionEnvVariables
- Application
- VersionBetaSettings
- Operation
- URLDispatchRule
- StaticDirectoryHandlerHTTPHeaders
- ListVersionsResponse
- FileInfo
- AutomaticScaling
- ListModulesResponse
- APIEndpointHandler
- StatusDetailsItem
- Network
- StaticFilesHandlerHTTPHeaders
- Resources
- DeploymentFiles
- CPUUtilization
- TrafficSplitAllocations
- ManualScaling
- BasicScaling
- Version
- Module
- StaticFilesHandler
- ErrorHandler
- OperationMetadata
- SourceReference
- OperationResponse
- ContainerInfo
- Deployment
- StaticDirectoryHandler
- appEngineService :: Service
- cloudPlatformScope :: OAuthScope
- 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 TrafficSplit
- trafficSplit :: TrafficSplit
- tsShardBy :: Lens' TrafficSplit (Maybe Text)
- tsAllocations :: Lens' TrafficSplit (Maybe TrafficSplitAllocations)
- data ScriptHandler
- scriptHandler :: ScriptHandler
- shScriptPath :: Lens' ScriptHandler (Maybe Text)
- data URLMap
- urlMap :: URLMap
- umScript :: Lens' URLMap (Maybe ScriptHandler)
- umSecurityLevel :: Lens' URLMap (Maybe Text)
- umAPIEndpoint :: Lens' URLMap (Maybe APIEndpointHandler)
- umURLRegex :: Lens' URLMap (Maybe Text)
- umRedirectHTTPResponseCode :: Lens' URLMap (Maybe Text)
- umAuthFailAction :: Lens' URLMap (Maybe Text)
- umStaticFiles :: Lens' URLMap (Maybe StaticFilesHandler)
- umLogin :: Lens' URLMap (Maybe Text)
- umStaticDirectory :: Lens' URLMap (Maybe StaticDirectoryHandler)
- data Library
- library :: Library
- lName :: Lens' Library (Maybe Text)
- lVersion :: Lens' Library (Maybe Text)
- data ListOperationsResponse
- listOperationsResponse :: ListOperationsResponse
- lorNextPageToken :: Lens' ListOperationsResponse (Maybe Text)
- lorOperations :: Lens' ListOperationsResponse [Operation]
- data HealthCheck
- healthCheck :: HealthCheck
- hcHealthyThreshold :: Lens' HealthCheck (Maybe Word32)
- hcDisableHealthCheck :: Lens' HealthCheck (Maybe Bool)
- hcCheckInterval :: Lens' HealthCheck (Maybe Text)
- hcRestartThreshold :: Lens' HealthCheck (Maybe Word32)
- hcHost :: Lens' HealthCheck (Maybe Text)
- hcTimeout :: Lens' HealthCheck (Maybe Text)
- hcUnhealthyThreshold :: Lens' HealthCheck (Maybe Word32)
- data APIConfigHandler
- apiConfigHandler :: APIConfigHandler
- achScript :: Lens' APIConfigHandler (Maybe Text)
- achSecurityLevel :: Lens' APIConfigHandler (Maybe Text)
- achURL :: Lens' APIConfigHandler (Maybe Text)
- achAuthFailAction :: Lens' APIConfigHandler (Maybe Text)
- achLogin :: Lens' APIConfigHandler (Maybe Text)
- data VersionEnvVariables
- versionEnvVariables :: HashMap Text Text -> VersionEnvVariables
- vevAddtional :: Lens' VersionEnvVariables (HashMap Text Text)
- data Application
- application :: Application
- aLocation :: Lens' Application (Maybe Text)
- aCodeBucket :: Lens' Application (Maybe Text)
- aName :: Lens' Application (Maybe Text)
- aDispatchRules :: Lens' Application [URLDispatchRule]
- aId :: Lens' Application (Maybe Text)
- data VersionBetaSettings
- versionBetaSettings :: HashMap Text Text -> VersionBetaSettings
- vbsAddtional :: Lens' VersionBetaSettings (HashMap Text 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 URLDispatchRule
- urlDispatchRule :: URLDispatchRule
- udrPath :: Lens' URLDispatchRule (Maybe Text)
- udrDomain :: Lens' URLDispatchRule (Maybe Text)
- udrModule :: Lens' URLDispatchRule (Maybe Text)
- data StaticDirectoryHandlerHTTPHeaders
- staticDirectoryHandlerHTTPHeaders :: HashMap Text Text -> StaticDirectoryHandlerHTTPHeaders
- sdhhttphAddtional :: Lens' StaticDirectoryHandlerHTTPHeaders (HashMap Text Text)
- data ListVersionsResponse
- listVersionsResponse :: ListVersionsResponse
- lvrNextPageToken :: Lens' ListVersionsResponse (Maybe Text)
- lvrVersions :: Lens' ListVersionsResponse [Version]
- data FileInfo
- fileInfo :: FileInfo
- fiSha1Sum :: Lens' FileInfo (Maybe Text)
- fiMimeType :: Lens' FileInfo (Maybe Text)
- fiSourceURL :: Lens' FileInfo (Maybe Text)
- data AutomaticScaling
- automaticScaling :: AutomaticScaling
- asMaxTotalInstances :: Lens' AutomaticScaling (Maybe Int32)
- asMinIdleInstances :: Lens' AutomaticScaling (Maybe Int32)
- asMinPendingLatency :: Lens' AutomaticScaling (Maybe Text)
- asCPUUtilization :: Lens' AutomaticScaling (Maybe CPUUtilization)
- asMaxIdleInstances :: Lens' AutomaticScaling (Maybe Int32)
- asMinTotalInstances :: Lens' AutomaticScaling (Maybe Int32)
- asMaxConcurrentRequests :: Lens' AutomaticScaling (Maybe Int32)
- asCoolDownPeriod :: Lens' AutomaticScaling (Maybe Text)
- asMaxPendingLatency :: Lens' AutomaticScaling (Maybe Text)
- data ListModulesResponse
- listModulesResponse :: ListModulesResponse
- lmrNextPageToken :: Lens' ListModulesResponse (Maybe Text)
- lmrModules :: Lens' ListModulesResponse [Module]
- data APIEndpointHandler
- apiEndpointHandler :: APIEndpointHandler
- aehScriptPath :: Lens' APIEndpointHandler (Maybe Text)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data Network
- network :: Network
- nForwardedPorts :: Lens' Network [Text]
- nInstanceTag :: Lens' Network (Maybe Text)
- nName :: Lens' Network (Maybe Text)
- data StaticFilesHandlerHTTPHeaders
- staticFilesHandlerHTTPHeaders :: HashMap Text Text -> StaticFilesHandlerHTTPHeaders
- sfhhttphAddtional :: Lens' StaticFilesHandlerHTTPHeaders (HashMap Text Text)
- data Resources
- resources :: Resources
- rMemoryGb :: Lens' Resources (Maybe Double)
- rDiskGb :: Lens' Resources (Maybe Double)
- rCPU :: Lens' Resources (Maybe Double)
- data DeploymentFiles
- deploymentFiles :: HashMap Text FileInfo -> DeploymentFiles
- dfAddtional :: Lens' DeploymentFiles (HashMap Text FileInfo)
- data CPUUtilization
- cpuUtilization :: CPUUtilization
- cuAggregationWindowLength :: Lens' CPUUtilization (Maybe Text)
- cuTargetUtilization :: Lens' CPUUtilization (Maybe Double)
- data TrafficSplitAllocations
- trafficSplitAllocations :: HashMap Text Double -> TrafficSplitAllocations
- tsaAddtional :: Lens' TrafficSplitAllocations (HashMap Text Double)
- data ManualScaling
- manualScaling :: ManualScaling
- msInstances :: Lens' ManualScaling (Maybe Int32)
- data BasicScaling
- basicScaling :: BasicScaling
- bsMaxInstances :: Lens' BasicScaling (Maybe Int32)
- bsIdleTimeout :: Lens' BasicScaling (Maybe Text)
- data Version
- version :: Version
- vCreationTime :: Lens' Version (Maybe Text)
- vRuntime :: Lens' Version (Maybe Text)
- vDeployer :: Lens' Version (Maybe Text)
- vNobuildFilesRegex :: Lens' Version (Maybe Text)
- vInstanceClass :: Lens' Version (Maybe Text)
- vHealthCheck :: Lens' Version (Maybe HealthCheck)
- vEnv :: Lens' Version (Maybe Text)
- vDefaultExpiration :: Lens' Version (Maybe Text)
- vAutomaticScaling :: Lens' Version (Maybe AutomaticScaling)
- vErrorHandlers :: Lens' Version [ErrorHandler]
- vVM :: Lens' Version (Maybe Bool)
- vHandlers :: Lens' Version [URLMap]
- vInboundServices :: Lens' Version [Text]
- vNetwork :: Lens' Version (Maybe Network)
- vResources :: Lens' Version (Maybe Resources)
- vName :: Lens' Version (Maybe Text)
- vThreadsafe :: Lens' Version (Maybe Bool)
- vBetaSettings :: Lens' Version (Maybe VersionBetaSettings)
- vBasicScaling :: Lens' Version (Maybe BasicScaling)
- vManualScaling :: Lens' Version (Maybe ManualScaling)
- vAPIConfig :: Lens' Version (Maybe APIConfigHandler)
- vId :: Lens' Version (Maybe Text)
- vEnvVariables :: Lens' Version (Maybe VersionEnvVariables)
- vServingStatus :: Lens' Version (Maybe Text)
- vLibraries :: Lens' Version [Library]
- vDeployment :: Lens' Version (Maybe Deployment)
- data Module
- module' :: Module
- mSplit :: Lens' Module (Maybe TrafficSplit)
- mName :: Lens' Module (Maybe Text)
- mId :: Lens' Module (Maybe Text)
- data StaticFilesHandler
- staticFilesHandler :: StaticFilesHandler
- sfhHTTPHeaders :: Lens' StaticFilesHandler (Maybe StaticFilesHandlerHTTPHeaders)
- sfhPath :: Lens' StaticFilesHandler (Maybe Text)
- sfhRequireMatchingFile :: Lens' StaticFilesHandler (Maybe Bool)
- sfhExpiration :: Lens' StaticFilesHandler (Maybe Text)
- sfhMimeType :: Lens' StaticFilesHandler (Maybe Text)
- sfhApplicationReadable :: Lens' StaticFilesHandler (Maybe Bool)
- sfhUploadPathRegex :: Lens' StaticFilesHandler (Maybe Text)
- data ErrorHandler
- errorHandler :: ErrorHandler
- ehMimeType :: Lens' ErrorHandler (Maybe Text)
- ehErrorCode :: Lens' ErrorHandler (Maybe Text)
- ehStaticFile :: Lens' ErrorHandler (Maybe Text)
- data OperationMetadata
- operationMetadata :: OperationMetadata
- omInsertTime :: Lens' OperationMetadata (Maybe Text)
- omUser :: Lens' OperationMetadata (Maybe Text)
- omMethod :: Lens' OperationMetadata (Maybe Text)
- omEndTime :: Lens' OperationMetadata (Maybe Text)
- omOperationType :: Lens' OperationMetadata (Maybe Text)
- omTarget :: Lens' OperationMetadata (Maybe Text)
- data SourceReference
- sourceReference :: SourceReference
- srRepository :: Lens' SourceReference (Maybe Text)
- srRevisionId :: Lens' SourceReference (Maybe Text)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data ContainerInfo
- containerInfo :: ContainerInfo
- ciImage :: Lens' ContainerInfo (Maybe Text)
- data Deployment
- deployment :: Deployment
- dContainer :: Lens' Deployment (Maybe ContainerInfo)
- dFiles :: Lens' Deployment (Maybe DeploymentFiles)
- dSourceReferences :: Lens' Deployment [SourceReference]
- data StaticDirectoryHandler
- staticDirectoryHandler :: StaticDirectoryHandler
- sdhHTTPHeaders :: Lens' StaticDirectoryHandler (Maybe StaticDirectoryHandlerHTTPHeaders)
- sdhRequireMatchingFile :: Lens' StaticDirectoryHandler (Maybe Bool)
- sdhExpiration :: Lens' StaticDirectoryHandler (Maybe Text)
- sdhMimeType :: Lens' StaticDirectoryHandler (Maybe Text)
- sdhApplicationReadable :: Lens' StaticDirectoryHandler (Maybe Bool)
- sdhDirectory :: Lens' StaticDirectoryHandler (Maybe Text)
Service Configuration
appEngineService :: Service Source
Default request referring to version v1beta4
of the Google App Engine Admin API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformScope :: OAuthScope Source
View and manage your data across Google Cloud Platform services
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][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` which 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 purpose. - 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.
sDetails :: Lens' Status [StatusDetailsItem] Source
A list of messages that carry the error details. There will be 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][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][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.
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 'ype with type URL.
TrafficSplit
data TrafficSplit Source
Configuration for traffic splitting for versions within a single module. Traffic splitting allows traffic directed to the module to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example.
See: trafficSplit
smart constructor.
trafficSplit :: TrafficSplit Source
Creates a value of TrafficSplit
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsShardBy :: Lens' TrafficSplit (Maybe Text) Source
Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
tsAllocations :: Lens' TrafficSplit (Maybe TrafficSplitAllocations) Source
Mapping from module version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated in this field may not be deleted until the module is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
ScriptHandler
data ScriptHandler Source
Executes a script to handle the request that matches the URL pattern.
See: scriptHandler
smart constructor.
scriptHandler :: ScriptHandler Source
Creates a value of ScriptHandler
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
shScriptPath :: Lens' ScriptHandler (Maybe Text) Source
Specifies the path to the script from the application root directory.
URLMap
A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
See: urlMap
smart constructor.
Creates a value of URLMap
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
umScript :: Lens' URLMap (Maybe ScriptHandler) Source
Executes a script to handle the request that matches the URL pattern.
umSecurityLevel :: Lens' URLMap (Maybe Text) Source
Configures whether security (HTTPS) should be enforced for this URL.
umAPIEndpoint :: Lens' URLMap (Maybe APIEndpointHandler) Source
Use API Endpoints to handle requests.
umURLRegex :: Lens' URLMap (Maybe Text) Source
A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
umRedirectHTTPResponseCode :: Lens' URLMap (Maybe Text) Source
`30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
umAuthFailAction :: Lens' URLMap (Maybe Text) Source
For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
umStaticFiles :: Lens' URLMap (Maybe StaticFilesHandler) Source
Returns the contents of a file, such as an image, as the response.
umStaticDirectory :: Lens' URLMap (Maybe StaticDirectoryHandler) Source
Serves the entire contents of a directory as static files. This attribute is deprecated. You can mimic the behavior of static directories using static files.
Library
A Python runtime third-party library required by the application.
See: library
smart constructor.
ListOperationsResponse
data ListOperationsResponse Source
The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
See: listOperationsResponse
smart constructor.
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.
HealthCheck
data HealthCheck Source
Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances.
See: healthCheck
smart constructor.
healthCheck :: HealthCheck Source
Creates a value of HealthCheck
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hcHealthyThreshold :: Lens' HealthCheck (Maybe Word32) Source
The number of consecutive successful health checks before receiving traffic.
hcDisableHealthCheck :: Lens' HealthCheck (Maybe Bool) Source
Whether to explicitly disable health checks for this instance.
hcCheckInterval :: Lens' HealthCheck (Maybe Text) Source
The interval between health checks.
hcRestartThreshold :: Lens' HealthCheck (Maybe Word32) Source
The number of consecutive failed health checks before an instance is restarted.
hcHost :: Lens' HealthCheck (Maybe Text) Source
The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
hcTimeout :: Lens' HealthCheck (Maybe Text) Source
The amount of time before the health check is considered failed.
hcUnhealthyThreshold :: Lens' HealthCheck (Maybe Word32) Source
The number of consecutive failed health checks before removing traffic.
APIConfigHandler
data APIConfigHandler Source
API Serving configuration for Cloud Endpoints.
See: apiConfigHandler
smart constructor.
apiConfigHandler :: APIConfigHandler Source
Creates a value of APIConfigHandler
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
achScript :: Lens' APIConfigHandler (Maybe Text) Source
Specifies the path to the script from the application root directory.
achSecurityLevel :: Lens' APIConfigHandler (Maybe Text) Source
Configures whether security (HTTPS) should be enforced for this URL.
achAuthFailAction :: Lens' APIConfigHandler (Maybe Text) Source
For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
achLogin :: Lens' APIConfigHandler (Maybe Text) Source
What level of login is required to access this resource. Default is "optional".
VersionEnvVariables
data VersionEnvVariables Source
Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
See: versionEnvVariables
smart constructor.
Creates a value of VersionEnvVariables
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Application
data Application Source
An Application contains the top-level configuration of an App Engine application.
See: application
smart constructor.
application :: Application Source
Creates a value of Application
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aLocation :: Lens' Application (Maybe Text) Source
The location from which the application will be run. Choices are "us-central" for United States and "europe-west" for European Union. Application instances will run out of data centers in the chosen location and all of the application's End User Content will be stored at rest in the chosen location. The default is "us-central".
aCodeBucket :: Lens' Application (Maybe Text) Source
A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. 'OutputOnly
aName :: Lens' Application (Maybe Text) Source
The full path to the application in the API. Example: "apps/myapp". 'OutputOnly
aDispatchRules :: Lens' Application [URLDispatchRule] Source
HTTP path dispatch rules for requests to the app that do not explicitly target a module or version. The rules are order-dependent.
aId :: Lens' Application (Maybe Text) Source
The relative name/path of the application. Example: "myapp". 'OutputOnly
VersionBetaSettings
data VersionBetaSettings Source
Beta settings supplied to the application via metadata.
See: versionBetaSettings
smart constructor.
Creates a value of VersionBetaSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation
smart constructor.
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.
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 above, 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.
URLDispatchRule
data URLDispatchRule Source
Rules to match an HTTP request and dispatch that request to a module.
See: urlDispatchRule
smart constructor.
urlDispatchRule :: URLDispatchRule Source
Creates a value of URLDispatchRule
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udrPath :: Lens' URLDispatchRule (Maybe Text) Source
The pathname within the host. This must start with a '/'. A single '*' (glob) can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
udrDomain :: Lens' URLDispatchRule (Maybe Text) Source
The domain name to match on. Supports '*' (glob) wildcarding on the left-hand side of a '.'. If empty, all domains will be matched (the same as '*').
udrModule :: Lens' URLDispatchRule (Maybe Text) Source
The resource id of a Module in this application that should service the matched request. The Module must already exist. Example: "default".
StaticDirectoryHandlerHTTPHeaders
data StaticDirectoryHandlerHTTPHeaders Source
HTTP headers to use for all responses from these URLs.
See: staticDirectoryHandlerHTTPHeaders
smart constructor.
staticDirectoryHandlerHTTPHeaders Source
Creates a value of StaticDirectoryHandlerHTTPHeaders
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListVersionsResponse
data ListVersionsResponse Source
Response message for `Versions.ListVersions`.
See: listVersionsResponse
smart constructor.
listVersionsResponse :: ListVersionsResponse Source
Creates a value of ListVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvrNextPageToken :: Lens' ListVersionsResponse (Maybe Text) Source
Continuation token for fetching the next page of results.
lvrVersions :: Lens' ListVersionsResponse [Version] Source
The versions belonging to the requested application module.
FileInfo
A single source file which is part of the application to be deployed.
See: fileInfo
smart constructor.
Creates a value of FileInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fiMimeType :: Lens' FileInfo (Maybe Text) Source
The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
fiSourceURL :: Lens' FileInfo (Maybe Text) Source
The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage.
AutomaticScaling
data AutomaticScaling Source
Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
See: automaticScaling
smart constructor.
automaticScaling :: AutomaticScaling Source
Creates a value of AutomaticScaling
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asMaxTotalInstances :: Lens' AutomaticScaling (Maybe Int32) Source
Max number of instances that App Engine should start to handle requests.
asMinIdleInstances :: Lens' AutomaticScaling (Maybe Int32) Source
The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a module, since other versions are not expected to receive significant traffic.
asMinPendingLatency :: Lens' AutomaticScaling (Maybe Text) Source
The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
asCPUUtilization :: Lens' AutomaticScaling (Maybe CPUUtilization) Source
Target scaling by CPU usage.
asMaxIdleInstances :: Lens' AutomaticScaling (Maybe Int32) Source
The maximum number of idle instances that App Engine should maintain for this version.
asMinTotalInstances :: Lens' AutomaticScaling (Maybe Int32) Source
Minimum number of instances that App Engine should maintain.
asMaxConcurrentRequests :: Lens' AutomaticScaling (Maybe Int32) Source
The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
asCoolDownPeriod :: Lens' AutomaticScaling (Maybe Text) Source
The amount of time that the Autoscaler should wait between changes to the number of virtual machines. Applies only to the VM runtime.
asMaxPendingLatency :: Lens' AutomaticScaling (Maybe Text) Source
The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
ListModulesResponse
data ListModulesResponse Source
Response message for `Modules.ListModules`.
See: listModulesResponse
smart constructor.
listModulesResponse :: ListModulesResponse Source
Creates a value of ListModulesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmrNextPageToken :: Lens' ListModulesResponse (Maybe Text) Source
Continuation token for fetching the next page of results.
lmrModules :: Lens' ListModulesResponse [Module] Source
The modules belonging to the requested application.
APIEndpointHandler
data APIEndpointHandler Source
Use Google Cloud Endpoints to handle requests.
See: apiEndpointHandler
smart constructor.
apiEndpointHandler :: APIEndpointHandler Source
Creates a value of APIEndpointHandler
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aehScriptPath :: Lens' APIEndpointHandler (Maybe Text) Source
Specifies the path to the script from the application root directory.
StatusDetailsItem
data StatusDetailsItem Source
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 'ype with type URL.
Network
Used to specify extra network settings (for VM runtimes only).
See: network
smart constructor.
Creates a value of Network
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nForwardedPorts :: Lens' Network [Text] Source
A list of ports (or port pairs) to forward from the VM into the app container.
nName :: Lens' Network (Maybe Text) Source
The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
StaticFilesHandlerHTTPHeaders
data StaticFilesHandlerHTTPHeaders Source
HTTP headers to use for all responses from these URLs.
See: staticFilesHandlerHTTPHeaders
smart constructor.
staticFilesHandlerHTTPHeaders Source
Creates a value of StaticFilesHandlerHTTPHeaders
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Resources
Used to specify how many machine resources an app version needs.
See: resources
smart constructor.
DeploymentFiles
data DeploymentFiles Source
A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
See: deploymentFiles
smart constructor.
Creates a value of DeploymentFiles
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CPUUtilization
data CPUUtilization Source
Target scaling by CPU usage.
See: cpuUtilization
smart constructor.
cpuUtilization :: CPUUtilization Source
Creates a value of CPUUtilization
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cuAggregationWindowLength :: Lens' CPUUtilization (Maybe Text) Source
The period of time over which CPU utilization is calculated.
cuTargetUtilization :: Lens' CPUUtilization (Maybe Double) Source
Target (0-1) CPU utilization ratio to maintain when scaling.
TrafficSplitAllocations
data TrafficSplitAllocations Source
Mapping from module version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated in this field may not be deleted until the module is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
See: trafficSplitAllocations
smart constructor.
trafficSplitAllocations Source
Creates a value of TrafficSplitAllocations
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ManualScaling
data ManualScaling Source
A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
See: manualScaling
smart constructor.
manualScaling :: ManualScaling Source
Creates a value of ManualScaling
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
msInstances :: Lens' ManualScaling (Maybe Int32) Source
The number of instances to assign to the module at the start. This number can later be altered by using the Modules API `set_num_instances()` function.
BasicScaling
data BasicScaling Source
A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
See: basicScaling
smart constructor.
basicScaling :: BasicScaling Source
Creates a value of BasicScaling
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bsMaxInstances :: Lens' BasicScaling (Maybe Int32) Source
The maximum number of instances for App Engine to create for this version.
bsIdleTimeout :: Lens' BasicScaling (Maybe Text) Source
The instance will be shut down this amount of time after receiving its last request.
Version
A Version is a specific set of source code and configuration files deployed to a module.
See: version
smart constructor.
Creates a value of Version
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vCreationTime :: Lens' Version (Maybe Text) Source
Creation time of this version. This will be between the start and end times of the operation that creates this version. 'OutputOnly
vRuntime :: Lens' Version (Maybe Text) Source
The desired runtime. Values can include python27, java7, go, etc.
vDeployer :: Lens' Version (Maybe Text) Source
The email address of the user who created this version. 'OutputOnly
vNobuildFilesRegex :: Lens' Version (Maybe Text) Source
Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
vInstanceClass :: Lens' Version (Maybe Text) Source
The frontend instance class to use to run this app. Valid values are `[F1, F2, F4, F4_1G]`. Default: "F1"
vHealthCheck :: Lens' Version (Maybe HealthCheck) Source
Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
vEnv :: Lens' Version (Maybe Text) Source
The App Engine execution environment to use for this version. Default: "1"
vDefaultExpiration :: Lens' Version (Maybe Text) Source
The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
vAutomaticScaling :: Lens' Version (Maybe AutomaticScaling) Source
Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
vErrorHandlers :: Lens' Version [ErrorHandler] Source
Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
vVM :: Lens' Version (Maybe Bool) Source
Whether to deploy this app in a VM container (deprecated, use "env":"2").
vHandlers :: Lens' Version [URLMap] Source
An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
vInboundServices :: Lens' Version [Text] Source
Before an application can receive email or XMPP messages, the application must be configured to enable the service.
vNetwork :: Lens' Version (Maybe Network) Source
Used to specify extra network settings (for VM runtimes only).
vResources :: Lens' Version (Maybe Resources) Source
Used to specify how many machine resources an app version needs (for VM runtimes only).
vName :: Lens' Version (Maybe Text) Source
The full path to the Version resource in the API. Example: "apps/myapp/modules/default/versions/v1". 'OutputOnly
vThreadsafe :: Lens' Version (Maybe Bool) Source
If true, multiple requests can be dispatched to the app at once.
vBetaSettings :: Lens' Version (Maybe VersionBetaSettings) Source
Beta settings supplied to the application via metadata.
vBasicScaling :: Lens' Version (Maybe BasicScaling) Source
A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
vManualScaling :: Lens' Version (Maybe ManualScaling) Source
A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
vAPIConfig :: Lens' Version (Maybe APIConfigHandler) Source
Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
vId :: Lens' Version (Maybe Text) Source
The relative name/path of the Version within the module. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
vEnvVariables :: Lens' Version (Maybe VersionEnvVariables) Source
Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
vServingStatus :: Lens' Version (Maybe Text) Source
The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
vLibraries :: Lens' Version [Library] Source
Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
vDeployment :: Lens' Version (Maybe Deployment) Source
Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
Module
A module is a component of an application that provides a single service or configuration. A module has a collection of versions that define a specific set of code used to implement the functionality of that module.
See: module'
smart constructor.
mSplit :: Lens' Module (Maybe TrafficSplit) Source
A mapping that defines fractional HTTP traffic diversion to different versions within the module.
mName :: Lens' Module (Maybe Text) Source
The full path to the Module resource in the API. Example: "apps/myapp/modules/default" 'OutputOnly
mId :: Lens' Module (Maybe Text) Source
The relative name/path of the module within the application. Example: "default" 'OutputOnly
StaticFilesHandler
data StaticFilesHandler Source
Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.
See: staticFilesHandler
smart constructor.
staticFilesHandler :: StaticFilesHandler Source
Creates a value of StaticFilesHandler
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sfhHTTPHeaders :: Lens' StaticFilesHandler (Maybe StaticFilesHandlerHTTPHeaders) Source
HTTP headers to use for all responses from these URLs.
sfhPath :: Lens' StaticFilesHandler (Maybe Text) Source
The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
sfhRequireMatchingFile :: Lens' StaticFilesHandler (Maybe Bool) Source
If true, this [UrlMap][google.appengine.v1beta4.UrlMap] entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next [UrlMap][google.appengine.v1beta4.UrlMap] that matches the requested URL.
sfhExpiration :: Lens' StaticFilesHandler (Maybe Text) Source
The length of time a static file served by this handler ought to be cached by web proxies and browsers.
sfhMimeType :: Lens' StaticFilesHandler (Maybe Text) Source
If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
sfhApplicationReadable :: Lens' StaticFilesHandler (Maybe Bool) Source
By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
sfhUploadPathRegex :: Lens' StaticFilesHandler (Maybe Text) Source
A regular expression that matches the file paths for all files that will be referenced by this handler.
ErrorHandler
data ErrorHandler Source
A custom static error page to be served when an error occurs.
See: errorHandler
smart constructor.
errorHandler :: ErrorHandler Source
Creates a value of ErrorHandler
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ehMimeType :: Lens' ErrorHandler (Maybe Text) Source
MIME type of file. If unspecified, "text/html" is assumed.
ehErrorCode :: Lens' ErrorHandler (Maybe Text) Source
The error condition this handler applies to.
ehStaticFile :: Lens' ErrorHandler (Maybe Text) Source
Static file content to be served for this error.
OperationMetadata
data OperationMetadata Source
Metadata for the given [google.longrunning.Operation][google.longrunning.Operation].
See: operationMetadata
smart constructor.
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:
omInsertTime :: Lens' OperationMetadata (Maybe Text) Source
Timestamp that this operation was received. 'OutputOnly
omUser :: Lens' OperationMetadata (Maybe Text) Source
The user who requested this operation. 'OutputOnly
omMethod :: Lens' OperationMetadata (Maybe Text) Source
API method name that initiated the operation. Example: "google.appengine.v1beta4.Version.CreateVersion". 'OutputOnly
omEndTime :: Lens' OperationMetadata (Maybe Text) Source
Timestamp that this operation was completed. (Not present if the operation is still in progress.) 'OutputOnly
omOperationType :: Lens' OperationMetadata (Maybe Text) Source
The type of the operation (deprecated, use method field instead). Example: "create_version". 'OutputOnly
omTarget :: Lens' OperationMetadata (Maybe Text) Source
Resource that this operation is acting on. Example: "apps/myapp/modules/default". 'OutputOnly
SourceReference
data SourceReference Source
A reference to a particular snapshot of the source tree used to build and deploy the application.
See: sourceReference
smart constructor.
sourceReference :: SourceReference Source
Creates a value of SourceReference
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srRepository :: Lens' SourceReference (Maybe Text) Source
Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
srRevisionId :: Lens' SourceReference (Maybe Text) Source
The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
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.
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 'ype with type URL.
ContainerInfo
data ContainerInfo Source
A Docker (container) image which should be used to start the application.
See: containerInfo
smart constructor.
containerInfo :: ContainerInfo Source
Creates a value of ContainerInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciImage :: Lens' ContainerInfo (Maybe Text) Source
Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image'digest
Deployment
data Deployment Source
Code and application artifacts used to deploy a version to App Engine.
See: deployment
smart constructor.
deployment :: Deployment Source
Creates a value of Deployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dContainer :: Lens' Deployment (Maybe ContainerInfo) Source
If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
dFiles :: Lens' Deployment (Maybe DeploymentFiles) Source
A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
dSourceReferences :: Lens' Deployment [SourceReference] Source
The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
StaticDirectoryHandler
data StaticDirectoryHandler Source
Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.
See: staticDirectoryHandler
smart constructor.
staticDirectoryHandler :: StaticDirectoryHandler Source
Creates a value of StaticDirectoryHandler
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdhHTTPHeaders :: Lens' StaticDirectoryHandler (Maybe StaticDirectoryHandlerHTTPHeaders) Source
HTTP headers to use for all responses from these URLs.
sdhRequireMatchingFile :: Lens' StaticDirectoryHandler (Maybe Bool) Source
If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
sdhExpiration :: Lens' StaticDirectoryHandler (Maybe Text) Source
The length of time a static file served by this handler ought to be cached by web proxies and browsers.
sdhMimeType :: Lens' StaticDirectoryHandler (Maybe Text) Source
If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
sdhApplicationReadable :: Lens' StaticDirectoryHandler (Maybe Bool) Source
By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
sdhDirectory :: Lens' StaticDirectoryHandler (Maybe Text) Source
The path to the directory containing the static files, from the application root directory. Everything after the end of the matched url pattern is appended to static_dir to form the full path to the requested file.