Package types (1.0.2)

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. .. attribute:: script_path

Path to the script from the application root directory.

:type: str

Application

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

AuditData

App Engine admin service audit log. .. attribute:: update_service

Detailed information about UpdateService call.

:type: google.cloud.appengine_admin_v1.types.UpdateServiceMethod

AuthFailAction

Actions to take when the user is not logged in.

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.

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.

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. .. attribute:: name

Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.

:type: str

BatchUpdateIngressRulesResponse

Response message for Firewall.UpdateAllIngressRules. .. attribute:: ingress_rules

The full list of ingress FirewallRules for this application.

:type: Sequence[google.cloud.appengine_admin_v1.types.FirewallRule]

CertificateRawData

An SSL certificate obtained from a certificate authority. .. attribute:: public_certificate

PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:

.. raw:: html

   <pre>
   -----BEGIN CERTIFICATE-----
   <certificate_value>
   -----END CERTIFICATE-----
   </pre>

:type: str

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. .. attribute:: aggregation_window_length

Period of time over which CPU utilization is calculated.

:type: google.protobuf.duration_pb2.Duration

CreateApplicationRequest

Request message for Applications.CreateApplication. .. attribute:: application

Application configuration.

:type: google.cloud.appengine_admin_v1.types.Application

CreateAuthorizedCertificateRequest

Request message for AuthorizedCertificates.CreateAuthorizedCertificate.

CreateDomainMappingRequest

Request message for DomainMappings.CreateDomainMapping. .. attribute:: parent

Name of the parent Application resource. Example: apps/myapp.

:type: str

CreateIngressRuleRequest

Request message for Firewall.CreateIngressRule. .. attribute:: parent

Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.

:type: str

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. .. attribute:: request

Create version request.

:type: google.cloud.appengine_admin_v1.types.CreateVersionRequest

CreateVersionRequest

Request message for Versions.CreateVersion. .. attribute:: parent

Name of the parent resource to create this version under. Example: apps/myapp/services/default.

:type: str

DebugInstanceRequest

Request message for Instances.DebugInstance. .. attribute:: name

Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

:type: str

DeleteAuthorizedCertificateRequest

Request message for AuthorizedCertificates.DeleteAuthorizedCertificate.

DeleteDomainMappingRequest

Request message for DomainMappings.DeleteDomainMapping. .. attribute:: name

Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.

:type: str

DeleteIngressRuleRequest

Request message for Firewall.DeleteIngressRule. .. attribute:: name

Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.

:type: str

DeleteInstanceRequest

Request message for Instances.DeleteInstance. .. attribute:: name

Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

:type: str

DeleteServiceRequest

Request message for Services.DeleteService. .. attribute:: name

Name of the resource requested. Example: apps/myapp/services/default.

:type: str

DeleteVersionRequest

Request message for Versions.DeleteVersion. .. attribute:: name

Name of the resource requested. Example: apps/myapp/services/default/versions/v1.

:type: str

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. .. attribute:: name

Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.

@OutputOnly

:type: str

DomainOverrideStrategy

Override strategy for mutating an existing mapping.

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. .. attribute:: shell

The format should be a shell command that can be fed to bash -c.

:type: str

ErrorHandler

Custom static error page to be served when an error occurs. .. attribute:: error_code

Error condition this handler applies to.

:type: google.cloud.appengine_admin_v1.types.ErrorHandler.ErrorCode

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. .. attribute:: name

Name of the Application resource to get. Example: apps/myapp.

:type: str

GetAuthorizedCertificateRequest

Request message for AuthorizedCertificates.GetAuthorizedCertificate.

GetDomainMappingRequest

Request message for DomainMappings.GetDomainMapping. .. attribute:: name

Name of the resource requested. Example: apps/myapp/domainMappings/example.com.

:type: str

GetIngressRuleRequest

Request message for Firewall.GetIngressRule. .. attribute:: name

Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.

:type: str

GetInstanceRequest

Request message for Instances.GetInstance. .. attribute:: name

Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

:type: str

GetServiceRequest

Request message for Services.GetService. .. attribute:: name

Name of the resource requested. Example: apps/myapp/services/default.

:type: str

GetVersionRequest

Request message for Versions.GetVersion. .. attribute:: name

Name of the resource requested. Example: apps/myapp/services/default/versions/v1.

:type: str

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.

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. .. attribute:: parent

