Class ListPromotionsRequest.Builder (0.1.0)

public static final class ListPromotionsRequest.Builder extends GeneratedMessageV3.Builder<ListPromotionsRequest.Builder> implements ListPromotionsRequestOrBuilder

Request message for the ListPromotions method.

Protobuf type google.shopping.merchant.promotions.v1beta.ListPromotionsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListPromotionsRequest build()
Returns
Type Description
ListPromotionsRequest

buildPartial()

public ListPromotionsRequest buildPartial()
Returns
Type Description
ListPromotionsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListPromotionsRequest.Builder clearPageSize()

Output only. The maximum number of promotions 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 promotions will be returned.

int32 page_size = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListPromotionsRequest.Builder clearPageToken()

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

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

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

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

clearParent()

public ListPromotionsRequest.Builder clearParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListPromotionsRequest getDefaultInstanceForType()
Returns
Type Description
ListPromotionsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Output only. The maximum number of promotions 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 promotions will be returned.

int32 page_size = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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

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

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

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

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

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 ListPromotionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPromotionsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(ListPromotionsRequest other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListPromotionsRequest.Builder setPageSize(int value)

Output only. The maximum number of promotions 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 promotions will be returned.

int32 page_size = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListPromotionsRequest.Builder setPageToken(String value)

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

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListPromotionsRequest.Builder setPageTokenBytes(ByteString value)

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

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

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListPromotionsRequest.Builder setParent(String value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListPromotionsRequest.Builder setParentBytes(ByteString value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListPromotionsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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