Patch

Updates the specified Application resource

24 variables
11 variables

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services

Input

This building block consumes 24 input parameters

  = Parameter name
  = Format

appsId STRING Required

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

updateMask ANY

Standard field mask for the set of fields to be updated

dispatchRules[] OBJECT

Rules to match an HTTP request and dispatch that request to a service

dispatchRules[].path STRING

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

dispatchRules[].domain STRING

Domain name to match against. The wildcard "" is supported if specified before a period: ".".Defaults to matching all domains: "*"

dispatchRules[].service STRING

Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default

gcrDomain STRING

The Google Container Registry domain used for storing managed build docker images for this application

name STRING

Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly

defaultCookieExpiration ANY

Cookie expiration policy for this application

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

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)

servingStatus ENUMERATION

Serving status of this application

defaultHostname STRING

Hostname used to reach this application, as resolved by App Engine.@OutputOnly

featureSettings OBJECT

The feature specific settings to be used in the application. These define behaviors that are user configurable

featureSettings.useContainerOptimizedOs BOOLEAN

If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image

featureSettings.splitHealthChecks BOOLEAN

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

authDomain STRING

Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account

iap OBJECT

Identity-Aware Proxy

iap.oauth2ClientSecret STRING

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_sha256 field.@InputOnly

iap.oauth2ClientId STRING

OAuth2 client ID to use for the authentication flow

iap.oauth2ClientSecretSha256 STRING

Hex-encoded SHA-256 hash of the client secret.@OutputOnly

iap.enabled BOOLEAN

Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty

codeBucket STRING

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

defaultBucket STRING

Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly

Output

This building block provides 11 output parameters

  = Parameter name
  = Format

error OBJECT

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors)

error.code INTEGER

The status code, which should be an enum value of google.rpc.Code

error.message STRING

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client

error.details[] OBJECT

error.details[].customKey.value ANY

metadata OBJECT

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any

metadata.customKey.value ANY

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any

done BOOLEAN

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available

response OBJECT

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

response.customKey.value ANY

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse

name STRING

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}