Class ListPromotionsRequest (0.7.0)

public final class ListPromotionsRequest extends GeneratedMessageV3 implements ListPromotionsRequestOrBuilder

Request message for the ListPromotions method.

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

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListPromotionsRequest getDefaultInstance()
Returns
Type Description
ListPromotionsRequest

getDescriptor()

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

newBuilder()

public static ListPromotionsRequest.Builder newBuilder()
Returns
Type Description
ListPromotionsRequest.Builder

newBuilder(ListPromotionsRequest prototype)

public static ListPromotionsRequest.Builder newBuilder(ListPromotionsRequest prototype)
Parameter
Name Description
prototype ListPromotionsRequest
Returns
Type Description
ListPromotionsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListPromotionsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPromotionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListPromotionsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListPromotionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListPromotionsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListPromotionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListPromotionsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPromotionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListPromotionsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListPromotionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListPromotionsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListPromotionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListPromotionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListPromotionsRequest> parser()
Returns
Type Description
Parser<ListPromotionsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListPromotionsRequest getDefaultInstanceForType()
Returns
Type Description
ListPromotionsRequest

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.

getParserForType()

public Parser<ListPromotionsRequest> getParserForType()
Returns
Type Description
Parser<ListPromotionsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListPromotionsRequest.Builder newBuilderForType()
Returns
Type Description
ListPromotionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListPromotionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListPromotionsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListPromotionsRequest.Builder toBuilder()
Returns
Type Description
ListPromotionsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException