Class FindGroupChatsRequest (0.57.0)

public final class FindGroupChatsRequest extends GeneratedMessage implements FindGroupChatsRequestOrBuilder

A request to get group chat spaces based on user resources.

Protobuf type google.chat.v1.FindGroupChatsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

SPACE_VIEW_FIELD_NUMBER

public static final int SPACE_VIEW_FIELD_NUMBER
Field Value
Type Description
int

USERS_FIELD_NUMBER

public static final int USERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FindGroupChatsRequest getDefaultInstance()
Returns
Type Description
FindGroupChatsRequest

getDescriptor()

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

newBuilder()

public static FindGroupChatsRequest.Builder newBuilder()
Returns
Type Description
FindGroupChatsRequest.Builder

newBuilder(FindGroupChatsRequest prototype)

public static FindGroupChatsRequest.Builder newBuilder(FindGroupChatsRequest prototype)
Parameter
Name Description
prototype FindGroupChatsRequest
Returns
Type Description
FindGroupChatsRequest.Builder

parseDelimitedFrom(InputStream input)

public static FindGroupChatsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindGroupChatsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FindGroupChatsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FindGroupChatsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FindGroupChatsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FindGroupChatsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FindGroupChatsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FindGroupChatsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FindGroupChatsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FindGroupChatsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FindGroupChatsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FindGroupChatsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FindGroupChatsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FindGroupChatsRequest> parser()
Returns
Type Description
Parser<FindGroupChatsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FindGroupChatsRequest getDefaultInstanceForType()
Returns
Type Description
FindGroupChatsRequest

getPageSize()

public int getPageSize()

Optional. The maximum number of spaces to return. The service might return fewer than this value.

If unspecified, at most 10 spaces are returned.

The maximum value is 30. If you use a value more than 30, it's automatically changed to 30.

Negative values return an INVALID_ARGUMENT error.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<FindGroupChatsRequest> getParserForType()
Returns
Type Description
Parser<FindGroupChatsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpaceView()

public SpaceView getSpaceView()

Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.

.google.chat.v1.SpaceView space_view = 4;

Returns
Type Description
SpaceView

The spaceView.

getSpaceViewValue()

public int getSpaceViewValue()

Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.

.google.chat.v1.SpaceView space_view = 4;

Returns
Type Description
int

The enum numeric value on the wire for spaceView.

getUsers(int index)

public String getUsers(int index)

Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

The maximum number of users that can be specified in a single request is 49.

Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

repeated string users = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The users at the given index.

getUsersBytes(int index)

public ByteString getUsersBytes(int index)

Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

The maximum number of users that can be specified in a single request is 49.

Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

repeated string users = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the users at the given index.

getUsersCount()

public int getUsersCount()

Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

The maximum number of users that can be specified in a single request is 49.

Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

repeated string users = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of users.

getUsersList()

public ProtocolStringList getUsersList()

Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

The maximum number of users that can be specified in a single request is 49.

Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

repeated string users = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the users.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FindGroupChatsRequest.Builder newBuilderForType()
Returns
Type Description
FindGroupChatsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected FindGroupChatsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FindGroupChatsRequest.Builder
Overrides

toBuilder()

public FindGroupChatsRequest.Builder toBuilder()
Returns
Type Description
FindGroupChatsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException