Cloud Scheduler V1 Client - Class AppEngineRouting (1.10.4)

Reference documentation and code samples for the Cloud Scheduler V1 Client 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.

Generated from protobuf message google.cloud.scheduler.v1.AppEngineRouting

Namespace

Google \ Cloud \ Scheduler \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ service string

App service. By default, the job is sent to the service which is the default service when the job is attempted.
↳ version string

App version. By default, the job is sent to the version which is the default version when the job is attempted.
↳ instance string

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.
↳ host string

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]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name] * application_domain_name = The domain name of the app, for example

getService

App service.

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

Returns
Type Description
string

setService

App service.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getVersion

App version.

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

Returns
Type Description
string

setVersion

App version.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getInstance

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.

Returns
Type Description
string

setInstance

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getHost

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]
    | [service] + '.' + [application_domain_name]
    | [version] + '.' + [application_domain_name]
    | [version_dot_service]+ '.' + [application_domain_name]
    | [instance] + '.' + [application_domain_name]
    | [instance_dot_service] + '.' + [application_domain_name]
    | [instance_dot_version] + '.' + [application_domain_name]
    | [instance_dot_version_dot_service] + '.' + [application_domain_name]
  • application_domain_name = The domain name of the app, for example
  • 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 job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted.
Returns
Type Description
string

setHost

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]
    | [service] + '.' + [application_domain_name]
    | [version] + '.' + [application_domain_name]
    | [version_dot_service]+ '.' + [application_domain_name]
    | [instance] + '.' + [application_domain_name]
    | [instance_dot_service] + '.' + [application_domain_name]
    | [instance_dot_version] + '.' + [application_domain_name]
    | [instance_dot_version_dot_service] + '.' + [application_domain_name]
  • application_domain_name = The domain name of the app, for example
  • 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 job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted.
Parameter
Name Description
var string
Returns
Type Description
$this