Class CoordinationConfig.CoordinationServiceConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.tensorflow.proto.CoordinationConfig.CoordinationServiceConfig
- All Implemented Interfaces:
Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable, CoordinationConfig.CoordinationServiceConfigOrBuilder
- Enclosing class:
CoordinationConfig
public static final class CoordinationConfig.CoordinationServiceConfig
extends GeneratedMessageV3
implements CoordinationConfig.CoordinationServiceConfigOrBuilder
Coordination service configuration parameters. The system picks appropriate values for fields that are not set.Protobuf type
tensorflow.CoordinationServiceConfig- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classCoordination service configuration parameters.Nested classes/interfaces inherited from class GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterNested classes/interfaces inherited from class AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class AbstractMessage
memoizedSizeFields inherited from class AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanIf set, agents do not make an explicit Shutdown() call.booleanIf a task restarts with a new incarnation, we may allow it to reconnect silently.longMaximum wait time for all members in the cluster to be registered.getCoordinatedJobList(int index) repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;intrepeated .tensorflow.CoordinatedJob coordinated_job_list = 10;repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;getCoordinatedJobListOrBuilder(int index) repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;List<? extends CoordinationConfig.CoordinatedJobOrBuilder> repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;static final Descriptors.DescriptorbooleanWhether to enable the health check mechanism.booleanDisables coordination service.longHeartbeat timeout, if a task does not record heartbeat in this time window, it will be considered disconnected.booleanUse long polling to get error from coordination service as the error propagation mechanism.getRecoverableJobs(int index) The list of jobs which are recoverable.getRecoverableJobsBytes(int index) The list of jobs which are recoverable.intThe list of jobs which are recoverable.The list of jobs which are recoverable.intAddress where the coordination service instance is hosted.Address where the coordination service instance is hosted.Type of coordination service implementation to enable.Type of coordination service implementation to enable.longDenotes how long to wait for all coordination agents to reach the barriers (after the first shutdown request) before disconnecting together.final UnknownFieldSetinthashCode()protected GeneratedMessageV3.FieldAccessorTablefinal booleanprotected ObjectparseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) parseFrom(ByteString data) parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) parseFrom(CodedInputStream input) parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()voidwriteTo(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, writeStringNoTagMethods inherited from class AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
SERVICE_TYPE_FIELD_NUMBER
public static final int SERVICE_TYPE_FIELD_NUMBER- See Also:
-
SERVICE_LEADER_FIELD_NUMBER
public static final int SERVICE_LEADER_FIELD_NUMBER- See Also:
-
ENABLE_HEALTH_CHECK_FIELD_NUMBER
public static final int ENABLE_HEALTH_CHECK_FIELD_NUMBER- See Also:
-
CLUSTER_REGISTER_TIMEOUT_IN_MS_FIELD_NUMBER
public static final int CLUSTER_REGISTER_TIMEOUT_IN_MS_FIELD_NUMBER- See Also:
-
HEARTBEAT_TIMEOUT_IN_MS_FIELD_NUMBER
public static final int HEARTBEAT_TIMEOUT_IN_MS_FIELD_NUMBER- See Also:
-
COORDINATED_JOB_LIST_FIELD_NUMBER
public static final int COORDINATED_JOB_LIST_FIELD_NUMBER- See Also:
-
SHUTDOWN_BARRIER_TIMEOUT_IN_MS_FIELD_NUMBER
public static final int SHUTDOWN_BARRIER_TIMEOUT_IN_MS_FIELD_NUMBER- See Also:
-
AGENT_DESTRUCTION_WITHOUT_SHUTDOWN_FIELD_NUMBER
public static final int AGENT_DESTRUCTION_WITHOUT_SHUTDOWN_FIELD_NUMBER- See Also:
-
RECOVERABLE_JOBS_FIELD_NUMBER
public static final int RECOVERABLE_JOBS_FIELD_NUMBER- See Also:
-
ALLOW_NEW_INCARNATION_TO_RECONNECT_FIELD_NUMBER
public static final int ALLOW_NEW_INCARNATION_TO_RECONNECT_FIELD_NUMBER- See Also:
-
FORCE_DISABLE_FIELD_NUMBER
public static final int FORCE_DISABLE_FIELD_NUMBER- See Also:
-
POLL_FOR_ERROR_FROM_SERVICE_AT_STARTUP_FIELD_NUMBER
public static final int POLL_FOR_ERROR_FROM_SERVICE_AT_STARTUP_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classGeneratedMessageV3
-
getUnknownFields
- Specified by:
getUnknownFieldsin interfaceMessageOrBuilder- Overrides:
getUnknownFieldsin classGeneratedMessageV3
-
getDescriptor
-
internalGetFieldAccessorTable
- Specified by:
internalGetFieldAccessorTablein classGeneratedMessageV3
-
getServiceType
Type of coordination service implementation to enable. For example, setting the service type as "standalone" starts a service instance on the leader task to provide the coordination services such as heartbeats and consistent key-value store.
string service_type = 1;- Specified by:
getServiceTypein interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The serviceType.
-
getServiceTypeBytes
Type of coordination service implementation to enable. For example, setting the service type as "standalone" starts a service instance on the leader task to provide the coordination services such as heartbeats and consistent key-value store.
string service_type = 1;- Specified by:
getServiceTypeBytesin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The bytes for serviceType.
-
getServiceLeader
Address where the coordination service instance is hosted.
string service_leader = 2;- Specified by:
getServiceLeaderin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The serviceLeader.
-
getServiceLeaderBytes
Address where the coordination service instance is hosted.
string service_leader = 2;- Specified by:
getServiceLeaderBytesin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The bytes for serviceLeader.
-
getEnableHealthCheck
public boolean getEnableHealthCheck()Whether to enable the health check mechanism.
bool enable_health_check = 3;- Specified by:
getEnableHealthCheckin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The enableHealthCheck.
-
getClusterRegisterTimeoutInMs
public long getClusterRegisterTimeoutInMs()Maximum wait time for all members in the cluster to be registered.
int64 cluster_register_timeout_in_ms = 4;- Specified by:
getClusterRegisterTimeoutInMsin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The clusterRegisterTimeoutInMs.
-
getHeartbeatTimeoutInMs
public long getHeartbeatTimeoutInMs()Heartbeat timeout, if a task does not record heartbeat in this time window, it will be considered disconnected. Note: This is also used as a grace period to accept any heartbeats after the agent has disconnected, to account for the lag time between the service recording the state change and the agent stopping heartbeats.
int64 heartbeat_timeout_in_ms = 5;- Specified by:
getHeartbeatTimeoutInMsin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The heartbeatTimeoutInMs.
-
getCoordinatedJobListList
repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;- Specified by:
getCoordinatedJobListListin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder
-
getCoordinatedJobListOrBuilderList
public List<? extends CoordinationConfig.CoordinatedJobOrBuilder> getCoordinatedJobListOrBuilderList()repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;- Specified by:
getCoordinatedJobListOrBuilderListin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder
-
getCoordinatedJobListCount
public int getCoordinatedJobListCount()repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;- Specified by:
getCoordinatedJobListCountin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder
-
getCoordinatedJobList
repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;- Specified by:
getCoordinatedJobListin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder
-
getCoordinatedJobListOrBuilder
repeated .tensorflow.CoordinatedJob coordinated_job_list = 10;- Specified by:
getCoordinatedJobListOrBuilderin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder
-
getShutdownBarrierTimeoutInMs
public long getShutdownBarrierTimeoutInMs()Denotes how long to wait for all coordination agents to reach the barriers (after the first shutdown request) before disconnecting together. If set to 0, no barrier is imposed upon shutdown and each worker can disconnect individually.
int64 shutdown_barrier_timeout_in_ms = 7;- Specified by:
getShutdownBarrierTimeoutInMsin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The shutdownBarrierTimeoutInMs.
-
getAgentDestructionWithoutShutdown
public boolean getAgentDestructionWithoutShutdown()If set, agents do not make an explicit Shutdown() call. Service will only find out about the disconnecte agent via stale heartbeats. Used for testing.
bool agent_destruction_without_shutdown = 8;- Specified by:
getAgentDestructionWithoutShutdownin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The agentDestructionWithoutShutdown.
-
getRecoverableJobsList
The list of jobs which are recoverable. If a task in this list fails, it will not propagate error to other tasks. If empty, no jobs will be recoverable and every task failure will cause error propagation to other tasks.
repeated string recoverable_jobs = 9;- Specified by:
getRecoverableJobsListin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- A list containing the recoverableJobs.
-
getRecoverableJobsCount
public int getRecoverableJobsCount()The list of jobs which are recoverable. If a task in this list fails, it will not propagate error to other tasks. If empty, no jobs will be recoverable and every task failure will cause error propagation to other tasks.
repeated string recoverable_jobs = 9;- Specified by:
getRecoverableJobsCountin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The count of recoverableJobs.
-
getRecoverableJobs
The list of jobs which are recoverable. If a task in this list fails, it will not propagate error to other tasks. If empty, no jobs will be recoverable and every task failure will cause error propagation to other tasks.
repeated string recoverable_jobs = 9;- Specified by:
getRecoverableJobsin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The recoverableJobs at the given index.
-
getRecoverableJobsBytes
The list of jobs which are recoverable. If a task in this list fails, it will not propagate error to other tasks. If empty, no jobs will be recoverable and every task failure will cause error propagation to other tasks.
repeated string recoverable_jobs = 9;- Specified by:
getRecoverableJobsBytesin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the recoverableJobs at the given index.
-
getAllowNewIncarnationToReconnect
public boolean getAllowNewIncarnationToReconnect()If a task restarts with a new incarnation, we may allow it to reconnect silently. This is useful when we know that a task can immediately resume work upon re-connecting to the service.
bool allow_new_incarnation_to_reconnect = 11;- Specified by:
getAllowNewIncarnationToReconnectin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The allowNewIncarnationToReconnect.
-
getForceDisable
public boolean getForceDisable()Disables coordination service. Some libraries enable coordination service by default even if the user did not specify any config. This field allows users to explicitly disable coordination service under all situations.
bool force_disable = 12;- Specified by:
getForceDisablein interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The forceDisable.
-
getPollForErrorFromServiceAtStartup
public boolean getPollForErrorFromServiceAtStartup()Use long polling to get error from coordination service as the error propagation mechanism.
bool poll_for_error_from_service_at_startup = 13;- Specified by:
getPollForErrorFromServiceAtStartupin interfaceCoordinationConfig.CoordinationServiceConfigOrBuilder- Returns:
- The pollForErrorFromServiceAtStartup.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfaceMessageLiteOrBuilder- Overrides:
isInitializedin classGeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfaceMessageLite- Overrides:
writeToin classGeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfaceMessageLite- Overrides:
getSerializedSizein classGeneratedMessageV3
-
equals
- Specified by:
equalsin interfaceMessage- Overrides:
equalsin classAbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfaceMessage- Overrides:
hashCodein classAbstractMessage
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(ByteBuffer data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(ByteString data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(byte[] data) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static CoordinationConfig.CoordinationServiceConfig parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static CoordinationConfig.CoordinationServiceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static CoordinationConfig.CoordinationServiceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfaceMessage- Specified by:
newBuilderForTypein interfaceMessageLite
-
newBuilder
-
newBuilder
public static CoordinationConfig.CoordinationServiceConfig.Builder newBuilder(CoordinationConfig.CoordinationServiceConfig prototype) -
toBuilder
- Specified by:
toBuilderin interfaceMessage- Specified by:
toBuilderin interfaceMessageLite
-
newBuilderForType
protected CoordinationConfig.CoordinationServiceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classGeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfaceMessage- Specified by:
getParserForTypein interfaceMessageLite- Overrides:
getParserForTypein classGeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfaceMessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfaceMessageOrBuilder
-