Class Tablet.Builder (6.107.0) 

public static final class Tablet.Builder extends GeneratedMessageV3.Builder<Tablet.Builder> 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

Inheritance

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

Implements

TabletOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Tablet build()
Returns
Type Description
Tablet

buildPartial()

public Tablet buildPartial()
Returns
Type Description
Tablet

clear()

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

clearDistance()

public Tablet.Builder clearDistance()

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
Tablet.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIncarnation()

public Tablet.Builder clearIncarnation()

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
Tablet.Builder

This builder for chaining.

clearLocation()

public Tablet.Builder clearLocation()

Where this tablet is located. This is the name of a Google Cloud region, such as "us-central1".

string location = 3;

Returns
Type Description
Tablet.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRole()

public Tablet.Builder clearRole()

The role of the tablet.

.google.spanner.v1.Tablet.Role role = 4;

Returns
Type Description
Tablet.Builder

This builder for chaining.

clearServerAddress()

public Tablet.Builder clearServerAddress()

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
Tablet.Builder

This builder for chaining.

clearSkip()

public Tablet.Builder clearSkip()

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
Tablet.Builder

This builder for chaining.

clearTabletUid()

public Tablet.Builder clearTabletUid()

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
Tablet.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public Tablet getDefaultInstanceForType()
Returns
Type Description
Tablet

getDescriptorForType()

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

getDistance()

public int 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.

getRole()

public Tablet.Role getRole()

The role of the tablet.

.google.spanner.v1.Tablet.Role role = 4;

Returns
Type Description
Tablet.Role

The role.

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.

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()

public boolean 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(Tablet other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDistance(int value)

public Tablet.Builder setDistance(int value)

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;

Parameter
Name Description
value int

The distance to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIncarnation(ByteString value)

public Tablet.Builder setIncarnation(ByteString value)

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;

Parameter
Name Description
value ByteString

The incarnation to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setLocation(String value)

public Tablet.Builder setLocation(String value)

Where this tablet is located. This is the name of a Google Cloud region, such as "us-central1".

string location = 3;

Parameter
Name Description
value String

The location to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public Tablet.Builder setLocationBytes(ByteString value)

Where this tablet is located. This is the name of a Google Cloud region, such as "us-central1".

string location = 3;

Parameter
Name Description
value ByteString

The bytes for location to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

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

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

setRole(Tablet.Role value)

public Tablet.Builder setRole(Tablet.Role value)

The role of the tablet.

.google.spanner.v1.Tablet.Role role = 4;

Parameter
Name Description
value Tablet.Role

The role to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setRoleValue(int value)

public Tablet.Builder setRoleValue(int value)

The role of the tablet.

.google.spanner.v1.Tablet.Role role = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for role to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setServerAddress(String value)

public Tablet.Builder setServerAddress(String value)

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;

Parameter
Name Description
value String

The serverAddress to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setServerAddressBytes(ByteString value)

public Tablet.Builder setServerAddressBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for serverAddress to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setSkip(boolean value)

public Tablet.Builder setSkip(boolean value)

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;

Parameter
Name Description
value boolean

The skip to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setTabletUid(long value)

public Tablet.Builder setTabletUid(long value)

The UID of the tablet, unique within the database. Matches the tablet_uids and leader_tablet_uid fields in Group.

uint64 tablet_uid = 1;

Parameter
Name Description
value long

The tabletUid to set.
Returns
Type Description
Tablet.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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