Class Application (2.54.0)

public final class Application extends GeneratedMessageV3 implements ApplicationOrBuilder

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

Protobuf type google.appengine.v1.Application

Static Fields

AUTH_DOMAIN_FIELD_NUMBER

public static final int AUTH_DOMAIN_FIELD_NUMBER
Field Value
Type Description
int

CODE_BUCKET_FIELD_NUMBER

public static final int CODE_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_TYPE_FIELD_NUMBER

public static final int DATABASE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_BUCKET_FIELD_NUMBER

public static final int DEFAULT_BUCKET_FIELD_NUMBER
Field Value
Type Description
int
public static final int DEFAULT_COOKIE_EXPIRATION_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_HOSTNAME_FIELD_NUMBER

public static final int DEFAULT_HOSTNAME_FIELD_NUMBER
Field Value
Type Description
int

DISPATCH_RULES_FIELD_NUMBER

public static final int DISPATCH_RULES_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_SETTINGS_FIELD_NUMBER

public static final int FEATURE_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

GCR_DOMAIN_FIELD_NUMBER

public static final int GCR_DOMAIN_FIELD_NUMBER
Field Value
Type Description
int

IAP_FIELD_NUMBER

public static final int IAP_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SERVING_STATUS_FIELD_NUMBER

public static final int SERVING_STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Application getDefaultInstance()
Returns
Type Description
Application

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Application.Builder newBuilder()
Returns
Type Description
Application.Builder

newBuilder(Application prototype)

public static Application.Builder newBuilder(Application prototype)
Parameter
Name Description
prototype Application
Returns
Type Description
Application.Builder

parseDelimitedFrom(InputStream input)

public static Application parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Application
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Application parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Application
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Application parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Application
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Application parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Application
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Application parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Application
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Application parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Application
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Application parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Application
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Application parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Application
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Application parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Application
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Application parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Application
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Application parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Application
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Application parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Application
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Application> parser()
Returns
Type Description
Parser<Application>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAuthDomain()

public String getAuthDomain()

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

Defaults to open access for any Google Account.

string auth_domain = 6;

Returns
Type Description
String

The authDomain.

getAuthDomainBytes()

public ByteString getAuthDomainBytes()

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

Defaults to open access for any Google Account.

string auth_domain = 6;

Returns
Type Description
ByteString

The bytes for authDomain.

getCodeBucket()

public String 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

string code_bucket = 8;

Returns
Type Description
String

The codeBucket.

getCodeBucketBytes()

public ByteString getCodeBucketBytes()

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

string code_bucket = 8;

Returns
Type Description
ByteString

The bytes for codeBucket.

getDatabaseType()

public Application.DatabaseType getDatabaseType()

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

.google.appengine.v1.Application.DatabaseType database_type = 17;

Returns
Type Description
Application.DatabaseType

The databaseType.

getDatabaseTypeValue()

public int getDatabaseTypeValue()

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

.google.appengine.v1.Application.DatabaseType database_type = 17;

Returns
Type Description
int

The enum numeric value on the wire for databaseType.

getDefaultBucket()

public String getDefaultBucket()

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

@OutputOnly

string default_bucket = 12;

Returns
Type Description
String

The defaultBucket.

getDefaultBucketBytes()

public ByteString getDefaultBucketBytes()

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

@OutputOnly

string default_bucket = 12;

Returns
Type Description
ByteString

The bytes for defaultBucket.

getDefaultCookieExpiration()

public Duration getDefaultCookieExpiration()

Cookie expiration policy for this application.

.google.protobuf.Duration default_cookie_expiration = 9;

Returns
Type Description
Duration

The defaultCookieExpiration.

getDefaultCookieExpirationOrBuilder()

public DurationOrBuilder getDefaultCookieExpirationOrBuilder()

Cookie expiration policy for this application.

.google.protobuf.Duration default_cookie_expiration = 9;

Returns
Type Description
DurationOrBuilder

getDefaultHostname()

public String getDefaultHostname()

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

@OutputOnly

string default_hostname = 11;

Returns
Type Description
String

The defaultHostname.

getDefaultHostnameBytes()

public ByteString getDefaultHostnameBytes()

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

@OutputOnly

string default_hostname = 11;

Returns
Type Description
ByteString

The bytes for defaultHostname.

getDefaultInstanceForType()

public Application getDefaultInstanceForType()
Returns
Type Description
Application

getDispatchRules(int index)

public UrlDispatchRule getDispatchRules(int index)

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.

repeated .google.appengine.v1.UrlDispatchRule dispatch_rules = 3;

Parameter
Name Description
index int
Returns
Type Description
UrlDispatchRule

getDispatchRulesCount()

public int getDispatchRulesCount()

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.

repeated .google.appengine.v1.UrlDispatchRule dispatch_rules = 3;

Returns
Type Description
int

getDispatchRulesList()

public List<UrlDispatchRule> getDispatchRulesList()

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.

repeated .google.appengine.v1.UrlDispatchRule dispatch_rules = 3;

Returns
Type Description
List<UrlDispatchRule>

getDispatchRulesOrBuilder(int index)

public UrlDispatchRuleOrBuilder getDispatchRulesOrBuilder(int index)

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.

repeated .google.appengine.v1.UrlDispatchRule dispatch_rules = 3;

Parameter
Name Description
index int
Returns
Type Description
UrlDispatchRuleOrBuilder

getDispatchRulesOrBuilderList()

public List<? extends UrlDispatchRuleOrBuilder> getDispatchRulesOrBuilderList()

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.

repeated .google.appengine.v1.UrlDispatchRule dispatch_rules = 3;

Returns
Type Description
List<? extends com.google.appengine.v1.UrlDispatchRuleOrBuilder>

getFeatureSettings()

public Application.FeatureSettings getFeatureSettings()

The feature specific settings to be used in the application.

.google.appengine.v1.Application.FeatureSettings feature_settings = 18;

Returns
Type Description
Application.FeatureSettings

The featureSettings.

getFeatureSettingsOrBuilder()

public Application.FeatureSettingsOrBuilder getFeatureSettingsOrBuilder()

The feature specific settings to be used in the application.

.google.appengine.v1.Application.FeatureSettings feature_settings = 18;

Returns
Type Description
Application.FeatureSettingsOrBuilder

getGcrDomain()

public String getGcrDomain()

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

string gcr_domain = 16;

Returns
Type Description
String

The gcrDomain.

getGcrDomainBytes()

public ByteString getGcrDomainBytes()

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

string gcr_domain = 16;

Returns
Type Description
ByteString

The bytes for gcrDomain.

getIap()

public Application.IdentityAwareProxy getIap()

.google.appengine.v1.Application.IdentityAwareProxy iap = 14;

Returns
Type Description
Application.IdentityAwareProxy

The iap.

getIapOrBuilder()

public Application.IdentityAwareProxyOrBuilder getIapOrBuilder()

.google.appengine.v1.Application.IdentityAwareProxy iap = 14;

Returns
Type Description
Application.IdentityAwareProxyOrBuilder

getId()

public String 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.

string id = 2;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

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.

string id = 2;

Returns
Type Description
ByteString

The bytes for id.

getLocationId()

public String 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.

string location_id = 7;

Returns
Type Description
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

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.

string location_id = 7;

Returns
Type Description
ByteString

The bytes for locationId.

getName()

public String getName()

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

@OutputOnly

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

@OutputOnly

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Application> getParserForType()
Returns
Type Description
Parser<Application>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String 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.

string service_account = 13;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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.

string service_account = 13;

Returns
Type Description
ByteString

The bytes for serviceAccount.

getServingStatus()

public Application.ServingStatus getServingStatus()

Serving status of this application.

.google.appengine.v1.Application.ServingStatus serving_status = 10;

Returns
Type Description
Application.ServingStatus

The servingStatus.

getServingStatusValue()

public int getServingStatusValue()

Serving status of this application.

.google.appengine.v1.Application.ServingStatus serving_status = 10;

Returns
Type Description
int

The enum numeric value on the wire for servingStatus.

hasDefaultCookieExpiration()

public boolean hasDefaultCookieExpiration()

Cookie expiration policy for this application.

.google.protobuf.Duration default_cookie_expiration = 9;

Returns
Type Description
boolean

Whether the defaultCookieExpiration field is set.

hasFeatureSettings()

public boolean hasFeatureSettings()

The feature specific settings to be used in the application.

.google.appengine.v1.Application.FeatureSettings feature_settings = 18;

Returns
Type Description
boolean

Whether the featureSettings field is set.

hasIap()

public boolean hasIap()

.google.appengine.v1.Application.IdentityAwareProxy iap = 14;

Returns
Type Description
boolean

Whether the iap field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Application.Builder newBuilderForType()
Returns
Type Description
Application.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Application.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Application.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Application.Builder toBuilder()
Returns
Type Description
Application.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException