Class ServiceConfig.DispatcherConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tensorflow.proto.data.experimental.ServiceConfig.DispatcherConfig

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, ServiceConfig.DispatcherConfigOrBuilder

Enclosing class:

ServiceConfig

public static final class ServiceConfig.DispatcherConfig
extends GeneratedMessageV3
implements ServiceConfig.DispatcherConfigOrBuilder

Configuration for a tf.data service DispatchServer.
Next id: 13

Protobuf type tensorflow.data.experimental.DispatcherConfig

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ServiceConfig.DispatcherConfig.Builder	Configuration for a tf.data service DispatchServer.

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLIENT_TIMEOUT_MS_FIELD_NUMBER
static final int	DEPLOYMENT_MODE_FIELD_NUMBER
static final int	FAULT_TOLERANT_MODE_FIELD_NUMBER
static final int	GC_DYNAMIC_SHARDING_JOBS_FIELD_NUMBER
static final int	JOB_GC_CHECK_INTERVAL_MS_FIELD_NUMBER
static final int	JOB_GC_TIMEOUT_MS_FIELD_NUMBER
static final int	PORT_FIELD_NUMBER
static final int	PROTOCOL_FIELD_NUMBER
static final int	WORK_DIR_FIELD_NUMBER
static final int	WORKER_ADDRESSES_FIELD_NUMBER
static final int	WORKER_MAX_CONCURRENT_SNAPSHOTS_FIELD_NUMBER
static final int	WORKER_TIMEOUT_MS_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
long	getClientTimeoutMs()	How long to wait before garbage-collecting a client that hasn't heartbeated to the dispatcher.
static ServiceConfig.DispatcherConfig	getDefaultInstance()
ServiceConfig.DispatcherConfig	getDefaultInstanceForType()
DataService.DeploymentMode	getDeploymentMode()	(Optional.) tf.data service deployment mode.
int	getDeploymentModeValue()	(Optional.) tf.data service deployment mode.
static final Descriptors.Descriptor	getDescriptor()
boolean	getFaultTolerantMode()	Whether to run in fault tolerant mode, where dispatcher state is saved across restarts.
boolean	getGcDynamicShardingJobs()	Whether dynamically sharded jobs should be eligible for garbage collection.
long	getJobGcCheckIntervalMs()	How often the dispatcher should scan through to delete old and unused jobs.
long	getJobGcTimeoutMs()	How long a job needs to be unused before it becomes a candidate for garbage collection.
Parser<ServiceConfig.DispatcherConfig>	getParserForType()
long	getPort()	The port for the dispatcher to bind to.
String	getProtocol()	The protocol for the dispatcher to use when connecting to workers.
ByteString	getProtocolBytes()	The protocol for the dispatcher to use when connecting to workers.
int	getSerializedSize()
final UnknownFieldSet	getUnknownFields()
String	getWorkDir()	A work directory to use for storing dispatcher state, and for recovering during restarts.
ByteString	getWorkDirBytes()	A work directory to use for storing dispatcher state, and for recovering during restarts.
String	getWorkerAddresses(int index)	(Optional.)
ByteString	getWorkerAddressesBytes(int index)	(Optional.)
int	getWorkerAddressesCount()	(Optional.)
ProtocolStringList	getWorkerAddressesList()	(Optional.)
long	getWorkerMaxConcurrentSnapshots()	The maximum number of snapshots that a worker can concurrently process at a given point in time.
long	getWorkerTimeoutMs()	How long to wait for a worker to heartbeat before considering it missing.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static ServiceConfig.DispatcherConfig.Builder	newBuilder()
static ServiceConfig.DispatcherConfig.Builder	newBuilder(ServiceConfig.DispatcherConfig prototype)
ServiceConfig.DispatcherConfig.Builder	newBuilderForType()
protected ServiceConfig.DispatcherConfig.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ServiceConfig.DispatcherConfig	parseDelimitedFrom(InputStream input)
static ServiceConfig.DispatcherConfig	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.DispatcherConfig	parseFrom(byte[] data)
static ServiceConfig.DispatcherConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.DispatcherConfig	parseFrom(ByteString data)
static ServiceConfig.DispatcherConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.DispatcherConfig	parseFrom(CodedInputStream input)
static ServiceConfig.DispatcherConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.DispatcherConfig	parseFrom(InputStream input)
static ServiceConfig.DispatcherConfig	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ServiceConfig.DispatcherConfig	parseFrom(ByteBuffer data)
static ServiceConfig.DispatcherConfig	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Parser<ServiceConfig.DispatcherConfig>	parser()
ServiceConfig.DispatcherConfig.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

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

