apps

Creates, updates, deletes, gets or lists a apps resource.

Overview

Name	apps
Type	Resource
Id	google.appengine.apps

Fields

Name	Datatype	Description
id	string	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.
name	string	Output only. Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
authDomain	string	Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
codeBucket	string	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.@OutputOnly
databaseType	string	The type of the Cloud Firestore or Cloud Datastore database associated with this application.
defaultBucket	string	Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
defaultCookieExpiration	string	Cookie expiration policy for this application.
defaultHostname	string	Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly
dispatchRules	array	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.
featureSettings	object	The feature specific settings to be used in the application. These define behaviors that are user configurable.
gcrDomain	string	Output only. The Google Container Registry domain used for storing managed build docker images for this application.
generatedCustomerMetadata	object	Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
iap	object	Identity-Aware Proxy
locationId	string	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 (https://cloud.google.com/appengine/docs/locations).
serviceAccount	string	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.
servingStatus	string	Serving status of this application.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	appsId	Gets information about an application.
create	INSERT		Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/).
patch	UPDATE	appsId	Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.
repair	EXEC	appsId	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.

SELECT examples

Gets information about an application.

SELECT
id,
name,
authDomain,
codeBucket,
databaseType,
defaultBucket,
defaultCookieExpiration,
defaultHostname,
dispatchRules,
featureSettings,
gcrDomain,
generatedCustomerMetadata,
iap,
locationId,
serviceAccount,
servingStatus
FROM google.appengine.apps
WHERE appsId = '{{ appsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new apps resource.

All Properties

/*+ create */
INSERT INTO google.appengine.apps (
dispatchRules,
authDomain,
locationId,
defaultCookieExpiration,
servingStatus,
serviceAccount,
iap,
databaseType,
featureSettings,
generatedCustomerMetadata
)
SELECT 
'{{ dispatchRules }}',
'{{ authDomain }}',
'{{ locationId }}',
'{{ defaultCookieExpiration }}',
'{{ servingStatus }}',
'{{ serviceAccount }}',
'{{ iap }}',
'{{ databaseType }}',
'{{ featureSettings }}',
'{{ generatedCustomerMetadata }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: id
      value: string
    - name: dispatchRules
      value:
        - - name: domain
            value: string
          - name: path
            value: string
          - name: service
            value: string
    - name: authDomain
      value: string
    - name: locationId
      value: string
    - name: codeBucket
      value: string
    - name: defaultCookieExpiration
      value: string
    - name: servingStatus
      value: string
    - name: defaultHostname
      value: string
    - name: defaultBucket
      value: string
    - name: serviceAccount
      value: string
    - name: iap
      value:
        - name: enabled
          value: boolean
        - name: oauth2ClientId
          value: string
        - name: oauth2ClientSecret
          value: string
        - name: oauth2ClientSecretSha256
          value: string
    - name: gcrDomain
      value: string
    - name: databaseType
      value: string
    - name: featureSettings
      value:
        - name: splitHealthChecks
          value: boolean
        - name: useContainerOptimizedOs
          value: boolean
    - name: generatedCustomerMetadata
      value: object

UPDATE example

Updates a apps resource.

/*+ update */
UPDATE google.appengine.apps
SET 
dispatchRules = '{{ dispatchRules }}',
authDomain = '{{ authDomain }}',
locationId = '{{ locationId }}',
defaultCookieExpiration = '{{ defaultCookieExpiration }}',
servingStatus = '{{ servingStatus }}',
serviceAccount = '{{ serviceAccount }}',
iap = '{{ iap }}',
databaseType = '{{ databaseType }}',
featureSettings = '{{ featureSettings }}',
generatedCustomerMetadata = '{{ generatedCustomerMetadata }}'
WHERE 
appsId = '{{ appsId }}';