Class AppEngineRouting.Builder (2.1.11)

public static final class AppEngineRouting.Builder extends GeneratedMessageV3.Builder<AppEngineRouting.Builder> 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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AppEngineRouting.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

build()

public AppEngineRouting build()
Returns
TypeDescription
AppEngineRouting

buildPartial()

public AppEngineRouting buildPartial()
Returns
TypeDescription
AppEngineRouting

clear()

public AppEngineRouting.Builder clear()
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AppEngineRouting.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

clearHost()

public AppEngineRouting.Builder clearHost()

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
AppEngineRouting.Builder

This builder for chaining.

clearInstance()

public AppEngineRouting.Builder clearInstance()

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
AppEngineRouting.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AppEngineRouting.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

clearService()

public AppEngineRouting.Builder clearService()

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
AppEngineRouting.Builder

This builder for chaining.

clearVersion()

public AppEngineRouting.Builder clearVersion()

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
AppEngineRouting.Builder

This builder for chaining.

clone()

public AppEngineRouting.Builder clone()
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

getDefaultInstanceForType()

public AppEngineRouting getDefaultInstanceForType()
Returns
TypeDescription
AppEngineRouting

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AppEngineRouting other)

public AppEngineRouting.Builder mergeFrom(AppEngineRouting other)
Parameter
NameDescription
otherAppEngineRouting
Returns
TypeDescription
AppEngineRouting.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AppEngineRouting.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppEngineRouting.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AppEngineRouting.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AppEngineRouting.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AppEngineRouting.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

setHost(String value)

public AppEngineRouting.Builder setHost(String value)

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;

Parameter
NameDescription
valueString

The host to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.

setHostBytes(ByteString value)

public AppEngineRouting.Builder setHostBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for host to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.

setInstance(String value)

public AppEngineRouting.Builder setInstance(String value)

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;

Parameter
NameDescription
valueString

The instance to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.

setInstanceBytes(ByteString value)

public AppEngineRouting.Builder setInstanceBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for instance to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AppEngineRouting.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

setService(String value)

public AppEngineRouting.Builder setService(String value)

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;

Parameter
NameDescription
valueString

The service to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.

setServiceBytes(ByteString value)

public AppEngineRouting.Builder setServiceBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for service to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AppEngineRouting.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AppEngineRouting.Builder
Overrides

setVersion(String value)

public AppEngineRouting.Builder setVersion(String value)

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;

Parameter
NameDescription
valueString

The version to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.

setVersionBytes(ByteString value)

public AppEngineRouting.Builder setVersionBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for version to set.

Returns
TypeDescription
AppEngineRouting.Builder

This builder for chaining.