Package com.google.cloud.scheduler.v1

Interface AppEngineRoutingOrBuilder

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

  • Method Summary

    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 Details

    • getService

      String getService()
       App service.

 By default, the job is sent to the service which is the default
 service when the job is attempted.
      string service = 1;
      Returns:
      The service.

    • getServiceBytes

      com.google.protobuf.ByteString getServiceBytes()
       App service.

 By default, the job is sent to the service which is the default
 service when the job is attempted.
      string service = 1;
      Returns:
      The bytes for service.

    • getVersion

      String getVersion()
       App version.

 By default, the job is sent to the version which is the default
 version when the job is attempted.
      string version = 2;
      Returns:
      The version.

    • getVersionBytes

      com.google.protobuf.ByteString getVersionBytes()
       App version.

 By default, the job is sent to the version which is the default
 version when the job is attempted.
      string version = 2;
      Returns:
      The bytes for version.

    • getInstance

      String 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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#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 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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#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 job is sent to.

 For more information about how App Engine requests are routed, see
 [here](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
 job's project ID.

 * `service =` [service][google.cloud.scheduler.v1.AppEngineRouting.service]

 * `version =` [version][google.cloud.scheduler.v1.AppEngineRouting.version]

 * `version_dot_service =`
 [version][google.cloud.scheduler.v1.AppEngineRouting.version] `+ '.' +`
 [service][google.cloud.scheduler.v1.AppEngineRouting.service]

 * `instance =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance]

 * `instance_dot_service =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] `+ '.' +`
 [service][google.cloud.scheduler.v1.AppEngineRouting.service]

 * `instance_dot_version =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] `+ '.' +`
 [version][google.cloud.scheduler.v1.AppEngineRouting.version]

 * `instance_dot_version_dot_service =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] `+ '.' +`
 [version][google.cloud.scheduler.v1.AppEngineRouting.version] `+ '.' +`
 [service][google.cloud.scheduler.v1.AppEngineRouting.service]


 If [service][google.cloud.scheduler.v1.AppEngineRouting.service] is empty,
 then the job will be sent to the service which is the default service when
 the job is attempted.

 If [version][google.cloud.scheduler.v1.AppEngineRouting.version] is empty,
 then the job will be sent to the version which is the default version when
 the job is attempted.

 If [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] is
 empty, then the job will be sent to an instance which is available when the
 job is attempted.

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

    • getHostBytes

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

 For more information about how App Engine requests are routed, see
 [here](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
 job's project ID.

 * `service =` [service][google.cloud.scheduler.v1.AppEngineRouting.service]

 * `version =` [version][google.cloud.scheduler.v1.AppEngineRouting.version]

 * `version_dot_service =`
 [version][google.cloud.scheduler.v1.AppEngineRouting.version] `+ '.' +`
 [service][google.cloud.scheduler.v1.AppEngineRouting.service]

 * `instance =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance]

 * `instance_dot_service =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] `+ '.' +`
 [service][google.cloud.scheduler.v1.AppEngineRouting.service]

 * `instance_dot_version =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] `+ '.' +`
 [version][google.cloud.scheduler.v1.AppEngineRouting.version]

 * `instance_dot_version_dot_service =`
 [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] `+ '.' +`
 [version][google.cloud.scheduler.v1.AppEngineRouting.version] `+ '.' +`
 [service][google.cloud.scheduler.v1.AppEngineRouting.service]


 If [service][google.cloud.scheduler.v1.AppEngineRouting.service] is empty,
 then the job will be sent to the service which is the default service when
 the job is attempted.

 If [version][google.cloud.scheduler.v1.AppEngineRouting.version] is empty,
 then the job will be sent to the version which is the default version when
 the job is attempted.

 If [instance][google.cloud.scheduler.v1.AppEngineRouting.instance] is
 empty, then the job will be sent to an instance which is available when the
 job is attempted.

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