Interface ListUserListsRequestOrBuilder (0.8.0)

public interface ListUserListsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: display_name = "list 1"). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (has)

    Supported fields:

  • id

  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: display_name = "list 1"). Fields must be specified using either all camel case or all snake case. Don't use a combination of camel case and snake case.

Supported operations:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (has)

    Supported fields:

  • id

  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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 ListUserLists call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserLists must match the call that provided the page token.

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 ListUserLists call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserLists must match the call that provided the page token.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}

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 parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.