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
- API Declaration
- Resources
- appengine.apps.create
- appengine.apps.get
- appengine.apps.locations.get
- appengine.apps.locations.list
- appengine.apps.operations.get
- appengine.apps.operations.list
- appengine.apps.patch
- appengine.apps.repair
- appengine.apps.services.delete
- appengine.apps.services.get
- appengine.apps.services.list
- appengine.apps.services.patch
- appengine.apps.services.versions.create
- appengine.apps.services.versions.delete
- appengine.apps.services.versions.get
- appengine.apps.services.versions.instances.debug
- appengine.apps.services.versions.instances.delete
- appengine.apps.services.versions.instances.get
- appengine.apps.services.versions.instances.list
- appengine.apps.services.versions.list
- appengine.apps.services.versions.patch
- Types
- OperationMetadataExperimental
- NetworkUtilization
- Status
- OperationSchema
- LocationSchema
- TrafficSplit
- ScriptHandler
- ListServicesResponse
- URLMap
- Library
- ListLocationsResponse
- DiskUtilization
- ListOperationsResponse
- HealthCheck
- APIConfigHandler
- VersionEnvVariables
- Application
- VersionBetaSettings
- Service
- EndpointsAPIService
- Location
- Operation
- ZipInfo
- URLDispatchRule
- ListVersionsResponse
- FileInfo
- AutomaticScaling
- OperationMetadataV1Beta5
- Volume
- APIEndpointHandler
- StatusDetailsItem
- Network
- DebugInstanceRequest
- StaticFilesHandlerHTTPHeaders
- Resources
- DeploymentFiles
- CPUUtilization
- TrafficSplitAllocations
- ManualScaling
- BasicScaling
- OperationMetadataV1
- Version
- StaticFilesHandler
- ErrorHandler
- LocationLabels
- LocationMetadata
- OperationMetadata
- ListInstancesResponse
- RequestUtilization
- RepairApplicationRequest
- OperationResponse
- ContainerInfo
- Instance
- Deployment
Provisions and manages App Engine applications.
- appEngineService :: ServiceConfig
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- appEngineAdminScope :: Proxy '["https://www.googleapis.com/auth/appengine.admin"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type AppEngineAPI = AppsOperationsListResource :<|> (AppsOperationsGetResource :<|> (AppsLocationsListResource :<|> (AppsLocationsGetResource :<|> (AppsServicesVersionsInstancesListResource :<|> (AppsServicesVersionsInstancesGetResource :<|> (AppsServicesVersionsInstancesDebugResource :<|> (AppsServicesVersionsInstancesDeleteResource :<|> (AppsServicesVersionsListResource :<|> (AppsServicesVersionsPatchResource :<|> (AppsServicesVersionsGetResource :<|> (AppsServicesVersionsCreateResource :<|> (AppsServicesVersionsDeleteResource :<|> (AppsServicesListResource :<|> (AppsServicesPatchResource :<|> (AppsServicesGetResource :<|> (AppsServicesDeleteResource :<|> (AppsPatchResource :<|> (AppsGetResource :<|> (AppsCreateResource :<|> AppsRepairResource)))))))))))))))))))
- module Network.Google.Resource.AppEngine.Apps.Create
- module Network.Google.Resource.AppEngine.Apps.Get
- module Network.Google.Resource.AppEngine.Apps.Locations.Get
- module Network.Google.Resource.AppEngine.Apps.Locations.List
- module Network.Google.Resource.AppEngine.Apps.Operations.Get
- module Network.Google.Resource.AppEngine.Apps.Operations.List
- module Network.Google.Resource.AppEngine.Apps.Patch
- module Network.Google.Resource.AppEngine.Apps.Repair
- module Network.Google.Resource.AppEngine.Apps.Services.Delete
- module Network.Google.Resource.AppEngine.Apps.Services.Get
- module Network.Google.Resource.AppEngine.Apps.Services.List
- module Network.Google.Resource.AppEngine.Apps.Services.Patch
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Create
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Delete
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Get
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Instances.Debug
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Instances.Delete
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Instances.Get
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Instances.List
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.List
- module Network.Google.Resource.AppEngine.Apps.Services.Versions.Patch
- data OperationMetadataExperimental
- operationMetadataExperimental :: OperationMetadataExperimental
- omeInsertTime :: Lens' OperationMetadataExperimental (Maybe Text)
- omeUser :: Lens' OperationMetadataExperimental (Maybe Text)
- omeMethod :: Lens' OperationMetadataExperimental (Maybe Text)
- omeEndTime :: Lens' OperationMetadataExperimental (Maybe Text)
- omeTarget :: Lens' OperationMetadataExperimental (Maybe Text)
- data NetworkUtilization
- networkUtilization :: NetworkUtilization
- nuTargetReceivedBytesPerSecond :: Lens' NetworkUtilization (Maybe Int32)
- nuTargetSentPacketsPerSecond :: Lens' NetworkUtilization (Maybe Int32)
- nuTargetReceivedPacketsPerSecond :: Lens' NetworkUtilization (Maybe Int32)
- nuTargetSentBytesPerSecond :: Lens' NetworkUtilization (Maybe Int32)
- 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 LocationSchema
- locationSchema :: HashMap Text JSONValue -> LocationSchema
- lsAddtional :: Lens' LocationSchema (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 ListServicesResponse
- listServicesResponse :: ListServicesResponse
- lsrNextPageToken :: Lens' ListServicesResponse (Maybe Text)
- lsrServices :: Lens' ListServicesResponse [Service]
- 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)
- data Library
- library :: Library
- lName :: Lens' Library (Maybe Text)
- lVersion :: Lens' Library (Maybe Text)
- data ListLocationsResponse
- listLocationsResponse :: ListLocationsResponse
- llrNextPageToken :: Lens' ListLocationsResponse (Maybe Text)
- llrLocations :: Lens' ListLocationsResponse [Location]
- data DiskUtilization
- diskUtilization :: DiskUtilization
- duTargetReadBytesPerSecond :: Lens' DiskUtilization (Maybe Int32)
- duTargetReadOpsPerSecond :: Lens' DiskUtilization (Maybe Int32)
- duTargetWriteOpsPerSecond :: Lens' DiskUtilization (Maybe Int32)
- duTargetWriteBytesPerSecond :: Lens' DiskUtilization (Maybe Int32)
- 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
- aDefaultHostname :: Lens' Application (Maybe Text)
- aDefaultCookieExpiration :: Lens' Application (Maybe Text)
- aAuthDomain :: Lens' Application (Maybe Text)
- aCodeBucket :: Lens' Application (Maybe Text)
- aName :: Lens' Application (Maybe Text)
- aDispatchRules :: Lens' Application [URLDispatchRule]
- aDefaultBucket :: Lens' Application (Maybe Text)
- aId :: Lens' Application (Maybe Text)
- aLocationId :: Lens' Application (Maybe Text)
- data VersionBetaSettings
- versionBetaSettings :: HashMap Text Text -> VersionBetaSettings
- vbsAddtional :: Lens' VersionBetaSettings (HashMap Text Text)
- data Service
- service :: Service
- sSplit :: Lens' Service (Maybe TrafficSplit)
- sName :: Lens' Service (Maybe Text)
- sId :: Lens' Service (Maybe Text)
- data EndpointsAPIService
- endpointsAPIService :: EndpointsAPIService
- easName :: Lens' EndpointsAPIService (Maybe Text)
- easConfigId :: Lens' EndpointsAPIService (Maybe Text)
- data Location
- location :: Location
- locName :: Lens' Location (Maybe Text)
- locMetadata :: Lens' Location (Maybe LocationSchema)
- locLabels :: Lens' Location (Maybe LocationLabels)
- locLocationId :: 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 ZipInfo
- zipInfo :: ZipInfo
- ziFilesCount :: Lens' ZipInfo (Maybe Int32)
- ziSourceURL :: Lens' ZipInfo (Maybe Text)
- data URLDispatchRule
- urlDispatchRule :: URLDispatchRule
- udrPath :: Lens' URLDispatchRule (Maybe Text)
- udrService :: Lens' URLDispatchRule (Maybe Text)
- udrDomain :: Lens' URLDispatchRule (Maybe 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
- asNetworkUtilization :: Lens' AutomaticScaling (Maybe NetworkUtilization)
- asMaxTotalInstances :: Lens' AutomaticScaling (Maybe Int32)
- asMinIdleInstances :: Lens' AutomaticScaling (Maybe Int32)
- asDiskUtilization :: Lens' AutomaticScaling (Maybe DiskUtilization)
- 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)
- asRequestUtilization :: Lens' AutomaticScaling (Maybe RequestUtilization)
- asMaxPendingLatency :: Lens' AutomaticScaling (Maybe Text)
- data OperationMetadataV1Beta5
- operationMetadataV1Beta5 :: OperationMetadataV1Beta5
- omvbInsertTime :: Lens' OperationMetadataV1Beta5 (Maybe Text)
- omvbUser :: Lens' OperationMetadataV1Beta5 (Maybe Text)
- omvbMethod :: Lens' OperationMetadataV1Beta5 (Maybe Text)
- omvbEndTime :: Lens' OperationMetadataV1Beta5 (Maybe Text)
- omvbTarget :: Lens' OperationMetadataV1Beta5 (Maybe Text)
- data Volume
- volume :: Volume
- vSizeGb :: Lens' Volume (Maybe Double)
- vName :: Lens' Volume (Maybe Text)
- vVolumeType :: Lens' Volume (Maybe Text)
- 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
- nSubnetworkName :: Lens' Network (Maybe Text)
- nForwardedPorts :: Lens' Network [Text]
- nInstanceTag :: Lens' Network (Maybe Text)
- nName :: Lens' Network (Maybe Text)
- data DebugInstanceRequest
- debugInstanceRequest :: DebugInstanceRequest
- dirSSHKey :: Lens' DebugInstanceRequest (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)
- rVolumes :: Lens' Resources [Volume]
- 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 OperationMetadataV1
- operationMetadataV1 :: OperationMetadataV1
- omvEphemeralMessage :: Lens' OperationMetadataV1 (Maybe Text)
- omvInsertTime :: Lens' OperationMetadataV1 (Maybe Text)
- omvUser :: Lens' OperationMetadataV1 (Maybe Text)
- omvMethod :: Lens' OperationMetadataV1 (Maybe Text)
- omvEndTime :: Lens' OperationMetadataV1 (Maybe Text)
- omvWarning :: Lens' OperationMetadataV1 [Text]
- omvTarget :: Lens' OperationMetadataV1 (Maybe Text)
- data Version
- version :: Version
- verRuntime :: Lens' Version (Maybe Text)
- verNobuildFilesRegex :: Lens' Version (Maybe Text)
- verInstanceClass :: Lens' Version (Maybe Text)
- verHealthCheck :: Lens' Version (Maybe HealthCheck)
- verEndpointsAPIService :: Lens' Version (Maybe EndpointsAPIService)
- verEnv :: Lens' Version (Maybe Text)
- verDefaultExpiration :: Lens' Version (Maybe Text)
- verAutomaticScaling :: Lens' Version (Maybe AutomaticScaling)
- verErrorHandlers :: Lens' Version [ErrorHandler]
- verCreatedBy :: Lens' Version (Maybe Text)
- verVM :: Lens' Version (Maybe Bool)
- verHandlers :: Lens' Version [URLMap]
- verInboundServices :: Lens' Version [Text]
- verNetwork :: Lens' Version (Maybe Network)
- verResources :: Lens' Version (Maybe Resources)
- verName :: Lens' Version (Maybe Text)
- verThreadsafe :: Lens' Version (Maybe Bool)
- verBetaSettings :: Lens' Version (Maybe VersionBetaSettings)
- verBasicScaling :: Lens' Version (Maybe BasicScaling)
- verManualScaling :: Lens' Version (Maybe ManualScaling)
- verAPIConfig :: Lens' Version (Maybe APIConfigHandler)
- verId :: Lens' Version (Maybe Text)
- verEnvVariables :: Lens' Version (Maybe VersionEnvVariables)
- verServingStatus :: Lens' Version (Maybe Text)
- verDiskUsageBytes :: Lens' Version (Maybe Int64)
- verCreateTime :: Lens' Version (Maybe Text)
- verLibraries :: Lens' Version [Library]
- verVersionURL :: Lens' Version (Maybe Text)
- verDeployment :: Lens' Version (Maybe Deployment)
- 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 LocationLabels
- locationLabels :: HashMap Text Text -> LocationLabels
- llAddtional :: Lens' LocationLabels (HashMap Text Text)
- data LocationMetadata
- locationMetadata :: LocationMetadata
- lmStandardEnvironmentAvailable :: Lens' LocationMetadata (Maybe Bool)
- lmFlexibleEnvironmentAvailable :: Lens' LocationMetadata (Maybe Bool)
- 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 ListInstancesResponse
- listInstancesResponse :: ListInstancesResponse
- lirNextPageToken :: Lens' ListInstancesResponse (Maybe Text)
- lirInstances :: Lens' ListInstancesResponse [Instance]
- data RequestUtilization
- requestUtilization :: RequestUtilization
- ruTargetConcurrentRequests :: Lens' RequestUtilization (Maybe Int32)
- ruTargetRequestCountPerSecond :: Lens' RequestUtilization (Maybe Int32)
- data RepairApplicationRequest
- repairApplicationRequest :: RepairApplicationRequest
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data ContainerInfo
- containerInfo :: ContainerInfo
- ciImage :: Lens' ContainerInfo (Maybe Text)
- data Instance
- instance' :: Instance
- iMemoryUsage :: Lens' Instance (Maybe Int64)
- iVMStatus :: Lens' Instance (Maybe Text)
- iVMZoneName :: Lens' Instance (Maybe Text)
- iVMIP :: Lens' Instance (Maybe Text)
- iStartTime :: Lens' Instance (Maybe Text)
- iVMId :: Lens' Instance (Maybe Text)
- iAvailability :: Lens' Instance (Maybe Text)
- iVMName :: Lens' Instance (Maybe Text)
- iName :: Lens' Instance (Maybe Text)
- iVMDebugEnabled :: Lens' Instance (Maybe Bool)
- iRequests :: Lens' Instance (Maybe Int32)
- iQps :: Lens' Instance (Maybe Double)
- iId :: Lens' Instance (Maybe Text)
- iErrors :: Lens' Instance (Maybe Int32)
- iAverageLatency :: Lens' Instance (Maybe Int32)
- iAppEngineRelease :: Lens' Instance (Maybe Text)
- data Deployment
- deployment :: Deployment
- dZip :: Lens' Deployment (Maybe ZipInfo)
- dContainer :: Lens' Deployment (Maybe ContainerInfo)
- dFiles :: Lens' Deployment (Maybe DeploymentFiles)
Service Configuration
appEngineService :: ServiceConfig Source #
Default request referring to version v1
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
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
appEngineAdminScope :: Proxy '["https://www.googleapis.com/auth/appengine.admin"] Source #
View and manage your applications deployed on Google App Engine
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type AppEngineAPI = AppsOperationsListResource :<|> (AppsOperationsGetResource :<|> (AppsLocationsListResource :<|> (AppsLocationsGetResource :<|> (AppsServicesVersionsInstancesListResource :<|> (AppsServicesVersionsInstancesGetResource :<|> (AppsServicesVersionsInstancesDebugResource :<|> (AppsServicesVersionsInstancesDeleteResource :<|> (AppsServicesVersionsListResource :<|> (AppsServicesVersionsPatchResource :<|> (AppsServicesVersionsGetResource :<|> (AppsServicesVersionsCreateResource :<|> (AppsServicesVersionsDeleteResource :<|> (AppsServicesListResource :<|> (AppsServicesPatchResource :<|> (AppsServicesGetResource :<|> (AppsServicesDeleteResource :<|> (AppsPatchResource :<|> (AppsGetResource :<|> (AppsCreateResource :<|> AppsRepairResource))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Google App Engine Admin API service.
Resources
appengine.apps.create
appengine.apps.get
appengine.apps.locations.get
appengine.apps.locations.list
appengine.apps.operations.get
appengine.apps.operations.list
appengine.apps.patch
appengine.apps.repair
appengine.apps.services.delete
appengine.apps.services.get
appengine.apps.services.list
appengine.apps.services.patch
appengine.apps.services.versions.create
appengine.apps.services.versions.delete
appengine.apps.services.versions.get
appengine.apps.services.versions.instances.debug
appengine.apps.services.versions.instances.delete
appengine.apps.services.versions.instances.get
appengine.apps.services.versions.instances.list
appengine.apps.services.versions.list
appengine.apps.services.versions.patch
Types
OperationMetadataExperimental
data OperationMetadataExperimental Source #
Metadata for the given google.longrunning.Operation.
See: operationMetadataExperimental
smart constructor.
operationMetadataExperimental :: OperationMetadataExperimental Source #
Creates a value of OperationMetadataExperimental
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omeInsertTime :: Lens' OperationMetadataExperimental (Maybe Text) Source #
Time that this operation was created.'OutputOnly
omeUser :: Lens' OperationMetadataExperimental (Maybe Text) Source #
User who requested this operation.'OutputOnly
omeMethod :: Lens' OperationMetadataExperimental (Maybe Text) Source #
API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.'OutputOnly
omeEndTime :: Lens' OperationMetadataExperimental (Maybe Text) Source #
Time that this operation completed.'OutputOnly
omeTarget :: Lens' OperationMetadataExperimental (Maybe Text) Source #
Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.'OutputOnly
NetworkUtilization
data NetworkUtilization Source #
Target scaling by network usage. Only applicable for VM runtimes.
See: networkUtilization
smart constructor.
networkUtilization :: NetworkUtilization Source #
Creates a value of NetworkUtilization
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nuTargetReceivedBytesPerSecond :: Lens' NetworkUtilization (Maybe Int32) Source #
Target bytes received per second.
nuTargetSentPacketsPerSecond :: Lens' NetworkUtilization (Maybe Int32) Source #
Target packets sent per second.
nuTargetReceivedPacketsPerSecond :: Lens' NetworkUtilization (Maybe Int32) Source #
Target packets received per second.
nuTargetSentBytesPerSecond :: Lens' NetworkUtilization (Maybe Int32) Source #
Target bytes sent per second.
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 (https://github.com/grpc). The error model is designed to be: Simple to use and understand for most users Flexible enough to meet unexpected needsOverviewThe 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 which can be used for common error conditions.Language mappingThe 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 usesThe 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.
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.
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.
LocationSchema
data LocationSchema Source #
Service-specific metadata. For example the available capacity at the given location.
See: locationSchema
smart constructor.
Creates a value of LocationSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsAddtional :: Lens' LocationSchema (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
TrafficSplit
data TrafficSplit Source #
Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
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 #
Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
tsAllocations :: Lens' TrafficSplit (Maybe TrafficSplitAllocations) Source #
Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported 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 #
Path to the script from the application root directory.
ListServicesResponse
data ListServicesResponse Source #
Response message for Services.ListServices.
See: listServicesResponse
smart constructor.
listServicesResponse :: ListServicesResponse Source #
Creates a value of ListServicesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsrNextPageToken :: Lens' ListServicesResponse (Maybe Text) Source #
Continuation token for fetching the next page of results.
lsrServices :: Lens' ListServicesResponse [Service] Source #
The services belonging to the requested application.
URLMap
URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, 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 this URL pattern.
umAPIEndpoint :: Lens' URLMap (Maybe APIEndpointHandler) Source #
Uses API Endpoints to handle requests.
umURLRegex :: Lens' URLMap (Maybe Text) Source #
URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but 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.
umRedirectHTTPResponseCode :: Lens' URLMap (Maybe Text) Source #
30x code to use when performing redirects for the secure field. Defaults to 302.
umAuthFailAction :: Lens' URLMap (Maybe Text) Source #
Action to take when users access resources that require authentication. Defaults to redirect.
umStaticFiles :: Lens' URLMap (Maybe StaticFilesHandler) Source #
Returns the contents of a file, such as an image, as the response.
Library
Third-party Python runtime library that is required by the application.
See: library
smart constructor.
ListLocationsResponse
data ListLocationsResponse Source #
The response message for LocationService.ListLocations.
See: listLocationsResponse
smart constructor.
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.
DiskUtilization
data DiskUtilization Source #
Target scaling by disk usage. Only applicable for VM runtimes.
See: diskUtilization
smart constructor.
diskUtilization :: DiskUtilization Source #
Creates a value of DiskUtilization
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
duTargetReadBytesPerSecond :: Lens' DiskUtilization (Maybe Int32) Source #
Target bytes read per second.
duTargetReadOpsPerSecond :: Lens' DiskUtilization (Maybe Int32) Source #
Target ops read per seconds.
duTargetWriteOpsPerSecond :: Lens' DiskUtilization (Maybe Int32) Source #
Target ops written per second.
duTargetWriteBytesPerSecond :: Lens' DiskUtilization (Maybe Int32) Source #
Target bytes written per second.
ListOperationsResponse
data ListOperationsResponse Source #
The response message for 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 #
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
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 #
Number of consecutive successful health checks required before receiving traffic.
hcDisableHealthCheck :: Lens' HealthCheck (Maybe Bool) Source #
Whether to explicitly disable health checks for this instance.
hcCheckInterval :: Lens' HealthCheck (Maybe Text) Source #
Interval between health checks.
hcRestartThreshold :: Lens' HealthCheck (Maybe Word32) Source #
Number of consecutive failed health checks required before an instance is restarted.
hcHost :: Lens' HealthCheck (Maybe Text) Source #
Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
hcTimeout :: Lens' HealthCheck (Maybe Text) Source #
Time before the health check is considered failed.
hcUnhealthyThreshold :: Lens' HealthCheck (Maybe Word32) Source #
Number of consecutive failed health checks required before removing traffic.
APIConfigHandler
data APIConfigHandler Source #
Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.
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 #
Path to the script from the application root directory.
achSecurityLevel :: Lens' APIConfigHandler (Maybe Text) Source #
Security (HTTPS) enforcement for this URL.
achAuthFailAction :: Lens' APIConfigHandler (Maybe Text) Source #
Action to take when users access resources that require authentication. Defaults to redirect.
achLogin :: Lens' APIConfigHandler (Maybe Text) Source #
Level of login required to access this resource. Defaults to optional.
VersionEnvVariables
data VersionEnvVariables Source #
Environment variables available to the application.Only returned in GET requests if view=FULL is set.
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 resource 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:
aDefaultHostname :: Lens' Application (Maybe Text) Source #
Hostname used to reach this application, as resolved by App Engine.'OutputOnly
aDefaultCookieExpiration :: Lens' Application (Maybe Text) Source #
Cookie expiration policy for this application.
aAuthDomain :: Lens' Application (Maybe Text) Source #
Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
aCodeBucket :: Lens' Application (Maybe Text) Source #
Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.'OutputOnly
aName :: Lens' Application (Maybe Text) Source #
Full path to the Application resource in the API. Example: apps/myapp.'OutputOnly
aDispatchRules :: Lens' Application [URLDispatchRule] Source #
HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.'OutputOnly
aDefaultBucket :: Lens' Application (Maybe Text) Source #
Google Cloud Storage bucket that can be used by this application to store content.'OutputOnly
aId :: Lens' Application (Maybe Text) Source #
Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
aLocationId :: Lens' Application (Maybe Text) Source #
Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
VersionBetaSettings
data VersionBetaSettings Source #
Metadata settings that are supplied to this version to enable beta runtime features.
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:
Service
A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
See: service
smart constructor.
sSplit :: Lens' Service (Maybe TrafficSplit) Source #
Mapping that defines fractional HTTP traffic diversion to different versions within the service.
sName :: Lens' Service (Maybe Text) Source #
Full path to the Service resource in the API. Example: apps/myapp/services/default.'OutputOnly
sId :: Lens' Service (Maybe Text) Source #
Relative name of the service within the application. Example: default.'OutputOnly
EndpointsAPIService
data EndpointsAPIService Source #
Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview).
See: endpointsAPIService
smart constructor.
endpointsAPIService :: EndpointsAPIService Source #
Creates a value of EndpointsAPIService
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
easName :: Lens' EndpointsAPIService (Maybe Text) Source #
Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
easConfigId :: Lens' EndpointsAPIService (Maybe Text) Source #
Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
Location
A resource that represents Google Cloud Platform location.
See: location
smart constructor.
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:
locName :: Lens' Location (Maybe Text) Source #
Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
locMetadata :: Lens' Location (Maybe LocationSchema) Source #
Service-specific metadata. For example the available capacity at the given location.
locLabels :: Lens' Location (Maybe LocationLabels) Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
locLocationId :: 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.
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.
ZipInfo
The zip file information for a zip deployment.
See: zipInfo
smart constructor.
Creates a value of ZipInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ziFilesCount :: Lens' ZipInfo (Maybe Int32) Source #
An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
ziSourceURL :: Lens' ZipInfo (Maybe Text) Source #
URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
URLDispatchRule
data URLDispatchRule Source #
Rules to match an HTTP request and dispatch that request to a service.
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 #
Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
udrService :: Lens' URLDispatchRule (Maybe Text) Source #
Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
udrDomain :: Lens' URLDispatchRule (Maybe Text) Source #
Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
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 service.
FileInfo
Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
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.Defaults to the value from Google Cloud Storage.
fiSourceURL :: Lens' FileInfo (Maybe Text) Source #
URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
AutomaticScaling
data AutomaticScaling Source #
Automatic scaling 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:
asNetworkUtilization :: Lens' AutomaticScaling (Maybe NetworkUtilization) Source #
Target scaling by network usage.
asMaxTotalInstances :: Lens' AutomaticScaling (Maybe Int32) Source #
Maximum number of instances that should be started to handle requests.
asMinIdleInstances :: Lens' AutomaticScaling (Maybe Int32) Source #
Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
asDiskUtilization :: Lens' AutomaticScaling (Maybe DiskUtilization) Source #
Target scaling by disk usage.
asMinPendingLatency :: Lens' AutomaticScaling (Maybe Text) Source #
Minimum amount of time a request should 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 #
Maximum number of idle instances that should be maintained for this version.
asMinTotalInstances :: Lens' AutomaticScaling (Maybe Int32) Source #
Minimum number of instances that should be maintained for this version.
asMaxConcurrentRequests :: Lens' AutomaticScaling (Maybe Int32) Source #
Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
asCoolDownPeriod :: Lens' AutomaticScaling (Maybe Text) Source #
Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.
asRequestUtilization :: Lens' AutomaticScaling (Maybe RequestUtilization) Source #
Target scaling by request utilization.
asMaxPendingLatency :: Lens' AutomaticScaling (Maybe Text) Source #
Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
OperationMetadataV1Beta5
data OperationMetadataV1Beta5 Source #
Metadata for the given google.longrunning.Operation.
See: operationMetadataV1Beta5
smart constructor.
operationMetadataV1Beta5 :: OperationMetadataV1Beta5 Source #
Creates a value of OperationMetadataV1Beta5
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omvbInsertTime :: Lens' OperationMetadataV1Beta5 (Maybe Text) Source #
Timestamp that this operation was created.'OutputOnly
omvbUser :: Lens' OperationMetadataV1Beta5 (Maybe Text) Source #
User who requested this operation.'OutputOnly
omvbMethod :: Lens' OperationMetadataV1Beta5 (Maybe Text) Source #
API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.'OutputOnly
omvbEndTime :: Lens' OperationMetadataV1Beta5 (Maybe Text) Source #
Timestamp that this operation completed.'OutputOnly
omvbTarget :: Lens' OperationMetadataV1Beta5 (Maybe Text) Source #
Name of the resource that this operation is acting on. Example: apps/myapp/services/default.'OutputOnly
Volume
Volumes mounted within the app container. Only applicable for VM runtimes.
See: volume
smart constructor.
Creates a value of Volume
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
APIEndpointHandler
data APIEndpointHandler Source #
Uses 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 #
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 'type with type URL.
Network
Extra network settings. Only applicable for VM runtimes.
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:
nSubnetworkName :: Lens' Network (Maybe Text) Source #
Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
nForwardedPorts :: Lens' Network [Text] Source #
List of ports, or port pairs, to forward from the virtual machine to the application container.
nName :: Lens' Network (Maybe Text) Source #
Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
DebugInstanceRequest
data DebugInstanceRequest Source #
Request message for Instances.DebugInstance.
See: debugInstanceRequest
smart constructor.
debugInstanceRequest :: DebugInstanceRequest Source #
Creates a value of DebugInstanceRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dirSSHKey :: Lens' DebugInstanceRequest (Maybe Text) Source #
Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
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
Machine resources for a version.
See: resources
smart constructor.
DeploymentFiles
data DeploymentFiles Source #
Manifest of the files stored in Google Cloud Storage that are included as part of this version. 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 #
Period of time over which CPU utilization is calculated.
cuTargetUtilization :: Lens' CPUUtilization (Maybe Double) Source #
Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
TrafficSplitAllocations
data TrafficSplitAllocations Source #
Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported 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 service 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 #
Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
BasicScaling
data BasicScaling Source #
A service 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 #
Maximum number of instances to create for this version.
bsIdleTimeout :: Lens' BasicScaling (Maybe Text) Source #
Duration of time after the last request that an instance must wait before the instance is shut down.
OperationMetadataV1
data OperationMetadataV1 Source #
Metadata for the given google.longrunning.Operation.
See: operationMetadataV1
smart constructor.
operationMetadataV1 :: OperationMetadataV1 Source #
Creates a value of OperationMetadataV1
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omvEphemeralMessage :: Lens' OperationMetadataV1 (Maybe Text) Source #
Ephemeral message that may change every time the operation is polled. 'OutputOnly
omvInsertTime :: Lens' OperationMetadataV1 (Maybe Text) Source #
Time that this operation was created.'OutputOnly
omvUser :: Lens' OperationMetadataV1 (Maybe Text) Source #
User who requested this operation.'OutputOnly
omvMethod :: Lens' OperationMetadataV1 (Maybe Text) Source #
API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.'OutputOnly
omvEndTime :: Lens' OperationMetadataV1 (Maybe Text) Source #
Time that this operation completed.'OutputOnly
omvWarning :: Lens' OperationMetadataV1 [Text] Source #
Durable messages that persist on every operation poll. 'OutputOnly
omvTarget :: Lens' OperationMetadataV1 (Maybe Text) Source #
Name of the resource that this operation is acting on. Example: apps/myapp/services/default.'OutputOnly
Version
A Version resource is a specific set of source code and configuration files that are deployed into a service.
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:
verRuntime
verNobuildFilesRegex
verInstanceClass
verHealthCheck
verEndpointsAPIService
verEnv
verDefaultExpiration
verAutomaticScaling
verErrorHandlers
verCreatedBy
verVM
verHandlers
verInboundServices
verNetwork
verResources
verName
verThreadsafe
verBetaSettings
verBasicScaling
verManualScaling
verAPIConfig
verId
verEnvVariables
verServingStatus
verDiskUsageBytes
verCreateTime
verLibraries
verVersionURL
verDeployment
verNobuildFilesRegex :: Lens' Version (Maybe Text) Source #
Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
verInstanceClass :: Lens' Version (Maybe Text) Source #
Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
verHealthCheck :: Lens' Version (Maybe HealthCheck) Source #
Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
verEndpointsAPIService :: Lens' Version (Maybe EndpointsAPIService) Source #
Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
verEnv :: Lens' Version (Maybe Text) Source #
App Engine execution environment for this version.Defaults to standard.
verDefaultExpiration :: Lens' Version (Maybe Text) Source #
Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
verAutomaticScaling :: Lens' Version (Maybe AutomaticScaling) Source #
Automatic scaling is based on request rate, response latencies, and other application metrics.
verErrorHandlers :: Lens' Version [ErrorHandler] Source #
Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
verCreatedBy :: Lens' Version (Maybe Text) Source #
Email address of the user who created this version.'OutputOnly
verVM :: Lens' Version (Maybe Bool) Source #
Whether to deploy this version in a container on a virtual machine.
verHandlers :: Lens' Version [URLMap] Source #
An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
verInboundServices :: Lens' Version [Text] Source #
Before an application can receive email or XMPP messages, the application must be configured to enable the service.
verNetwork :: Lens' Version (Maybe Network) Source #
Extra network settings. Only applicable for VM runtimes.
verResources :: Lens' Version (Maybe Resources) Source #
Machine resources for this version. Only applicable for VM runtimes.
verName :: Lens' Version (Maybe Text) Source #
Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.'OutputOnly
verThreadsafe :: Lens' Version (Maybe Bool) Source #
Whether multiple requests can be dispatched to this version at once.
verBetaSettings :: Lens' Version (Maybe VersionBetaSettings) Source #
Metadata settings that are supplied to this version to enable beta runtime features.
verBasicScaling :: Lens' Version (Maybe BasicScaling) Source #
A service 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.
verManualScaling :: Lens' Version (Maybe ManualScaling) Source #
A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
verAPIConfig :: Lens' Version (Maybe APIConfigHandler) Source #
Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
verId :: Lens' Version (Maybe Text) Source #
Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
verEnvVariables :: Lens' Version (Maybe VersionEnvVariables) Source #
Environment variables available to the application.Only returned in GET requests if view=FULL is set.
verServingStatus :: Lens' Version (Maybe Text) Source #
Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
verDiskUsageBytes :: Lens' Version (Maybe Int64) Source #
Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.'OutputOnly
verLibraries :: Lens' Version [Library] Source #
Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
verVersionURL :: Lens' Version (Maybe Text) Source #
Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"'OutputOnly
verDeployment :: Lens' Version (Maybe Deployment) Source #
Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
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 #
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 #
Whether this handler should match the request if the file referenced by the handler does not exist.
sfhExpiration :: Lens' StaticFilesHandler (Maybe Text) Source #
Time a static file served by this handler should be cached by web proxies and browsers.
sfhMimeType :: Lens' StaticFilesHandler (Maybe Text) Source #
MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
sfhApplicationReadable :: Lens' StaticFilesHandler (Maybe Bool) Source #
Whether files should also be uploaded as code data. 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 the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
sfhUploadPathRegex :: Lens' StaticFilesHandler (Maybe Text) Source #
Regular expression that matches the file paths for all files that should be referenced by this handler.
ErrorHandler
data ErrorHandler Source #
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. Defaults to text/html.
ehErrorCode :: Lens' ErrorHandler (Maybe Text) Source #
Error condition this handler applies to.
ehStaticFile :: Lens' ErrorHandler (Maybe Text) Source #
Static file content to be served for this error.
LocationLabels
data LocationLabels Source #
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
See: locationLabels
smart constructor.
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 #
Metadata for the given google.cloud.location.Location.
See: locationMetadata
smart constructor.
locationMetadata :: LocationMetadata Source #
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:
lmStandardEnvironmentAvailable :: Lens' LocationMetadata (Maybe Bool) Source #
App Engine Standard Environment is available in the given location.'OutputOnly
lmFlexibleEnvironmentAvailable :: Lens' LocationMetadata (Maybe Bool) Source #
App Engine Flexible Environment is available in the given location.'OutputOnly
OperationMetadata
data OperationMetadata Source #
Metadata for the given 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 created.'OutputOnly
omUser :: Lens' OperationMetadata (Maybe Text) Source #
User who requested this operation.'OutputOnly
omMethod :: Lens' OperationMetadata (Maybe Text) Source #
API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.'OutputOnly
omEndTime :: Lens' OperationMetadata (Maybe Text) Source #
Timestamp that this operation completed.'OutputOnly
omOperationType :: Lens' OperationMetadata (Maybe Text) Source #
Type of this operation. Deprecated, use method field instead. Example: "create_version".'OutputOnly
omTarget :: Lens' OperationMetadata (Maybe Text) Source #
Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.'OutputOnly
ListInstancesResponse
data ListInstancesResponse Source #
Response message for Instances.ListInstances.
See: listInstancesResponse
smart constructor.
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 #
Continuation token for fetching the next page of results.
lirInstances :: Lens' ListInstancesResponse [Instance] Source #
The instances belonging to the requested version.
RequestUtilization
data RequestUtilization Source #
Target scaling by request utilization. Only applicable for VM runtimes.
See: requestUtilization
smart constructor.
requestUtilization :: RequestUtilization Source #
Creates a value of RequestUtilization
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ruTargetConcurrentRequests :: Lens' RequestUtilization (Maybe Int32) Source #
Target number of concurrent requests.
ruTargetRequestCountPerSecond :: Lens' RequestUtilization (Maybe Int32) Source #
Target requests per second.
RepairApplicationRequest
data RepairApplicationRequest Source #
Request message for 'Applications.RepairApplication'.
See: repairApplicationRequest
smart constructor.
repairApplicationRequest :: RepairApplicationRequest Source #
Creates a value of RepairApplicationRequest
with the minimum fields required to make a request.
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 'type with type URL.
ContainerInfo
data ContainerInfo Source #
Docker image that is used to start a VM container for the version you deploy.
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 #
URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image'digest"
Instance
An Instance resource is the computing unit that App Engine uses to automatically scale an application.
See: instance'
smart constructor.
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:
iVMStatus :: Lens' Instance (Maybe Text) Source #
Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.'OutputOnly
iVMZoneName :: Lens' Instance (Maybe Text) Source #
Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.'OutputOnly
iVMIP :: Lens' Instance (Maybe Text) Source #
The IP address of this instance. Only applicable for instances in App Engine flexible environment.'OutputOnly
iVMId :: Lens' Instance (Maybe Text) Source #
Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.'OutputOnly
iVMName :: Lens' Instance (Maybe Text) Source #
Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.'OutputOnly
iName :: Lens' Instance (Maybe Text) Source #
Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.'OutputOnly
iVMDebugEnabled :: Lens' Instance (Maybe Bool) Source #
Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.'OutputOnly
iRequests :: Lens' Instance (Maybe Int32) Source #
Number of requests since this instance was started.'OutputOnly
iQps :: Lens' Instance (Maybe Double) Source #
Average queries per second (QPS) over the last minute.'OutputOnly
iId :: Lens' Instance (Maybe Text) Source #
Relative name of the instance within the version. Example: instance-1.'OutputOnly
iErrors :: Lens' Instance (Maybe Int32) Source #
Number of errors since this instance was started.'OutputOnly
iAverageLatency :: Lens' Instance (Maybe Int32) Source #
Average latency (ms) over the last minute.'OutputOnly
iAppEngineRelease :: Lens' Instance (Maybe Text) Source #
App Engine release this instance is running on.'OutputOnly
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:
dZip :: Lens' Deployment (Maybe ZipInfo) Source #
The zip file for this deployment, if this is a zip deployment.
dContainer :: Lens' Deployment (Maybe ContainerInfo) Source #
A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
dFiles :: Lens' Deployment (Maybe DeploymentFiles) Source #
Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.