Cloud Tasks V2beta2 API - Class Google::Cloud::Tasks::V2beta2::AppEngineRouting (v0.11.3)

Reference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#host

def host() -> ::String
Returns
  • (::String) — 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]
      | [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][google.cloud.tasks.v2beta2.AppEngineRouting.service]

    • instance_dot_version = instance + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]

    • instance_dot_version_dot_service = instance + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] + '.' + [service][google.cloud.tasks.v2beta2.AppEngineRouting.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.

#host=

def host=(value) -> ::String
Parameter
  • value (::String) — 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]
      | [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][google.cloud.tasks.v2beta2.AppEngineRouting.service]

    • instance_dot_version = instance + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]

    • instance_dot_version_dot_service = instance + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] + '.' + [service][google.cloud.tasks.v2beta2.AppEngineRouting.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.

Returns
  • (::String) — 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]
      | [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][google.cloud.tasks.v2beta2.AppEngineRouting.service]

    • instance_dot_version = instance + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]

    • instance_dot_version_dot_service = instance + '.' + [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] + '.' + [service][google.cloud.tasks.v2beta2.AppEngineRouting.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.

#instance

def instance() -> ::String
Returns

#instance=

def instance=(value) -> ::String
Parameter
Returns

#service

def service() -> ::String
Returns
  • (::String) — 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.

#service=

def service=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#version

def version() -> ::String
Returns
  • (::String) — 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.

#version=

def version=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.