public final class ListMembershipsRequest extends GeneratedMessageV3 implements ListMembershipsRequestOrBuilder
Request message for listing memberships.
Protobuf type google.chat.v1.ListMembershipsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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 |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SHOW_GROUPS_FIELD_NUMBER
public static final int SHOW_GROUPS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SHOW_INVITED_FIELD_NUMBER
public static final int SHOW_INVITED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USE_ADMIN_ACCESS_FIELD_NUMBER
public static final int USE_ADMIN_ACCESS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListMembershipsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListMembershipsRequest.Builder newBuilder()
newBuilder(ListMembershipsRequest prototype)
public static ListMembershipsRequest.Builder newBuilder(ListMembershipsRequest prototype)
public static ListMembershipsRequest parseDelimitedFrom(InputStream input)
public static ListMembershipsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListMembershipsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListMembershipsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListMembershipsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListMembershipsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListMembershipsRequest parseFrom(CodedInputStream input)
public static ListMembershipsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListMembershipsRequest parseFrom(InputStream input)
public static ListMembershipsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListMembershipsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListMembershipsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListMembershipsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListMembershipsRequest getDefaultInstanceForType()
getFilter()
public String getFilter()
Optional. A query filter.
You can filter memberships by a member's role
(role)
and type
(member.type).
To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER.
To filter by type, set member.type to HUMAN or BOT. You can also
filter for member.type using the != operator.
To filter by both role and type, use the AND operator. To filter by
either role or type, use the OR operator.
Either member.type = "HUMAN" or member.type != "BOT" is required
when use_admin_access is set to true. Other member type filters will be
rejected.
For example, the following queries are valid:
`
role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"
member.type != "BOT"
The following queries are invalid:
member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
Invalid queries are rejected by the server with an INVALID_ARGUMENT`
error.
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
Optional. A query filter.
You can filter memberships by a member's role
(role)
and type
(member.type).
To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER.
To filter by type, set member.type to HUMAN or BOT. You can also
filter for member.type using the != operator.
To filter by both role and type, use the AND operator. To filter by
either role or type, use the OR operator.
Either member.type = "HUMAN" or member.type != "BOT" is required
when use_admin_access is set to true. Other member type filters will be
rejected.
For example, the following queries are valid:
`
role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"
member.type != "BOT"
The following queries are invalid:
member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
Invalid queries are rejected by the server with an INVALID_ARGUMENT`
error.
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
getPageSize()
Optional. The maximum number of memberships to return. The service might
return fewer than this value.
If unspecified, at most 100 memberships are returned.
The maximum value is 1000. If you use a value more than 1000, it's
automatically changed to 1000.
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 list memberships.
Provide this parameter to retrieve the subsequent page.
When paginating, all other parameters provided should match the call that
provided the page token. Passing different values to the other parameters
might 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 list memberships.
Provide this parameter to retrieve the subsequent page.
When paginating, all other parameters provided should match the call that
provided the page token. Passing different values to the other parameters
might lead to unexpected results.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
getParent()
public String getParent()
Required. The resource name of the space for which to fetch a membership
list.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The resource name of the space for which to fetch a membership
list.
Format: spaces/{space}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListMembershipsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getShowGroups()
public boolean getShowGroups()
Optional. When true, also returns memberships associated with a
Google Group, in
addition to other types of memberships. If a
filter is set,
Google Group
memberships that don't match the filter criteria aren't returned.
bool show_groups = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The showGroups.
|
getShowInvited()
public boolean getShowInvited()
Optional. When true, also returns memberships associated with
invited members, in
addition to other types of memberships. If a
filter is set,
invited memberships
that don't match the filter criteria aren't returned.
Currently requires user
authentication.
bool show_invited = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The showInvited.
|
getUseAdminAccess()
public boolean getUseAdminAccess()
Optional. When true, the method runs using the user's Google Workspace
administrator privileges.
The calling user must be a Google Workspace administrator with the
manage chat and spaces conversations
privilege.
Requires either the chat.admin.memberships.readonly or
chat.admin.memberships OAuth 2.0
scope.
Listing app memberships in a space isn't supported when using admin access.
bool use_admin_access = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The useAdminAccess.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListMembershipsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListMembershipsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListMembershipsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
