Class AppEngineRouting.Builder (2.53.0) 

public static final class AppEngineRouting.Builder extends GeneratedMessageV3.Builder<AppEngineRouting.Builder> implements AppEngineRoutingOrBuilder

App Engine Routing.

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.

Protobuf type google.cloud.scheduler.v1beta1.AppEngineRouting

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AppEngineRouting.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AppEngineRouting.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AppEngineRouting.Builder
Overrides

build()

public AppEngineRouting build()
Returns
Type Description
AppEngineRouting

buildPartial()

public AppEngineRouting buildPartial()
Returns
Type Description
AppEngineRouting

clear()

public AppEngineRouting.Builder clear()
Returns
Type Description
AppEngineRouting.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public AppEngineRouting.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AppEngineRouting.Builder
Overrides

clearHost()

public AppEngineRouting.Builder clearHost()

Output only. The host that the job is sent to.

For more information about how App Engine requests are routed, see here.

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

  • 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 job will be sent to the service which is the default service when the job is attempted.

If version is empty, then the job will be sent to the version which is the default version when the job is attempted.

If instance is empty, then the job will be sent to an instance which is available when the job is attempted.

If service, version, or 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
Type Description
AppEngineRouting.Builder

This builder for chaining.

clearInstance()

public AppEngineRouting.Builder clearInstance()

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. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

string instance = 3;

Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AppEngineRouting.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AppEngineRouting.Builder
Overrides

clearService()

public AppEngineRouting.Builder clearService()

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
Type Description
AppEngineRouting.Builder

This builder for chaining.

clearVersion()

public AppEngineRouting.Builder clearVersion()

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
Type Description
AppEngineRouting.Builder

This builder for chaining.

clone()

public AppEngineRouting.Builder clone()
Returns
Type Description
AppEngineRouting.Builder
Overrides

getDefaultInstanceForType()

public AppEngineRouting getDefaultInstanceForType()
Returns
Type Description
AppEngineRouting

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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

  • 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 job will be sent to the service which is the default service when the job is attempted.

If version is empty, then the job will be sent to the version which is the default version when the job is attempted.

If instance is empty, then the job will be sent to an instance which is available when the job is attempted.

If service, version, or 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
Type Description
String

The host.

getHostBytes()

public ByteString getHostBytes()

Output only. The host that the job is sent to.

For more information about how App Engine requests are routed, see here.

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

  • 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 job will be sent to the service which is the default service when the job is attempted.

If version is empty, then the job will be sent to the version which is the default version when the job is attempted.

If instance is empty, then the job will be sent to an instance which is available when the job is attempted.

If service, version, or 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
Type Description
ByteString

The bytes for host.

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. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

string instance = 3;

Returns
Type Description
String

The instance.

getInstanceBytes()

public 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. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

string instance = 3;

Returns
Type Description
ByteString

The bytes for instance.

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;

Returns
Type Description
String

The service.

getServiceBytes()

public 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
Type Description
ByteString

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;

Returns
Type Description
String

The version.

getVersionBytes()

public 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
Type Description
ByteString

The bytes for version.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AppEngineRouting other)

public AppEngineRouting.Builder mergeFrom(AppEngineRouting other)
Parameter
Name Description
other AppEngineRouting
Returns
Type Description
AppEngineRouting.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AppEngineRouting.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineRouting.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AppEngineRouting.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AppEngineRouting.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AppEngineRouting.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AppEngineRouting.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public AppEngineRouting.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AppEngineRouting.Builder
Overrides

setHost(String value)

public AppEngineRouting.Builder setHost(String value)

Output only. The host that the job is sent to.

For more information about how App Engine requests are routed, see here.

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

  • 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 job will be sent to the service which is the default service when the job is attempted.

If version is empty, then the job will be sent to the version which is the default version when the job is attempted.

If instance is empty, then the job will be sent to an instance which is available when the job is attempted.

If service, version, or 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;

Parameter
Name Description
value String

The host to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

setHostBytes(ByteString value)

public AppEngineRouting.Builder setHostBytes(ByteString value)

Output only. The host that the job is sent to.

For more information about how App Engine requests are routed, see here.

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

  • 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 job will be sent to the service which is the default service when the job is attempted.

If version is empty, then the job will be sent to the version which is the default version when the job is attempted.

If instance is empty, then the job will be sent to an instance which is available when the job is attempted.

If service, version, or 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;

Parameter
Name Description
value ByteString

The bytes for host to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

setInstance(String value)

public AppEngineRouting.Builder setInstance(String value)

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. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

string instance = 3;

Parameter
Name Description
value String

The instance to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

setInstanceBytes(ByteString value)

public AppEngineRouting.Builder setInstanceBytes(ByteString value)

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. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.

string instance = 3;

Parameter
Name Description
value ByteString

The bytes for instance to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AppEngineRouting.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AppEngineRouting.Builder
Overrides

setService(String value)

public AppEngineRouting.Builder setService(String value)

App service.

By default, the job is sent to the service which is the default service when the job is attempted.

string service = 1;

Parameter
Name Description
value String

The service to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

setServiceBytes(ByteString value)

public AppEngineRouting.Builder setServiceBytes(ByteString value)

App service.

By default, the job is sent to the service which is the default service when the job is attempted.

string service = 1;

Parameter
Name Description
value ByteString

The bytes for service to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AppEngineRouting.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AppEngineRouting.Builder
Overrides

setVersion(String value)

public AppEngineRouting.Builder setVersion(String value)

App version.

By default, the job is sent to the version which is the default version when the job is attempted.

string version = 2;

Parameter
Name Description
value String

The version to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.

setVersionBytes(ByteString value)

public AppEngineRouting.Builder setVersionBytes(ByteString value)

App version.

By default, the job is sent to the version which is the default version when the job is attempted.

string version = 2;

Parameter
Name Description
value ByteString

The bytes for version to set.
Returns
Type Description
AppEngineRouting.Builder

This builder for chaining.