Class AppEngineRouting (2.36.0) 

publicfinalclass AppEngineRoutingextendsGeneratedMessageV3implementsAppEngineRoutingOrBuilder

App Engine Routing.

Defines routing characteristics specific to App Engine - service, version, and instance.

For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing.

Protobuf type google.cloud.tasks.v2beta2.AppEngineRouting

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

HOST_FIELD_NUMBER

publicstaticfinalintHOST_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

publicstaticfinalintINSTANCE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

publicstaticfinalintSERVICE_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

publicstaticfinalintVERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticAppEngineRoutinggetDefaultInstance()
Returns
Type Description
AppEngineRouting

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticAppEngineRouting.BuildernewBuilder()
Returns
Type Description
AppEngineRouting.Builder

newBuilder(AppEngineRouting prototype)

publicstaticAppEngineRouting.BuildernewBuilder(AppEngineRoutingprototype)
Parameter
Name Description
prototype AppEngineRouting
Returns
Type Description
AppEngineRouting.Builder

parseDelimitedFrom(InputStream input)

publicstaticAppEngineRoutingparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticAppEngineRoutingparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticAppEngineRoutingparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticAppEngineRoutingparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticAppEngineRoutingparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticAppEngineRoutingparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticAppEngineRoutingparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticAppEngineRoutingparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticAppEngineRoutingparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticAppEngineRoutingparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticAppEngineRoutingparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticAppEngineRoutingparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineRouting
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<AppEngineRouting>parser()
Returns
Type Description
Parser<AppEngineRouting>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicAppEngineRoutinggetDefaultInstanceForType()
Returns
Type Description
AppEngineRouting

getHost()

publicStringgetHost()

Output only. The host that the task is sent to.

For more information, see How Requests are Routed.

The host is constructed as:

  • host = [application_domain_name]</br> | [service] + '.' + [application_domain_name]</br> | [version] + '.' + [application_domain_name]</br> | [version_dot_service]+ '.' + [application_domain_name]</br> | [instance] + '.' + [application_domain_name]</br> | [instance_dot_service] + '.' + [application_domain_name]</br> | [instance_dot_version] + '.' + [application_domain_name]</br> | [instance_dot_version_dot_service] + '.' + [application_domain_name]

  • application_domain_name = The domain name of the app, for example <app-id>.appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name.

  • service = service

  • version = version

  • version_dot_service = version + '.' + service

  • instance = instance

  • instance_dot_service = instance + '.' + service

  • instance_dot_version = instance + '.' + version

  • instance_dot_version_dot_service = instance + '.' + version + '.' + service

    If service is empty, then the task will be sent to the service which is the default service when the task is attempted.

    If version is empty, then the task will be sent to the version which is the default version when the task is attempted.

    If instance is empty, then the task will be sent to an instance which is available when the task is attempted.

    If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.

string host = 4;

Returns
Type Description
String

The host.

getHostBytes()

publicByteStringgetHostBytes()

Output only. The host that the task is sent to.

For more information, see How Requests are Routed.

The host is constructed as:

  • host = [application_domain_name]</br> | [service] + '.' + [application_domain_name]</br> | [version] + '.' + [application_domain_name]</br> | [version_dot_service]+ '.' + [application_domain_name]</br> | [instance] + '.' + [application_domain_name]</br> | [instance_dot_service] + '.' + [application_domain_name]</br> | [instance_dot_version] + '.' + [application_domain_name]</br> | [instance_dot_version_dot_service] + '.' + [application_domain_name]

  • application_domain_name = The domain name of the app, for example <app-id>.appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name.

  • service = service

  • version = version

  • version_dot_service = version + '.' + service

  • instance = instance

  • instance_dot_service = instance + '.' + service

  • instance_dot_version = instance + '.' + version

  • instance_dot_version_dot_service = instance + '.' + version + '.' + service

    If service is empty, then the task will be sent to the service which is the default service when the task is attempted.

    If version is empty, then the task will be sent to the version which is the default version when the task is attempted.

    If instance is empty, then the task will be sent to an instance which is available when the task is attempted.

    If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.

string host = 4;

Returns
Type Description
ByteString

The bytes for host.

getInstance()

publicStringgetInstance()

App instance.

By default, the task is sent to an instance which is available when the task is attempted.

Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

string instance = 3;

Returns
Type Description
String

The instance.

getInstanceBytes()

publicByteStringgetInstanceBytes()

App instance.

By default, the task is sent to an instance which is available when the task is attempted.

Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

string instance = 3;

Returns
Type Description
ByteString

The bytes for instance.

getParserForType()

publicParser<AppEngineRouting>getParserForType()
Returns
Type Description
Parser<AppEngineRouting>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getService()

publicStringgetService()

App service.

By default, the task is sent to the service which is the default service when the task is attempted.

For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.

string service = 1;

Returns
Type Description
String

The service.

getServiceBytes()

publicByteStringgetServiceBytes()

App service.

By default, the task is sent to the service which is the default service when the task is attempted.

For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.

string service = 1;

Returns
Type Description
ByteString

The bytes for service.

getVersion()

publicStringgetVersion()

App version.

By default, the task is sent to the version which is the default version when the task is attempted.

For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.

string version = 2;

Returns
Type Description
String

The version.

getVersionBytes()

publicByteStringgetVersionBytes()

App version.

By default, the task is sent to the version which is the default version when the task is attempted.

For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.

string version = 2;

Returns
Type Description
ByteString

The bytes for version.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicAppEngineRouting.BuildernewBuilderForType()
Returns
Type Description
AppEngineRouting.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedAppEngineRouting.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AppEngineRouting.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicAppEngineRouting.BuildertoBuilder()
Returns
Type Description
AppEngineRouting.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.