Index
Applications
(interface)AuthorizedCertificates
(interface)AuthorizedDomains
(interface)DomainMappings
(interface)Firewall
(interface)Instances
(interface)Services
(interface)Versions
(interface)ApiConfigHandler
(message)ApiEndpointHandler
(message)Application
(message)Application.DatabaseType
(enum)Application.FeatureSettings
(message)Application.IdentityAwareProxy
(message)Application.ServingStatus
(enum)AuthFailAction
(enum)AuthorizedCertificate
(message)AuthorizedCertificateView
(enum)AuthorizedDomain
(message)AutomaticScaling
(message)BasicScaling
(message)BatchUpdateIngressRulesRequest
(message)BatchUpdateIngressRulesResponse
(message)CertificateRawData
(message)CloudBuildOptions
(message)ContainerInfo
(message)CpuUtilization
(message)CreateApplicationRequest
(message)CreateAuthorizedCertificateRequest
(message)CreateDomainMappingRequest
(message)CreateIngressRuleRequest
(message)CreateVersionMetadataV1
(message)CreateVersionRequest
(message)DebugInstanceRequest
(message)DeleteAuthorizedCertificateRequest
(message)DeleteDomainMappingRequest
(message)DeleteIngressRuleRequest
(message)DeleteInstanceRequest
(message)DeleteServiceRequest
(message)DeleteVersionRequest
(message)Deployment
(message)DiskUtilization
(message)DomainMapping
(message)DomainOverrideStrategy
(enum)EndpointsApiService
(message)EndpointsApiService.RolloutStrategy
(enum)Entrypoint
(message)ErrorHandler
(message)ErrorHandler.ErrorCode
(enum)FileInfo
(message)FirewallRule
(message)FirewallRule.Action
(enum)FlexibleRuntimeSettings
(message)GetApplicationRequest
(message)GetAuthorizedCertificateRequest
(message)GetDomainMappingRequest
(message)GetIngressRuleRequest
(message)GetInstanceRequest
(message)GetServiceRequest
(message)GetVersionRequest
(message)HealthCheck
(message)InboundServiceType
(enum)Instance
(message)Instance.Availability
(enum)Instance.Liveness
(message)Instance.Liveness.LivenessState
(enum)Library
(message)ListAuthorizedCertificatesRequest
(message)ListAuthorizedCertificatesResponse
(message)ListAuthorizedDomainsRequest
(message)ListAuthorizedDomainsResponse
(message)ListDomainMappingsRequest
(message)ListDomainMappingsResponse
(message)ListIngressRulesRequest
(message)ListIngressRulesResponse
(message)ListInstancesRequest
(message)ListInstancesResponse
(message)ListServicesRequest
(message)ListServicesResponse
(message)ListVersionsRequest
(message)ListVersionsResponse
(message)LivenessCheck
(message)LocationMetadata
(message)LoginRequirement
(enum)ManagedCertificate
(message)ManagementStatus
(enum)ManualScaling
(message)Network
(message)NetworkSettings
(message)NetworkSettings.IngressTrafficAllowed
(enum)NetworkUtilization
(message)OperationMetadataV1
(message)ReadinessCheck
(message)RepairApplicationRequest
(message)RequestUtilization
(message)ResourceRecord
(message)ResourceRecord.RecordType
(enum)Resources
(message)ScriptHandler
(message)SecurityLevel
(enum)Service
(message)ServingStatus
(enum)SslSettings
(message)SslSettings.SslManagementType
(enum)StandardSchedulerSettings
(message)StaticFilesHandler
(message)TrafficSplit
(message)TrafficSplit.ShardBy
(enum)UpdateApplicationRequest
(message)UpdateAuthorizedCertificateRequest
(message)UpdateDomainMappingRequest
(message)UpdateIngressRuleRequest
(message)UpdateServiceRequest
(message)UpdateVersionRequest
(message)UrlDispatchRule
(message)UrlMap
(message)UrlMap.RedirectHttpResponseCode
(enum)Version
(message)VersionView
(enum)Volume
(message)VpcAccessConnector
(message)VpcAccessConnector.EgressSetting
(enum)ZipInfo
(message)
Applications
Manages App Engine applications.
CreateApplication |
---|
Creates an App Engine application for a Google Cloud Platform project. Required fields:
For more information about App Engine applications, see Managing Projects, Applications, and Billing.
|
GetApplication |
---|
Gets information about an application.
|
RepairApplication |
---|
Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.
|
UpdateApplication |
---|
Updates the specified Application resource. You can update the following fields:
|
AuthorizedCertificates
Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.
CreateAuthorizedCertificate |
---|
Uploads the specified SSL certificate.
|
DeleteAuthorizedCertificate |
---|
Deletes the specified SSL certificate.
|
GetAuthorizedCertificate |
---|
Gets the specified SSL certificate.
|
ListAuthorizedCertificates |
---|
Lists all SSL certificates the user is authorized to administer.
|
UpdateAuthorizedCertificate |
---|
Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update
|
AuthorizedDomains
Manages domains a user is authorized to administer. To authorize use of a domain, verify ownership via Search Console.
ListAuthorizedDomains |
---|
Lists all domains the user is authorized to administer.
|
DomainMappings
Manages domains serving an application.
CreateDomainMapping |
---|
Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see
|
DeleteDomainMapping |
---|
Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a
|
GetDomainMapping |
---|
Gets the specified domain mapping.
|
ListDomainMappings |
---|
Lists the domain mappings on an application.
|
UpdateDomainMapping |
---|
Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update
|
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.
BatchUpdateIngressRules |
---|
Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules. If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.
|
CreateIngressRule |
---|
Creates a firewall rule for the application.
|
DeleteIngressRule |
---|
Deletes the specified firewall rule.
|
GetIngressRule |
---|
Gets the specified firewall rule.
|
ListIngressRules |
---|
Lists the firewall rules of an application.
|
UpdateIngressRule |
---|
Updates the specified firewall rule.
|
Instances
Manages instances of a version.
DebugInstance |
---|
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment.
|
DeleteInstance |
---|
Stops a running instance. The instance might be automatically recreated based on the scaling settings of the version. For more information, see "How Instances are Managed" (standard environment | flexible environment). To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to
|
GetInstance |
---|
Gets instance information.
|
ListInstances |
---|
Lists the instances of a version. Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API.
|
Services
Manages services of an application.
DeleteService |
---|
Deletes the specified service and all enclosed versions.
|
GetService |
---|
Gets the current configuration of the specified service.
|
ListServices |
---|
Lists all the services in the application.
|
UpdateService |
---|
Updates the configuration of the specified service.
|
Versions
Manages versions of a service.
CreateVersion |
---|
Deploys code and resource files to a new version.
|
DeleteVersion |
---|
Deletes an existing Version resource.
|
GetVersion |
---|
Gets the specified Version resource. By default, only a
|
ListVersions |
---|
Lists the versions of a service.
|
UpdateVersion |
---|
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: Standard environment automatic scaling in the standard environment:
basic scaling or manual scaling in the standard environment: Flexible environment automatic scaling in the flexible environment:
manual scaling in the flexible environment:
|
ApiConfigHandler
Google Cloud Endpoints configuration for API handlers.
Fields | |
---|---|
auth_fail_action |
Action to take when users access resources that require authentication. Defaults to |
login |
Level of login required to access this resource. Defaults to |
script |
Path to the script from the application root directory. |
security_level |
Security (HTTPS) enforcement for this URL. |
url |
URL to serve the endpoint at. |
ApiEndpointHandler
Uses Google Cloud Endpoints to handle requests.
Fields | |
---|---|
script_path |
Path to the script from the application root directory. |
Application
An Application resource contains the top-level configuration of an App Engine application.
Fields | |
---|---|
name |
Output only. Full path to the Application resource in the API. Example: Note: This field is used in responses only. Any value specified here in a request is ignored. |
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: |
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. |
auth_domain |
Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account. |
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 View the list of supported locations. |
code_bucket |
Output only. 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. Note: This field is used in responses only. Any value specified here in a request is ignored. |
default_cookie_expiration |
Cookie expiration policy for this application. |
serving_status |
Serving status of this application. |
default_hostname |
Output only. Hostname used to reach this application, as resolved by App Engine. Note: This field is used in responses only. Any value specified here in a request is ignored. |
default_bucket |
Output only. Google Cloud Storage bucket that can be used by this application to store content. Note: This field is used in responses only. Any value specified here in a request is ignored. |
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. |
iap |
|
gcr_domain |
Output only. The Google Container Registry domain used for storing managed build docker images for this application. |
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. |
DatabaseType
Enums | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
Database type is unspecified. |
CLOUD_DATASTORE |
Cloud Datastore |
CLOUD_FIRESTORE |
Cloud Firestore Native |
CLOUD_DATASTORE_COMPATIBILITY |
Cloud Firestore in Datastore Mode |
FeatureSettings
The feature specific settings to be used in the application. These define behaviors that are user configurable.
Fields | |
---|---|
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. |
use_container_optimized_os |
If true, use Container-Optimized OS base image for VMs, rather than a base Debian image. |
IdentityAwareProxy
Identity-Aware Proxy
Fields | |
---|---|
enabled |
Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the |
oauth2_client_id |
OAuth2 client ID to use for the authentication flow. |
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 @InputOnly |
oauth2_client_secret_sha256 |
Output only. Hex-encoded SHA-256 hash of the client secret. Note: This field is used in responses only. Any value specified here in a request is ignored. |
ServingStatus
Enums | |
---|---|
UNSPECIFIED |
Serving status is unspecified. |
SERVING |
Application is serving. |
USER_DISABLED |
Application has been disabled by the user. |
SYSTEM_DISABLED |
Application has been disabled by the system. |
AuthFailAction
Actions to take when the user is not logged in.
Enums | |
---|---|
AUTH_FAIL_ACTION_UNSPECIFIED |
Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed. |
AUTH_FAIL_ACTION_REDIRECT |
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 |
Rejects request with a 401 HTTP status code and an error message. |
AuthorizedCertificate
An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
Fields | |
---|---|
name |
Full path to the Note: This field is used in responses only. Any value specified here in a request is ignored. |
id |
Relative name of the certificate. This is a unique value autogenerated on Note: This field is used in responses only. Any value specified here in a request is ignored. |
display_name |
The user-specified display name of the certificate. This is not guaranteed to be unique. Example: |
domain_names[] |
Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: Note: This field is used in responses only. Any value specified here in a request is ignored. |
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 Note: This field is used in responses only. Any value specified here in a request is ignored. |
certificate_raw_data |
The SSL certificate serving the |
managed_certificate |
Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a Note: This field is used in responses only. Any value specified here in a request is ignored. |
visible_domain_mappings[] |
The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: This may not represent the full list of mapped domain mappings if the user does not have Only returned by Note: This field is used in responses only. Any value specified here in a request is ignored. |
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 Only returned by Note: This field is used in responses only. Any value specified here in a request is ignored. |
AuthorizedCertificateView
Fields that should be returned when an AuthorizedCertificate resource is retrieved.
Enums | |
---|---|
BASIC_CERTIFICATE |
Basic certificate information, including applicable domains and expiration date. |
FULL_CERTIFICATE |
The information from BASIC_CERTIFICATE , plus detailed information on the domain mappings that have this certificate mapped. |
AuthorizedDomain
A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console.
Fields | |
---|---|
name |
Full path to the Note: This field is used in responses only. Any value specified here in a request is ignored. |
id |
Fully qualified domain name of the domain authorized for use. Example: |
AutomaticScaling
Automatic scaling is based on request rate, response latencies, and other application metrics.
Fields | |
---|---|
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. |
max_idle_instances |
Maximum number of idle instances that should be maintained for this version. |
max_total_instances |
Maximum number of instances that should be started to handle requests for this version. |
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. |
min_total_instances |
Minimum number of running instances that should be maintained for this version. |
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. |
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.
Fields | |
---|---|
idle_timeout |
Duration of time after the last request that an instance must wait before the instance is shut down. |
max_instances |
Maximum number of instances to create for this version. |
BatchUpdateIngressRulesRequest
Request message for Firewall.BatchUpdateIngressRules
.
Fields | |
---|---|
name |
Name of the Firewall collection to set. Example: Authorization requires the following IAM permission on the specified resource
|
ingress_rules[] |
A list of FirewallRules to replace the existing set. |
BatchUpdateIngressRulesResponse
Response message for Firewall.UpdateAllIngressRules
.
Fields | |
---|---|
ingress_rules[] |
The full list of ingress FirewallRules for this application. |
CertificateRawData
An SSL certificate obtained from a certificate authority.
Fields | |
---|---|
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----- |
private_key |
Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- @InputOnly |
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.
Fields | |
---|---|
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. |
cloud_build_timeout |
The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. |
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.
Fields | |
---|---|
image |
URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest" |
CpuUtilization
Target scaling by CPU usage.
Fields | |
---|---|
aggregation_window_length |
Period of time over which CPU utilization is calculated. |
target_utilization |
Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1. |
CreateApplicationRequest
Request message for Applications.CreateApplication
.
Fields | |
---|---|
application |
Application configuration. Authorization requires the following IAM permission on the specified resource
|
CreateAuthorizedCertificateRequest
Request message for AuthorizedCertificates.CreateAuthorizedCertificate
.
Fields | |
---|---|
parent |
Name of the parent Authorization requires the following IAM permission on the specified resource
|
certificate |
SSL certificate data. |
CreateDomainMappingRequest
Request message for DomainMappings.CreateDomainMapping
.
Fields | |
---|---|
parent |
Name of the parent Application resource. Example: Authorization requires the following IAM permission on the specified resource
|
domain_mapping |
Domain mapping configuration. |
override_strategy |
Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. |
CreateIngressRuleRequest
Request message for Firewall.CreateIngressRule
.
Fields | |
---|---|
parent |
Name of the parent Firewall collection in which to create a new rule. Example: Authorization requires the following IAM permission on the specified resource
|
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. |
CreateVersionMetadataV1
Metadata for the given google.longrunning.Operation
during a google.appengine.v1.CreateVersionRequest
.
Fields | |
---|---|
cloud_build_id |
The Cloud Build ID if one was created as part of the version create. Note: This field is used in responses only. Any value specified here in a request is ignored. |
CreateVersionRequest
Request message for Versions.CreateVersion
.
Fields | |
---|---|
parent |
Name of the parent resource to create this version under. Example: Authorization requires the following IAM permission on the specified resource
|
version |
Application deployment configuration. |
DebugInstanceRequest
Request message for Instances.DebugInstance
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
ssh_key |
Public SSH key to add to the instance. Examples:
For more information, see Adding and Removing SSH Keys. Authorization requires the following IAM permission on the specified resource
|
DeleteAuthorizedCertificateRequest
Request message for AuthorizedCertificates.DeleteAuthorizedCertificate
.
Fields | |
---|---|
name |
Name of the resource to delete. Example: Authorization requires the following IAM permission on the specified resource
|
DeleteDomainMappingRequest
Request message for DomainMappings.DeleteDomainMapping
.
Fields | |
---|---|
name |
Name of the resource to delete. Example: Authorization requires the following IAM permission on the specified resource
|
DeleteIngressRuleRequest
Request message for Firewall.DeleteIngressRule
.
Fields | |
---|---|
name |
Name of the Firewall resource to delete. Example: Authorization requires the following IAM permission on the specified resource
|
DeleteInstanceRequest
Request message for Instances.DeleteInstance
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
DeleteServiceRequest
Request message for Services.DeleteService
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
DeleteVersionRequest
Request message for Versions.DeleteVersion
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
Deployment
Code and application artifacts used to deploy a version to App Engine.
Fields | |
---|---|
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. |
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. |
DiskUtilization
Target scaling by disk usage. Only applicable in the App Engine flexible environment.
Fields | |
---|---|
target_write_bytes_per_second |
Target bytes written per second. |
target_write_ops_per_second |
Target ops written per second. |
target_read_bytes_per_second |
Target bytes read per second. |
target_read_ops_per_second |
Target ops read per seconds. |
DomainMapping
A domain serving an App Engine application.
Fields | |
---|---|
name |
Full path to the Note: This field is used in responses only. Any value specified here in a request is ignored. |
id |
Relative name of the domain serving the application. Example: |
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. Note: This field is used in responses only. Any value specified here in a request is ignored. |
DomainOverrideStrategy
Override strategy for mutating an existing mapping.
Enums | |
---|---|
UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY |
Strategy unspecified. Defaults to STRICT . |
STRICT |
Overrides not allowed. If a mapping already exists for the specified domain, the request will return an ALREADY_EXISTS (409). |
OVERRIDE |
Overrides allowed. If a mapping already exists for the specified domain, the request will overwrite it. Note that this might stop another Google product from serving. For example, if the domain is mapped to another App Engine application, that app will no longer serve from that domain. |
EndpointsApiService
Google 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.
Fields | |
---|---|
name |
Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog" |
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 Endpoints also has a rollout strategy called |
rollout_strategy |
Endpoints rollout strategy. If |
disable_trace_sampling |
Enable or disable trace sampling. By default, this is set to false for enabled. |
RolloutStrategy
Available rollout strategies.
Enums | |
---|---|
UNSPECIFIED_ROLLOUT_STRATEGY |
Not specified. Defaults to FIXED . |
FIXED |
Endpoints service configuration ID will be fixed to the configuration ID specified by config_id . |
MANAGED |
Endpoints service configuration ID will be updated with each rollout. |
Entrypoint
The entrypoint for the application.
Fields | |
---|---|
shell |
The format should be a shell command that can be fed to |
ErrorHandler
Custom static error page to be served when an error occurs.
Fields | |
---|---|
error_code |
Error condition this handler applies to. |
static_file |
Static file content to be served for this error. |
mime_type |
MIME type of file. Defaults to |
ErrorCode
Error codes.
Enums | |
---|---|
ERROR_CODE_UNSPECIFIED |
Not specified. ERROR_CODE_DEFAULT is assumed. |
ERROR_CODE_DEFAULT |
All other error types. |
ERROR_CODE_OVER_QUOTA |
Application has exceeded a resource quota. |
ERROR_CODE_DOS_API_DENIAL |
Client blocked by the application's Denial of Service protection configuration. |
ERROR_CODE_TIMEOUT |
Deadline reached before the application responds. |
FileInfo
Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
Fields | |
---|---|
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>'. |
sha1_sum |
The SHA1 hash of the file, in hex. |
mime_type |
The MIME type of the file. Defaults to the value from Google Cloud Storage. |
FirewallRule
A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.
Fields | |
---|---|
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. |
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: Truncation will be silently performed on addresses which are not properly truncated. For example, |
description |
An optional string description of this rule. This field has a maximum length of 400 characters. |
Action
Available actions to take on matching requests.
Enums | |
---|---|
UNSPECIFIED_ACTION |
|
ALLOW |
Matching requests are allowed. |
DENY |
Matching requests are denied. |
FlexibleRuntimeSettings
Runtime settings for the App Engine flexible environment.
Fields | |
---|---|
operating_system |
The operating system of the application runtime. |
runtime_version |
The runtime version of an App Engine flexible application. |
GetApplicationRequest
Request message for Applications.GetApplication
.
Fields | |
---|---|
name |
Name of the Application resource to get. Example: Authorization requires the following IAM permission on the specified resource
|
GetAuthorizedCertificateRequest
Request message for AuthorizedCertificates.GetAuthorizedCertificate
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
view |
Controls the set of fields returned in the |
GetDomainMappingRequest
Request message for DomainMappings.GetDomainMapping
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
GetIngressRuleRequest
Request message for Firewall.GetIngressRule
.
Fields | |
---|---|
name |
Name of the Firewall resource to retrieve. Example: Authorization requires the following IAM permission on the specified resource
|
GetInstanceRequest
Request message for Instances.GetInstance
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
GetServiceRequest
Request message for Services.GetService
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
GetVersionRequest
Request message for Versions.GetVersion
.
Fields | |
---|---|
name |
Name of the resource requested. Example: Authorization requires the following IAM permission on the specified resource
|
view |
Controls the set of fields returned in the |
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.
Fields | |
---|---|
disable_health_check |
Whether to explicitly disable health checks for this instance. |
host |
Host header to send when performing an HTTP health check. Example: "myapp.appspot.com" |
healthy_threshold |
Number of consecutive successful health checks required before receiving traffic. |
unhealthy_threshold |
Number of consecutive failed health checks required before removing traffic. |
restart_threshold |
Number of consecutive failed health checks required before an instance is restarted. |
check_interval |
Interval between health checks. |
timeout |
Time before the health check is considered failed. |
InboundServiceType
Available inbound services.
Enums | |
---|---|
INBOUND_SERVICE_UNSPECIFIED |
Not specified. |
INBOUND_SERVICE_MAIL |
Allows an application to receive mail. |
INBOUND_SERVICE_MAIL_BOUNCE |
Allows an application to receive email-bound notifications. |
INBOUND_SERVICE_XMPP_ERROR |
Allows an application to receive error stanzas. |
INBOUND_SERVICE_XMPP_MESSAGE |
Allows an application to receive instant messages. |
INBOUND_SERVICE_XMPP_SUBSCRIBE |
Allows an application to receive user subscription POSTs. |
INBOUND_SERVICE_XMPP_PRESENCE |
Allows an application to receive a user's chat presence. |
INBOUND_SERVICE_CHANNEL_PRESENCE |
Registers an application for notifications when a client connects or disconnects from a channel. |
INBOUND_SERVICE_WARMUP |
Enables warmup requests. |
Instance
An Instance resource is the computing unit that App Engine uses to automatically scale an application.
Fields | |
---|---|
name |
Output only. Full path to the Instance resource in the API. Example: |
id |
Output only. Relative name of the instance within the version. Example: |
app_engine_release |
Output only. App Engine release this instance is running on. |
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. |
vm_zone_name |
Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. |
vm_id |
Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. |
start_time |
Output only. Time that this instance was started. Note: This field is used in responses only. Any value specified here in a request is ignored. |
requests |
Output only. Number of requests since this instance was started. |
errors |
Output only. Number of errors since this instance was started. |
qps |
Output only. Average queries per second (QPS) over the last minute. |
average_latency |
Output only. Average latency (ms) over the last minute. |
memory_usage |
Output only. Total memory in use (bytes). |
vm_status |
Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. |
vm_debug_enabled |
Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. |
vm_ip |
Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment. |
vm_liveness |
Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment. |
Availability
Availability of the instance.
Enums | |
---|---|
UNSPECIFIED |
|
RESIDENT |
|
DYNAMIC |
Liveness
Wrapper for LivenessState enum.
LivenessState
Liveness health check status for Flex instances.
Enums | |
---|---|
LIVENESS_STATE_UNSPECIFIED |
There is no liveness health check for the instance. Only applicable for instances in App Engine standard environment. |
UNKNOWN |
The health checking system is aware of the instance but its health is not known at the moment. |
HEALTHY |
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 |
The instance is reachable, but does not conform to the requirements defined by the health check. |
DRAINING |
The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused. |
TIMEOUT |
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. |
Library
Third-party Python runtime library that is required by the application.
Fields | |
---|---|
name |
Name of the library. Example: "django". |
version |
Version of the library to select, or "latest". |
ListAuthorizedCertificatesRequest
Request message for AuthorizedCertificates.ListAuthorizedCertificates
.
Fields | |
---|---|
parent |
Name of the parent Authorization requires the following IAM permission on the specified resource
|
view |
Controls the set of fields returned in the |
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListAuthorizedCertificatesResponse
Response message for AuthorizedCertificates.ListAuthorizedCertificates
.
Fields | |
---|---|
certificates[] |
The SSL certificates the user is authorized to administer. |
next_page_token |
Continuation token for fetching the next page of results. |
ListAuthorizedDomainsRequest
Request message for AuthorizedDomains.ListAuthorizedDomains
.
Fields | |
---|---|
parent |
Name of the parent Application resource. Example: Authorization requires the following IAM permission on the specified resource
|
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListAuthorizedDomainsResponse
Response message for AuthorizedDomains.ListAuthorizedDomains
.
Fields | |
---|---|
domains[] |
The authorized domains belonging to the user. |
next_page_token |
Continuation token for fetching the next page of results. |
ListDomainMappingsRequest
Request message for DomainMappings.ListDomainMappings
.
Fields | |
---|---|
parent |
Name of the parent Application resource. Example: Authorization requires the following IAM permission on the specified resource
|
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListDomainMappingsResponse
Response message for DomainMappings.ListDomainMappings
.
Fields | |
---|---|
domain_mappings[] |
The domain mappings for the application. |
next_page_token |
Continuation token for fetching the next page of results. |
ListIngressRulesRequest
Request message for Firewall.ListIngressRules
.
Fields | |
---|---|
parent |
Name of the Firewall collection to retrieve. Example: Authorization requires the following IAM permission on the specified resource
|
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
matching_address |
A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP. |
ListIngressRulesResponse
Response message for Firewall.ListIngressRules
.
Fields | |
---|---|
ingress_rules[] |
The ingress FirewallRules for this application. |
next_page_token |
Continuation token for fetching the next page of results. |
ListInstancesRequest
Request message for Instances.ListInstances
.
Fields | |
---|---|
parent |
Name of the parent Version resource. Example: Authorization requires the following IAM permission on the specified resource
|
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListInstancesResponse
Response message for Instances.ListInstances
.
Fields | |
---|---|
instances[] |
The instances belonging to the requested version. |
next_page_token |
Continuation token for fetching the next page of results. |
ListServicesRequest
Request message for Services.ListServices
.
Fields | |
---|---|
parent |
Name of the parent Application resource. Example: Authorization requires the following IAM permission on the specified resource
|
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListServicesResponse
Response message for Services.ListServices
.
Fields | |
---|---|
services[] |
The services belonging to the requested application. |
next_page_token |
Continuation token for fetching the next page of results. |
ListVersionsRequest
Request message for Versions.ListVersions
.
Fields | |
---|---|
parent |
Name of the parent Service resource. Example: Authorization requires the following IAM permission on the specified resource
|
view |
Controls the set of fields returned in the |
page_size |
Maximum results to return per page. |
page_token |
Continuation token for fetching the next page of results. |
ListVersionsResponse
Response message for Versions.ListVersions
.
Fields | |
---|---|
versions[] |
The versions belonging to the requested service. |
next_page_token |
Continuation token for fetching the next page of results. |
LivenessCheck
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.
Fields | |
---|---|
path |
The request path. |
host |
Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com" |
failure_threshold |
Number of consecutive failed checks required before considering the VM unhealthy. |
success_threshold |
Number of consecutive successful checks required before considering the VM healthy. |
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. |
LocationMetadata
Metadata for the given google.cloud.location.Location
.
Fields | |
---|---|
standard_environment_available |
App Engine standard environment is available in the given location. Note: This field is used in responses only. Any value specified here in a request is ignored. |
flexible_environment_available |
App Engine flexible environment is available in the given location. Note: This field is used in responses only. Any value specified here in a request is ignored. |
search_api_available |
Output only. Search API is available in the given location. |
LoginRequirement
Methods to restrict access to a URL based on login status.
Enums | |
---|---|
LOGIN_UNSPECIFIED |
Not specified. LOGIN_OPTIONAL is assumed. |