Reference documentation and code samples for the Google Cloud Commerce Consumer Procurement V1 Client class ListOrdersRequest.
Request message for ConsumerProcurementService.ListOrders.
Generated from protobuf message google.cloud.commerce.consumer.procurement.v1.ListOrdersRequest
Namespace
Google \ Cloud \ Commerce \ Consumer \ Procurement \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource to query for orders. This field has the form |
↳ page_size |
int
The maximum number of entries requested. The default page size is 25 and the maximum page size is 200. |
↳ page_token |
string
The token for fetching the next page. |
↳ filter |
string
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, |
getParent
Required. The parent resource to query for orders.
This field has the form billingAccounts/{billing-account-id}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent resource to query for orders.
This field has the form billingAccounts/{billing-account-id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of entries requested.
The default page size is 25 and the maximum page size is 200.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of entries requested.
The default page size is 25 and the maximum page size is 200.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
The token for fetching the next page.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
The token for fetching the next page.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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_nameIf 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 withOR, andNOTto form more complex queries. You can also group them to force a desired evaluation order. For example,display_name=abc OR display_name=def.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
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_nameIf 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 withOR, andNOTto form more complex queries. You can also group them to force a desired evaluation order. For example,display_name=abc OR display_name=def.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent resource to query for orders.
This field has the form |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Commerce\Consumer\Procurement\V1\ListOrdersRequest |
|