Package com.google.cloud.scheduler.v1beta1

Class AppEngineRouting

  • All Implemented Interfaces:
    AppEngineRoutingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AppEngineRouting
extends com.google.protobuf.GeneratedMessageV3
implements AppEngineRoutingOrBuilder
     App Engine Routing.

 For more information about services, versions, and instances see
 [An Overview of App
 Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
 [Microservices Architecture on Google App
 Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
 [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).
    Protobuf type google.cloud.scheduler.v1beta1.AppEngineRouting
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AppEngineRouting.Builder
      App Engine Routing.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int HOST_FIELD_NUMBER  
      static int INSTANCE_FIELD_NUMBER  
      static int SERVICE_FIELD_NUMBER  
      static int VERSION_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getService

        public 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;
        Specified by:
        getService in interface AppEngineRoutingOrBuilder
        Returns:
        The service.

      • getServiceBytes

        public 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;
        Specified by:
        getServiceBytes in interface AppEngineRoutingOrBuilder
        Returns:
        The bytes for service.

      • getVersion

        public 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;
        Specified by:
        getVersion in interface AppEngineRoutingOrBuilder
        Returns:
        The version.

      • getVersionBytes

        public 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;
        Specified by:
        getVersionBytes in interface AppEngineRoutingOrBuilder
        Returns:
        The bytes for version.

      • getInstance

        public 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;
        Specified by:
        getInstance in interface AppEngineRoutingOrBuilder
        Returns:
        The instance.

      • getInstanceBytes

        public 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;
        Specified by:
        getInstanceBytes in interface AppEngineRoutingOrBuilder
        Returns:
        The bytes for instance.

      • getHost

        public 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.v1beta1.AppEngineRouting.service]

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

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

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

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

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

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


 If [service][google.cloud.scheduler.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.AppEngineRouting.service],
 [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version], or
 [instance][google.cloud.scheduler.v1beta1.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;
        Specified by:
        getHost in interface AppEngineRoutingOrBuilder
        Returns:
        The host.

      • getHostBytes

        public 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.v1beta1.AppEngineRouting.service]

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

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

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

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

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

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


 If [service][google.cloud.scheduler.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.AppEngineRouting.service],
 [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version], or
 [instance][google.cloud.scheduler.v1beta1.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;
        Specified by:
        getHostBytes in interface AppEngineRoutingOrBuilder
        Returns:
        The bytes for host.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AppEngineRouting parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineRouting parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineRouting parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineRouting parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineRouting parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineRouting parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AppEngineRouting parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AppEngineRouting.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AppEngineRouting.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AppEngineRouting.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AppEngineRouting> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AppEngineRouting getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder