Leaderboard.Builder (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<Leaderboard.Builder>
    - - com.heroiclabs.nakama.api.Leaderboard.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LeaderboardOrBuilder, java.lang.Cloneable

Enclosing class:

Leaderboard
```
public static final class Leaderboard.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Leaderboard.Builder>
implements LeaderboardOrBuilder
```
```
 A leaderboard on the server.
 
```
Protobuf type nakama.api.Leaderboard

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Leaderboard`	`build()`
`Leaderboard`	`buildPartial()`
`Leaderboard.Builder`	`clear()`
`Leaderboard.Builder`	`clearAuthoritative()` Whether the leaderboard was created authoritatively or not.
`Leaderboard.Builder`	`clearCreateTime()` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`Leaderboard.Builder`	`clearId()` The ID of the leaderboard.
`Leaderboard.Builder`	`clearMetadata()` Additional information stored as a JSON object.
`Leaderboard.Builder`	`clearNextReset()` The UNIX time when the leaderboard is next playable.
`Leaderboard.Builder`	`clearOperator()` BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
`Leaderboard.Builder`	`clearPrevReset()` The UNIX time when the leaderboard was previously reset.
`Leaderboard.Builder`	`clearSortOrder()` ASC(0) or DESC(1) sort mode of scores in the leaderboard.
`boolean`	`getAuthoritative()` Whether the leaderboard was created authoritatively or not.
`com.google.protobuf.Timestamp`	`getCreateTime()` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`com.google.protobuf.Timestamp.Builder`	`getCreateTimeBuilder()` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`Leaderboard`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getId()` The ID of the leaderboard.
`com.google.protobuf.ByteString`	`getIdBytes()` The ID of the leaderboard.
`java.lang.String`	`getMetadata()` Additional information stored as a JSON object.
`com.google.protobuf.ByteString`	`getMetadataBytes()` Additional information stored as a JSON object.
`int`	`getNextReset()` The UNIX time when the leaderboard is next playable.
`Operator`	`getOperator()` BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
`int`	`getOperatorValue()` BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
`int`	`getPrevReset()` The UNIX time when the leaderboard was previously reset.
`int`	`getSortOrder()` ASC(0) or DESC(1) sort mode of scores in the leaderboard.
`boolean`	`hasCreateTime()` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Leaderboard.Builder`	`mergeCreateTime(com.google.protobuf.Timestamp value)` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`Leaderboard.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Leaderboard.Builder`	`mergeFrom(Leaderboard other)`
`Leaderboard.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Leaderboard.Builder`	`setAuthoritative(boolean value)` Whether the leaderboard was created authoritatively or not.
`Leaderboard.Builder`	`setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`Leaderboard.Builder`	`setCreateTime(com.google.protobuf.Timestamp value)` The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
`Leaderboard.Builder`	`setId(java.lang.String value)` The ID of the leaderboard.
`Leaderboard.Builder`	`setIdBytes(com.google.protobuf.ByteString value)` The ID of the leaderboard.
`Leaderboard.Builder`	`setMetadata(java.lang.String value)` Additional information stored as a JSON object.
`Leaderboard.Builder`	`setMetadataBytes(com.google.protobuf.ByteString value)` Additional information stored as a JSON object.
`Leaderboard.Builder`	`setNextReset(int value)` The UNIX time when the leaderboard is next playable.
`Leaderboard.Builder`	`setOperator(Operator value)` BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
`Leaderboard.Builder`	`setOperatorValue(int value)` BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
`Leaderboard.Builder`	`setPrevReset(int value)` The UNIX time when the leaderboard was previously reset.
`Leaderboard.Builder`	`setSortOrder(int value)` ASC(0) or DESC(1) sort mode of scores in the leaderboard.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Leaderboard.Builder>
  - clear
```
public Leaderboard.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessage.Builder<Leaderboard.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Leaderboard.Builder>
  - getDefaultInstanceForType
```
public Leaderboard getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Leaderboard build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Leaderboard buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public Leaderboard.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Leaderboard.Builder>
  - mergeFrom
```
public Leaderboard.Builder mergeFrom(Leaderboard other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Leaderboard.Builder>
  - mergeFrom
```
public Leaderboard.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Leaderboard.Builder>
    
    Throws:
    
    java.io.IOException
  - getId
```
public java.lang.String getId()
```
```
 The ID of the leaderboard.
 
```
    string id = 1 [json_name = "id"];
    Specified by:
    
    getId in interface LeaderboardOrBuilder
    
    Returns:
    
    The id.
  - getIdBytes
```
public com.google.protobuf.ByteString getIdBytes()
```
```
 The ID of the leaderboard.
 
```
    string id = 1 [json_name = "id"];
    Specified by:
    
    getIdBytes in interface LeaderboardOrBuilder
    
    Returns:
    
    The bytes for id.
  - setId
```
public Leaderboard.Builder setId(java.lang.String value)
```
```
 The ID of the leaderboard.
 
```
    string id = 1 [json_name = "id"];
    Parameters:
    
    value - The id to set.
    
    Returns:
    
    This builder for chaining.
  - clearId
```
public Leaderboard.Builder clearId()
```
```
 The ID of the leaderboard.
 
```
    string id = 1 [json_name = "id"];
    Returns:
    
    This builder for chaining.
  - setIdBytes
```
public Leaderboard.Builder setIdBytes(com.google.protobuf.ByteString value)
```
```
 The ID of the leaderboard.
 
```
    string id = 1 [json_name = "id"];
    Parameters:
    
    value - The bytes for id to set.
    
    Returns:
    
    This builder for chaining.
  - getSortOrder
```
public int getSortOrder()
```
```
 ASC(0) or DESC(1) sort mode of scores in the leaderboard.
 
```
    uint32 sort_order = 2 [json_name = "sortOrder"];
    Specified by:
    
    getSortOrder in interface LeaderboardOrBuilder
    
    Returns:
    
    The sortOrder.
  - setSortOrder
```
public Leaderboard.Builder setSortOrder(int value)
```
```
 ASC(0) or DESC(1) sort mode of scores in the leaderboard.
 
```
    uint32 sort_order = 2 [json_name = "sortOrder"];
    Parameters:
    
    value - The sortOrder to set.
    
    Returns:
    
    This builder for chaining.
  - clearSortOrder
```
public Leaderboard.Builder clearSortOrder()
```
```
 ASC(0) or DESC(1) sort mode of scores in the leaderboard.
 
```
    uint32 sort_order = 2 [json_name = "sortOrder"];
    Returns:
    
    This builder for chaining.
  - getOperatorValue
```
public int getOperatorValue()
```
```
 BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
 
```
    .nakama.api.Operator operator = 3 [json_name = "operator"];
    Specified by:
    
    getOperatorValue in interface LeaderboardOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for operator.
  - setOperatorValue
```
public Leaderboard.Builder setOperatorValue(int value)
```
```
 BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
 
```
    .nakama.api.Operator operator = 3 [json_name = "operator"];
    Parameters:
    
    value - The enum numeric value on the wire for operator to set.
    
    Returns:
    
    This builder for chaining.
  - getOperator
```
public Operator getOperator()
```
```
 BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
 
```
    .nakama.api.Operator operator = 3 [json_name = "operator"];
    Specified by:
    
    getOperator in interface LeaderboardOrBuilder
    
    Returns:
    
    The operator.
  - setOperator
```
public Leaderboard.Builder setOperator(Operator value)
```
```
 BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
 
```
    .nakama.api.Operator operator = 3 [json_name = "operator"];
    Parameters:
    
    value - The operator to set.
    
    Returns:
    
    This builder for chaining.
  - clearOperator
```
public Leaderboard.Builder clearOperator()
```
```
 BEST, SET, INCREMENT or DECREMENT operator mode of the leaderboard.
 
```
    .nakama.api.Operator operator = 3 [json_name = "operator"];
    Returns:
    
    This builder for chaining.
  - getPrevReset
```
public int getPrevReset()
```
```
 The UNIX time when the leaderboard was previously reset. A computed value.
 
```
    uint32 prev_reset = 4 [json_name = "prevReset"];
    Specified by:
    
    getPrevReset in interface LeaderboardOrBuilder
    
    Returns:
    
    The prevReset.
  - setPrevReset
```
public Leaderboard.Builder setPrevReset(int value)
```
```
 The UNIX time when the leaderboard was previously reset. A computed value.
 
```
    uint32 prev_reset = 4 [json_name = "prevReset"];
    Parameters:
    
    value - The prevReset to set.
    
    Returns:
    
    This builder for chaining.
  - clearPrevReset
```
public Leaderboard.Builder clearPrevReset()
```
```
 The UNIX time when the leaderboard was previously reset. A computed value.
 
```
    uint32 prev_reset = 4 [json_name = "prevReset"];
    Returns:
    
    This builder for chaining.
  - getNextReset
```
public int getNextReset()
```
```
 The UNIX time when the leaderboard is next playable. A computed value.
 
```
    uint32 next_reset = 5 [json_name = "nextReset"];
    Specified by:
    
    getNextReset in interface LeaderboardOrBuilder
    
    Returns:
    
    The nextReset.
  - setNextReset
```
public Leaderboard.Builder setNextReset(int value)
```
```
 The UNIX time when the leaderboard is next playable. A computed value.
 
```
    uint32 next_reset = 5 [json_name = "nextReset"];
    Parameters:
    
    value - The nextReset to set.
    
    Returns:
    
    This builder for chaining.
  - clearNextReset
```
public Leaderboard.Builder clearNextReset()
```
```
 The UNIX time when the leaderboard is next playable. A computed value.
 
```
    uint32 next_reset = 5 [json_name = "nextReset"];
    Returns:
    
    This builder for chaining.
  - getMetadata
```
public java.lang.String getMetadata()
```
```
 Additional information stored as a JSON object.
 
```
    string metadata = 6 [json_name = "metadata"];
    Specified by:
    
    getMetadata in interface LeaderboardOrBuilder
    
    Returns:
    
    The metadata.
  - getMetadataBytes
```
public com.google.protobuf.ByteString getMetadataBytes()
```
```
 Additional information stored as a JSON object.
 
```
    string metadata = 6 [json_name = "metadata"];
    Specified by:
    
    getMetadataBytes in interface LeaderboardOrBuilder
    
    Returns:
    
    The bytes for metadata.
  - setMetadata
```
public Leaderboard.Builder setMetadata(java.lang.String value)
```
```
 Additional information stored as a JSON object.
 
```
    string metadata = 6 [json_name = "metadata"];
    Parameters:
    
    value - The metadata to set.
    
    Returns:
    
    This builder for chaining.
  - clearMetadata
```
public Leaderboard.Builder clearMetadata()
```
```
 Additional information stored as a JSON object.
 
```
    string metadata = 6 [json_name = "metadata"];
    Returns:
    
    This builder for chaining.
  - setMetadataBytes
```
public Leaderboard.Builder setMetadataBytes(com.google.protobuf.ByteString value)
```
```
 Additional information stored as a JSON object.
 
```
    string metadata = 6 [json_name = "metadata"];
    Parameters:
    
    value - The bytes for metadata to set.
    
    Returns:
    
    This builder for chaining.
  - hasCreateTime
```
public boolean hasCreateTime()
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
    Specified by:
    
    hasCreateTime in interface LeaderboardOrBuilder
    
    Returns:
    
    Whether the createTime field is set.
  - getCreateTime
```
public com.google.protobuf.Timestamp getCreateTime()
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
    Specified by:
    
    getCreateTime in interface LeaderboardOrBuilder
    
    Returns:
    
    The createTime.
  - setCreateTime
```
public Leaderboard.Builder setCreateTime(com.google.protobuf.Timestamp value)
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
  - setCreateTime
```
public Leaderboard.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
  - mergeCreateTime
```
public Leaderboard.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
  - clearCreateTime
```
public Leaderboard.Builder clearCreateTime()
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
  - getCreateTimeBuilder
```
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
  - getCreateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard was created.
 
```
    .google.protobuf.Timestamp create_time = 7 [json_name = "createTime"];
    Specified by:
    
    getCreateTimeOrBuilder in interface LeaderboardOrBuilder
  - getAuthoritative
```
public boolean getAuthoritative()
```
```
 Whether the leaderboard was created authoritatively or not.
 
```
    bool authoritative = 8 [json_name = "authoritative"];
    Specified by:
    
    getAuthoritative in interface LeaderboardOrBuilder
    
    Returns:
    
    The authoritative.
  - setAuthoritative
```
public Leaderboard.Builder setAuthoritative(boolean value)
```
```
 Whether the leaderboard was created authoritatively or not.
 
```
    bool authoritative = 8 [json_name = "authoritative"];
    Parameters:
    
    value - The authoritative to set.
    
    Returns:
    
    This builder for chaining.
  - clearAuthoritative
```
public Leaderboard.Builder clearAuthoritative()
```
```
 Whether the leaderboard was created authoritatively or not.
 
```
    bool authoritative = 8 [json_name = "authoritative"];
    Returns:
    
    This builder for chaining.

Class Leaderboard.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getId

getIdBytes

setId

clearId

setIdBytes

getSortOrder

setSortOrder

clearSortOrder

getOperatorValue

setOperatorValue

getOperator

setOperator

clearOperator

getPrevReset

setPrevReset

clearPrevReset

getNextReset

setNextReset

clearNextReset

getMetadata

getMetadataBytes

setMetadata

clearMetadata

setMetadataBytes

hasCreateTime

getCreateTime

setCreateTime

setCreateTime

mergeCreateTime

clearCreateTime

getCreateTimeBuilder

getCreateTimeOrBuilder

getAuthoritative

setAuthoritative

clearAuthoritative