Class ListUserListGlobalLicenseCustomerInfosRequest.Builder (0.8.0) 

public static final class ListUserListGlobalLicenseCustomerInfosRequest.Builder extends GeneratedMessage.Builder<ListUserListGlobalLicenseCustomerInfosRequest.Builder> implements ListUserListGlobalLicenseCustomerInfosRequestOrBuilder

Request to list all UserListGlobalLicenseCustomerInfo resources for a given user list global license.

Protobuf type google.ads.datamanager.v1.ListUserListGlobalLicenseCustomerInfosRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListUserListGlobalLicenseCustomerInfosRequest.Builder

Static Methods

getDescriptor()

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

Methods

build()

public ListUserListGlobalLicenseCustomerInfosRequest build()
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest

buildPartial()

public ListUserListGlobalLicenseCustomerInfosRequest buildPartial()
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest

clear()

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

clearFilter()

public ListUserListGlobalLicenseCustomerInfosRequest.Builder clearFilter()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). 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
  • =
  • !=
  • >
  • >=
  • <

  • <=

    Unsupported Fields:

  • name (use get method instead)

  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time

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

Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

clearPageSize()

public ListUserListGlobalLicenseCustomerInfosRequest.Builder clearPageSize()

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

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

clearPageToken()

public ListUserListGlobalLicenseCustomerInfosRequest.Builder clearPageToken()

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

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

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

Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

clearParent()

public ListUserListGlobalLicenseCustomerInfosRequest.Builder clearParent()

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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

Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListUserListGlobalLicenseCustomerInfosRequest getDefaultInstanceForType()
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). 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
  • =
  • !=
  • >
  • >=
  • <

  • <=

    Unsupported Fields:

  • name (use get method instead)

  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). 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
  • =
  • !=
  • >
  • >=
  • <

  • <=

    Unsupported Fields:

  • name (use get method instead)

  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

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

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

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

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

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

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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(ListUserListGlobalLicenseCustomerInfosRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListUserListGlobalLicenseCustomerInfosRequest.Builder setFilter(String value)

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). 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
  • =
  • !=
  • >
  • >=
  • <

  • <=

    Unsupported Fields:

  • name (use get method instead)

  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListUserListGlobalLicenseCustomerInfosRequest.Builder setFilterBytes(ByteString value)

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). 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
  • =
  • !=
  • >
  • >=
  • <

  • <=

    Unsupported Fields:

  • name (use get method instead)

  • historical_pricings and all its subfields
  • pricing.start_time
  • pricing.end_time

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListUserListGlobalLicenseCustomerInfosRequest.Builder setPageSize(int value)

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

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListUserListGlobalLicenseCustomerInfosRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

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

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

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListUserListGlobalLicenseCustomerInfosRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

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

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

setParent(String value)

public ListUserListGlobalLicenseCustomerInfosRequest.Builder setParent(String value)

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListUserListGlobalLicenseCustomerInfosRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListUserListGlobalLicenseCustomerInfosRequest.Builder setParentBytes(ByteString value)

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

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

This builder for chaining.