App Engine v1 API - Namespace Google.Cloud.AppEngine.V1 (2.3.0)

Classes

ApiConfigHandler

Google Cloud 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.

Application.Types

Container for nested types declared in the Application message type.

Application.Types.FeatureSettings

The feature specific settings to be used in the application. These define behaviors that are user configurable.

Application.Types.IdentityAwareProxy

Identity-Aware Proxy

Applications

Manages App Engine applications.

Applications.ApplicationsBase

Base class for server-side implementations of Applications

Applications.ApplicationsClient

Client for Applications

ApplicationsClient

Applications client wrapper, for convenient use.

ApplicationsClientBuilder

Builder class for ApplicationsClient to provide simple configuration of credentials, endpoint etc.

ApplicationsClientImpl

Applications client wrapper implementation, for convenient use.

ApplicationsSettings

Settings for ApplicationsClient instances.

AuditData

App Engine admin service audit log.

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.

AuthorizedCertificates

Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.

AuthorizedCertificates.AuthorizedCertificatesBase

Base class for server-side implementations of AuthorizedCertificates

AuthorizedCertificates.AuthorizedCertificatesClient

Client for AuthorizedCertificates

AuthorizedCertificatesClient

AuthorizedCertificates client wrapper, for convenient use.

AuthorizedCertificatesClientBuilder

Builder class for AuthorizedCertificatesClient to provide simple configuration of credentials, endpoint etc.

AuthorizedCertificatesClientImpl

AuthorizedCertificates client wrapper implementation, for convenient use.

AuthorizedCertificatesSettings

Settings for AuthorizedCertificatesClient instances.

AuthorizedDomain

A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console.

AuthorizedDomains

Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central.

AuthorizedDomains.AuthorizedDomainsBase

Base class for server-side implementations of AuthorizedDomains

AuthorizedDomains.AuthorizedDomainsClient

Client for AuthorizedDomains

AuthorizedDomainsClient

AuthorizedDomains client wrapper, for convenient use.

AuthorizedDomainsClientBuilder

Builder class for AuthorizedDomainsClient to provide simple configuration of credentials, endpoint etc.

AuthorizedDomainsClientImpl

AuthorizedDomains client wrapper implementation, for convenient use.

AuthorizedDomainsSettings

Settings for AuthorizedDomainsClient instances.

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.

DomainMappings

Manages domains serving an application.

DomainMappings.DomainMappingsBase

Base class for server-side implementations of DomainMappings

DomainMappings.DomainMappingsClient

Client for DomainMappings

DomainMappingsClient

DomainMappings client wrapper, for convenient use.

DomainMappingsClientBuilder

Builder class for DomainMappingsClient to provide simple configuration of credentials, endpoint etc.

DomainMappingsClientImpl

DomainMappings client wrapper implementation, for convenient use.

DomainMappingsSettings

Settings for DomainMappingsClient instances.

EndpointsApiService

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.

The fields here refer to the name and configuration ID of a "service" resource in the Service Management API.

EndpointsApiService.Types

Container for nested types declared in the EndpointsApiService message type.

Entrypoint

The entrypoint for the application.

ErrorHandler

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

ErrorHandler.Types

Container for nested types declared in the ErrorHandler message type.

FileInfo

Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.

Firewall

Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests.

Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.

Firewall.FirewallBase

Base class for server-side implementations of Firewall

Firewall.FirewallClient

Client for Firewall

FirewallClient

Firewall client wrapper, for convenient use.

FirewallClientBuilder

Builder class for FirewallClient to provide simple configuration of credentials, endpoint etc.

FirewallClientImpl

Firewall client wrapper implementation, for convenient use.

FirewallRule

A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.

FirewallRule.Types

Container for nested types declared in the FirewallRule message type.

FirewallSettings

Settings for FirewallClient instances.

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.

Instance

An Instance resource is the computing unit that App Engine uses to automatically scale an application.

Instance.Types

Container for nested types declared in the Instance message type.

Instance.Types.Liveness

Wrapper for LivenessState enum.

Instance.Types.Liveness.Types

