Class AppEngineRouting (2.42.0) 

public final class AppEngineRouting extends GeneratedMessageV3 implements AppEngineRoutingOrBuilder

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.

Using AppEngineRouting requires appengine.applications.get Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

Protobuf type google.cloud.tasks.v2.AppEngineRouting

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AppEngineRouting

Static Fields

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AppEngineRouting getDefaultInstance()
Returns
Type Description
AppEngineRouting

getDescriptor()

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

newBuilder()

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

newBuilder(AppEngineRouting prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public AppEngineRouting getDefaultInstanceForType()
Returns
Type Description
AppEngineRouting

getHost()

public String getHost()

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

The host is constructed from the domain name of the app associated with the queue's project ID (for example <app-id>.appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name.

For more information, see How Requests are Routed.

string host = 4;

Returns
Type Description
String

The host.

getHostBytes()

public ByteString getHostBytes()

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

The host is constructed from the domain name of the app associated with the queue's project ID (for example <app-id>.appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name.

For more information, see How Requests are Routed.

string host = 4;

Returns
Type Description
ByteString

The bytes for host.

getInstance()

public String getInstance()

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()

public ByteString getInstanceBytes()

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()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getService()

public String getService()

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()

public ByteString getServiceBytes()

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()

public String getVersion()

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()

public ByteString getVersionBytes()

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()

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 AppEngineRouting.Builder newBuilderForType()
Returns
Type Description
AppEngineRouting.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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