Google Cloud Channel V1 Client - Class ListOffersRequest (1.2.1)

Reference documentation and code samples for the Google Cloud Channel V1 Client class ListOffersRequest.

Request message for ListOffers.

Generated from protobuf message google.cloud.channel.v1.ListOffersRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

↳ page_size int

Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

↳ page_token string

Optional. A token for a page of results other than the first page.

↳ filter string

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product). Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

↳ language_code string

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".

↳ show_future_offers bool

Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

getParent

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

Returns
TypeDescription
string

setParent

Required. The resource name of the reseller account from which to list Offers. Parent uses the format: accounts/{account_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

Returns
TypeDescription
int

setPageSize

Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 500 Offers. The maximum value is 1000; the server will coerce values above 1000.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. A token for a page of results other than the first page.

Returns
TypeDescription
string

setPageToken

Optional. A token for a page of results other than the first page.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product).

Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

Returns
TypeDescription
string

setFilter

Optional. The expression to filter results by name (name of the Offer), sku.name (name of the SKU), or sku.product.name (name of the Product).

Example 1: sku.product.name=products/p1 AND sku.name!=products/p1/skus/s1 Example 2: name=accounts/a1/offers/o1

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLanguageCode

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified.

The default value is "en-US".

Returns
TypeDescription
string

setLanguageCode

Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified.

The default value is "en-US".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getShowFutureOffers

Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

Returns
TypeDescription
bool

setShowFutureOffers

Optional. A boolean flag that determines if a response returns future offers 30 days from now. If the show_future_offers is true, the response will only contain offers that are scheduled to be available 30 days from now.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this