Reference documentation and code samples for the Google Cloud Commerce Producer V1beta Client class ListPrivateOffersRequest.
Message for requesting list of PrivateOffers
Generated from protobuf message google.cloud.commerceproducer.v1beta.ListPrivateOffersRequest
Namespace
Google \ Cloud \ CommerceProducer \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Parent value for ListPrivateOffersRequest |
↳ page_size |
int
Optional. Maximum results to return. The service may return fewer than this value. The maximum value is 500; values above 500 will be coerced to 500. If unspecified, the server will default to the maximum. |
↳ page_token |
string
Optional. A page token, received from a previous list response message. Provide this to retrieve the subsequent page. When paginating, all other parameters of the list request must match the request that returned the page token. |
↳ filter |
string
Optional. Filter expression that matches a subset of resources to show. See https://google.aip.dev/160 for more details. Only supports filtering by: * * |
↳ order_by |
string
Optional. Ordering expression for sorting the results. See https://google.aip.dev/132#ordering for more details. If no value is present the default ordering is unspecified. Only supports ordering by: * * |
getParent
Required. Parent value for ListPrivateOffersRequest
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. Parent value for ListPrivateOffersRequest
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Maximum results to return. The service may return fewer than this value. The maximum value is 500; values above 500 will be coerced to 500.
If unspecified, the server will default to the maximum.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Maximum results to return. The service may return fewer than this value. The maximum value is 500; values above 500 will be coerced to 500.
If unspecified, the server will default to the maximum.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous list response message.
Provide this to retrieve the subsequent page. When paginating, all other parameters of the list request must match the request that returned the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous list response message.
Provide this to retrieve the subsequent page. When paginating, all other parameters of the list request must match the request that returned the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filter expression that matches a subset of resources to show.
See https://google.aip.dev/160 for more details. Only supports filtering by:
update_time. Example:update_time > "2012-04-21T11:30:00-04:00".
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filter expression that matches a subset of resources to show.
See https://google.aip.dev/160 for more details. Only supports filtering by:
update_time. Example:update_time > "2012-04-21T11:30:00-04:00".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Ordering expression for sorting the results.
See https://google.aip.dev/132#ordering for more details. If no value is present the default ordering is unspecified. Only supports ordering by:
update_time
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Ordering expression for sorting the results.
See https://google.aip.dev/132#ordering for more details. If no value is present the default ordering is unspecified. Only supports ordering by:
update_time
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Parent value for ListPrivateOffersRequest Please see CommerceTransactionClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListPrivateOffersRequest |
|