Google Cloud Channel V1 Client - Class ListPurchasableOffersRequest (1.9.5)

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

Request message for ListPurchasableOffers.

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

Namespace

Google \ Cloud \ Channel \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ create_entitlement_purchase`	`Google\Cloud\Channel\V1\ListPurchasableOffersRequest\CreateEntitlementPurchase` List Offers for CreateEntitlement purchase.
`↳ change_offer_purchase`	`Google\Cloud\Channel\V1\ListPurchasableOffersRequest\ChangeOfferPurchase` List Offers for ChangeOffer purchase.
`↳ customer`	`string` Required. The resource name of the customer to list Offers for. Format: accounts/{account_id}/customers/{customer_id}.
`↳ page_size`	`int` Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 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.
`↳ 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".

getCreateEntitlementPurchase

List Offers for CreateEntitlement purchase.

Returns
Type	Description
`Google\Cloud\Channel\V1\ListPurchasableOffersRequest\CreateEntitlementPurchase\|null`

hasCreateEntitlementPurchase

setCreateEntitlementPurchase

List Offers for CreateEntitlement purchase.

Parameter
Name	Description
`var`	`Google\Cloud\Channel\V1\ListPurchasableOffersRequest\CreateEntitlementPurchase`

Returns
Type	Description
`$this`

getChangeOfferPurchase

List Offers for ChangeOffer purchase.

Returns
Type	Description
`Google\Cloud\Channel\V1\ListPurchasableOffersRequest\ChangeOfferPurchase\|null`

hasChangeOfferPurchase

setChangeOfferPurchase

List Offers for ChangeOffer purchase.

Parameter
Name	Description
`var`	`Google\Cloud\Channel\V1\ListPurchasableOffersRequest\ChangeOfferPurchase`

Returns
Type	Description
`$this`

getCustomer

Required. The resource name of the customer to list Offers for.

Format: accounts/{account_id}/customers/{customer_id}.

Returns
Type	Description
`string`

setCustomer

Required. The resource name of the customer to list Offers for.

Format: accounts/{account_id}/customers/{customer_id}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

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

Returns
Type	Description
`int`

setPageSize

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

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

Returns
Type	Description
`string`

setPageToken

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPurchaseOption

Returns
Type	Description
`string`