Package com.google.cloud.tasks.v2beta2

Interface AppEngineRoutingOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AppEngineRouting, AppEngineRouting.Builder
    public interface AppEngineRoutingOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getHost()
      Output only.
      com.google.protobuf.ByteString getHostBytes()
      Output only.
      String getInstance()
      App instance.
      com.google.protobuf.ByteString getInstanceBytes()
      App instance.
      String getService()
      App service.
      com.google.protobuf.ByteString getServiceBytes()
      App service.
      String getVersion()
      App version.
      com.google.protobuf.ByteString getVersionBytes()
      App version.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getService

        String getService()
         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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is
 not parsable into
 [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable,
 then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the
 empty string.
        string service = 1;
        Returns:
        The service.

      • getServiceBytes

        com.google.protobuf.ByteString getServiceBytes()
         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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is
 not parsable into
 [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable,
 then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the
 empty string.
        string service = 1;
        Returns:
        The bytes for service.

      • getVersion

        String getVersion()
         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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is
 not parsable into
 [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable,
 then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the
 empty string.
        string version = 2;
        Returns:
        The version.

      • getVersionBytes

        com.google.protobuf.ByteString getVersionBytes()
         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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is
 not parsable into
 [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable,
 then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the
 empty string.
        string version = 2;
        Returns:
        The bytes for version.

      • getInstance

        String getInstance()
         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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
 App Engine Flex does not support instances. For more information, see
 [App Engine Standard request
 routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
 and [App Engine Flex request
 routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
        string instance = 3;
        Returns:
        The instance.

      • getInstanceBytes

        com.google.protobuf.ByteString getInstanceBytes()
         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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
 App Engine Flex does not support instances. For more information, see
 [App Engine Standard request
 routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
 and [App Engine Flex request
 routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
        string instance = 3;
        Returns:
        The bytes for instance.

      • getHost

        String getHost()
         Output only. The host that the task is sent to.

 For more information, see
 [How Requests are
 Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

 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
   queue's project ID. Some tasks which were created using the App Engine
   SDK use a custom domain name.

 * `service =`
 [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

 * `version =`
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]

 * `version_dot_service =`
   [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +`
   [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

 * `instance =`
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]

 * `instance_dot_service =`
   [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.'
   +` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

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

 * `instance_dot_version_dot_service =`
   [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.'
   +` [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.'
   +` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

 If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is empty,
 then the task will be sent to the service which is the default service when
 the task is attempted.

 If [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] is empty,
 then the task will be sent to the version which is the default version when
 the task is attempted.

 If [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is
 empty, then the task will be sent to an instance which is available when
 the task is attempted.

 If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], or
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is
 invalid, then the task will be sent to the default version of the default
 service when the task is attempted.
        string host = 4;
        Returns:
        The host.

      • getHostBytes

        com.google.protobuf.ByteString getHostBytes()
         Output only. The host that the task is sent to.

 For more information, see
 [How Requests are
 Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

 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
   queue's project ID. Some tasks which were created using the App Engine
   SDK use a custom domain name.

 * `service =`
 [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

 * `version =`
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]

 * `version_dot_service =`
   [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +`
   [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

 * `instance =`
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]

 * `instance_dot_service =`
   [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.'
   +` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

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

 * `instance_dot_version_dot_service =`
   [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.'
   +` [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.'
   +` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]

 If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is empty,
 then the task will be sent to the service which is the default service when
 the task is attempted.

 If [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] is empty,
 then the task will be sent to the version which is the default version when
 the task is attempted.

 If [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is
 empty, then the task will be sent to an instance which is available when
 the task is attempted.

 If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
 [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], or
 [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is
 invalid, then the task will be sent to the default version of the default
 service when the task is attempted.
        string host = 4;
        Returns:
        The bytes for host.