Class AppEngineRouting (2.6.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.

Protobuf type google.cloud.tasks.v2beta2.AppEngineRouting

Inheritance

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

Static Fields

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_FIELD_NUMBER

public static final int INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AppEngineRouting getDefaultInstance()
Returns
TypeDescription
AppEngineRouting

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AppEngineRouting.Builder newBuilder()
Returns
TypeDescription
AppEngineRouting.Builder

newBuilder(AppEngineRouting )

public static AppEngineRouting.Builder newBuilder(AppEngineRouting )
Parameter
NameDescription
AppEngineRouting
Returns
TypeDescription
AppEngineRouting.Builder

parseDelimitedFrom(InputStream input)

public static AppEngineRouting parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppEngineRouting parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AppEngineRouting parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AppEngineRouting parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AppEngineRouting parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AppEngineRouting parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AppEngineRouting parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AppEngineRouting parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AppEngineRouting parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppEngineRouting parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AppEngineRouting parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AppEngineRouting parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppEngineRouting
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AppEngineRouting> parser()
Returns
TypeDescription
Parser<AppEngineRouting>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AppEngineRouting getDefaultInstanceForType()
Returns
TypeDescription
AppEngineRouting

getHost()

public String getHost()

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

The host.

getHostBytes()

public ByteString getHostBytes()

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for instance.

getParserForType()

public Parser<AppEngineRouting> getParserForType()
Returns
TypeDescription
Parser<AppEngineRouting>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for service.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for version.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AppEngineRouting.Builder newBuilderForType()
Returns
TypeDescription
AppEngineRouting.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AppEngineRouting.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AppEngineRouting.Builder toBuilder()
Returns
TypeDescription
AppEngineRouting.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
OverridesExceptions
TypeDescription
IOException