public final class Tablet extends GeneratedMessage implements TabletOrBuilder
A Tablet represents a single replica of a Group. A tablet is served by a
single server at a time, and can move between servers due to server death or
simply load balancing.
Protobuf type google.spanner.v1.Tablet
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
DISTANCE_FIELD_NUMBER
public static final int DISTANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INCARNATION_FIELD_NUMBER
public static final int INCARNATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROLE_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVER_ADDRESS_FIELD_NUMBER
public static final int SERVER_ADDRESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SKIP_FIELD_NUMBER
public static final int SKIP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TABLET_UID_FIELD_NUMBER
public static final int TABLET_UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Tablet getDefaultInstance()
| Returns |
| Type |
Description |
Tablet |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Tablet.Builder newBuilder()
newBuilder(Tablet prototype)
public static Tablet.Builder newBuilder(Tablet prototype)
| Parameter |
| Name |
Description |
prototype |
Tablet
|
public static Tablet parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Tablet |
|
public static Tablet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tablet |
|
parseFrom(byte[] data)
public static Tablet parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Tablet |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Tablet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tablet |
|
parseFrom(ByteString data)
public static Tablet parseFrom(ByteString data)
| Returns |
| Type |
Description |
Tablet |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Tablet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tablet |
|
public static Tablet parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Tablet |
|
public static Tablet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tablet |
|
public static Tablet parseFrom(InputStream input)
| Returns |
| Type |
Description |
Tablet |
|
public static Tablet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tablet |
|
parseFrom(ByteBuffer data)
public static Tablet parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Tablet |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Tablet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Tablet |
|
parser()
public static Parser<Tablet> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Tablet getDefaultInstanceForType()
| Returns |
| Type |
Description |
Tablet |
|
getDistance()
Distances help the client pick the closest tablet out of the list of
tablets for a given request. Tablets with lower distances should generally
be preferred. Tablets with the same distance are approximately equally
close; the client can choose arbitrarily.
Distances do not correspond precisely to expected latency, geographical
distance, or anything else. Distances should be compared only between
tablets of the same group; they are not meaningful between different
groups.
A value of zero indicates that the tablet may be in the same zone as
the client, and have minimum network latency. A value less than or equal to
five indicates that the tablet is thought to be in the same region as the
client, and may have a few milliseconds of network latency. Values greater
than five are most likely in a different region, with non-trivial network
latency.
Clients should use the following algorithm:
- If the request is using a directed read, eliminate any tablets that
do not match the directed read's target zone and/or replica type.
- (Read-write transactions only) Choose leader tablet if it has an
distance <=5.
- Group and sort tablets by distance. Choose a random
tablet with the lowest distance. If the request
is not a directed read, only consider replicas with distances <=5.
Send the request to the fallback endpoint.
The tablet picked by this algorithm may be skipped, either because it is
marked as skip by the server or because the corresponding server is
unreachable, flow controlled, etc. Skipped tablets should be added to the
skipped_tablet_uid field in RoutingHint; the algorithm above should
then be re-run without including the skipped tablet(s) to pick the next
best tablet.
uint32 distance = 6;
| Returns |
| Type |
Description |
int |
The distance.
|
getIncarnation()
public ByteString getIncarnation()
incarnation indicates the freshness of the tablet information contained
in this proto. Incarnations can be compared lexicographically; if
incarnation A is greater than incarnation B, then the Tablet
corresponding to A is newer than the Tablet corresponding to B, and
should be used preferentially.
bytes incarnation = 5;
| Returns |
| Type |
Description |
ByteString |
The incarnation.
|
getLocation()
public String getLocation()
Where this tablet is located. This is the name of a Google Cloud region,
such as "us-central1".
string location = 3;
| Returns |
| Type |
Description |
String |
The location.
|
getLocationBytes()
public ByteString getLocationBytes()
Where this tablet is located. This is the name of a Google Cloud region,
such as "us-central1".
string location = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for location.
|
getParserForType()
public Parser<Tablet> getParserForType()
Overrides
getRole()
public Tablet.Role getRole()
The role of the tablet.
.google.spanner.v1.Tablet.Role role = 4;
getRoleValue()
public int getRoleValue()
The role of the tablet.
.google.spanner.v1.Tablet.Role role = 4;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for role.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServerAddress()
public String getServerAddress()
The address of the server that is serving this tablet -- either an IP
address or DNS hostname and a port number.
string server_address = 2;
| Returns |
| Type |
Description |
String |
The serverAddress.
|
getServerAddressBytes()
public ByteString getServerAddressBytes()
The address of the server that is serving this tablet -- either an IP
address or DNS hostname and a port number.
string server_address = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for serverAddress.
|
getSkip()
If true, the tablet should not be chosen by the client. Typically, this
signals that the tablet is unhealthy in some way. Tablets with skip
set to true should be reported back to the server in
RoutingHint.skipped_tablet_uid; this cues the server to send updated
information for this tablet should it become usable again.
bool skip = 7;
| Returns |
| Type |
Description |
boolean |
The skip.
|
getTabletUid()
public long getTabletUid()
The UID of the tablet, unique within the database. Matches the
tablet_uids and leader_tablet_uid fields in Group.
uint64 tablet_uid = 1;
| Returns |
| Type |
Description |
long |
The tabletUid.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Tablet.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Tablet.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Tablet.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides