public static final class ListMembershipsRequest.Builder extends GeneratedMessageV3.Builder<ListMembershipsRequest.Builder> implements ListMembershipsRequestOrBuilder
Request message for listing memberships.
Protobuf type google.chat.v1.ListMembershipsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListMembershipsRequest.BuilderImplements
ListMembershipsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListMembershipsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
build()
public ListMembershipsRequest build()
Returns | |
---|---|
Type | Description |
ListMembershipsRequest |
buildPartial()
public ListMembershipsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListMembershipsRequest |
clear()
public ListMembershipsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListMembershipsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
clearFilter()
public ListMembershipsRequest.Builder clearFilter()
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 |
ListMembershipsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListMembershipsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
clearPageSize()
public ListMembershipsRequest.Builder clearPageSize()
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 |
ListMembershipsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListMembershipsRequest.Builder clearPageToken()
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 |
ListMembershipsRequest.Builder |
This builder for chaining. |
clearParent()
public ListMembershipsRequest.Builder clearParent()
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 |
ListMembershipsRequest.Builder |
This builder for chaining. |
clearShowGroups()
public ListMembershipsRequest.Builder clearShowGroups()
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 |
ListMembershipsRequest.Builder |
This builder for chaining. |
clearShowInvited()
public ListMembershipsRequest.Builder clearShowInvited()
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 |
ListMembershipsRequest.Builder |
This builder for chaining. |
clone()
public ListMembershipsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
getDefaultInstanceForType()
public ListMembershipsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListMembershipsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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
.
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 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 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 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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListMembershipsRequest other)
public ListMembershipsRequest.Builder mergeFrom(ListMembershipsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListMembershipsRequest |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListMembershipsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListMembershipsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListMembershipsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListMembershipsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
setFilter(String value)
public ListMembershipsRequest.Builder setFilter(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListMembershipsRequest.Builder setFilterBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListMembershipsRequest.Builder setPageSize(int value)
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];
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListMembershipsRequest.Builder setPageToken(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListMembershipsRequest.Builder setPageTokenBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListMembershipsRequest.Builder setParent(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListMembershipsRequest.Builder setParentBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListMembershipsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
setShowGroups(boolean value)
public ListMembershipsRequest.Builder setShowGroups(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value |
boolean The showGroups to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setShowInvited(boolean value)
public ListMembershipsRequest.Builder setShowInvited(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value |
boolean The showInvited to set. |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListMembershipsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListMembershipsRequest.Builder |