Name of the parent Application resource. Example: apps/myapp.

:type: str

ListAuthorizedDomainsResponse

Response message for AuthorizedDomains.ListAuthorizedDomains. .. attribute:: domains

The authorized domains belonging to the user.

:type: Sequence[google.cloud.appengine_admin_v1.types.AuthorizedDomain]

ListDomainMappingsRequest

Request message for DomainMappings.ListDomainMappings. .. attribute:: parent

Name of the parent Application resource. Example: apps/myapp.

:type: str

ListDomainMappingsResponse

Response message for DomainMappings.ListDomainMappings. .. attribute:: domain_mappings

The domain mappings for the application.

:type: Sequence[google.cloud.appengine_admin_v1.types.DomainMapping]

ListIngressRulesRequest

Request message for Firewall.ListIngressRules. .. attribute:: parent

Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.

:type: str

ListIngressRulesResponse

Response message for Firewall.ListIngressRules. .. attribute:: ingress_rules

The ingress FirewallRules for this application.

:type: Sequence[google.cloud.appengine_admin_v1.types.FirewallRule]

ListInstancesRequest

Request message for Instances.ListInstances. .. attribute:: parent

Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.

:type: str

ListInstancesResponse

Response message for Instances.ListInstances. .. attribute:: instances

The instances belonging to the requested version.

:type: Sequence[google.cloud.appengine_admin_v1.types.Instance]

ListServicesRequest

Request message for Services.ListServices. .. attribute:: parent

Name of the parent Application resource. Example: apps/myapp.

:type: str

ListServicesResponse

Response message for Services.ListServices. .. attribute:: services

The services belonging to the requested application.

:type: Sequence[google.cloud.appengine_admin_v1.types.Service]

ListVersionsRequest

Request message for Versions.ListVersions. .. attribute:: parent

Name of the parent Service resource. Example: apps/myapp/services/default.

:type: str

ListVersionsResponse

Response message for Versions.ListVersions. .. attribute:: versions

The versions belonging to the requested service.

:type: Sequence[google.cloud.appengine_admin_v1.types.Version]

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.

ManagedCertificate

A certificate managed by App Engine. .. attribute:: last_renewal_time

Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.

@OutputOnly

:type: google.protobuf.timestamp_pb2.Timestamp

ManagementStatus

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

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

ReadinessCheck

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

RepairApplicationRequest

Request message for 'Applications.RepairApplication'. .. attribute:: name

Name of the application to repair. Example: apps/myapp

:type: str

RequestUtilization

Target scaling by request utilization. Only applicable in the App Engine flexible environment.

ResourceRecord

A DNS resource record. .. attribute:: name

Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.

:type: str

Resources

Machine resources for a version. .. attribute:: cpu

Number of CPU cores needed.

:type: float

ScriptHandler

Executes a script to handle the request that matches the URL pattern.

SecurityLevel

Methods to enforce security (HTTPS) on a URL.

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.

SslSettings

SSL configuration for a DomainMapping resource. .. attribute:: certificate_id

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.

By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

:type: str

StandardSchedulerSettings

Scheduler settings for standard environment. .. attribute:: target_cpu_utilization

Target CPU utilization ratio to maintain when scaling.

:type: float

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. .. attribute:: name

Name of the Application resource to update. Example: apps/myapp.

:type: str

UpdateAuthorizedCertificateRequest

Request message for AuthorizedCertificates.UpdateAuthorizedCertificate.

UpdateDomainMappingRequest

Request message for DomainMappings.UpdateDomainMapping. .. attribute:: name

Name of the resource to update. Example: apps/myapp/domainMappings/example.com.

:type: str

UpdateIngressRuleRequest

Request message for Firewall.UpdateIngressRule. .. attribute:: name

Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.

:type: str

UpdateServiceMethod

Detailed information about UpdateService call. .. attribute:: request

Update service request.

:type: google.cloud.appengine_admin_v1.types.UpdateServiceRequest

UpdateServiceRequest

Request message for Services.UpdateService. .. attribute:: name

Name of the resource to update. Example: apps/myapp/services/default.

:type: str

UpdateVersionRequest

Request message for Versions.UpdateVersion. .. attribute:: name

Name of the resource to update. Example: apps/myapp/services/default/versions/1.

:type: str

ZipInfo

The zip file information for a zip deployment. .. attribute:: source_url

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/<bucket>/<object>'.

:type: str