Class PrivateOffer.SingleProductOffer.PriceModel.Commitment (0.1.0)

public static final class PrivateOffer.SingleProductOffer.PriceModel.Commitment extends GeneratedMessage implements PrivateOffer.SingleProductOffer.PriceModel.CommitmentOrBuilder

The price configurations for the commitment based subscriptions.

Protobuf type google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.PriceModel.Commitment

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > PrivateOffer.SingleProductOffer.PriceModel.Commitment

Static Fields

ADDITIONAL_CREDIT_FIELD_NUMBER

public static final int ADDITIONAL_CREDIT_FIELD_NUMBER
Field Value
Type Description
int

COMMITMENT_AMOUNT_FIELD_NUMBER

public static final int COMMITMENT_AMOUNT_FIELD_NUMBER
Field Value
Type Description
int

DISCARD_PREVIOUS_CREDIT_BALANCE_FIELD_NUMBER

public static final int DISCARD_PREVIOUS_CREDIT_BALANCE_FIELD_NUMBER
Field Value
Type Description
int

DISCOUNT_PERCENT_FIELD_NUMBER

public static final int DISCOUNT_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment getDefaultInstance()
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder newBuilder()
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder

newBuilder(PrivateOffer.SingleProductOffer.PriceModel.Commitment prototype)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder newBuilder(PrivateOffer.SingleProductOffer.PriceModel.Commitment prototype)
Parameter
Name Description
prototype PrivateOffer.SingleProductOffer.PriceModel.Commitment
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder

parseDelimitedFrom(InputStream input)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PrivateOffer.SingleProductOffer.PriceModel.Commitment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PrivateOffer.SingleProductOffer.PriceModel.Commitment> parser()
Returns
Type Description
Parser<Commitment>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdditionalCredit()

public Money getAdditionalCredit()

Optional. Additional credit granted to the customer. Additional credits are only supported for custom interval offers. Equivalent behavior can be achieved for standard interval offers by varying the commitment_amount and discount_percent.

Value cannot be negative. The currency must be "USD" and precision is limited to cents. The maximum allowed value is 1,000,000 USD.

.google.type.Money additional_credit = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Money

The additionalCredit.

getAdditionalCreditOrBuilder()

public MoneyOrBuilder getAdditionalCreditOrBuilder()

Optional. Additional credit granted to the customer. Additional credits are only supported for custom interval offers. Equivalent behavior can be achieved for standard interval offers by varying the commitment_amount and discount_percent.

Value cannot be negative. The currency must be "USD" and precision is limited to cents. The maximum allowed value is 1,000,000 USD.

.google.type.Money additional_credit = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.MoneyOrBuilder

getCommitmentAmount()

public Money getCommitmentAmount()

Optional. The commitment balance that the customer will receive. Value cannot be negative. The currency must be "USD" and precision is limited to cents. Must be present to publish the offer, if the parent message is set. The maximum allowed value is 1,000,000,000 USD.

If the current offer amends a private offer where the term has not ended, and if the field single_product_offer.standard_interval_price.price_model.commitment.commitment_amount is set on both the current offer and the amended private offer, then the commitment amount must be equal or higher on the current offer, compared to the amended private offer.

.google.type.Money commitment_amount = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Money

The commitmentAmount.

getCommitmentAmountOrBuilder()

public MoneyOrBuilder getCommitmentAmountOrBuilder()

Optional. The commitment balance that the customer will receive. Value cannot be negative. The currency must be "USD" and precision is limited to cents. Must be present to publish the offer, if the parent message is set. The maximum allowed value is 1,000,000,000 USD.

If the current offer amends a private offer where the term has not ended, and if the field single_product_offer.standard_interval_price.price_model.commitment.commitment_amount is set on both the current offer and the amended private offer, then the commitment amount must be equal or higher on the current offer, compared to the amended private offer.

.google.type.Money commitment_amount = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.MoneyOrBuilder

getDefaultInstanceForType()

public PrivateOffer.SingleProductOffer.PriceModel.Commitment getDefaultInstanceForType()
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment

getDiscardPreviousCreditBalance()

public boolean getDiscardPreviousCreditBalance()

Optional. Whether to discard the previous credit balance when the associated installment starts. If not set, the previous credit balance will be rolled over to the current installment.

