- Resource: Application
- UrlDispatchRule
- ServingStatus
- IdentityAwareProxy
- DatabaseType
- FeatureSettings
- Methods
Resource: Application
An Application resource contains the top-level configuration of an App Engine application.
JSON representation |
---|
{ "name": string, "id": string, "dispatchRules": [ { object ( |
Fields | |
---|---|
name |
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: |
dispatchRules[] |
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. |
authDomain |
Google Apps authentication domain that controls which users can access this application. Defaults to open access for any Google Account. |
locationId |
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. |
codeBucket |
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. |
defaultCookieExpiration |
Cookie expiration policy for this application. A duration in seconds with up to nine fractional digits, ending with ' |
servingStatus |
Serving status of this application. |
defaultHostname |
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. |
defaultBucket |
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. |
iap |
|
gcrDomain |
The Google Container Registry domain used for storing managed build docker images for this application. |
databaseType |
The type of the Cloud Firestore or Cloud Datastore database associated with this application. |
featureSettings |
The feature specific settings to be used in the application. |
UrlDispatchRule
Rules to match an HTTP request and dispatch that request to a service.
JSON representation |
---|
{ "domain": string, "path": string, "service": string } |
Fields | |
---|---|
domain |
Domain name to match against. The wildcard " Defaults to matching all domains: " |
path |
Pathname within the host. Must start with a " The sum of the lengths of the domain and path may not exceed 100 characters. |
service |
Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: |
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. |
IdentityAwareProxy
Identity-Aware Proxy
JSON representation |
---|
{ "enabled": boolean, "oauth2ClientId": string, "oauth2ClientSecret": string, "oauth2ClientSecretSha256": string } |
Fields | |
---|---|
enabled |
Whether the serving infrastructure will authenticate and authorize all incoming requests. If true, the |
oauth2ClientId |
OAuth2 client ID to use for the authentication flow. |
oauth2ClientSecret |
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 |
oauth2ClientSecretSha256 |
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. |
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.
JSON representation |
---|
{ "splitHealthChecks": boolean, "useContainerOptimizedOs": boolean } |
Fields | |
---|---|
splitHealthChecks |
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 'readinessCheck' and 'livenessCheck' values instead of 'healthCheck' ones. Once the legacy 'healthCheck' behavior is deprecated, and this value is always true, this setting can be removed. |
useContainerOptimizedOs |
If true, use Container-Optimized OS base image for VMs, rather than a base Debian image. |
Methods |
|
---|---|
|
Creates an App Engine application for a Google Cloud Platform project. |
|
Gets information about an application. |
|
Updates the specified Application resource. |
|
Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. |