Package types (1.9.1)

API documentation for appengine_admin_v1.types package.

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.

Application

An Application resource contains the top-level configuration of an App Engine application.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AuthFailAction

Actions to take when the user is not logged in.

Values: AUTH_FAIL_ACTION_UNSPECIFIED (0): Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed. AUTH_FAIL_ACTION_REDIRECT (1): Redirects user to "accounts.google.com". The user is redirected back to the application URL after signing in or creating an account. AUTH_FAIL_ACTION_UNAUTHORIZED (2): Rejects request with a 401 HTTP status code and an error message.

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.

AuthorizedCertificateView

Fields that should be returned when an AuthorizedCertificate resource is retrieved.

Values: BASIC_CERTIFICATE (0): Basic certificate information, including applicable domains and expiration date. FULL_CERTIFICATE (1): The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped.

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.

CreateApplicationRequest

Request message for Applications.CreateApplication.

CreateAuthorizedCertificateRequest

Request message for AuthorizedCertificates.CreateAuthorizedCertificate.

CreateDomainMappingRequest

Request message for DomainMappings.CreateDomainMapping.

CreateIngressRuleRequest

Request message for Firewall.CreateIngressRule.

CreateVersionMetadataV1

Metadata for the given google.longrunning.Operation][google.longrunning.Operation] during a google.appengine.v1.CreateVersionRequest][google.appengine.v1.CreateVersionRequest].

CreateVersionMethod

Detailed information about CreateVersion call.

CreateVersionRequest

Request message for Versions.CreateVersion.

DebugInstanceRequest

Request message for Instances.DebugInstance.

DeleteAuthorizedCertificateRequest

Request message for AuthorizedCertificates.DeleteAuthorizedCertificate.

DeleteDomainMappingRequest

Request message for DomainMappings.DeleteDomainMapping.

DeleteIngressRuleRequest

Request message for Firewall.DeleteIngressRule.

DeleteInstanceRequest

Request message for Instances.DeleteInstance.

DeleteServiceRequest

Request message for Services.DeleteService.

DeleteVersionRequest

Request message for Versions.DeleteVersion.

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.

DomainOverrideStrategy

Override strategy for mutating an existing mapping.

Values: UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY (0): Strategy unspecified. Defaults to STRICT. STRICT (1): Overrides not allowed. If a mapping already exists for the specified domain, the request will return an ALREADY_EXISTS (409). OVERRIDE (2): Overrides allowed. If a mapping already exists for the specified domain, the request will overwrite it. Note that this might stop another Google product from serving. For example, if the domain is mapped to another App Engine application, that app will no longer serve from that domain.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ErrorHandler

Custom static error page to be served when an error occurs.

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.

GetApplicationRequest

Request message for Applications.GetApplication.

GetAuthorizedCertificateRequest

Request message for AuthorizedCertificates.GetAuthorizedCertificate.

GetDomainMappingRequest

Request message for DomainMappings.GetDomainMapping.

GetIngressRuleRequest

Request message for Firewall.GetIngressRule.

GetInstanceRequest

Request message for Instances.GetInstance.

GetServiceRequest

Request message for Services.GetService.

GetVersionRequest

Request message for Versions.GetVersion.

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.

InboundServiceType

Available inbound services.

Values: INBOUND_SERVICE_UNSPECIFIED (0): Not specified. INBOUND_SERVICE_MAIL (1): Allows an application to receive mail. INBOUND_SERVICE_MAIL_BOUNCE (2): Allows an application to receive email-bound notifications. INBOUND_SERVICE_XMPP_ERROR (3): Allows an application to receive error stanzas. INBOUND_SERVICE_XMPP_MESSAGE (4): Allows an application to receive instant messages. INBOUND_SERVICE_XMPP_SUBSCRIBE (5): Allows an application to receive user subscription POSTs. INBOUND_SERVICE_XMPP_PRESENCE (6): Allows an application to receive a user's chat presence. INBOUND_SERVICE_CHANNEL_PRESENCE (7): Registers an application for notifications when a client connects or disconnects from a channel. INBOUND_SERVICE_WARMUP (9): Enables warmup requests.

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.

ListAuthorizedCertificatesRequest