If there are no previous installments, then the value of this field will not matter - since it has no effect when no credits exist.

bool discard_previous_credit_balance = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The discardPreviousCreditBalance.

getDiscountPercent()

public Decimal getDiscountPercent()

Optional. The discount percent on commitment_amount.

For example, 10 means a discount of 10%. If the original commitment_amount is $100 then the discounted amount will be $90. The customer is charged $90 and receives $100 in credits.

All reported usage will be charged at the standard price. If this field is set, the price_model.usage must be unset. A private offer can apply a discount to all usage or to a usage commitment, but not both.

Must be between 0 and 100 inclusive, with precision up to 2 decimal places. If this field is set, then the allowed pattern for 'value' is ^([0-9]{1,2}(\\.\\d{1,2})?|100(\\.0{1,2})?)$. Examples of valid values: "0", "100.0", "12.34", "40.0". Example of invalid values: ".3", "-1", "100.1", "12.345", "+12", "".

Must be present to publish the offer.

.google.type.Decimal discount_percent = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.Decimal

The discountPercent.

getDiscountPercentOrBuilder()

public DecimalOrBuilder getDiscountPercentOrBuilder()

Optional. The discount percent on commitment_amount.

For example, 10 means a discount of 10%. If the original commitment_amount is $100 then the discounted amount will be $90. The customer is charged $90 and receives $100 in credits.

All reported usage will be charged at the standard price. If this field is set, the price_model.usage must be unset. A private offer can apply a discount to all usage or to a usage commitment, but not both.

Must be between 0 and 100 inclusive, with precision up to 2 decimal places. If this field is set, then the allowed pattern for 'value' is ^([0-9]{1,2}(\\.\\d{1,2})?|100(\\.0{1,2})?)$. Examples of valid values: "0", "100.0", "12.34", "40.0". Example of invalid values: ".3", "-1", "100.1", "12.345", "+12", "".

Must be present to publish the offer.

.google.type.Decimal discount_percent = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
com.google.type.DecimalOrBuilder

getParserForType()

public Parser<PrivateOffer.SingleProductOffer.PriceModel.Commitment> getParserForType()
Returns
Type Description
Parser<Commitment>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAdditionalCredit()

public boolean hasAdditionalCredit()

Optional. Additional credit granted to the customer. Additional credits are only supported for custom interval offers. Equivalent behavior can be achieved for standard interval offers by varying the commitment_amount and discount_percent.

Value cannot be negative. The currency must be "USD" and precision is limited to cents. The maximum allowed value is 1,000,000 USD.

.google.type.Money additional_credit = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the additionalCredit field is set.

hasCommitmentAmount()

public boolean hasCommitmentAmount()

Optional. The commitment balance that the customer will receive. Value cannot be negative. The currency must be "USD" and precision is limited to cents. Must be present to publish the offer, if the parent message is set. The maximum allowed value is 1,000,000,000 USD.

If the current offer amends a private offer where the term has not ended, and if the field single_product_offer.standard_interval_price.price_model.commitment.commitment_amount is set on both the current offer and the amended private offer, then the commitment amount must be equal or higher on the current offer, compared to the amended private offer.

.google.type.Money commitment_amount = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the commitmentAmount field is set.

hasDiscountPercent()

public boolean hasDiscountPercent()

Optional. The discount percent on commitment_amount.

For example, 10 means a discount of 10%. If the original commitment_amount is $100 then the discounted amount will be $90. The customer is charged $90 and receives $100 in credits.

All reported usage will be charged at the standard price. If this field is set, the price_model.usage must be unset. A private offer can apply a discount to all usage or to a usage commitment, but not both.

Must be between 0 and 100 inclusive, with precision up to 2 decimal places. If this field is set, then the allowed pattern for 'value' is ^([0-9]{1,2}(\\.\\d{1,2})?|100(\\.0{1,2})?)$. Examples of valid values: "0", "100.0", "12.34", "40.0". Example of invalid values: ".3", "-1", "100.1", "12.345", "+12", "".

Must be present to publish the offer.

.google.type.Decimal discount_percent = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the discountPercent field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder newBuilderForType()
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder
Overrides

toBuilder()

public PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder toBuilder()
Returns
Type Description
PrivateOffer.SingleProductOffer.PriceModel.Commitment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException