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

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

An installment of the offer.

Generated from protobuf message google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment

Namespace

Google \ Cloud \ CommerceProducer \ V1beta \ PrivateOffer \ SingleProductOffer

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ start_time Google\Type\DateTime

Optional. The start time of the installment. Each installment must have a unique start time with one exception: When the term.start_policy of the offer's term is IMMEDIATE, the start_time of the first installment must be unset. The actual start time is not recorded in the offer and instead is determined by the time the resulting order became active. When the term.start_policy of the offer's term is SCHEDULED_START_TIME, then the first installment's start_time must match term.scheduled_start_time. If the term.end_policy of the offer's term is SCHEDULED_END_TIME, then installment start_time must be before term.scheduled_end_time. If it's AFTER_DURATION, then installment start_time must be before the time calculated by adding the term.duration_months to the start time of the offer. The start_time of the installments cannot be before the accept_deadline_time of the offer. Installment start times must be in strictly increasing chronological order.

↳ price_model PriceModel

Optional. The price model of the installment. All installments must have the same form of price model.

getStartTime

Optional. The start time of the installment.

Each installment must have a unique start time with one exception: When the term.start_policy of the offer's term is IMMEDIATE, the start_time of the first installment must be unset. The actual start time is not recorded in the offer and instead is determined by the time the resulting order became active. When the term.start_policy of the offer's term is SCHEDULED_START_TIME, then the first installment's start_time must match term.scheduled_start_time. If the term.end_policy of the offer's term is SCHEDULED_END_TIME, then installment start_time must be before term.scheduled_end_time. If it's AFTER_DURATION, then installment start_time must be before the time calculated by adding the term.duration_months to the start time of the offer. The start_time of the installments cannot be before the accept_deadline_time of the offer. Installment start times must be in strictly increasing chronological order.

Returns
Type Description
Google\Type\DateTime|null

hasStartTime

clearStartTime

setStartTime

Optional. The start time of the installment.

Each installment must have a unique start time with one exception: When the term.start_policy of the offer's term is IMMEDIATE, the start_time of the first installment must be unset. The actual start time is not recorded in the offer and instead is determined by the time the resulting order became active. When the term.start_policy of the offer's term is SCHEDULED_START_TIME, then the first installment's start_time must match term.scheduled_start_time. If the term.end_policy of the offer's term is SCHEDULED_END_TIME, then installment start_time must be before term.scheduled_end_time. If it's AFTER_DURATION, then installment start_time must be before the time calculated by adding the term.duration_months to the start time of the offer. The start_time of the installments cannot be before the accept_deadline_time of the offer. Installment start times must be in strictly increasing chronological order.

Parameter
Name Description
var Google\Type\DateTime
Returns
Type Description
$this

getPriceModel

Optional. The price model of the installment.

All installments must have the same form of price model.

Returns
Type Description
PriceModel|null

hasPriceModel

clearPriceModel

setPriceModel

Optional. The price model of the installment.

All installments must have the same form of price model.

Parameter
Name Description
var PriceModel
Returns
Type Description
$this