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

↳ iap Google\Cloud\AppEngine\V1\Application\IdentityAwareProxy
↳ 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
TypeDescription
string

setName

Full path to the Application resource in the API.

Example: apps/myapp. @OutputOnly

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Internal\RepeatedField

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
NameDescription
var array<Google\Cloud\AppEngine\V1\UrlDispatchRule>
Returns
TypeDescription
$this

getAuthDomain

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

Defaults to open access for any Google Account.

Returns
TypeDescription
string

setAuthDomain

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

Defaults to open access for any Google Account.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDefaultCookieExpiration

Cookie expiration policy for this application.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasDefaultCookieExpiration

clearDefaultCookieExpiration

setDefaultCookieExpiration

Cookie expiration policy for this application.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getServingStatus

Serving status of this application.

Returns
TypeDescription
int

setServingStatus

Serving status of this application.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDefaultHostname

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

@OutputOnly

Returns
TypeDescription
string

setDefaultHostname

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

@OutputOnly

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDefaultBucket

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

@OutputOnly

Returns
TypeDescription
string

setDefaultBucket

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

@OutputOnly

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getIap

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

Returns
TypeDescription
Google\Cloud\AppEngine\V1\Application\IdentityAwareProxy|null

hasIap

clearIap

setIap

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

Parameter
NameDescription
var Google\Cloud\AppEngine\V1\Application\IdentityAwareProxy
Returns
TypeDescription
$this

getGcrDomain

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

Returns
TypeDescription
string

setGcrDomain

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDatabaseType

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

Returns
TypeDescription
int

setDatabaseType

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFeatureSettings

The feature specific settings to be used in the application.

Returns
TypeDescription
Google\Cloud\AppEngine\V1\Application\FeatureSettings|null

hasFeatureSettings

clearFeatureSettings

setFeatureSettings

The feature specific settings to be used in the application.

Parameter
NameDescription
var Google\Cloud\AppEngine\V1\Application\FeatureSettings
Returns
TypeDescription
$this