Expand description
The messages and enums that are part of this client library.
Modules§
- application
- Defines additional types related to Application.
- audit_
data - Defines additional types related to AuditData.
- endpoints_
api_ service - Defines additional types related to EndpointsApiService.
- entrypoint
- Defines additional types related to Entrypoint.
- error_
handler - Defines additional types related to ErrorHandler.
- firewall_
rule - Defines additional types related to FirewallRule.
- instance
- Defines additional types related to Instance.
- network_
settings - Defines additional types related to NetworkSettings.
- operation_
metadata_ v_ 1 - Defines additional types related to OperationMetadataV1.
- resource_
record - Defines additional types related to ResourceRecord.
- ssl_
settings - Defines additional types related to SslSettings.
- traffic_
split - Defines additional types related to TrafficSplit.
- url_map
- Defines additional types related to UrlMap.
- version
- Defines additional types related to Version.
- vpc_
access_ connector - Defines additional types related to VpcAccessConnector.
Structs§
- ApiConfig
Handler - Google Cloud Endpoints configuration for API handlers.
- ApiEndpoint
Handler - Uses Google Cloud Endpoints to handle requests.
- Application
- An Application resource contains the top-level configuration of an App Engine application.
- Audit
Data - App Engine admin service audit log.
- Authorized
Certificate - 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.
- Authorized
Domain - A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console.
- Automatic
Scaling - Automatic scaling is based on request rate, response latencies, and other application metrics.
- Basic
Scaling - 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.
- Batch
Update Ingress Rules Request - Request message for
Firewall.BatchUpdateIngressRules. - Batch
Update Ingress Rules Response - Response message for
Firewall.UpdateAllIngressRules. - Certificate
RawData - An SSL certificate obtained from a certificate authority.
- Cloud
Build Options - 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.
- Container
Info - 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.
- Create
Application Request - Request message for
Applications.CreateApplication. - Create
Authorized Certificate Request - Request message for
AuthorizedCertificates.CreateAuthorizedCertificate. - Create
Domain Mapping Request - Request message for
DomainMappings.CreateDomainMapping. - Create
Ingress Rule Request - Request message for
Firewall.CreateIngressRule. - Create
Version Metadata V1 - Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.
- Create
Version Method - Detailed information about CreateVersion call.
- Create
Version Request - Request message for
Versions.CreateVersion. - Debug
Instance Request - Request message for
Instances.DebugInstance. - Delete
Authorized Certificate Request - Request message for
AuthorizedCertificates.DeleteAuthorizedCertificate. - Delete
Domain Mapping Request - Request message for
DomainMappings.DeleteDomainMapping. - Delete
Ingress Rule Request - Request message for
Firewall.DeleteIngressRule. - Delete
Instance Request - Request message for
Instances.DeleteInstance. - Delete
Service Request - Request message for
Services.DeleteService. - Delete
Version Request - Request message for
Versions.DeleteVersion. - Deployment
- Code and application artifacts used to deploy a version to App Engine.
- Disk
Utilization - Target scaling by disk usage. Only applicable in the App Engine flexible environment.
- Domain
Mapping - A domain serving an App Engine application.
- Endpoints
ApiService - Cloud 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.
- Entrypoint
- The entrypoint for the application.
- Error
Handler - Custom static error page to be served when an error occurs.
- File
Info - Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
- Firewall
Rule - A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- GetApplication
Request - Request message for
Applications.GetApplication. - GetAuthorized
Certificate Request - Request message for
AuthorizedCertificates.GetAuthorizedCertificate. - GetDomain
Mapping Request - Request message for
DomainMappings.GetDomainMapping. - GetIngress
Rule Request - Request message for
Firewall.GetIngressRule. - GetInstance
Request - Request message for
Instances.GetInstance. - GetService
Request - Request message for
Services.GetService. - GetVersion
Request - Request message for
Versions.GetVersion. - Health
Check - Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
- 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.
- List
Authorized Certificates Request - Request message for
AuthorizedCertificates.ListAuthorizedCertificates. - List
Authorized Certificates Response - Response message for
AuthorizedCertificates.ListAuthorizedCertificates. - List
Authorized Domains Request - Request message for
AuthorizedDomains.ListAuthorizedDomains. - List
Authorized Domains Response - Response message for
AuthorizedDomains.ListAuthorizedDomains. - List
Domain Mappings Request - Request message for
DomainMappings.ListDomainMappings. - List
Domain Mappings Response - Response message for
DomainMappings.ListDomainMappings. - List
Ingress Rules Request - Request message for
Firewall.ListIngressRules. - List
Ingress Rules Response - Response message for
Firewall.ListIngressRules. - List
Instances Request - Request message for
Instances.ListInstances. - List
Instances Response - Response message for
Instances.ListInstances. - List
Services Request - Request message for
Services.ListServices. - List
Services Response - Response message for
Services.ListServices. - List
Versions Request - Request message for
Versions.ListVersions. - List
Versions Response - Response message for
Versions.ListVersions. - Liveness
Check - Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
- Location
Metadata - Metadata for the given [google.cloud.location.Location][google.cloud.location.Location].
- Managed
Certificate - A certificate managed by App Engine.
- Manual
Scaling - 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.
- Network
Settings - A NetworkSettings resource is a container for ingress settings for a version or service.
- Network
Utilization - Target scaling by network usage. Only applicable in the App Engine flexible environment.
- Operation
Metadata V1 - Metadata for the given google.longrunning.Operation.
- Readiness
Check - Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
- Repair
Application Request - Request message for ‘Applications.RepairApplication’.
- Request
Utilization - Target scaling by request utilization. Only applicable in the App Engine flexible environment.
- Resource
Record - A DNS resource record.
- Resources
- Machine resources for a version.
- Script
Handler - 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
DomainMappingresource. - Standard
Scheduler Settings - Scheduler settings for standard environment.
- Static
Files Handler - 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.
- Traffic
Split - Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
- Update
Application Request - Request message for
Applications.UpdateApplication. - Update
Authorized Certificate Request - Request message for
AuthorizedCertificates.UpdateAuthorizedCertificate. - Update
Domain Mapping Request - Request message for
DomainMappings.UpdateDomainMapping. - Update
Ingress Rule Request - Request message for
Firewall.UpdateIngressRule. - Update
Service Method - Detailed information about UpdateService call.
- Update
Service Request - Request message for
Services.UpdateService. - Update
Version Request - Request message for
Versions.UpdateVersion. - UrlDispatch
Rule - 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.
- VpcAccess
Connector - VPC access connector specification.
- ZipInfo
- The zip file information for a zip deployment.
Enums§
- Auth
Fail Action - Actions to take when the user is not logged in.
- Authorized
Certificate View - Fields that should be returned when an AuthorizedCertificate resource is retrieved.
- Domain
Override Strategy - Override strategy for mutating an existing mapping.
- Inbound
Service Type - Available inbound services.
- Login
Requirement - Methods to restrict access to a URL based on login status.
- Management
Status - State of certificate management. Refers to the most recent certificate acquisition or renewal attempt.
- Security
Level - Methods to enforce security (HTTPS) on a URL.
- Serving
Status - Run states of a version.
- Version
View - Fields that should be returned when Version resources are retrieved.