Types for Google Cloud Appengine Admin v1 API¶
- class google.cloud.appengine_admin_v1.types.ApiConfigHandler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGoogle Cloud Endpoints configuration for API handlers.
- auth_fail_action¶
Action to take when users access resources that require authentication. Defaults to
redirect.
- login¶
Level of login required to access this resource. Defaults to
optional.
- security_level¶
Security (HTTPS) enforcement for this URL.
- class google.cloud.appengine_admin_v1.types.ApiEndpointHandler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUses Google Cloud Endpoints to handle requests.
- class google.cloud.appengine_admin_v1.types.Application(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn Application resource contains the top-level configuration of an App Engine application.
- id¶
Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example:
myapp.- Type
- dispatch_rules¶
HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.UrlDispatchRule]
- auth_domain¶
Google Apps authentication domain that controls which users can access this application.
Defaults to open access for any Google Account.
- Type
- location_id¶
Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application’s end user content is stored.
Defaults to
us-central.View the list of supported locations.
- Type
- code_bucket¶
Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.
@OutputOnly
- Type
- default_cookie_expiration¶
Cookie expiration policy for this application.
- serving_status¶
Serving status of this application.
- default_hostname¶
Hostname used to reach this application, as resolved by App Engine. @OutputOnly
- Type
- default_bucket¶
Google Cloud Storage bucket that can be used by this application to store content.
@OutputOnly
- Type
- service_account¶
The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
- Type
- gcr_domain¶
The Google Container Registry domain used for storing managed build docker images for this application.
- Type
- database_type¶
The type of the Cloud Firestore or Cloud Datastore database associated with this application.
- feature_settings¶
The feature specific settings to be used in the application.
- class DatabaseType(value)[source]¶
Bases:
proto.enums.Enum- Values:
- DATABASE_TYPE_UNSPECIFIED (0):
Database type is unspecified.
- CLOUD_DATASTORE (1):
Cloud Datastore
- CLOUD_FIRESTORE (2):
Cloud Firestore Native
- CLOUD_DATASTORE_COMPATIBILITY (3):
Cloud Firestore in Datastore Mode
- class FeatureSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe feature specific settings to be used in the application. These define behaviors that are user configurable.
- split_health_checks¶
Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to ‘readiness_check’ and ‘liveness_check’ values instead of ‘health_check’ ones. Once the legacy ‘health_check’ behavior is deprecated, and this value is always true, this setting can be removed.
- Type
- use_container_optimized_os¶
If true, use Container-Optimized OS base image for VMs, rather than a base Debian image.
- Type
- class IdentityAwareProxy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageIdentity-Aware Proxy
- enabled¶
Whether the serving infrastructure will authenticate and authorize all incoming requests.
If true, the
oauth2_client_idandoauth2_client_secretfields must be non-empty.- Type
- oauth2_client_secret¶
OAuth2 client secret to use for the authentication flow.
For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the
oauth2_client_secret_sha256field.@InputOnly
- Type
- class ServingStatus(value)[source]¶
Bases:
proto.enums.Enum- Values:
- UNSPECIFIED (0):
Serving status is unspecified.
- SERVING (1):
Application is serving.
- USER_DISABLED (2):
Application has been disabled by the user.
- SYSTEM_DISABLED (3):
Application has been disabled by the system.
- class google.cloud.appengine_admin_v1.types.AuditData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApp Engine admin service audit log.
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.
- update_service¶
Detailed information about UpdateService call.
This field is a member of oneof
method.
- class google.cloud.appengine_admin_v1.types.AuthFailAction(value)[source]¶
Bases:
proto.enums.EnumActions to take when the user is not logged in.
- Values:
- AUTH_FAIL_ACTION_UNSPECIFIED (0):
Not specified.
AUTH_FAIL_ACTION_REDIRECTis 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
401HTTP status code and an error message.
- class google.cloud.appengine_admin_v1.types.AuthorizedCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn 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.
- name¶
Full path to the
AuthorizedCertificateresource in the API. Example:apps/myapp/authorizedCertificates/12345.@OutputOnly
- Type
- id¶
Relative name of the certificate. This is a unique value autogenerated on
AuthorizedCertificateresource creation. Example:12345.@OutputOnly
- Type
- display_name¶
The user-specified display name of the certificate. This is not guaranteed to be unique. Example:
My Certificate.- Type
- domain_names¶
Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example:
example.com.@OutputOnly
- Type
MutableSequence[str]
- expire_time¶
The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using
`AuthorizedCertificates.UpdateAuthorizedCertificate<>`__.@OutputOnly
- certificate_raw_data¶
The SSL certificate serving the
AuthorizedCertificateresource. This must be obtained independently from a certificate authority.
- managed_certificate¶
Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a
DomainMappingand cannot be updated or deleted via theAuthorizedCertificatesAPI. If this certificate is manually administered by the user, this field will be empty.@OutputOnly
- visible_domain_mappings¶
The full paths to user visible Domain Mapping resources that have this certificate mapped. Example:
apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have
VIEWERpermissions on all of the applications that have this certificate mapped. Seedomain_mappings_countfor a complete count.Only returned by
GETorLISTrequests when specifically requested by theview=FULL_CERTIFICATEoption.@OutputOnly
- Type
MutableSequence[str]
- domain_mappings_count¶
Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have
VIEWERpermissions.Only returned by
GETorLISTrequests when specifically requested by theview=FULL_CERTIFICATEoption.@OutputOnly
- Type
- class google.cloud.appengine_admin_v1.types.AuthorizedCertificateView(value)[source]¶
Bases:
proto.enums.EnumFields 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.
- class google.cloud.appengine_admin_v1.types.AuthorizedDomain(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console.
- name¶
Full path to the
AuthorizedDomainresource in the API. Example:apps/myapp/authorizedDomains/example.com.@OutputOnly
- Type
- class google.cloud.appengine_admin_v1.types.AutomaticScaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAutomatic scaling is based on request rate, response latencies, and other application metrics.
- cool_down_period¶
The time period that the Autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
- cpu_utilization¶
Target scaling by CPU usage.
- max_concurrent_requests¶
Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.
Defaults to a runtime-specific value.
- Type
- max_idle_instances¶
Maximum number of idle instances that should be maintained for this version.
- Type
- max_total_instances¶
Maximum number of instances that should be started to handle requests for this version.
- Type
- max_pending_latency¶
Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- min_idle_instances¶
Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
- Type
- min_total_instances¶
Minimum number of running instances that should be maintained for this version.
- Type
- min_pending_latency¶
Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- request_utilization¶
Target scaling by request utilization.
- disk_utilization¶
Target scaling by disk usage.
- network_utilization¶
Target scaling by network usage.
- standard_scheduler_settings¶
Scheduler settings for standard environment.
- class google.cloud.appengine_admin_v1.types.BasicScaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- idle_timeout¶
Duration of time after the last request that an instance must wait before the instance is shut down.
- class google.cloud.appengine_admin_v1.types.BatchUpdateIngressRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Firewall.BatchUpdateIngressRules.- ingress_rules¶
A list of FirewallRules to replace the existing set.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.FirewallRule]
- class google.cloud.appengine_admin_v1.types.BatchUpdateIngressRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
Firewall.UpdateAllIngressRules.- ingress_rules¶
The full list of ingress FirewallRules for this application.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.FirewallRule]
- class google.cloud.appengine_admin_v1.types.CertificateRawData(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn SSL certificate obtained from a certificate authority.
- public_certificate¶
PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE----- - Type
- class google.cloud.appengine_admin_v1.types.CloudBuildOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions 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.
- app_yaml_path¶
Path to the yaml file used in deployment, used to determine runtime configuration details.
Required for flexible environment builds.
See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
- Type
- cloud_build_timeout¶
The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
- class google.cloud.appengine_admin_v1.types.ContainerInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDocker 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.
- class google.cloud.appengine_admin_v1.types.CpuUtilization(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget scaling by CPU usage.
- aggregation_window_length¶
Period of time over which CPU utilization is calculated.
- class google.cloud.appengine_admin_v1.types.CreateApplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Applications.CreateApplication.- application¶
Application configuration.
- class google.cloud.appengine_admin_v1.types.CreateAuthorizedCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
AuthorizedCertificates.CreateAuthorizedCertificate.- certificate¶
SSL certificate data.
- class google.cloud.appengine_admin_v1.types.CreateDomainMappingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
DomainMappings.CreateDomainMapping.- domain_mapping¶
Domain mapping configuration.
- override_strategy¶
Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
- class google.cloud.appengine_admin_v1.types.CreateIngressRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Firewall.CreateIngressRule.- parent¶
Name of the parent Firewall collection in which to create a new rule. Example:
apps/myapp/firewall/ingressRules.- Type
- rule¶
A FirewallRule containing the new resource.
The user may optionally provide a position at which the new rule will be placed. The positions define a sequential list starting at 1. If a rule already exists at the given position, rules greater than the provided position will be moved forward by one.
If no position is provided, the server will place the rule as the second to last rule in the sequence before the required default allow-all or deny-all rule.
- class google.cloud.appengine_admin_v1.types.CreateVersionMetadataV1(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata for the given [google.longrunning.Operation][google.longrunning.Operation] during a [google.appengine.v1.CreateVersionRequest][google.appengine.v1.CreateVersionRequest].
- class google.cloud.appengine_admin_v1.types.CreateVersionMethod(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetailed information about CreateVersion call.
- request¶
Create version request.
- class google.cloud.appengine_admin_v1.types.CreateVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Versions.CreateVersion.- parent¶
Name of the parent resource to create this version under. Example:
apps/myapp/services/default.- Type
- version¶
Application deployment configuration.
- class google.cloud.appengine_admin_v1.types.DebugInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Instances.DebugInstance.- name¶
Name of the resource requested. Example:
apps/myapp/services/default/versions/v1/instances/instance-1.- Type
- ssh_key¶
Public SSH key to add to the instance. Examples:
[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME][USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}
For more information, see Adding and Removing SSH Keys.
- Type
- class google.cloud.appengine_admin_v1.types.DeleteAuthorizedCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
AuthorizedCertificates.DeleteAuthorizedCertificate.
- class google.cloud.appengine_admin_v1.types.DeleteDomainMappingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
DomainMappings.DeleteDomainMapping.
- class google.cloud.appengine_admin_v1.types.DeleteIngressRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Firewall.DeleteIngressRule.
- class google.cloud.appengine_admin_v1.types.DeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Instances.DeleteInstance.
- class google.cloud.appengine_admin_v1.types.DeleteServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Services.DeleteService.
- class google.cloud.appengine_admin_v1.types.DeleteVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Versions.DeleteVersion.
- class google.cloud.appengine_admin_v1.types.Deployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCode and application artifacts used to deploy a version to App Engine.
- files¶
Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
- Type
MutableMapping[str, google.cloud.appengine_admin_v1.types.FileInfo]
- container¶
The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
- zip_¶
The zip file for this deployment, if this is a zip deployment.
- cloud_build_options¶
Options for any Google Cloud Build builds created as a part of this deployment.
These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
- class FilesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.appengine_admin_v1.types.DiskUtilization(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget scaling by disk usage. Only applicable in the App Engine flexible environment.
- class google.cloud.appengine_admin_v1.types.DomainMapping(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA domain serving an App Engine application.
- name¶
Full path to the
DomainMappingresource in the API. Example:apps/myapp/domainMapping/example.com.@OutputOnly
- Type
- ssl_settings¶
SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
- resource_records¶
The resource records required to configure this domain mapping. These records must be added to the domain’s DNS configuration in order to serve the application via this domain mapping.
@OutputOnly
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.ResourceRecord]
- class google.cloud.appengine_admin_v1.types.DomainOverrideStrategy(value)[source]¶
Bases:
proto.enums.EnumOverride 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.
- class google.cloud.appengine_admin_v1.types.EndpointsApiService(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud 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.
- name¶
Endpoints service name which is the name of the “service” resource in the Service Management API. For example “myapi.endpoints.myproject.cloud.goog”.
- Type
- config_id¶
Endpoints service configuration ID as specified by the Service Management API. For example “2016-09-19r1”.
By default, the rollout strategy for Endpoints is
RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. Theconfig_idfield is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called
RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case,config_idmust be omitted.- Type
- rollout_strategy¶
Endpoints rollout strategy. If
FIXED,config_idmust be specified. IfMANAGED,config_idmust be omitted.
- disable_trace_sampling¶
Enable or disable trace sampling. By default, this is set to false for enabled.
- Type
- class RolloutStrategy(value)[source]¶
Bases:
proto.enums.EnumAvailable rollout strategies.
- Values:
- UNSPECIFIED_ROLLOUT_STRATEGY (0):
Not specified. Defaults to
FIXED.- FIXED (1):
Endpoints service configuration ID will be fixed to the configuration ID specified by
config_id.- MANAGED (2):
Endpoints service configuration ID will be updated with each rollout.
- class google.cloud.appengine_admin_v1.types.Entrypoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe entrypoint for the application.
- class google.cloud.appengine_admin_v1.types.ErrorHandler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCustom static error page to be served when an error occurs.
- error_code¶
Error condition this handler applies to.
- class ErrorCode(value)[source]¶
Bases:
proto.enums.EnumError codes.
- Values:
- ERROR_CODE_UNSPECIFIED (0):
Not specified. ERROR_CODE_DEFAULT is assumed.
- ERROR_CODE_DEFAULT (0):
All other error types.
- ERROR_CODE_OVER_QUOTA (1):
Application has exceeded a resource quota.
- ERROR_CODE_DOS_API_DENIAL (2):
Client blocked by the application’s Denial of Service protection configuration.
- ERROR_CODE_TIMEOUT (3):
Deadline reached before the application responds.
- class google.cloud.appengine_admin_v1.types.FileInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSingle source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
- source_url¶
URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form ‘http(s)://storage.googleapis.com/<bucket>/<object>’.
- Type
- class google.cloud.appengine_admin_v1.types.FirewallRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
- priority¶
A positive integer between [1, Int32.MaxValue-1] that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.
A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.
- Type
- action¶
The action to take on matched requests.
- source_range¶
IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character “*” to match all IPs equivalent to “0/0” and “::/0” together. Examples:
192.168.1.1or192.168.0.0/16or2001:db8::/32or2001:0db8:0000:0042:0000:8a2e:0370:7334.Truncation will be silently performed on addresses which are not properly truncated. For example, `1.2.3.4/24` is accepted as the same address as `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` is accepted as the same address as `2001:db8::/32`.
- Type
- description¶
An optional string description of this rule. This field has a maximum length of 100 characters.
- Type
- class Action(value)[source]¶
Bases:
proto.enums.EnumAvailable actions to take on matching requests.
- Values:
- UNSPECIFIED_ACTION (0):
No description available.
- ALLOW (1):
Matching requests are allowed.
- DENY (2):
Matching requests are denied.
- class google.cloud.appengine_admin_v1.types.GetApplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Applications.GetApplication.
- class google.cloud.appengine_admin_v1.types.GetAuthorizedCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
AuthorizedCertificates.GetAuthorizedCertificate.- view¶
Controls the set of fields returned in the
GETresponse.
- class google.cloud.appengine_admin_v1.types.GetDomainMappingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
DomainMappings.GetDomainMapping.
- class google.cloud.appengine_admin_v1.types.GetIngressRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Firewall.GetIngressRule.
- class google.cloud.appengine_admin_v1.types.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Instances.GetInstance.
- class google.cloud.appengine_admin_v1.types.GetServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Services.GetService.
- class google.cloud.appengine_admin_v1.types.GetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Versions.GetVersion.- view¶
Controls the set of fields returned in the
Getresponse.
- class google.cloud.appengine_admin_v1.types.HealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHealth checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.
- host¶
Host header to send when performing an HTTP health check. Example: “myapp.appspot.com”.
- Type
- healthy_threshold¶
Number of consecutive successful health checks required before receiving traffic.
- Type
- unhealthy_threshold¶
Number of consecutive failed health checks required before removing traffic.
- Type
- restart_threshold¶
Number of consecutive failed health checks required before an instance is restarted.
- Type
- check_interval¶
Interval between health checks.
- timeout¶
Time before the health check is considered failed.
- class google.cloud.appengine_admin_v1.types.InboundServiceType(value)[source]¶
Bases:
proto.enums.EnumAvailable 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.
- class google.cloud.appengine_admin_v1.types.Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn Instance resource is the computing unit that App Engine uses to automatically scale an application.
- name¶
Output only. Full path to the Instance resource in the API. Example:
apps/myapp/services/default/versions/v1/instances/instance-1.- Type
- availability¶
Output only. Availability of the instance.
- vm_name¶
Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
- Type
- vm_zone_name¶
Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.
- Type
- vm_id¶
Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.
- Type
- start_time¶
Output only. Time that this instance was started. @OutputOnly
- vm_status¶
Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.
- Type
- vm_debug_enabled¶
Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.
- Type
- vm_ip¶
Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.
- Type
- vm_liveness¶
Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.
- class Availability(value)[source]¶
Bases:
proto.enums.EnumAvailability of the instance.
- Values:
- UNSPECIFIED (0):
No description available.
- RESIDENT (1):
No description available.
- DYNAMIC (2):
No description available.
- class Liveness(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageWrapper for LivenessState enum.
- class LivenessState(value)[source]¶
Bases:
proto.enums.EnumLiveness health check status for Flex instances.
- Values:
- LIVENESS_STATE_UNSPECIFIED (0):
There is no liveness health check for the instance. Only applicable for instances in App Engine standard environment.
- UNKNOWN (1):
The health checking system is aware of the instance but its health is not known at the moment.
- HEALTHY (2):
The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.
- UNHEALTHY (3):
The instance is reachable, but does not conform to the requirements defined by the health check.
- DRAINING (4):
The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.
- TIMEOUT (5):
The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.
- class google.cloud.appengine_admin_v1.types.Library(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThird-party Python runtime library that is required by the application.
- class google.cloud.appengine_admin_v1.types.ListAuthorizedCertificatesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
AuthorizedCertificates.ListAuthorizedCertificates.- view¶
Controls the set of fields returned in the
LISTresponse.
- class google.cloud.appengine_admin_v1.types.ListAuthorizedCertificatesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
AuthorizedCertificates.ListAuthorizedCertificates.- certificates¶
The SSL certificates the user is authorized to administer.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.AuthorizedCertificate]
- class google.cloud.appengine_admin_v1.types.ListAuthorizedDomainsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
AuthorizedDomains.ListAuthorizedDomains.
- class google.cloud.appengine_admin_v1.types.ListAuthorizedDomainsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
AuthorizedDomains.ListAuthorizedDomains.- domains¶
The authorized domains belonging to the user.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.AuthorizedDomain]
- class google.cloud.appengine_admin_v1.types.ListDomainMappingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
DomainMappings.ListDomainMappings.
- class google.cloud.appengine_admin_v1.types.ListDomainMappingsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
DomainMappings.ListDomainMappings.- domain_mappings¶
The domain mappings for the application.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.DomainMapping]
- class google.cloud.appengine_admin_v1.types.ListIngressRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Firewall.ListIngressRules.- parent¶
Name of the Firewall collection to retrieve. Example:
apps/myapp/firewall/ingressRules.- Type
- class google.cloud.appengine_admin_v1.types.ListIngressRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
Firewall.ListIngressRules.- ingress_rules¶
The ingress FirewallRules for this application.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.FirewallRule]
- class google.cloud.appengine_admin_v1.types.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Instances.ListInstances.- parent¶
Name of the parent Version resource. Example:
apps/myapp/services/default/versions/v1.- Type
- class google.cloud.appengine_admin_v1.types.ListInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
Instances.ListInstances.- instances¶
The instances belonging to the requested version.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.Instance]
- class google.cloud.appengine_admin_v1.types.ListServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Services.ListServices.
- class google.cloud.appengine_admin_v1.types.ListServicesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
Services.ListServices.- services¶
The services belonging to the requested application.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.Service]
- class google.cloud.appengine_admin_v1.types.ListVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Versions.ListVersions.- view¶
Controls the set of fields returned in the
Listresponse.
- class google.cloud.appengine_admin_v1.types.ListVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for
Versions.ListVersions.- versions¶
The versions belonging to the requested service.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.Version]
- class google.cloud.appengine_admin_v1.types.LivenessCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHealth checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
- host¶
Host header to send when performing a HTTP Liveness check. Example: “myapp.appspot.com”.
- Type
- failure_threshold¶
Number of consecutive failed checks required before considering the VM unhealthy.
- Type
- success_threshold¶
Number of consecutive successful checks required before considering the VM healthy.
- Type
- check_interval¶
Interval between health checks.
- timeout¶
Time before the check is considered failed.
- initial_delay¶
The initial delay before starting to execute the checks.
- class google.cloud.appengine_admin_v1.types.LocationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata for the given [google.cloud.location.Location][google.cloud.location.Location].
- standard_environment_available¶
App Engine standard environment is available in the given location. @OutputOnly
- Type
- flexible_environment_available¶
App Engine flexible environment is available in the given location. @OutputOnly
- Type
- search_api_available¶
Output only. Search API is available in the given location.
- Type
- class google.cloud.appengine_admin_v1.types.LoginRequirement(value)[source]¶
Bases:
proto.enums.EnumMethods to restrict access to a URL based on login status.
- Values:
- LOGIN_UNSPECIFIED (0):
Not specified.
LOGIN_OPTIONALis 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_actionis taken. In addition, if the user is not an administrator for the application, they are given an error message regardless ofauth_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.
- class google.cloud.appengine_admin_v1.types.ManagedCertificate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA certificate managed by App Engine.
- 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
- status¶
Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.
@OutputOnly
- class google.cloud.appengine_admin_v1.types.ManagementStatus(value)[source]¶
Bases:
proto.enums.EnumState 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.
- class google.cloud.appengine_admin_v1.types.ManualScaling(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
- instances¶
Number of instances to assign to the service at the start. This number can later be altered by using the Modules API
set_num_instances()function.- Type
- class google.cloud.appengine_admin_v1.types.Network(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExtra network settings. Only applicable in the App Engine flexible environment.
- forwarded_ports¶
List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
- Type
MutableSequence[str]
- instance_tag¶
Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
- Type
- name¶
Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.
Defaults to
default.- Type
- subnetwork_name¶
Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.
If a subnetwork name is specified, a network name will also be required unless it is for the default network.
If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.
If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
- Type
- class google.cloud.appengine_admin_v1.types.NetworkSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA NetworkSettings resource is a container for ingress settings for a version or service.
- ingress_traffic_allowed¶
The ingress settings for version or service.
- class IngressTrafficAllowed(value)[source]¶
Bases:
proto.enums.EnumIf unspecified, INGRESS_TRAFFIC_ALLOWED_ALL will be used.
- Values:
- INGRESS_TRAFFIC_ALLOWED_UNSPECIFIED (0):
Unspecified
- INGRESS_TRAFFIC_ALLOWED_ALL (1):
Allow HTTP traffic from public and private sources.
- INGRESS_TRAFFIC_ALLOWED_INTERNAL_ONLY (2):
Allow HTTP traffic from only private VPC sources.
- INGRESS_TRAFFIC_ALLOWED_INTERNAL_AND_LB (3):
Allow HTTP traffic from private VPC sources and through load balancers.
- class google.cloud.appengine_admin_v1.types.NetworkUtilization(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget scaling by network usage. Only applicable in the App Engine flexible environment.
- class google.cloud.appengine_admin_v1.types.OperationMetadataV1(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata for the given [google.longrunning.Operation][google.longrunning.Operation].
- method¶
API method that initiated this operation. Example:
google.appengine.v1.Versions.CreateVersion.@OutputOnly
- Type
- insert_time¶
Time that this operation was created.
@OutputOnly
- end_time¶
Time that this operation completed.
@OutputOnly
- target¶
Name of the resource that this operation is acting on. Example:
apps/myapp/services/default.@OutputOnly
- Type
- ephemeral_message¶
Ephemeral message that may change every time the operation is polled. @OutputOnly
- Type
- warning¶
Durable messages that persist on every operation poll. @OutputOnly
- Type
MutableSequence[str]
- class google.cloud.appengine_admin_v1.types.ReadinessCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReadiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
- host¶
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”.
- Type
- success_threshold¶
Number of consecutive successful checks required before receiving traffic.
- Type
- check_interval¶
Interval between health checks.
- timeout¶
Time before the check is considered failed.
- app_start_timeout¶
A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
- class google.cloud.appengine_admin_v1.types.RepairApplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘Applications.RepairApplication’.
- class google.cloud.appengine_admin_v1.types.RequestUtilization(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTarget scaling by request utilization. Only applicable in the App Engine flexible environment.
- class google.cloud.appengine_admin_v1.types.ResourceRecord(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA DNS resource record.
- name¶
Relative name of the object affected by this record. Only applicable for
CNAMErecords. Example: ‘www’.- Type
- rrdata¶
Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
- Type
- type_¶
Resource record type. Example:
AAAA.
- class RecordType(value)[source]¶
Bases:
proto.enums.EnumA resource record type.
- Values:
- RECORD_TYPE_UNSPECIFIED (0):
An unknown resource record.
- A (1):
An A resource record. Data is an IPv4 address.
- AAAA (2):
An AAAA resource record. Data is an IPv6 address.
- CNAME (3):
A CNAME resource record. Data is a domain name to be aliased.
- class google.cloud.appengine_admin_v1.types.Resources(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMachine resources for a version.
- volumes¶
User specified volumes.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.Volume]
- class google.cloud.appengine_admin_v1.types.ScriptHandler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageExecutes a script to handle the request that matches the URL pattern.
- class google.cloud.appengine_admin_v1.types.SecurityLevel(value)[source]¶
Bases:
proto.enums.EnumMethods 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.
- class google.cloud.appengine_admin_v1.types.Service(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- name¶
Full path to the Service resource in the API. Example:
apps/myapp/services/default.@OutputOnly
- Type
- split¶
Mapping that defines fractional HTTP traffic diversion to different versions within the service.
- labels¶
A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., “env=prod”, “env=qa”).
<p>Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
- network_settings¶
Ingress settings for this service. Will apply to all versions.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.appengine_admin_v1.types.ServingStatus(value)[source]¶
Bases:
proto.enums.EnumRun 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.
- class google.cloud.appengine_admin_v1.types.SslSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSSL configuration for a
DomainMappingresource.- certificate_id¶
ID of the
AuthorizedCertificateresource 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.MANUALon aCREATEorUPDATErequest. You must be authorized to administer theAuthorizedCertificateresource to manually map it to aDomainMappingresource. Example:12345.- Type
- ssl_management_type¶
SSL management type for this domain. If
AUTOMATIC, a managed certificate is automatically provisioned. IfMANUAL,certificate_idmust be manually specified in order to configure SSL for this domain.
- pending_managed_certificate_id¶
ID of the managed
AuthorizedCertificateresource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, thecertificate_idfield will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear thecertificate_idfield with anUpdateDomainMappingRequest.@OutputOnly
- Type
- class SslManagementType(value)[source]¶
Bases:
proto.enums.EnumThe SSL management type for this domain.
- Values:
- SSL_MANAGEMENT_TYPE_UNSPECIFIED (0):
Defaults to
AUTOMATIC.- AUTOMATIC (1):
SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.
- MANUAL (2):
SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain.
- class google.cloud.appengine_admin_v1.types.StandardSchedulerSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageScheduler settings for standard environment.
- target_throughput_utilization¶
Target throughput utilization ratio to maintain when scaling
- Type
- min_instances¶
Minimum number of instances to run for this version. Set to zero to disable
min_instancesconfiguration.- Type
- class google.cloud.appengine_admin_v1.types.StaticFilesHandler(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFiles 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.
- path¶
Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
- Type
- upload_path_regex¶
Regular expression that matches the file paths for all files that should be referenced by this handler.
- Type
- mime_type¶
MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file’s filename extension.
- Type
- expiration¶
Time a static file served by this handler should be cached by web proxies and browsers.
- require_matching_file¶
Whether this handler should match the request if the file referenced by the handler does not exist.
- Type
- application_readable¶
Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
- Type
- class HttpHeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.appengine_admin_v1.types.TrafficSplit(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTraffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.
- shard_by¶
Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.
- allocations¶
Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.
- class AllocationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class ShardBy(value)[source]¶
Bases:
proto.enums.EnumAvailable sharding mechanisms.
- Values:
- UNSPECIFIED (0):
Diversion method unspecified.
- COOKIE (1):
Diversion based on a specially named cookie, “GOOGAPPUID.” The cookie must be set by the application itself or no diversion will occur.
- IP (2):
Diversion based on applying the modulus operation to a fingerprint of the IP address.
- RANDOM (3):
Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version’s traffic share.
- class google.cloud.appengine_admin_v1.types.UpdateApplicationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Applications.UpdateApplication.- application¶
An Application containing the updated resource.
- update_mask¶
Required. Standard field mask for the set of fields to be updated.
- class google.cloud.appengine_admin_v1.types.UpdateAuthorizedCertificateRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
AuthorizedCertificates.UpdateAuthorizedCertificate.- certificate¶
An
AuthorizedCertificatecontaining the updated resource. Only fields set in the field mask will be updated.
- update_mask¶
Standard field mask for the set of fields to be updated. Updates are only supported on the
certificate_raw_dataanddisplay_namefields.
- class google.cloud.appengine_admin_v1.types.UpdateDomainMappingRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
DomainMappings.UpdateDomainMapping.- domain_mapping¶
A domain mapping containing the updated resource. Only fields set in the field mask will be updated.
- update_mask¶
Required. Standard field mask for the set of fields to be updated.
- class google.cloud.appengine_admin_v1.types.UpdateIngressRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Firewall.UpdateIngressRule.- name¶
Name of the Firewall resource to update. Example:
apps/myapp/firewall/ingressRules/100.- Type
- rule¶
A FirewallRule containing the updated resource
- update_mask¶
Standard field mask for the set of fields to be updated.
- class google.cloud.appengine_admin_v1.types.UpdateServiceMethod(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDetailed information about UpdateService call.
- request¶
Update service request.
- class google.cloud.appengine_admin_v1.types.UpdateServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Services.UpdateService.- service¶
A Service resource containing the updated service. Only fields set in the field mask will be updated.
- update_mask¶
Required. Standard field mask for the set of fields to be updated.
- migrate_traffic¶
Set to
trueto gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests and automatic scaling. You must specify the`shardBy<https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy>`__ field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic.- Type
- class google.cloud.appengine_admin_v1.types.UpdateVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for
Versions.UpdateVersion.- version¶
A Version containing the updated resource. Only fields set in the field mask will be updated.
- update_mask¶
Standard field mask for the set of fields to be updated.
- class google.cloud.appengine_admin_v1.types.UrlDispatchRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRules to match an HTTP request and dispatch that request to a service.
- domain¶
Domain name to match against. The wildcard “
*” is supported if specified before a period: “*.”.Defaults to matching all domains: “
*”.- Type
- path¶
Pathname within the host. Must start with a “
/”. A single “*” can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
- Type
- class google.cloud.appengine_admin_v1.types.UrlMap(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageURL 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.
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.
- url_regex¶
URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
- Type
- static_files¶
Returns the contents of a file, such as an image, as the response.
This field is a member of oneof
handler_type.
- script¶
Executes a script to handle the requests that match this URL pattern. Only the
autovalue is supported for Node.js in the App Engine standard environment, for example"script": "auto".This field is a member of oneof
handler_type.
- security_level¶
Security (HTTPS) enforcement for this URL.
- login¶
Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
- auth_fail_action¶
Action to take when users access resources that require authentication. Defaults to
redirect.
- redirect_http_response_code¶
30xcode to use when performing redirects for thesecurefield. Defaults to302.
- class RedirectHttpResponseCode(value)[source]¶
Bases:
proto.enums.EnumRedirect codes.
- Values:
- REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED (0):
Not specified.
302is assumed.- REDIRECT_HTTP_RESPONSE_CODE_301 (1):
301 Moved Permanentlycode.- REDIRECT_HTTP_RESPONSE_CODE_302 (2):
302 Moved Temporarilycode.- REDIRECT_HTTP_RESPONSE_CODE_303 (3):
303 See Othercode.- REDIRECT_HTTP_RESPONSE_CODE_307 (4):
307 Temporary Redirectcode.
- class google.cloud.appengine_admin_v1.types.Version(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Version resource is a specific set of source code and configuration files that are deployed into a service.
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.
- name¶
Full path to the Version resource in the API. Example:
apps/myapp/services/default/versions/v1.@OutputOnly
- Type
- id¶
Relative name of the version within the service. Example:
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: “default”, “latest”, and any name with the prefix “ah-“.- Type
- automatic_scaling¶
Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic.
This field is a member of oneof
scaling.
- 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.
This field is a member of oneof
scaling.
- 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. Manually scaled versions are sometimes referred to as “backends”.
This field is a member of oneof
scaling.
- inbound_services¶
Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- Type
MutableSequence[google.cloud.appengine_admin_v1.types.InboundServiceType]
- instance_class¶
Instance class that is used to run this version. Valid values are:
AutomaticScaling:
F1,F2,F4,F4_1GManualScaling or BasicScaling:
B1,B2,B4,B8,B4_1G
Defaults to
F1for AutomaticScaling andB1for ManualScaling or BasicScaling.- Type
- network¶
Extra network settings. Only applicable in the App Engine flexible environment.
- zones¶
The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
- Type
MutableSequence[str]
- resources¶
Machine resources for this version. Only applicable in the App Engine flexible environment.
- runtime_channel¶
The channel of the runtime to use. Only available for some runtimes. Defaults to the
defaultchannel.- Type
- app_engine_apis¶
Allows App Engine second generation runtimes to access the legacy bundled services.
- Type
- beta_settings¶
Metadata settings that are supplied to this version to enable beta runtime features.
- serving_status¶
Current serving status of this version. Only the versions with a
SERVINGstatus create instances and can be billed.SERVING_STATUS_UNSPECIFIEDis an invalid value. Defaults toSERVING.
- create_time¶
Time that this version was created.
@OutputOnly
- disk_usage_bytes¶
Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.
@OutputOnly
- Type
- runtime_api_version¶
The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/<language>/config/appref
- Type
- service_account¶
The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
- Type
- handlers¶
An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.
Only returned in
GETrequests ifview=FULLis set.- Type
MutableSequence[google.cloud.appengine_admin_v1.types.UrlMap]
- error_handlers¶
Custom static error pages. Limited to 10KB per page.
Only returned in
GETrequests ifview=FULLis set.- Type
MutableSequence[google.cloud.appengine_admin_v1.types.ErrorHandler]
- libraries¶
Configuration for third-party Python runtime libraries that are required by the application.
Only returned in
GETrequests ifview=FULLis set.- Type
MutableSequence[google.cloud.appengine_admin_v1.types.Library]
- api_config¶
Serving configuration for Google Cloud Endpoints.
Only returned in
GETrequests ifview=FULLis set.
- env_variables¶
Environment variables available to the application.
Only returned in
GETrequests ifview=FULLis set.
- build_env_variables¶
Environment variables available to the build environment.
Only returned in
GETrequests ifview=FULLis set.
- default_expiration¶
Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
Only returned in
GETrequests ifview=FULLis set.
- health_check¶
Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.
Only returned in
GETrequests ifview=FULLis set.
- readiness_check¶
Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.
Only returned in
GETrequests ifview=FULLis set.
- liveness_check¶
Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances
Only returned in
GETrequests ifview=FULLis set.
- nobuild_files_regex¶
Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
Only returned in
GETrequests ifview=FULLis set.- Type
- deployment¶
Code and application artifacts that make up this version.
Only returned in
GETrequests ifview=FULLis set.
- version_url¶
Serving URL for this version. Example:
“https://myversion-dot-myservice-dot-myapp.appspot.com”
@OutputOnly
- Type
- endpoints_api_service¶
Cloud Endpoints configuration.
If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
- entrypoint¶
The entrypoint for the application.
- vpc_access_connector¶
Enables VPC connectivity for standard apps.
- class BetaSettingsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class BuildEnvVariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class EnvVariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.appengine_admin_v1.types.VersionView(value)[source]¶
Bases:
proto.enums.EnumFields 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 inGetorListby default.
- class google.cloud.appengine_admin_v1.types.Volume(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVolumes mounted within the app container. Only applicable in the App Engine flexible environment.
- class google.cloud.appengine_admin_v1.types.VpcAccessConnector(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageVPC access connector specification.
- name¶
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- Type
- egress_setting¶
The egress setting for the connector, controlling what traffic is diverted through it.
- class EgressSetting(value)[source]¶
Bases:
proto.enums.EnumAvailable egress settings.
This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_IP_RANGES will be used.
- Values:
- EGRESS_SETTING_UNSPECIFIED (0):
No description available.
- ALL_TRAFFIC (1):
Force the use of VPC Access for all egress traffic from the function.
- PRIVATE_IP_RANGES (2):
Use the VPC Access Connector for private IP space from RFC1918.
- class google.cloud.appengine_admin_v1.types.ZipInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe zip file information for a zip deployment.
- 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
