ListGroupsRequest.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<ListGroupsRequest.Builder>
    - - com.heroiclabs.nakama.api.ListGroupsRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ListGroupsRequest
```
public static final class ListGroupsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListGroupsRequest.Builder>
implements ListGroupsRequestOrBuilder
```
```
 List groups based on given filters.
 
```
Protobuf type nakama.api.ListGroupsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListGroupsRequest`	`build()`
`ListGroupsRequest`	`buildPartial()`
`ListGroupsRequest.Builder`	`clear()`
`ListGroupsRequest.Builder`	`clearCursor()` Optional pagination cursor.
`ListGroupsRequest.Builder`	`clearLangTag()` Language tag filter
`ListGroupsRequest.Builder`	`clearLimit()` Max number of groups to return.
`ListGroupsRequest.Builder`	`clearMembers()` Number of group members
`ListGroupsRequest.Builder`	`clearName()` List groups that contain this value in their names.
`ListGroupsRequest.Builder`	`clearOpen()` Optional Open/Closed filter.
`java.lang.String`	`getCursor()` Optional pagination cursor.
`com.google.protobuf.ByteString`	`getCursorBytes()` Optional pagination cursor.
`ListGroupsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getLangTag()` Language tag filter
`com.google.protobuf.ByteString`	`getLangTagBytes()` Language tag filter
`com.google.protobuf.Int32Value`	`getLimit()` Max number of groups to return.
`com.google.protobuf.Int32Value.Builder`	`getLimitBuilder()` Max number of groups to return.
`com.google.protobuf.Int32ValueOrBuilder`	`getLimitOrBuilder()` Max number of groups to return.
`com.google.protobuf.Int32Value`	`getMembers()` Number of group members
`com.google.protobuf.Int32Value.Builder`	`getMembersBuilder()` Number of group members
`com.google.protobuf.Int32ValueOrBuilder`	`getMembersOrBuilder()` Number of group members
`java.lang.String`	`getName()` List groups that contain this value in their names.
`com.google.protobuf.ByteString`	`getNameBytes()` List groups that contain this value in their names.
`com.google.protobuf.BoolValue`	`getOpen()` Optional Open/Closed filter.
`com.google.protobuf.BoolValue.Builder`	`getOpenBuilder()` Optional Open/Closed filter.
`com.google.protobuf.BoolValueOrBuilder`	`getOpenOrBuilder()` Optional Open/Closed filter.
`boolean`	`hasLimit()` Max number of groups to return.
`boolean`	`hasMembers()` Number of group members
`boolean`	`hasOpen()` Optional Open/Closed filter.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListGroupsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListGroupsRequest.Builder`	`mergeFrom(ListGroupsRequest other)`
`ListGroupsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListGroupsRequest.Builder`	`mergeLimit(com.google.protobuf.Int32Value value)` Max number of groups to return.
`ListGroupsRequest.Builder`	`mergeMembers(com.google.protobuf.Int32Value value)` Number of group members
`ListGroupsRequest.Builder`	`mergeOpen(com.google.protobuf.BoolValue value)` Optional Open/Closed filter.
`ListGroupsRequest.Builder`	`setCursor(java.lang.String value)` Optional pagination cursor.
`ListGroupsRequest.Builder`	`setCursorBytes(com.google.protobuf.ByteString value)` Optional pagination cursor.
`ListGroupsRequest.Builder`	`setLangTag(java.lang.String value)` Language tag filter
`ListGroupsRequest.Builder`	`setLangTagBytes(com.google.protobuf.ByteString value)` Language tag filter
`ListGroupsRequest.Builder`	`setLimit(com.google.protobuf.Int32Value.Builder builderForValue)` Max number of groups to return.
`ListGroupsRequest.Builder`	`setLimit(com.google.protobuf.Int32Value value)` Max number of groups to return.
`ListGroupsRequest.Builder`	`setMembers(com.google.protobuf.Int32Value.Builder builderForValue)` Number of group members
`ListGroupsRequest.Builder`	`setMembers(com.google.protobuf.Int32Value value)` Number of group members
`ListGroupsRequest.Builder`	`setName(java.lang.String value)` List groups that contain this value in their names.
`ListGroupsRequest.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` List groups that contain this value in their names.
`ListGroupsRequest.Builder`	`setOpen(com.google.protobuf.BoolValue.Builder builderForValue)` Optional Open/Closed filter.
`ListGroupsRequest.Builder`	`setOpen(com.google.protobuf.BoolValue value)` Optional Open/Closed filter.

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<ListGroupsRequest.Builder>
  - clear
