Class ListOrdersRequest (0.49.0) 

public final class ListOrdersRequest extends GeneratedMessageV3 implements ListOrdersRequestOrBuilder

Request message for ConsumerProcurementService.ListOrders.

Protobuf type google.cloud.commerce.consumer.procurement.v1.ListOrdersRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListOrdersRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

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 ListOrdersRequest getDefaultInstance()
Returns
Type Description
ListOrdersRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListOrdersRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListOrdersRequest getDefaultInstanceForType()
Returns
Type Description
ListOrdersRequest

getFilter()

public String getFilter()

Filter that you can use to limit the list request.

A query string that can match a selected set of attributes with string values. For example, display_name=abc. Supported query attributes are

  • display_name

    If the query contains special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, display_name="foo:bar", where the display name needs to be quoted because it contains special character colon.

    Queries can be combined with OR, and NOT to form more complex queries. You can also group them to force a desired evaluation order. For example, display_name=abc OR display_name=def.

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Filter that you can use to limit the list request.

A query string that can match a selected set of attributes with string values. For example, display_name=abc. Supported query attributes are

  • display_name

    If the query contains special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, display_name="foo:bar", where the display name needs to be quoted because it contains special character colon.

    Queries can be combined with OR, and NOT to form more complex queries. You can also group them to force a desired evaluation order. For example, display_name=abc OR display_name=def.

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of entries requested. The default page size is 25 and the maximum page size is 200.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

The token for fetching the next page.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The token for fetching the next page.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent resource to query for orders. This field has the form billingAccounts/{billing-account-id}.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource to query for orders. This field has the form billingAccounts/{billing-account-id}.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListOrdersRequest> getParserForType()
Returns
Type Description
Parser<ListOrdersRequest>
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 ListOrdersRequest.Builder newBuilderForType()
Returns
Type Description
ListOrdersRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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