Google Cloud Channel V1 Client - Class ListPurchasableOffersRequest (1.0.1)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Generated from protobuf field .google.cloud.channel.v1.ListPurchasableOffersRequest.CreateEntitlementPurchase create_entitlement_purchase = 2;

Returns
TypeDescription
Google\Cloud\Channel\V1\ListPurchasableOffersRequest\CreateEntitlementPurchase|null

hasCreateEntitlementPurchase

setCreateEntitlementPurchase

List Offers for CreateEntitlement purchase.

Generated from protobuf field .google.cloud.channel.v1.ListPurchasableOffersRequest.CreateEntitlementPurchase create_entitlement_purchase = 2;

Parameter
NameDescription
var Google\Cloud\Channel\V1\ListPurchasableOffersRequest\CreateEntitlementPurchase
Returns
TypeDescription
$this

getChangeOfferPurchase

List Offers for ChangeOffer purchase.

Generated from protobuf field .google.cloud.channel.v1.ListPurchasableOffersRequest.ChangeOfferPurchase change_offer_purchase = 3;

Returns
TypeDescription
Google\Cloud\Channel\V1\ListPurchasableOffersRequest\ChangeOfferPurchase|null

hasChangeOfferPurchase

setChangeOfferPurchase

List Offers for ChangeOffer purchase.

Generated from protobuf field .google.cloud.channel.v1.ListPurchasableOffersRequest.ChangeOfferPurchase change_offer_purchase = 3;

Parameter
NameDescription
var Google\Cloud\Channel\V1\ListPurchasableOffersRequest\ChangeOfferPurchase
Returns
TypeDescription
$this

getCustomer

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

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

Generated from protobuf field string customer = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setCustomer

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

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

Generated from protobuf field string customer = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.

Generated from protobuf field int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Generated from protobuf field string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setPageToken

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

Generated from protobuf field string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];

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".

Generated from protobuf field string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];

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".

Generated from protobuf field string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPurchaseOption

Returns
TypeDescription
string