Field Details

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER

See Also:

• Constant Field Values

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER

See Also:

• Constant Field Values

WORK_DIR_FIELD_NUMBER

public static final int WORK_DIR_FIELD_NUMBER

See Also:

• Constant Field Values

FAULT_TOLERANT_MODE_FIELD_NUMBER

public static final int FAULT_TOLERANT_MODE_FIELD_NUMBER

See Also:

• Constant Field Values

WORKER_ADDRESSES_FIELD_NUMBER

public static final int WORKER_ADDRESSES_FIELD_NUMBER

See Also:

• Constant Field Values

DEPLOYMENT_MODE_FIELD_NUMBER

public static final int DEPLOYMENT_MODE_FIELD_NUMBER

See Also:

• Constant Field Values

JOB_GC_CHECK_INTERVAL_MS_FIELD_NUMBER

public static final int JOB_GC_CHECK_INTERVAL_MS_FIELD_NUMBER

See Also:

• Constant Field Values

JOB_GC_TIMEOUT_MS_FIELD_NUMBER

public static final int JOB_GC_TIMEOUT_MS_FIELD_NUMBER

See Also:

• Constant Field Values

GC_DYNAMIC_SHARDING_JOBS_FIELD_NUMBER

public static final int GC_DYNAMIC_SHARDING_JOBS_FIELD_NUMBER

See Also:

• Constant Field Values

CLIENT_TIMEOUT_MS_FIELD_NUMBER

public static final int CLIENT_TIMEOUT_MS_FIELD_NUMBER

See Also:

• Constant Field Values

WORKER_TIMEOUT_MS_FIELD_NUMBER

public static final int WORKER_TIMEOUT_MS_FIELD_NUMBER

See Also:

• Constant Field Values

WORKER_MAX_CONCURRENT_SNAPSHOTS_FIELD_NUMBER

public static final int WORKER_MAX_CONCURRENT_SNAPSHOTS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getPort

public long getPort()

The port for the dispatcher to bind to. A value of 0 indicates that the
dispatcher may bind to any available port.

int64 port = 1;

Specified by:

getPort in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The port.

getProtocol

public String getProtocol()

The protocol for the dispatcher to use when connecting to workers.

string protocol = 2;

Specified by:

getProtocol in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The protocol.

getProtocolBytes

public ByteString getProtocolBytes()

The protocol for the dispatcher to use when connecting to workers.

string protocol = 2;

Specified by:

getProtocolBytes in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The bytes for protocol.

getWorkDir

public String getWorkDir()

A work directory to use for storing dispatcher state, and for recovering
during restarts. The empty string indicates not to use any work directory.

string work_dir = 3;

Specified by:

getWorkDir in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The workDir.

getWorkDirBytes

public ByteString getWorkDirBytes()

A work directory to use for storing dispatcher state, and for recovering
during restarts. The empty string indicates not to use any work directory.

string work_dir = 3;

Specified by:

getWorkDirBytes in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The bytes for workDir.

getFaultTolerantMode

public boolean getFaultTolerantMode()

Whether to run in fault tolerant mode, where dispatcher state is saved
across restarts. Requires that `work_dir` is nonempty.

bool fault_tolerant_mode = 4;

Specified by:

getFaultTolerantMode in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The faultTolerantMode.

getWorkerAddressesList

public ProtocolStringList getWorkerAddressesList()

(Optional.) If the job uses auto-sharding, it needs to specify a fixed list
of worker addresses that will register with the dispatcher. The worker
addresses should be in the format "host" or "host:port", where "port" is an
integer, named port, or %port% to match any port.

repeated string worker_addresses = 7;

Specified by:

getWorkerAddressesList in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

A list containing the workerAddresses.

getWorkerAddressesCount

public int getWorkerAddressesCount()

(Optional.) If the job uses auto-sharding, it needs to specify a fixed list
of worker addresses that will register with the dispatcher. The worker
addresses should be in the format "host" or "host:port", where "port" is an
integer, named port, or %port% to match any port.

repeated string worker_addresses = 7;

Specified by:

getWorkerAddressesCount in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The count of workerAddresses.

getWorkerAddresses

public String getWorkerAddresses(int index)

(Optional.) If the job uses auto-sharding, it needs to specify a fixed list
of worker addresses that will register with the dispatcher. The worker
addresses should be in the format "host" or "host:port", where "port" is an
integer, named port, or %port% to match any port.

repeated string worker_addresses = 7;

Specified by:

getWorkerAddresses in interface ServiceConfig.DispatcherConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The workerAddresses at the given index.

getWorkerAddressesBytes

public ByteString getWorkerAddressesBytes(int index)

