Class ListOrdersRequest.Builder (0.42.0)

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

A request to list orders.

Protobuf type google.cloud.gdchardwaremanagement.v1alpha.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()

Optional. Filtering condition. See AIP-160.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

clearOrderBy()

public ListOrdersRequest.Builder clearOrderBy()

Optional. Hint for how to order the results.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

clearPageSize()

public ListOrdersRequest.Builder clearPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

clearPageToken()

public ListOrdersRequest.Builder clearPageToken()

Optional. A token identifying a page of results the server should return.

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

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

clearParent()

public ListOrdersRequest.Builder clearParent()

Required. The project and location to list orders in. Format: projects/{project}/locations/{location}

To list orders across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

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

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()

Optional. Filtering condition. See AIP-160.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filtering condition. See AIP-160.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Hint for how to order the results.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Hint for how to order the results.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A token identifying a page of results the server should return.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A token identifying a page of results the server should return.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The project and location to list orders in. Format: projects/{project}/locations/{location}

To list orders across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project and location to list orders in. Format: projects/{project}/locations/{location}

To list orders across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

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

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)

Optional. Filtering condition. See AIP-160.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. Filtering condition. See AIP-160.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListOrdersRequest.Builder setOrderBy(String value)

Optional. Hint for how to order the results.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListOrdersRequest.Builder setOrderByBytes(ByteString value)

Optional. Hint for how to order the results.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListOrdersRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListOrdersRequest.Builder setPageSize(int value)

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

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)

Optional. A token identifying a page of results the server should return.

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

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)

Optional. A token identifying a page of results the server should return.

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

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 project and location to list orders in. Format: projects/{project}/locations/{location}

To list orders across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

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

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 project and location to list orders in. Format: projects/{project}/locations/{location}

To list orders across all locations, substitute - (the hyphen or dash character) for the location and check the unreachable field in the response message.

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

This builder for chaining.