Container for nested types declared in the Liveness message type.

InstanceName

Resource name for the Instance resource.

Instances

Manages instances of a version.

Instances.InstancesBase

Base class for server-side implementations of Instances

Instances.InstancesClient

Client for Instances

InstancesClient

Instances client wrapper, for convenient use.

InstancesClientBuilder

Builder class for InstancesClient to provide simple configuration of credentials, endpoint etc.

InstancesClientImpl

Instances client wrapper implementation, for convenient use.

InstancesSettings

Settings for InstancesClient instances.

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][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.

NetworkSettings

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

NetworkSettings.Types

Container for nested types declared in the NetworkSettings message type.

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].

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.

ResourceRecord.Types

Container for nested types declared in the ResourceRecord message type.

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.

Services

Manages services of an application.

Services.ServicesBase

Base class for server-side implementations of Services

Services.ServicesClient

Client for Services

ServicesClient

Services client wrapper, for convenient use.

ServicesClientBuilder

Builder class for ServicesClient to provide simple configuration of credentials, endpoint etc.

ServicesClientImpl

Services client wrapper implementation, for convenient use.

ServicesSettings

Settings for ServicesClient instances.

SslSettings

SSL configuration for a DomainMapping resource.

SslSettings.Types

Container for nested types declared in the SslSettings message type.

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.

TrafficSplit.Types

Container for nested types declared in the TrafficSplit message type.

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.

UrlMap.Types

Container for nested types declared in the UrlMap message type.

Version

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

Versions

Manages versions of a service.

Versions.VersionsBase

Base class for server-side implementations of Versions

Versions.VersionsClient

Client for Versions

VersionsClient

Versions client wrapper, for convenient use.

VersionsClientBuilder

Builder class for VersionsClient to provide simple configuration of credentials, endpoint etc.

VersionsClientImpl

Versions client wrapper implementation, for convenient use.

VersionsSettings

Settings for VersionsClient instances.

Volume

Volumes mounted within the app container. Only applicable in the App Engine flexible environment.

VpcAccessConnector

VPC access connector specification.

VpcAccessConnector.Types

Container for nested types declared in the VpcAccessConnector message type.

ZipInfo

The zip file information for a zip deployment.

Enums

Application.Types.DatabaseType

Application.Types.ServingStatus

AuditData.MethodOneofCase

Enum of possible cases for the "method" oneof.

AuthFailAction

Actions to take when the user is not logged in.

AuthorizedCertificateView

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

DomainOverrideStrategy

Override strategy for mutating an existing mapping.

EndpointsApiService.Types.RolloutStrategy

Available rollout strategies.

Entrypoint.CommandOneofCase

Enum of possible cases for the "command" oneof.

ErrorHandler.Types.ErrorCode

Error codes.

FirewallRule.Types.Action

Available actions to take on matching requests.

InboundServiceType

Available inbound services.

Instance.Types.Availability

Availability of the instance.

Instance.Types.Liveness.Types.LivenessState

Liveness health check status for Flex instances.

InstanceName.ResourceNameType

The possible contents of InstanceName.

LoginRequirement

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

ManagementStatus

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

NetworkSettings.Types.IngressTrafficAllowed

If unspecified, INGRESS_TRAFFIC_ALLOWED_ALL will be used.

OperationMetadataV1.MethodMetadataOneofCase

Enum of possible cases for the "method_metadata" oneof.

ResourceRecord.Types.RecordType

A resource record type.

SecurityLevel

Methods to enforce security (HTTPS) on a URL.

ServingStatus

Run states of a version.

SslSettings.Types.SslManagementType

The SSL management type for this domain.

TrafficSplit.Types.ShardBy

Available sharding mechanisms.

UrlMap.HandlerTypeOneofCase

Enum of possible cases for the "handler_type" oneof.

UrlMap.Types.RedirectHttpResponseCode

Redirect codes.

Version.ScalingOneofCase

Enum of possible cases for the "scaling" oneof.

VersionView

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

VpcAccessConnector.Types.EgressSetting

Available egress settings.

This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_IP_RANGES will be used.