Class: Google::Apps::Chat::V1::ListMembershipsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/chat/v1/membership.rb

Overview

Request message for listing memberships.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



300
301
302
303
 
# File 'proto_docs/google/chat/v1/membership.rb', line 300

class ListMembershipsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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.

Returns:

  • (::Integer) —

    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.



300
301
302
303
 
# File 'proto_docs/google/chat/v1/membership.rb', line 300

class ListMembershipsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



300
301
302
303
 
# File 'proto_docs/google/chat/v1/membership.rb', line 300

class ListMembershipsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The resource name of the space for which to fetch a membership list.

Format: spaces/{space}.

Returns:

  • (::String) —

    Required. The resource name of the space for which to fetch a membership list.

    Format: spaces/{space}



300
301
302
303
 
# File 'proto_docs/google/chat/v1/membership.rb', line 300

class ListMembershipsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#show_groups ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



300
301
302
303
 
# File 'proto_docs/google/chat/v1/membership.rb', line 300

class ListMembershipsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#show_invited ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



300
301
302
303
 
# File 'proto_docs/google/chat/v1/membership.rb', line 300

class ListMembershipsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_admin_access ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



300
301
302
303
 
# File 'proto_docs/google/chat/v1/membership.rb', line 300

class ListMembershipsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end