```
public ListGroupsRequest.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<ListGroupsRequest.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<ListGroupsRequest.Builder>
  - getDefaultInstanceForType
```
public ListGroupsRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ListGroupsRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ListGroupsRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public ListGroupsRequest.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<ListGroupsRequest.Builder>
  - mergeFrom
```
public ListGroupsRequest.Builder mergeFrom(ListGroupsRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListGroupsRequest.Builder>
  - mergeFrom
```
public ListGroupsRequest.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<ListGroupsRequest.Builder>
    
    Throws:
    
    java.io.IOException
  - getName
```
public java.lang.String getName()
```
```
 List groups that contain this value in their names.
 
```
    string name = 1 [json_name = "name"];
    Specified by:
    
    getName in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 List groups that contain this value in their names.
 
```
    string name = 1 [json_name = "name"];
    Specified by:
    
    getNameBytes in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public ListGroupsRequest.Builder setName(java.lang.String value)
```
```
 List groups that contain this value in their names.
 
```
    string name = 1 [json_name = "name"];
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    This builder for chaining.
  - clearName
```
public ListGroupsRequest.Builder clearName()
```
```
 List groups that contain this value in their names.
 
```
    string name = 1 [json_name = "name"];
    Returns:
    
    This builder for chaining.
  - setNameBytes
```
public ListGroupsRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 List groups that contain this value in their names.
 
```
    string name = 1 [json_name = "name"];
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - getCursor
```
public java.lang.String getCursor()
```
```
 Optional pagination cursor.
 
```
    string cursor = 2 [json_name = "cursor"];
    Specified by:
    
    getCursor in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The cursor.
  - getCursorBytes
```
public com.google.protobuf.ByteString getCursorBytes()
```
```
 Optional pagination cursor.
 
```
    string cursor = 2 [json_name = "cursor"];
    Specified by:
    
    getCursorBytes in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The bytes for cursor.
  - setCursor
```
public ListGroupsRequest.Builder setCursor(java.lang.String value)
```
```
 Optional pagination cursor.
 
```
    string cursor = 2 [json_name = "cursor"];
    Parameters:
    
    value - The cursor to set.
    
    Returns:
    
    This builder for chaining.
  - clearCursor
```
public ListGroupsRequest.Builder clearCursor()
```
```
 Optional pagination cursor.
 
```
    string cursor = 2 [json_name = "cursor"];
    Returns:
    
    This builder for chaining.
  - setCursorBytes
```
public ListGroupsRequest.Builder setCursorBytes(com.google.protobuf.ByteString value)
```
```
 Optional pagination cursor.
 
```
    string cursor = 2 [json_name = "cursor"];
    Parameters:
    
    value - The bytes for cursor to set.
    
    Returns:
    
    This builder for chaining.
  - hasLimit
```
public boolean hasLimit()
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
    Specified by:
    
    hasLimit in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    Whether the limit field is set.
  - getLimit
```
public com.google.protobuf.Int32Value getLimit()
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
    Specified by:
    
    getLimit in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The limit.
  - setLimit
```
public ListGroupsRequest.Builder setLimit(com.google.protobuf.Int32Value value)
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
  - setLimit
```
public ListGroupsRequest.Builder setLimit(com.google.protobuf.Int32Value.Builder builderForValue)
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
  - mergeLimit
```
public ListGroupsRequest.Builder mergeLimit(com.google.protobuf.Int32Value value)
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
  - clearLimit
```
public ListGroupsRequest.Builder clearLimit()
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
  - getLimitBuilder
```
public com.google.protobuf.Int32Value.Builder getLimitBuilder()
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
  - getLimitOrBuilder
```
public com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()
```
```
 Max number of groups to return. Between 1 and 100.
 
```
    .google.protobuf.Int32Value limit = 3 [json_name = "limit"];
    Specified by:
    
    getLimitOrBuilder in interface ListGroupsRequestOrBuilder
  - getLangTag
```
public java.lang.String getLangTag()
```
```
 Language tag filter
 
