- 2.52.0 (latest)
- 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 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.
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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AppEngineRouting.BuilderImplements
AppEngineRoutingOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AppEngineRouting.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
build()
public AppEngineRouting build()
Returns | |
---|---|
Type | Description |
AppEngineRouting |
buildPartial()
public AppEngineRouting buildPartial()
Returns | |
---|---|
Type | Description |
AppEngineRouting |
clear()
public AppEngineRouting.Builder clear()
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
clearField(Descriptors.FieldDescriptor field)
public AppEngineRouting.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
clearHost()
public AppEngineRouting.Builder clearHost()
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 |
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 | |
---|---|
Type | Description |
AppEngineRouting.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AppEngineRouting.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
AppEngineRouting.Builder |
This builder for chaining. |
clone()
public AppEngineRouting.Builder clone()
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
getDefaultInstanceForType()
public AppEngineRouting getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AppEngineRouting |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(AppEngineRouting other)
public AppEngineRouting.Builder mergeFrom(AppEngineRouting other)
Parameter | |
---|---|
Name | Description |
other |
AppEngineRouting |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AppEngineRouting.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public AppEngineRouting.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AppEngineRouting.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public AppEngineRouting.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
setHost(String value)
public AppEngineRouting.Builder setHost(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The host to set. |
Returns | |
---|---|
Type | Description |
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.
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for host to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The instance to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for instance to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
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 | |
---|---|
Name | Description |
value |
String The service to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for service to set. |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AppEngineRouting.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
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 | |
---|---|
Name | Description |
value |
String The version to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for version to set. |
Returns | |
---|---|
Type | Description |
AppEngineRouting.Builder |
This builder for chaining. |