Class ListOrdersRequest.Builder (0.81.0)

public static final class ListOrdersRequest.Builder extends GeneratedMessage.Builder<ListOrdersRequest.Builder> implements ListOrdersRequestOrBuilder

Request message for ConsumerProcurementService.ListOrders.

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

Static Methods

getDescriptor()

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

Methods

build()

public ListOrdersRequest build()
Returns
Type Description
ListOrdersRequest

buildPartial()

public ListOrdersRequest buildPartial()
Returns
Type Description
ListOrdersRequest

clear()

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

clearFilter()

public ListOrdersRequest.Builder clearFilter()

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
ListOrdersRequest.Builder

This builder for chaining.

clearPageSize()

public ListOrdersRequest.Builder clearPageSize()

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
ListOrdersRequest.Builder

This builder for chaining.

clearPageToken()

public ListOrdersRequest.Builder clearPageToken()

The token for fetching the next page.

string page_token = 3;

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

clearParent()

public ListOrdersRequest.Builder clearParent()

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
ListOrdersRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListOrdersRequest getDefaultInstanceForType()
Returns
Type Description
ListOrdersRequest

getDescriptorForType()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListOrdersRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListOrdersRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListOrdersRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListOrdersRequest.Builder setPageSize(int value)

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

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListOrdersRequest.Builder setPageToken(String value)

The token for fetching the next page.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListOrdersRequest.Builder setPageTokenBytes(ByteString value)

The token for fetching the next page.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setParent(String value)

public ListOrdersRequest.Builder setParent(String value)

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];

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListOrdersRequest.Builder setParentBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.