Request message for AuthorizedCertificates.ListAuthorizedCertificates.

ListAuthorizedCertificatesResponse

Response message for AuthorizedCertificates.ListAuthorizedCertificates.

ListAuthorizedDomainsRequest

Request message for AuthorizedDomains.ListAuthorizedDomains.

ListAuthorizedDomainsResponse

Response message for AuthorizedDomains.ListAuthorizedDomains.

ListDomainMappingsRequest

Request message for DomainMappings.ListDomainMappings.

ListDomainMappingsResponse

Response message for DomainMappings.ListDomainMappings.

ListIngressRulesRequest

Request message for Firewall.ListIngressRules.

ListIngressRulesResponse

Response message for Firewall.ListIngressRules.

ListInstancesRequest

Request message for Instances.ListInstances.

ListInstancesResponse

Response message for Instances.ListInstances.

ListServicesRequest

Request message for Services.ListServices.

ListServicesResponse

Response message for Services.ListServices.

ListVersionsRequest

Request message for Versions.ListVersions.

ListVersionsResponse

Response message for Versions.ListVersions.

LivenessCheck

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.

LocationMetadata

Metadata for the given google.cloud.location.Location.

LoginRequirement

Methods to restrict access to a URL based on login status.

Values: LOGIN_UNSPECIFIED (0): Not specified. LOGIN_OPTIONAL is assumed. LOGIN_OPTIONAL (1): Does not require that the user is signed in. LOGIN_ADMIN (2): If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds. LOGIN_REQUIRED (3): If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken.

ManagedCertificate

A certificate managed by App Engine.

ManagementStatus

State of certificate management. Refers to the most recent certificate acquisition or renewal attempt.

Values: MANAGEMENT_STATUS_UNSPECIFIED (0): No description available. OK (1): Certificate was successfully obtained and inserted into the serving system. PENDING (2): Certificate is under active attempts to acquire or renew. FAILED_RETRYING_NOT_VISIBLE (4): Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving. FAILED_PERMANENT (6): All renewal attempts have been exhausted, likely due to an invalid DNS setup. FAILED_RETRYING_CAA_FORBIDDEN (7): Most recent renewal failed due to an explicit CAA record that does not include one of the in-use CAs (Google CA and Let's Encrypt). Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving. FAILED_RETRYING_CAA_CHECKING (8): Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving.

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.

NetworkSettings

A NetworkSettings resource is a container for ingress settings for a version or service.

NetworkUtilization

Target scaling by network usage. Only applicable in the App Engine flexible environment.

OperationMetadataV1

Metadata for the given google.longrunning.Operation][google.longrunning.Operation].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

SecurityLevel

Methods to enforce security (HTTPS) on a URL.

Values: SECURE_UNSPECIFIED (0): Not specified. SECURE_DEFAULT (0): Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly. SECURE_NEVER (1): Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL. SECURE_OPTIONAL (2): Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly. SECURE_ALWAYS (3): Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.

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.

ServingStatus

Run states of a version.

Values: SERVING_STATUS_UNSPECIFIED (0): Not specified. SERVING (1): Currently serving. Instances are created according to the scaling settings of the version. STOPPED (2): Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING.

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.

TrafficSplit

Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.

UpdateApplicationRequest

Request message for Applications.UpdateApplication.

UpdateAuthorizedCertificateRequest

Request message for AuthorizedCertificates.UpdateAuthorizedCertificate.

UpdateDomainMappingRequest

Request message for DomainMappings.UpdateDomainMapping.

UpdateIngressRuleRequest

Request message for Firewall.UpdateIngressRule.

UpdateServiceMethod

Detailed information about UpdateService call.

UpdateServiceRequest

Request message for Services.UpdateService.

UpdateVersionRequest

Request message for Versions.UpdateVersion.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Version

A Version resource is a specific set of source code and configuration files that are deployed into a service.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

VersionView

Fields that should be returned when Version][google.appengine.v1.Version] resources are retrieved.

Values: BASIC (0): Basic version information including scaling and inbound services, but not detailed deployment information. FULL (1): The information from BASIC, plus detailed information about the deployment. This format is required when creating resources, but is not returned in Get or List by default.