Class ListProductsRequest.Builder (0.3.0)

public static final class ListProductsRequest.Builder extends GeneratedMessageV3.Builder<ListProductsRequest.Builder> implements ListProductsRequestOrBuilder

Request message for the ListProducts method.

Protobuf type google.shopping.merchant.products.v1beta.ListProductsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListProductsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListProductsRequest.Builder
Overrides

build()

public ListProductsRequest build()
Returns
Type Description
ListProductsRequest

buildPartial()

public ListProductsRequest buildPartial()
Returns
Type Description
ListProductsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public ListProductsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListProductsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListProductsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListProductsRequest.Builder
Overrides

clearPageSize()

public ListProductsRequest.Builder clearPageSize()

The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of products will be returned.

int32 page_size = 2;

Returns
Type Description
ListProductsRequest.Builder

This builder for chaining.

clearPageToken()

public ListProductsRequest.Builder clearPageToken()

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

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

string page_token = 3;

Returns
Type Description
ListProductsRequest.Builder

This builder for chaining.

clearParent()

public ListProductsRequest.Builder clearParent()

Required. The account to list processed products for. Format: accounts/{account}

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

Returns
Type Description
ListProductsRequest.Builder

This builder for chaining.

clone()

public ListProductsRequest.Builder clone()
Returns
Type Description
ListProductsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListProductsRequest getDefaultInstanceForType()
Returns
Type Description
ListProductsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of products will be returned.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

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

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

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

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The account to list processed products for. 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 account to list processed products for. Format: accounts/{account}

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(ListProductsRequest other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListProductsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListProductsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListProductsRequest.Builder
Overrides

setPageSize(int value)

public ListProductsRequest.Builder setPageSize(int value)

The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of products will be returned.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListProductsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListProductsRequest.Builder setPageToken(String value)

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

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListProductsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListProductsRequest.Builder setPageTokenBytes(ByteString value)

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

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListProductsRequest.Builder

This builder for chaining.

setParent(String value)

public ListProductsRequest.Builder setParent(String value)

Required. The account to list processed products for. 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
ListProductsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListProductsRequest.Builder setParentBytes(ByteString value)

Required. The account to list processed products for. 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
ListProductsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListProductsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListProductsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListProductsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListProductsRequest.Builder
Overrides