Google Cloud Appengine Admin V1 Client - Class Application (1.0.6)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class Application.

An Application resource contains the top-level configuration of an App Engine application.

Generated from protobuf message google.appengine.v1.Application

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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

↳ 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 .

↳ dispatch_rules
array< Google\Cloud\AppEngine\V1\UrlDispatchRule >

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
string

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

↳ location_id
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 .

↳ code_bucket
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

↳ default_cookie_expiration
Google\Protobuf\Duration

Cookie expiration policy for this application.

↳ serving_status
int

Serving status of this application.

↳ default_hostname
string

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

↳ default_bucket
string

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

↳ service_account
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.

↳ gcr_domain
string

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

↳ database_type
int

The type of the Cloud Firestore or Cloud Datastore database associated with this application.

↳ feature_settings
Google\Cloud\AppEngine\V1\Application\FeatureSettings

The feature specific settings to be used in the application.

getName

Full path to the Application resource in the API.

Example: apps/myapp . @OutputOnly

Returns
Type
Description
string

setName

Full path to the Application resource in the API.

Example: apps/myapp . @OutputOnly

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getId

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 .

Returns
Type
Description
string

setId

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 .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDispatchRules

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.

Returns
Type
Description

setDispatchRules

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.

Parameter
Name
Description
Returns
Type
Description
$this

getAuthDomain

Google Apps authentication domain that controls which users can access this application.

Defaults to open access for any Google Account.

Returns
Type
Description
string

setAuthDomain

Google Apps authentication domain that controls which users can access this application.

Defaults to open access for any Google Account.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLocationId

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 .

Returns
Type
Description
string

setLocationId

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 .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCodeBucket

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

Returns
Type
Description
string

setCodeBucket

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDefaultCookieExpiration

Cookie expiration policy for this application.

Returns
Type
Description

hasDefaultCookieExpiration

clearDefaultCookieExpiration

setDefaultCookieExpiration

Cookie expiration policy for this application.

Parameter
Name
Description
Returns
Type
Description
$this

getServingStatus

Serving status of this application.

Returns
Type
Description
int

setServingStatus

Serving status of this application.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getDefaultHostname

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

@OutputOnly

Returns
Type
Description
string

setDefaultHostname

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

@OutputOnly

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDefaultBucket

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

@OutputOnly

Returns
Type
Description
string

setDefaultBucket

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

@OutputOnly

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getServiceAccount

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.

Returns
Type
Description
string

setServiceAccount

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getIap

Generated from protobuf field .google.appengine.v1.Application.IdentityAwareProxy iap = 14;

hasIap

clearIap

setIap

Generated from protobuf field .google.appengine.v1.Application.IdentityAwareProxy iap = 14;

Returns
Type
Description
$this

getGcrDomain

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

Returns
Type
Description
string

setGcrDomain

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDatabaseType

The type of the Cloud Firestore or Cloud Datastore database associated with this application.

Returns
Type
Description
int

setDatabaseType

The type of the Cloud Firestore or Cloud Datastore database associated with this application.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getFeatureSettings

The feature specific settings to be used in the application.

hasFeatureSettings

clearFeatureSettings

setFeatureSettings

The feature specific settings to be used in the application.

Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: