Interface AppEngineRoutingOrBuilder (2.43.0)

Version 2.43.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.12
• 2.2.0
• 2.1.11

public interface AppEngineRoutingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getHost()

public abstract 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
Type	Description
String	The host.

getHostBytes()

public abstract 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
Type	Description
ByteString	The bytes for host.

getInstance()

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

getService()

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