Google Cloud Tasks v2 API - Class AppEngineRouting (3.3.0)

public sealed class AppEngineRouting : IMessage<AppEngineRouting>, IEquatable<AppEngineRouting>, IDeepCloneable<AppEngineRouting>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Tasks v2 API class AppEngineRouting.

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][google.cloud.tasks.v2.AppEngineRouting] requires appengine.applications.get Google IAM permission for the project and the following scope:

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

Inheritance

object > AppEngineRouting

Implements

IMessage AppEngineRouting, IEquatable AppEngineRouting, IDeepCloneable AppEngineRouting, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Tasks.V2

Assembly

Google.Cloud.Tasks.V2.dll

Constructors

AppEngineRouting()

public AppEngineRouting()

AppEngineRouting(AppEngineRouting)

public AppEngineRouting(AppEngineRouting other)

Parameter
Name	Description
`other`	`AppEngineRouting`

Properties

Host

public string Host { get; set; }

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][google.cloud.tasks.v2.AppEngineRouting.service], [version][google.cloud.tasks.v2.AppEngineRouting.version], and [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. Tasks which were created using the App Engine SDK might have a custom domain name.

For more information, see How Requests are Routed.

Property Value
Type	Description
`string`

Instance

public string Instance { get; set; }

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.

Property Value
Type	Description
`string`

Service

public string Service { get; set; }

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][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable into [service][google.cloud.tasks.v2.AppEngineRouting.service], [version][google.cloud.tasks.v2.AppEngineRouting.version], and [instance][google.cloud.tasks.v2.AppEngineRouting.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][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable, then [service][google.cloud.tasks.v2.AppEngineRouting.service], [version][google.cloud.tasks.v2.AppEngineRouting.version], and [instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty string.

Property Value
Type	Description
`string`

Version

public string Version { get; set; }

App version.

By default, the task is sent to the version which is the default version when the task is attempted.

Property Value
Type	Description
`string`