googleapis.appengine.v1 library

Classes

ApiConfigHandler
Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.
ApiEndpointHandler
Uses Google Cloud Endpoints to handle requests.
AppengineApi
Provisions and manages developers' App Engine applications.
Application
An Application resource contains the top-level configuration of an App Engine application.
AppsAuthorizedCertificatesResourceApi
AppsAuthorizedDomainsResourceApi
AppsDomainMappingsResourceApi
AppsFirewallIngressRulesResourceApi
AppsFirewallResourceApi
AppsLocationsResourceApi
AppsOperationsResourceApi
AppsResourceApi
AppsServicesResourceApi
AppsServicesVersionsInstancesResourceApi
AppsServicesVersionsResourceApi
AuthorizedCertificate
An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
AuthorizedDomain
A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).
AutomaticScaling
Automatic scaling is based on request rate, response latencies, and other application metrics.
BasicScaling
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.
BatchUpdateIngressRulesRequest
Request message for Firewall.BatchUpdateIngressRules.
BatchUpdateIngressRulesResponse
Response message for Firewall.UpdateAllIngressRules.
CertificateRawData
An SSL certificate obtained from a certificate authority.
CloudBuildOptions
Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.
ContainerInfo
Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.
CpuUtilization
Target scaling by CPU usage.
CreateVersionMetadataV1
Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.
CreateVersionMetadataV1Alpha
Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.
CreateVersionMetadataV1Beta
Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.
DebugInstanceRequest
Request message for Instances.DebugInstance.
Deployment
Code and application artifacts used to deploy a version to App Engine.
DiskUtilization
Target scaling by disk usage. Only applicable in the App Engine flexible environment.
DomainMapping
A domain serving an App Engine application.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
EndpointsApiService
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. Only valid for App Engine Flexible environment deployments.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).
Entrypoint
The entrypoint for the application.
ErrorHandler
Custom static error page to be served when an error occurs.
FeatureSettings
The feature specific settings to be used in the application. These define behaviors that are user configurable.
FileInfo
Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
FirewallRule
A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
HealthCheck
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
IdentityAwareProxy
Identity-Aware Proxy
Instance
An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Library
Third-party Python runtime library that is required by the application.
ListAuthorizedCertificatesResponse
Response message for AuthorizedCertificates.ListAuthorizedCertificates.
ListAuthorizedDomainsResponse
Response message for AuthorizedDomains.ListAuthorizedDomains.
ListDomainMappingsResponse
Response message for DomainMappings.ListDomainMappings.
ListIngressRulesResponse
Response message for Firewall.ListIngressRules.
ListInstancesResponse
Response message for Instances.ListInstances.
ListLocationsResponse
The response message for Locations.ListLocations.
ListOperationsResponse
The response message for Operations.ListOperations.
ListServicesResponse
Response message for Services.ListServices.
ListVersionsResponse
Response message for Versions.ListVersions.
LivenessCheck
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
Location
A resource that represents Google Cloud Platform location.
LocationMetadata
Metadata for the given google.cloud.location.Location.
ManagedCertificate
A certificate managed by App Engine.
ManualScaling
A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
Network
Extra network settings. Only applicable in the App Engine flexible environment.
NetworkUtilization
Target scaling by network usage. Only applicable in the App Engine flexible environment.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationMetadata
Metadata for the given google.longrunning.Operation.
OperationMetadataV1
Metadata for the given google.longrunning.Operation.
OperationMetadataV1Alpha
Metadata for the given google.longrunning.Operation.
OperationMetadataV1Beta
Metadata for the given google.longrunning.Operation.
OperationMetadataV1Beta5
Metadata for the given google.longrunning.Operation.
ReadinessCheck
Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
RepairApplicationRequest
Request message for 'Applications.RepairApplication'.
RequestUtilization
Target scaling by request utilization. Only applicable in the App Engine flexible environment.
ResourceRecord
A DNS resource record.
Resources
Machine resources for a version.
ScriptHandler
Executes a script to handle the request that matches the URL pattern.
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.
SslSettings
SSL configuration for a DomainMapping resource.
StandardSchedulerSettings
Scheduler settings for standard environment.
StaticFilesHandler
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.
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 that 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. 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.
TrafficSplit
Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
UrlDispatchRule
Rules to match an HTTP request and dispatch that request to a service.
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.
Version
A Version resource is a specific set of source code and configuration files that are deployed into a service.
Volume
Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
ZipInfo
The zip file information for a zip deployment.

Constants

USER_AGENT → const String
'dart-api-client appengine/v1'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.