public interface ListMembershipsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract 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
.
To filter by both role and type, use the AND
operator. To filter by
either role or type, use the OR
operator.
For example, the following queries are valid:
`
role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"
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 abstract 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
.
To filter by both role and type, use the AND
operator. To filter by
either role or type, use the OR
operator.
For example, the following queries are valid:
`
role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"
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()
public abstract int 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getShowGroups()
public abstract 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 abstract 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. |