Class: Google::Apis::CloudtasksV2::AppEngineRouting

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2/classes.rb,
generated/google/apis/cloudtasks_v2/representations.rb,
generated/google/apis/cloudtasks_v2/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. Using AppEngineRouting requires appengine.applications.get Google IAM permission for the project and the following scope: https://www.googleapis.com/auth/cloud-platform

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.


203
204
205
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 203

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

Instance Attribute Details

#hostString

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 .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed. Corresponds to the JSON property host

Returns:

  • (String)

166
167
168
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 166

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)

179
180
181
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 179

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)

190
191
192
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 190

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)

201
202
203
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 201

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


208
209
210
211
212
213
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 208

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