Google Cloud Commerce Producer V1beta Client - Class ListStandardOffersRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Commerce Producer V1beta Client class ListStandardOffersRequest.

Message for requesting list of StandardOffers

Generated from protobuf message google.cloud.commerceproducer.v1beta.ListStandardOffersRequest

Namespace

Google \ Cloud \ CommerceProducer \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Parent value for ListStandardOffersRequest
↳ 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. Supports filtering by: * * effective_time. Example: effective_time > "2012-04-21T11:30:00-04:00". * * expire_time. Example: expire_time < "2026-05-06T00:00:00Z".
↳ 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. Supports ordering by: * * effective_time * * expire_time

getParent

Required. Parent value for ListStandardOffersRequest

Returns
Type Description
string

setParent

Required. Parent value for ListStandardOffersRequest

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. Supports filtering by:

  • effective_time. Example: effective_time > "2012-04-21T11:30:00-04:00".
  • expire_time. Example: expire_time < "2026-05-06T00:00:00Z".
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. Supports filtering by:

  • effective_time. Example: effective_time > "2012-04-21T11:30:00-04:00".
  • expire_time. Example: expire_time < "2026-05-06T00:00:00Z".
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. Supports ordering by:

  • effective_time
  • expire_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. Supports ordering by:

  • effective_time
  • expire_time
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Parent value for ListStandardOffersRequest Please see CommerceTransactionClient::serviceName() for help formatting this field.
Returns
Type Description
ListStandardOffersRequest