```
    string lang_tag = 4 [json_name = "langTag"];
    Specified by:
    
    getLangTag in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The langTag.
  - getLangTagBytes
```
public com.google.protobuf.ByteString getLangTagBytes()
```
```
 Language tag filter
 
```
    string lang_tag = 4 [json_name = "langTag"];
    Specified by:
    
    getLangTagBytes in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The bytes for langTag.
  - setLangTag
```
public ListGroupsRequest.Builder setLangTag(java.lang.String value)
```
```
 Language tag filter
 
```
    string lang_tag = 4 [json_name = "langTag"];
    Parameters:
    
    value - The langTag to set.
    
    Returns:
    
    This builder for chaining.
  - clearLangTag
```
public ListGroupsRequest.Builder clearLangTag()
```
```
 Language tag filter
 
```
    string lang_tag = 4 [json_name = "langTag"];
    Returns:
    
    This builder for chaining.
  - setLangTagBytes
```
public ListGroupsRequest.Builder setLangTagBytes(com.google.protobuf.ByteString value)
```
```
 Language tag filter
 
```
    string lang_tag = 4 [json_name = "langTag"];
    Parameters:
    
    value - The bytes for langTag to set.
    
    Returns:
    
    This builder for chaining.
  - hasMembers
```
public boolean hasMembers()
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
    Specified by:
    
    hasMembers in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    Whether the members field is set.
  - getMembers
```
public com.google.protobuf.Int32Value getMembers()
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
    Specified by:
    
    getMembers in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The members.
  - setMembers
```
public ListGroupsRequest.Builder setMembers(com.google.protobuf.Int32Value value)
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
  - setMembers
```
public ListGroupsRequest.Builder setMembers(com.google.protobuf.Int32Value.Builder builderForValue)
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
  - mergeMembers
```
public ListGroupsRequest.Builder mergeMembers(com.google.protobuf.Int32Value value)
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
  - clearMembers
```
public ListGroupsRequest.Builder clearMembers()
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
  - getMembersBuilder
```
public com.google.protobuf.Int32Value.Builder getMembersBuilder()
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
  - getMembersOrBuilder
```
public com.google.protobuf.Int32ValueOrBuilder getMembersOrBuilder()
```
```
 Number of group members
 
```
    .google.protobuf.Int32Value members = 5 [json_name = "members"];
    Specified by:
    
    getMembersOrBuilder in interface ListGroupsRequestOrBuilder
  - hasOpen
```
public boolean hasOpen()
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
    Specified by:
    
    hasOpen in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    Whether the open field is set.
  - getOpen
```
public com.google.protobuf.BoolValue getOpen()
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
    Specified by:
    
    getOpen in interface ListGroupsRequestOrBuilder
    
    Returns:
    
    The open.
  - setOpen
```
public ListGroupsRequest.Builder setOpen(com.google.protobuf.BoolValue value)
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
  - setOpen
```
public ListGroupsRequest.Builder setOpen(com.google.protobuf.BoolValue.Builder builderForValue)
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
  - mergeOpen
```
public ListGroupsRequest.Builder mergeOpen(com.google.protobuf.BoolValue value)
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
  - clearOpen
```
public ListGroupsRequest.Builder clearOpen()
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
  - getOpenBuilder
```
public com.google.protobuf.BoolValue.Builder getOpenBuilder()
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
  - getOpenOrBuilder
```
public com.google.protobuf.BoolValueOrBuilder getOpenOrBuilder()
```
```
 Optional Open/Closed filter.
 
```
    .google.protobuf.BoolValue open = 6 [json_name = "open"];
    Specified by:
    
    getOpenOrBuilder in interface ListGroupsRequestOrBuilder

Class ListGroupsRequest.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

getName

getNameBytes

setName

clearName

setNameBytes

getCursor

getCursorBytes

setCursor

clearCursor

setCursorBytes

hasLimit

getLimit

setLimit

setLimit

mergeLimit

clearLimit

getLimitBuilder

getLimitOrBuilder

getLangTag

getLangTagBytes

setLangTag

clearLangTag

setLangTagBytes

hasMembers

getMembers

setMembers

setMembers

mergeMembers

clearMembers

getMembersBuilder

getMembersOrBuilder

hasOpen

getOpen

setOpen

setOpen

mergeOpen

clearOpen

getOpenBuilder

getOpenOrBuilder