Google Cloud Scheduler v1 API - Class AppEngineRouting (3.5.0)

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

Reference documentation and code samples for the Google Cloud Scheduler v1 API class AppEngineRouting.

App Engine Routing.

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.

Inheritance

object > AppEngineRouting

Namespace

Google.Cloud.Scheduler.V1

Assembly

Google.Cloud.Scheduler.V1.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 job is sent to.

For more information about how App Engine requests are routed, see here.

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 job's project ID.

  • service = [service][google.cloud.scheduler.v1.AppEngineRouting.service]

  • version = [version][google.cloud.scheduler.v1.AppEngineRouting.version]

  • version_dot_service = [version][google.cloud.scheduler.v1.AppEngineRouting.version] + '.' + [service][google.cloud.scheduler.v1.AppEngineRouting.service]

  • instance = [instance][google.cloud.scheduler.v1.AppEngineRouting.instance]

  • instance_dot_service = [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] + '.' + [service][google.cloud.scheduler.v1.AppEngineRouting.service]

  • instance_dot_version = [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] + '.' + [version][google.cloud.scheduler.v1.AppEngineRouting.version]

  • instance_dot_version_dot_service = [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] + '.' + [version][google.cloud.scheduler.v1.AppEngineRouting.version] + '.' + [service][google.cloud.scheduler.v1.AppEngineRouting.service]

If [service][google.cloud.scheduler.v1.AppEngineRouting.service] is empty, then the job will be sent to the service which is the default service when the job is attempted.

If [version][google.cloud.scheduler.v1.AppEngineRouting.version] is empty, then the job will be sent to the version which is the default version when the job is attempted.

If [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] is empty, then the job will be sent to an instance which is available when the job is attempted.

If [service][google.cloud.scheduler.v1.AppEngineRouting.service], [version][google.cloud.scheduler.v1.AppEngineRouting.version], or [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] is invalid, then the job will be sent to the default version of the default service when the job is attempted.

Property Value
Type Description
string

Instance

public string Instance { get; set; }

App instance.

By default, the job is sent to an instance which is available when the job 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 job is sent to the service which is the default service when the job is attempted.

Property Value
Type Description
string

Version

public string Version { get; set; }

App version.

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

Property Value
Type Description
string