(Optional.) If the job uses auto-sharding, it needs to specify a fixed list
of worker addresses that will register with the dispatcher. The worker
addresses should be in the format "host" or "host:port", where "port" is an
integer, named port, or %port% to match any port.

repeated string worker_addresses = 7;

Specified by:

getWorkerAddressesBytes in interface ServiceConfig.DispatcherConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the workerAddresses at the given index.

getDeploymentModeValue

public int getDeploymentModeValue()

(Optional.) tf.data service deployment mode. Supported values are "REMOTE",
"COLOCATED", and "HYBRID". If unspecified, it is assumed to be "REMOTE".

.tensorflow.data.DeploymentMode deployment_mode = 9;

Specified by:

getDeploymentModeValue in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The enum numeric value on the wire for deploymentMode.

getDeploymentMode

public DataService.DeploymentMode getDeploymentMode()

(Optional.) tf.data service deployment mode. Supported values are "REMOTE",
"COLOCATED", and "HYBRID". If unspecified, it is assumed to be "REMOTE".

.tensorflow.data.DeploymentMode deployment_mode = 9;

Specified by:

getDeploymentMode in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The deploymentMode.

getJobGcCheckIntervalMs

public long getJobGcCheckIntervalMs()

How often the dispatcher should scan through to delete old and unused
jobs. A value of 0 indicates that the decision should be left up to the
runtime.

int64 job_gc_check_interval_ms = 5;

Specified by:

getJobGcCheckIntervalMs in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The jobGcCheckIntervalMs.

getJobGcTimeoutMs

public long getJobGcTimeoutMs()

How long a job needs to be unused before it becomes a candidate for garbage
collection. A value of -1 indicates that jobs should never be garbage
collected. A value of 0 indicates that the decision should be left up to
the runtime. Note: This does not apply to dynamic sharding unless users
explicitly opt-in by enabling `gc_dynamic_sharding_jobs` below.

int64 job_gc_timeout_ms = 6;

Specified by:

getJobGcTimeoutMs in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The jobGcTimeoutMs.

getGcDynamicShardingJobs

public boolean getGcDynamicShardingJobs()

Whether dynamically sharded jobs should be eligible for garbage collection.
These jobs are not garbage collected by default, since if a job is garbage
collected and then re-created, it will revisit all data from the start. If
revisiting data is acceptible and you want automatic reclamation of
iterator memory, set `gc_dynamic_sharding_jobs` to `true`.

bool gc_dynamic_sharding_jobs = 11;

Specified by:

getGcDynamicShardingJobs in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The gcDynamicShardingJobs.

getClientTimeoutMs

public long getClientTimeoutMs()

How long to wait before garbage-collecting a client that hasn't
heartbeated to the dispatcher. A value of 0 indicates that the timeout
should be left to the runtime.

int64 client_timeout_ms = 8;

Specified by:

getClientTimeoutMs in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The clientTimeoutMs.

getWorkerTimeoutMs

public long getWorkerTimeoutMs()

How long to wait for a worker to heartbeat before considering it missing.
A value of 0 indicates that the timeout should be left to the runtime.

int64 worker_timeout_ms = 10;

Specified by:

getWorkerTimeoutMs in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The workerTimeoutMs.

getWorkerMaxConcurrentSnapshots

public long getWorkerMaxConcurrentSnapshots()

The maximum number of snapshots that a worker can concurrently process at a
given point in time. This is a tradeoff between worker resource usage and
snapshot wall time. A value of 0 indicates that the decision should be left
up to the runtime.

int64 worker_max_concurrent_snapshots = 12;

Specified by:

getWorkerMaxConcurrentSnapshots in interface ServiceConfig.DispatcherConfigOrBuilder

Returns:

The workerMaxConcurrentSnapshots.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(ByteBuffer data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(ByteString data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(byte[] data)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ServiceConfig.DispatcherConfig parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ServiceConfig.DispatcherConfig parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(CodedInputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

public static ServiceConfig.DispatcherConfig parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

newBuilderForType

public ServiceConfig.DispatcherConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ServiceConfig.DispatcherConfig.Builder newBuilder()

newBuilder

public static ServiceConfig.DispatcherConfig.Builder newBuilder(ServiceConfig.DispatcherConfig prototype)

toBuilder

public ServiceConfig.DispatcherConfig.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ServiceConfig.DispatcherConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ServiceConfig.DispatcherConfig getDefaultInstance()

parser

public static Parser<ServiceConfig.DispatcherConfig> parser()

getParserForType

public Parser<ServiceConfig.DispatcherConfig> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ServiceConfig.DispatcherConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder