Class ListUserListsRequest.Builder (0.8.0)

public static final class ListUserListsRequest.Builder extends GeneratedMessage.Builder<ListUserListsRequest.Builder> implements ListUserListsRequestOrBuilder

Request message for ListUserLists.

Protobuf type google.ads.datamanager.v1.ListUserListsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ListUserListsRequest build()
Returns
Type Description
ListUserListsRequest

buildPartial()

public ListUserListsRequest buildPartial()
Returns
Type Description
ListUserListsRequest

clear()

public ListUserListsRequest.Builder clear()
Returns
Type Description
ListUserListsRequest.Builder
Overrides

clearFilter()

public ListUserListsRequest.Builder clearFilter()

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
ListUserListsRequest.Builder

This builder for chaining.

clearPageSize()

public ListUserListsRequest.Builder clearPageSize()

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
ListUserListsRequest.Builder

This builder for chaining.

clearPageToken()

public ListUserListsRequest.Builder clearPageToken()

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
ListUserListsRequest.Builder

This builder for chaining.

clearParent()

public ListUserListsRequest.Builder clearParent()

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
ListUserListsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListUserListsRequest getDefaultInstanceForType()
Returns
Type Description
ListUserListsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListUserListsRequest other)

public ListUserListsRequest.Builder mergeFrom(ListUserListsRequest other)
Parameter
Name Description
other ListUserListsRequest
Returns
Type Description
ListUserListsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListUserListsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListUserListsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListUserListsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListUserListsRequest.Builder
Overrides

setFilter(String value)

public ListUserListsRequest.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListUserListsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListUserListsRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListUserListsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListUserListsRequest.Builder setPageSize(int value)

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];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListUserListsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListUserListsRequest.Builder setPageToken(String value)

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];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListUserListsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListUserListsRequest.Builder setPageTokenBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListUserListsRequest.Builder

This builder for chaining.

setParent(String value)

public ListUserListsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListUserListsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListUserListsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListUserListsRequest.Builder

This builder for chaining.