Class ListLfpStoresRequest.Builder (1.13.0)

public static final class ListLfpStoresRequest.Builder extends GeneratedMessage.Builder<ListLfpStoresRequest.Builder> implements ListLfpStoresRequestOrBuilder

Request message for the ListLfpStores method.

Protobuf type google.shopping.merchant.lfp.v1beta.ListLfpStoresRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListLfpStoresRequest build()
Returns
Type Description
ListLfpStoresRequest

buildPartial()

public ListLfpStoresRequest buildPartial()
Returns
Type Description
ListLfpStoresRequest

clear()

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

clearPageSize()

public ListLfpStoresRequest.Builder clearPageSize()

Optional. The maximum number of LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

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

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.

clearPageToken()

public ListLfpStoresRequest.Builder clearPageToken()

Optional. A page token, received from a previous ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

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

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.

clearParent()

public ListLfpStoresRequest.Builder clearParent()

Required. The LFP partner. Format: accounts/{account}

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

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.

clearTargetAccount()

public ListLfpStoresRequest.Builder clearTargetAccount()

Required. The Merchant Center id of the merchant to list stores for.

int64 target_account = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListLfpStoresRequest getDefaultInstanceForType()
Returns
Type Description
ListLfpStoresRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Optional. The maximum number of LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

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 ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

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 ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The LFP partner. Format: 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 LFP partner. Format: accounts/{account}

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

Returns
Type Description
ByteString

The bytes for parent.

getTargetAccount()

public long getTargetAccount()

Required. The Merchant Center id of the merchant to list stores for.

int64 target_account = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The targetAccount.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(ListLfpStoresRequest other)

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

setPageSize(int value)

public ListLfpStoresRequest.Builder setPageSize(int value)

Optional. The maximum number of LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize. The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListLfpStoresRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListLfpStoresRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.

setParent(String value)

public ListLfpStoresRequest.Builder setParent(String value)

Required. The LFP partner. Format: 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
ListLfpStoresRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListLfpStoresRequest.Builder setParentBytes(ByteString value)

Required. The LFP partner. Format: 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
ListLfpStoresRequest.Builder

This builder for chaining.

setTargetAccount(long value)

public ListLfpStoresRequest.Builder setTargetAccount(long value)

Required. The Merchant Center id of the merchant to list stores for.

int64 target_account = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value long

The targetAccount to set.

Returns
Type Description
ListLfpStoresRequest.Builder

This builder for chaining.