Class: Google::Apis::CloudtasksV2beta2::AppEngineRouting

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2beta2/classes.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb,
generated/google/apis/cloudtasks_v2beta2/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AppEngineRouting

Returns a new instance of AppEngineRouting.



378
379
380
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 378

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#hostString

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 .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name.
  • 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 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. Corresponds to the JSON property host

Returns:

  • (String)


322
323
324
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 322

def host
  @host
end

#instanceString

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. Corresponds to the JSON property instance

Returns:

  • (String)


340
341
342
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 340

def instance
  @instance
end

#serviceString

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. Corresponds to the JSON property service

Returns:

  • (String)


358
359
360
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 358

def service
  @service
end

#versionString

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. Corresponds to the JSON property version

Returns:

  • (String)


376
377
378
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 376

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



383
384
385
386
387
388
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 383

def update!(**args)
  @host = args[:host] if args.key?(:host)
  @instance = args[:instance] if args.key?(:instance)
  @service = args[:service] if args.key?(:service)
  @version = args[:version] if args.key?(:version)
end