Class PrivateOffer.SingleProductOffer.Builder (0.1.0)

public static final class PrivateOffer.SingleProductOffer.Builder extends GeneratedMessage.Builder<PrivateOffer.SingleProductOffer.Builder> implements PrivateOffer.SingleProductOfferOrBuilder

Configurations for the offer that is associated with a single product.

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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PrivateOffer.SingleProductOffer.Builder

Implements

PrivateOffer.SingleProductOfferOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllEffectiveInstallmentTimeline(Iterable<? extends PrivateOffer.SingleProductOffer.Installment> values)

public PrivateOffer.SingleProductOffer.Builder addAllEffectiveInstallmentTimeline(Iterable<? extends PrivateOffer.SingleProductOffer.Installment> values)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment>

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addAllFeatures(Iterable<? extends PrivateOffer.SingleProductOffer.Feature> values)

public PrivateOffer.SingleProductOffer.Builder addAllFeatures(Iterable<? extends PrivateOffer.SingleProductOffer.Feature> values)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature>

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addEffectiveInstallmentTimeline(PrivateOffer.SingleProductOffer.Installment value)

public PrivateOffer.SingleProductOffer.Builder addEffectiveInstallmentTimeline(PrivateOffer.SingleProductOffer.Installment value)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.Installment

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addEffectiveInstallmentTimeline(PrivateOffer.SingleProductOffer.Installment.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder addEffectiveInstallmentTimeline(PrivateOffer.SingleProductOffer.Installment.Builder builderForValue)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	PrivateOffer.SingleProductOffer.Installment.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment value)

public PrivateOffer.SingleProductOffer.Builder addEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment value)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
value	PrivateOffer.SingleProductOffer.Installment

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder addEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment.Builder builderForValue)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
builderForValue	PrivateOffer.SingleProductOffer.Installment.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addEffectiveInstallmentTimelineBuilder()

public PrivateOffer.SingleProductOffer.Installment.Builder addEffectiveInstallmentTimelineBuilder()

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Installment.Builder

addEffectiveInstallmentTimelineBuilder(int index)

public PrivateOffer.SingleProductOffer.Installment.Builder addEffectiveInstallmentTimelineBuilder(int index)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Installment.Builder

addFeatures(PrivateOffer.SingleProductOffer.Feature value)

public PrivateOffer.SingleProductOffer.Builder addFeatures(PrivateOffer.SingleProductOffer.Feature value)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.Feature

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addFeatures(PrivateOffer.SingleProductOffer.Feature.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder addFeatures(PrivateOffer.SingleProductOffer.Feature.Builder builderForValue)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	PrivateOffer.SingleProductOffer.Feature.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addFeatures(int index, PrivateOffer.SingleProductOffer.Feature value)

public PrivateOffer.SingleProductOffer.Builder addFeatures(int index, PrivateOffer.SingleProductOffer.Feature value)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	PrivateOffer.SingleProductOffer.Feature

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addFeatures(int index, PrivateOffer.SingleProductOffer.Feature.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder addFeatures(int index, PrivateOffer.SingleProductOffer.Feature.Builder builderForValue)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	PrivateOffer.SingleProductOffer.Feature.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

addFeaturesBuilder()

public PrivateOffer.SingleProductOffer.Feature.Builder addFeaturesBuilder()

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Feature.Builder

addFeaturesBuilder(int index)

public PrivateOffer.SingleProductOffer.Feature.Builder addFeaturesBuilder(int index)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Feature.Builder

build()

public PrivateOffer.SingleProductOffer build()

Returns
Type	Description
PrivateOffer.SingleProductOffer

buildPartial()

public PrivateOffer.SingleProductOffer buildPartial()

Returns
Type	Description
PrivateOffer.SingleProductOffer

clear()

public PrivateOffer.SingleProductOffer.Builder clear()

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAmendedOffer()

public PrivateOffer.SingleProductOffer.Builder clearAmendedOffer()

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

clearAmendedPrivateOffer()

public PrivateOffer.SingleProductOffer.Builder clearAmendedPrivateOffer()

Optional. An existing private offer that will be superseded by this offer. Unless the private offer is for a product type that supports multiple active orders, an amendment private offer must be transacted if and only if the destination customer billing account already contains an active order for the same product. The offer to be superseded must be the offer associated with an active order.

Amendments generally fall into one of two scenarios:

1. Active Order / Ended Offer: The term of the amended offer has ended but it is still associated with an active order. The new offer must amend the ended private offer.

2. Active Order / Active Offer: The term of the amended offer is still active and the associated order is active. Similar to above, the new offer must amend the currently active offer (unless "multiple active orders" are supported).

   If this is set, then the base_standard_offer parent service must match the parent service of the base_standard_offer in the amended_private_offer.

   Active Term Restrictions: If the term of the amended private offer has NOT ended, then the following compatibility rules apply:

3. Price Model Compatibility:

4. Flat Fee (with or without usage) offers can amend Flat Fee offers.
5. Usage-only or CUD offers can amend usage-only offers.
6. Commitment-based offers must amend offers of the same price model subtype (e.g., "additional usage at list price" vs "all usage discounted").
7. Billing Frequency Compatibility: Determined by standard_interval or custom_interval_price.
8. If the amended offer has a custom billing frequency, the new offer must also have a custom frequency.
9. If the amended offer has a standard frequency (Monthly, Quarterly, or Yearly), the new offer must maintain the same frequency or transition to a custom frequency.
10. Switching between different standard frequencies (e.g., Monthly to Quarterly) is not supported.
11. For Monthly frequency, switching between MONTHLY_PRORATED and MONTHLY_NOT_PRORATED is supported, unless the offer's term.end_policy is MATCH_AMENDED_OFFER.

12. For usage-only offers, there are no billing frequency restrictions.

    Other criteria for offer amendment are detailed elsewhere.

string amended_private_offer = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

clearAmendedStandardOffer()

public PrivateOffer.SingleProductOffer.Builder clearAmendedStandardOffer()

Optional. An existing standard offer that will be superseded by this offer. An amendment private offer must be transacted if the destination customer billing account already contains an active order for the same product, and otherwise cannot be transacted. The offer to be superseded must be the offer associated with the active order.

If this is set, then the base_standard_offer must contain the same parent service as the parent service of the amended_standard_offer. The price model of this offer must be compatible with the price model of the amended_standard_offer:

• Flat Fee, or Flat Fee with usage offers can amend Flat Fee or Flat Fee with usage standard offers.

• Usage-only offers, or CUD offers can amend usage-only standard offers.

  Other criteria for offer amendment are detailed elsewhere.

string amended_standard_offer = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

clearBaseStandardOffer()

public PrivateOffer.SingleProductOffer.Builder clearBaseStandardOffer()

Optional. The StandardOffer this PrivateOffer is based on. Must be in the same project as the private offer, and must be effective at the time of publishing. Must be present to publish the offer.

Format: projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

string base_standard_offer = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

clearContractValue()

public PrivateOffer.SingleProductOffer.Builder clearContractValue()

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

clearCustomIntervalPrice()

public PrivateOffer.SingleProductOffer.Builder clearCustomIntervalPrice()

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

clearEffectiveInstallmentTimeline()

public PrivateOffer.SingleProductOffer.Builder clearEffectiveInstallmentTimeline()

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

clearFeatures()

public PrivateOffer.SingleProductOffer.Builder clearFeatures()

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

clearPrice()

public PrivateOffer.SingleProductOffer.Builder clearPrice()

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

clearResellerPrivateOfferPlanId()

public PrivateOffer.SingleProductOffer.Builder clearResellerPrivateOfferPlanId()

Output only. Present for offers created by a reseller from a reseller private offer plan (RPOP). When set, contains the ID of the originating RPOP. Not included for PRIVATE_OFFER_VIEW_BASIC.

string reseller_private_offer_plan_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

clearRevenueShare()

public PrivateOffer.SingleProductOffer.Builder clearRevenueShare()

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

clearServiceLevel()

public PrivateOffer.SingleProductOffer.Builder clearServiceLevel()

Output only. The service level (also known as the 'plan') of the base standard offer. The value is populated at publish time from the base standard offer.

string service_level = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

clearStandardIntervalPrice()

public PrivateOffer.SingleProductOffer.Builder clearStandardIntervalPrice()

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

getAmendedOfferCase()

public PrivateOffer.SingleProductOffer.AmendedOfferCase getAmendedOfferCase()

Returns
Type	Description
PrivateOffer.SingleProductOffer.AmendedOfferCase

getAmendedPrivateOffer()

public String getAmendedPrivateOffer()

Optional. An existing private offer that will be superseded by this offer. Unless the private offer is for a product type that supports multiple active orders, an amendment private offer must be transacted if and only if the destination customer billing account already contains an active order for the same product. The offer to be superseded must be the offer associated with an active order.

Amendments generally fall into one of two scenarios:

1. Active Order / Ended Offer: The term of the amended offer has ended but it is still associated with an active order. The new offer must amend the ended private offer.

2. Active Order / Active Offer: The term of the amended offer is still active and the associated order is active. Similar to above, the new offer must amend the currently active offer (unless "multiple active orders" are supported).

   If this is set, then the base_standard_offer parent service must match the parent service of the base_standard_offer in the amended_private_offer.

   Active Term Restrictions: If the term of the amended private offer has NOT ended, then the following compatibility rules apply:

3. Price Model Compatibility:

4. Flat Fee (with or without usage) offers can amend Flat Fee offers.
5. Usage-only or CUD offers can amend usage-only offers.
6. Commitment-based offers must amend offers of the same price model subtype (e.g., "additional usage at list price" vs "all usage discounted").
7. Billing Frequency Compatibility: Determined by standard_interval or custom_interval_price.
8. If the amended offer has a custom billing frequency, the new offer must also have a custom frequency.
9. If the amended offer has a standard frequency (Monthly, Quarterly, or Yearly), the new offer must maintain the same frequency or transition to a custom frequency.
10. Switching between different standard frequencies (e.g., Monthly to Quarterly) is not supported.
11. For Monthly frequency, switching between MONTHLY_PRORATED and MONTHLY_NOT_PRORATED is supported, unless the offer's term.end_policy is MATCH_AMENDED_OFFER.

12. For usage-only offers, there are no billing frequency restrictions.

    Other criteria for offer amendment are detailed elsewhere.

string amended_private_offer = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The amendedPrivateOffer.

getAmendedPrivateOfferBytes()

public ByteString getAmendedPrivateOfferBytes()

Optional. An existing private offer that will be superseded by this offer. Unless the private offer is for a product type that supports multiple active orders, an amendment private offer must be transacted if and only if the destination customer billing account already contains an active order for the same product. The offer to be superseded must be the offer associated with an active order.

Amendments generally fall into one of two scenarios:

1. Active Order / Ended Offer: The term of the amended offer has ended but it is still associated with an active order. The new offer must amend the ended private offer.

2. Active Order / Active Offer: The term of the amended offer is still active and the associated order is active. Similar to above, the new offer must amend the currently active offer (unless "multiple active orders" are supported).

   If this is set, then the base_standard_offer parent service must match the parent service of the base_standard_offer in the amended_private_offer.

   Active Term Restrictions: If the term of the amended private offer has NOT ended, then the following compatibility rules apply:

3. Price Model Compatibility:

4. Flat Fee (with or without usage) offers can amend Flat Fee offers.
5. Usage-only or CUD offers can amend usage-only offers.
6. Commitment-based offers must amend offers of the same price model subtype (e.g., "additional usage at list price" vs "all usage discounted").
7. Billing Frequency Compatibility: Determined by standard_interval or custom_interval_price.
8. If the amended offer has a custom billing frequency, the new offer must also have a custom frequency.
9. If the amended offer has a standard frequency (Monthly, Quarterly, or Yearly), the new offer must maintain the same frequency or transition to a custom frequency.
10. Switching between different standard frequencies (e.g., Monthly to Quarterly) is not supported.
11. For Monthly frequency, switching between MONTHLY_PRORATED and MONTHLY_NOT_PRORATED is supported, unless the offer's term.end_policy is MATCH_AMENDED_OFFER.

12. For usage-only offers, there are no billing frequency restrictions.

    Other criteria for offer amendment are detailed elsewhere.

string amended_private_offer = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for amendedPrivateOffer.

getAmendedStandardOffer()

public String getAmendedStandardOffer()

Optional. An existing standard offer that will be superseded by this offer. An amendment private offer must be transacted if the destination customer billing account already contains an active order for the same product, and otherwise cannot be transacted. The offer to be superseded must be the offer associated with the active order.

If this is set, then the base_standard_offer must contain the same parent service as the parent service of the amended_standard_offer. The price model of this offer must be compatible with the price model of the amended_standard_offer:

• Flat Fee, or Flat Fee with usage offers can amend Flat Fee or Flat Fee with usage standard offers.

• Usage-only offers, or CUD offers can amend usage-only standard offers.

  Other criteria for offer amendment are detailed elsewhere.

string amended_standard_offer = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The amendedStandardOffer.

getAmendedStandardOfferBytes()

public ByteString getAmendedStandardOfferBytes()

Optional. An existing standard offer that will be superseded by this offer. An amendment private offer must be transacted if the destination customer billing account already contains an active order for the same product, and otherwise cannot be transacted. The offer to be superseded must be the offer associated with the active order.

If this is set, then the base_standard_offer must contain the same parent service as the parent service of the amended_standard_offer. The price model of this offer must be compatible with the price model of the amended_standard_offer:

• Flat Fee, or Flat Fee with usage offers can amend Flat Fee or Flat Fee with usage standard offers.

• Usage-only offers, or CUD offers can amend usage-only standard offers.

  Other criteria for offer amendment are detailed elsewhere.

string amended_standard_offer = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for amendedStandardOffer.

getBaseStandardOffer()

public String getBaseStandardOffer()

Optional. The StandardOffer this PrivateOffer is based on. Must be in the same project as the private offer, and must be effective at the time of publishing. Must be present to publish the offer.

Format: projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

string base_standard_offer = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The baseStandardOffer.

getBaseStandardOfferBytes()

public ByteString getBaseStandardOfferBytes()

Optional. The StandardOffer this PrivateOffer is based on. Must be in the same project as the private offer, and must be effective at the time of publishing. Must be present to publish the offer.

Format: projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

string base_standard_offer = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for baseStandardOffer.

getContractValue()

public PrivateOffer.SingleProductOffer.ContractValue getContractValue()

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.ContractValue	The contractValue.

getContractValueBuilder()

public PrivateOffer.SingleProductOffer.ContractValue.Builder getContractValueBuilder()

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.ContractValue.Builder

getContractValueOrBuilder()

public PrivateOffer.SingleProductOffer.ContractValueOrBuilder getContractValueOrBuilder()

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.ContractValueOrBuilder

getCustomIntervalPrice()

public PrivateOffer.SingleProductOffer.CustomIntervalPrice getCustomIntervalPrice()

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.CustomIntervalPrice	The customIntervalPrice.

getCustomIntervalPriceBuilder()

public PrivateOffer.SingleProductOffer.CustomIntervalPrice.Builder getCustomIntervalPriceBuilder()

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.CustomIntervalPrice.Builder

getCustomIntervalPriceOrBuilder()

public PrivateOffer.SingleProductOffer.CustomIntervalPriceOrBuilder getCustomIntervalPriceOrBuilder()

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.CustomIntervalPriceOrBuilder

getDefaultInstanceForType()

public PrivateOffer.SingleProductOffer getDefaultInstanceForType()

Returns
Type	Description
PrivateOffer.SingleProductOffer

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getEffectiveInstallmentTimeline(int index)

public PrivateOffer.SingleProductOffer.Installment getEffectiveInstallmentTimeline(int index)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Installment

getEffectiveInstallmentTimelineBuilder(int index)

public PrivateOffer.SingleProductOffer.Installment.Builder getEffectiveInstallmentTimelineBuilder(int index)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Installment.Builder

getEffectiveInstallmentTimelineBuilderList()

public List<PrivateOffer.SingleProductOffer.Installment.Builder> getEffectiveInstallmentTimelineBuilderList()

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Builder>

getEffectiveInstallmentTimelineCount()

public int getEffectiveInstallmentTimelineCount()

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getEffectiveInstallmentTimelineList()

public List<PrivateOffer.SingleProductOffer.Installment> getEffectiveInstallmentTimelineList()

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Installment>

getEffectiveInstallmentTimelineOrBuilder(int index)

public PrivateOffer.SingleProductOffer.InstallmentOrBuilder getEffectiveInstallmentTimelineOrBuilder(int index)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.InstallmentOrBuilder

getEffectiveInstallmentTimelineOrBuilderList()

public List<? extends PrivateOffer.SingleProductOffer.InstallmentOrBuilder> getEffectiveInstallmentTimelineOrBuilderList()

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.InstallmentOrBuilder>

getFeatures(int index)

public PrivateOffer.SingleProductOffer.Feature getFeatures(int index)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Feature

getFeaturesBuilder(int index)

public PrivateOffer.SingleProductOffer.Feature.Builder getFeaturesBuilder(int index)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Feature.Builder

getFeaturesBuilderList()

public List<PrivateOffer.SingleProductOffer.Feature.Builder> getFeaturesBuilderList()

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getFeaturesCount()

public int getFeaturesCount()

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getFeaturesList()

public List<PrivateOffer.SingleProductOffer.Feature> getFeaturesList()

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Feature>

getFeaturesOrBuilder(int index)

public PrivateOffer.SingleProductOffer.FeatureOrBuilder getFeaturesOrBuilder(int index)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.FeatureOrBuilder

getFeaturesOrBuilderList()

public List<? extends PrivateOffer.SingleProductOffer.FeatureOrBuilder> getFeaturesOrBuilderList()

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.FeatureOrBuilder>

getPriceCase()

public PrivateOffer.SingleProductOffer.PriceCase getPriceCase()

Returns
Type	Description
PrivateOffer.SingleProductOffer.PriceCase

getResellerPrivateOfferPlanId()

public String getResellerPrivateOfferPlanId()

Output only. Present for offers created by a reseller from a reseller private offer plan (RPOP). When set, contains the ID of the originating RPOP. Not included for PRIVATE_OFFER_VIEW_BASIC.

string reseller_private_offer_plan_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The resellerPrivateOfferPlanId.

getResellerPrivateOfferPlanIdBytes()

public ByteString getResellerPrivateOfferPlanIdBytes()

Output only. Present for offers created by a reseller from a reseller private offer plan (RPOP). When set, contains the ID of the originating RPOP. Not included for PRIVATE_OFFER_VIEW_BASIC.

string reseller_private_offer_plan_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for resellerPrivateOfferPlanId.

getRevenueShare()

public PrivateOffer.SingleProductOffer.RevenueShare getRevenueShare()

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.RevenueShare	The revenueShare.

getRevenueShareBuilder()

public PrivateOffer.SingleProductOffer.RevenueShare.Builder getRevenueShareBuilder()

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.RevenueShare.Builder

getRevenueShareOrBuilder()

public PrivateOffer.SingleProductOffer.RevenueShareOrBuilder getRevenueShareOrBuilder()

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
PrivateOffer.SingleProductOffer.RevenueShareOrBuilder

getServiceLevel()

public String getServiceLevel()

Output only. The service level (also known as the 'plan') of the base standard offer. The value is populated at publish time from the base standard offer.

string service_level = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The serviceLevel.

getServiceLevelBytes()

public ByteString getServiceLevelBytes()

Output only. The service level (also known as the 'plan') of the base standard offer. The value is populated at publish time from the base standard offer.

string service_level = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for serviceLevel.

getStandardIntervalPrice()

public PrivateOffer.SingleProductOffer.StandardIntervalPrice getStandardIntervalPrice()

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.StandardIntervalPrice	The standardIntervalPrice.

getStandardIntervalPriceBuilder()

public PrivateOffer.SingleProductOffer.StandardIntervalPrice.Builder getStandardIntervalPriceBuilder()

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.StandardIntervalPrice.Builder

getStandardIntervalPriceOrBuilder()

public PrivateOffer.SingleProductOffer.StandardIntervalPriceOrBuilder getStandardIntervalPriceOrBuilder()

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
PrivateOffer.SingleProductOffer.StandardIntervalPriceOrBuilder

hasAmendedPrivateOffer()

public boolean hasAmendedPrivateOffer()

Optional. An existing private offer that will be superseded by this offer. Unless the private offer is for a product type that supports multiple active orders, an amendment private offer must be transacted if and only if the destination customer billing account already contains an active order for the same product. The offer to be superseded must be the offer associated with an active order.

Amendments generally fall into one of two scenarios:

1. Active Order / Ended Offer: The term of the amended offer has ended but it is still associated with an active order. The new offer must amend the ended private offer.

2. Active Order / Active Offer: The term of the amended offer is still active and the associated order is active. Similar to above, the new offer must amend the currently active offer (unless "multiple active orders" are supported).

   If this is set, then the base_standard_offer parent service must match the parent service of the base_standard_offer in the amended_private_offer.

   Active Term Restrictions: If the term of the amended private offer has NOT ended, then the following compatibility rules apply:

3. Price Model Compatibility:

4. Flat Fee (with or without usage) offers can amend Flat Fee offers.
5. Usage-only or CUD offers can amend usage-only offers.
6. Commitment-based offers must amend offers of the same price model subtype (e.g., "additional usage at list price" vs "all usage discounted").
7. Billing Frequency Compatibility: Determined by standard_interval or custom_interval_price.
8. If the amended offer has a custom billing frequency, the new offer must also have a custom frequency.
9. If the amended offer has a standard frequency (Monthly, Quarterly, or Yearly), the new offer must maintain the same frequency or transition to a custom frequency.
10. Switching between different standard frequencies (e.g., Monthly to Quarterly) is not supported.
11. For Monthly frequency, switching between MONTHLY_PRORATED and MONTHLY_NOT_PRORATED is supported, unless the offer's term.end_policy is MATCH_AMENDED_OFFER.

12. For usage-only offers, there are no billing frequency restrictions.

    Other criteria for offer amendment are detailed elsewhere.

string amended_private_offer = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the amendedPrivateOffer field is set.

hasAmendedStandardOffer()

public boolean hasAmendedStandardOffer()

Optional. An existing standard offer that will be superseded by this offer. An amendment private offer must be transacted if the destination customer billing account already contains an active order for the same product, and otherwise cannot be transacted. The offer to be superseded must be the offer associated with the active order.

If this is set, then the base_standard_offer must contain the same parent service as the parent service of the amended_standard_offer. The price model of this offer must be compatible with the price model of the amended_standard_offer:

• Flat Fee, or Flat Fee with usage offers can amend Flat Fee or Flat Fee with usage standard offers.

• Usage-only offers, or CUD offers can amend usage-only standard offers.

  Other criteria for offer amendment are detailed elsewhere.

string amended_standard_offer = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the amendedStandardOffer field is set.

hasContractValue()

public boolean hasContractValue()

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the contractValue field is set.

hasCustomIntervalPrice()

public boolean hasCustomIntervalPrice()

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customIntervalPrice field is set.

hasRevenueShare()

public boolean hasRevenueShare()

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the revenueShare field is set.

hasStandardIntervalPrice()

public boolean hasStandardIntervalPrice()

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the standardIntervalPrice field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeContractValue(PrivateOffer.SingleProductOffer.ContractValue value)

public PrivateOffer.SingleProductOffer.Builder mergeContractValue(PrivateOffer.SingleProductOffer.ContractValue value)

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.ContractValue

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

mergeCustomIntervalPrice(PrivateOffer.SingleProductOffer.CustomIntervalPrice value)

public PrivateOffer.SingleProductOffer.Builder mergeCustomIntervalPrice(PrivateOffer.SingleProductOffer.CustomIntervalPrice value)

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.CustomIntervalPrice

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

mergeFrom(PrivateOffer.SingleProductOffer other)

public PrivateOffer.SingleProductOffer.Builder mergeFrom(PrivateOffer.SingleProductOffer other)

Parameter
Name	Description
other	PrivateOffer.SingleProductOffer

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PrivateOffer.SingleProductOffer.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public PrivateOffer.SingleProductOffer.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRevenueShare(PrivateOffer.SingleProductOffer.RevenueShare value)

public PrivateOffer.SingleProductOffer.Builder mergeRevenueShare(PrivateOffer.SingleProductOffer.RevenueShare value)

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.RevenueShare

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

mergeStandardIntervalPrice(PrivateOffer.SingleProductOffer.StandardIntervalPrice value)

public PrivateOffer.SingleProductOffer.Builder mergeStandardIntervalPrice(PrivateOffer.SingleProductOffer.StandardIntervalPrice value)

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.StandardIntervalPrice

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

removeEffectiveInstallmentTimeline(int index)

public PrivateOffer.SingleProductOffer.Builder removeEffectiveInstallmentTimeline(int index)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

removeFeatures(int index)

public PrivateOffer.SingleProductOffer.Builder removeFeatures(int index)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setAmendedPrivateOffer(String value)

public PrivateOffer.SingleProductOffer.Builder setAmendedPrivateOffer(String value)

Optional. An existing private offer that will be superseded by this offer. Unless the private offer is for a product type that supports multiple active orders, an amendment private offer must be transacted if and only if the destination customer billing account already contains an active order for the same product. The offer to be superseded must be the offer associated with an active order.

Amendments generally fall into one of two scenarios:

1. Active Order / Ended Offer: The term of the amended offer has ended but it is still associated with an active order. The new offer must amend the ended private offer.

2. Active Order / Active Offer: The term of the amended offer is still active and the associated order is active. Similar to above, the new offer must amend the currently active offer (unless "multiple active orders" are supported).

   If this is set, then the base_standard_offer parent service must match the parent service of the base_standard_offer in the amended_private_offer.

   Active Term Restrictions: If the term of the amended private offer has NOT ended, then the following compatibility rules apply:

3. Price Model Compatibility:

4. Flat Fee (with or without usage) offers can amend Flat Fee offers.
5. Usage-only or CUD offers can amend usage-only offers.
6. Commitment-based offers must amend offers of the same price model subtype (e.g., "additional usage at list price" vs "all usage discounted").
7. Billing Frequency Compatibility: Determined by standard_interval or custom_interval_price.
8. If the amended offer has a custom billing frequency, the new offer must also have a custom frequency.
9. If the amended offer has a standard frequency (Monthly, Quarterly, or Yearly), the new offer must maintain the same frequency or transition to a custom frequency.
10. Switching between different standard frequencies (e.g., Monthly to Quarterly) is not supported.
11. For Monthly frequency, switching between MONTHLY_PRORATED and MONTHLY_NOT_PRORATED is supported, unless the offer's term.end_policy is MATCH_AMENDED_OFFER.

12. For usage-only offers, there are no billing frequency restrictions.

    Other criteria for offer amendment are detailed elsewhere.

string amended_private_offer = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The amendedPrivateOffer to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setAmendedPrivateOfferBytes(ByteString value)

public PrivateOffer.SingleProductOffer.Builder setAmendedPrivateOfferBytes(ByteString value)

Optional. An existing private offer that will be superseded by this offer. Unless the private offer is for a product type that supports multiple active orders, an amendment private offer must be transacted if and only if the destination customer billing account already contains an active order for the same product. The offer to be superseded must be the offer associated with an active order.

Amendments generally fall into one of two scenarios:

1. Active Order / Ended Offer: The term of the amended offer has ended but it is still associated with an active order. The new offer must amend the ended private offer.

2. Active Order / Active Offer: The term of the amended offer is still active and the associated order is active. Similar to above, the new offer must amend the currently active offer (unless "multiple active orders" are supported).

   If this is set, then the base_standard_offer parent service must match the parent service of the base_standard_offer in the amended_private_offer.

   Active Term Restrictions: If the term of the amended private offer has NOT ended, then the following compatibility rules apply:

3. Price Model Compatibility:

4. Flat Fee (with or without usage) offers can amend Flat Fee offers.
5. Usage-only or CUD offers can amend usage-only offers.
6. Commitment-based offers must amend offers of the same price model subtype (e.g., "additional usage at list price" vs "all usage discounted").
7. Billing Frequency Compatibility: Determined by standard_interval or custom_interval_price.
8. If the amended offer has a custom billing frequency, the new offer must also have a custom frequency.
9. If the amended offer has a standard frequency (Monthly, Quarterly, or Yearly), the new offer must maintain the same frequency or transition to a custom frequency.
10. Switching between different standard frequencies (e.g., Monthly to Quarterly) is not supported.
11. For Monthly frequency, switching between MONTHLY_PRORATED and MONTHLY_NOT_PRORATED is supported, unless the offer's term.end_policy is MATCH_AMENDED_OFFER.

12. For usage-only offers, there are no billing frequency restrictions.

    Other criteria for offer amendment are detailed elsewhere.

string amended_private_offer = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes for amendedPrivateOffer to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setAmendedStandardOffer(String value)

public PrivateOffer.SingleProductOffer.Builder setAmendedStandardOffer(String value)

Optional. An existing standard offer that will be superseded by this offer. An amendment private offer must be transacted if the destination customer billing account already contains an active order for the same product, and otherwise cannot be transacted. The offer to be superseded must be the offer associated with the active order.

If this is set, then the base_standard_offer must contain the same parent service as the parent service of the amended_standard_offer. The price model of this offer must be compatible with the price model of the amended_standard_offer:

• Flat Fee, or Flat Fee with usage offers can amend Flat Fee or Flat Fee with usage standard offers.

• Usage-only offers, or CUD offers can amend usage-only standard offers.

  Other criteria for offer amendment are detailed elsewhere.

string amended_standard_offer = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The amendedStandardOffer to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setAmendedStandardOfferBytes(ByteString value)

public PrivateOffer.SingleProductOffer.Builder setAmendedStandardOfferBytes(ByteString value)

Optional. An existing standard offer that will be superseded by this offer. An amendment private offer must be transacted if the destination customer billing account already contains an active order for the same product, and otherwise cannot be transacted. The offer to be superseded must be the offer associated with the active order.

If this is set, then the base_standard_offer must contain the same parent service as the parent service of the amended_standard_offer. The price model of this offer must be compatible with the price model of the amended_standard_offer:

• Flat Fee, or Flat Fee with usage offers can amend Flat Fee or Flat Fee with usage standard offers.

• Usage-only offers, or CUD offers can amend usage-only standard offers.

  Other criteria for offer amendment are detailed elsewhere.

string amended_standard_offer = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes for amendedStandardOffer to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setBaseStandardOffer(String value)

public PrivateOffer.SingleProductOffer.Builder setBaseStandardOffer(String value)

Optional. The StandardOffer this PrivateOffer is based on. Must be in the same project as the private offer, and must be effective at the time of publishing. Must be present to publish the offer.

Format: projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

string base_standard_offer = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The baseStandardOffer to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setBaseStandardOfferBytes(ByteString value)

public PrivateOffer.SingleProductOffer.Builder setBaseStandardOfferBytes(ByteString value)

Optional. The StandardOffer this PrivateOffer is based on. Must be in the same project as the private offer, and must be effective at the time of publishing. Must be present to publish the offer.

Format: projects/{project}/locations/{location}/services/{service}/standardOffers/{standard_offer}

string base_standard_offer = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes for baseStandardOffer to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setContractValue(PrivateOffer.SingleProductOffer.ContractValue value)

public PrivateOffer.SingleProductOffer.Builder setContractValue(PrivateOffer.SingleProductOffer.ContractValue value)

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.ContractValue

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setContractValue(PrivateOffer.SingleProductOffer.ContractValue.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder setContractValue(PrivateOffer.SingleProductOffer.ContractValue.Builder builderForValue)

Output only. Contract value of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.ContractValue contract_value = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	PrivateOffer.SingleProductOffer.ContractValue.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setCustomIntervalPrice(PrivateOffer.SingleProductOffer.CustomIntervalPrice value)

public PrivateOffer.SingleProductOffer.Builder setCustomIntervalPrice(PrivateOffer.SingleProductOffer.CustomIntervalPrice value)

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.CustomIntervalPrice

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setCustomIntervalPrice(PrivateOffer.SingleProductOffer.CustomIntervalPrice.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder setCustomIntervalPrice(PrivateOffer.SingleProductOffer.CustomIntervalPrice.Builder builderForValue)

Optional. Price configurations for offers with custom intervals. Custom interval corresponds to "custom billing frequency", see https://docs.cloud.google.com/marketplace/docs/partners/offers/select-payment-schedule. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.CustomIntervalPrice custom_interval_price = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	PrivateOffer.SingleProductOffer.CustomIntervalPrice.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment value)

public PrivateOffer.SingleProductOffer.Builder setEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment value)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
value	PrivateOffer.SingleProductOffer.Installment

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder setEffectiveInstallmentTimeline(int index, PrivateOffer.SingleProductOffer.Installment.Builder builderForValue)

Output only. The effective installment timeline of the offer. Not included for PRIVATE_OFFER_VIEW_BASIC. Included for PRIVATE_OFFER_VIEW_FULL if all necessary information is available to generate the timeline, and if the offer has 'standard_interval_price' of 'MONTHLY_PRORATED', 'MONTHLY_NOT_PRORATED', 'QUARTERLY_NOT_PRORATED', or 'YEARLY_NOT_PRORATED'.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Installment effective_installment_timeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
builderForValue	PrivateOffer.SingleProductOffer.Installment.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setFeatures(int index, PrivateOffer.SingleProductOffer.Feature value)

public PrivateOffer.SingleProductOffer.Builder setFeatures(int index, PrivateOffer.SingleProductOffer.Feature value)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	PrivateOffer.SingleProductOffer.Feature

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setFeatures(int index, PrivateOffer.SingleProductOffer.Feature.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder setFeatures(int index, PrivateOffer.SingleProductOffer.Feature.Builder builderForValue)

Optional. The custom product features to display for this offer. Feature display_name values must be unique to publish the offer. The set of features specified here should generally include all features included in the base service level, with optionally customized values, but is not required to match exactly and may include additional features.

repeated .google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.Feature features = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	PrivateOffer.SingleProductOffer.Feature.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setResellerPrivateOfferPlanId(String value)

public PrivateOffer.SingleProductOffer.Builder setResellerPrivateOfferPlanId(String value)

Output only. Present for offers created by a reseller from a reseller private offer plan (RPOP). When set, contains the ID of the originating RPOP. Not included for PRIVATE_OFFER_VIEW_BASIC.

string reseller_private_offer_plan_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The resellerPrivateOfferPlanId to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setResellerPrivateOfferPlanIdBytes(ByteString value)

public PrivateOffer.SingleProductOffer.Builder setResellerPrivateOfferPlanIdBytes(ByteString value)

Output only. Present for offers created by a reseller from a reseller private offer plan (RPOP). When set, contains the ID of the originating RPOP. Not included for PRIVATE_OFFER_VIEW_BASIC.

string reseller_private_offer_plan_id = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for resellerPrivateOfferPlanId to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setRevenueShare(PrivateOffer.SingleProductOffer.RevenueShare value)

public PrivateOffer.SingleProductOffer.Builder setRevenueShare(PrivateOffer.SingleProductOffer.RevenueShare value)

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.RevenueShare

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setRevenueShare(PrivateOffer.SingleProductOffer.RevenueShare.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder setRevenueShare(PrivateOffer.SingleProductOffer.RevenueShare.Builder builderForValue)

Output only. Revenue share information for this Private Offer. Not included for PRIVATE_OFFER_VIEW_BASIC.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.RevenueShare revenue_share = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	PrivateOffer.SingleProductOffer.RevenueShare.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setServiceLevel(String value)

public PrivateOffer.SingleProductOffer.Builder setServiceLevel(String value)

Output only. The service level (also known as the 'plan') of the base standard offer. The value is populated at publish time from the base standard offer.

string service_level = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The serviceLevel to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setServiceLevelBytes(ByteString value)

public PrivateOffer.SingleProductOffer.Builder setServiceLevelBytes(ByteString value)

Output only. The service level (also known as the 'plan') of the base standard offer. The value is populated at publish time from the base standard offer.

string service_level = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for serviceLevel to set.

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder	This builder for chaining.

setStandardIntervalPrice(PrivateOffer.SingleProductOffer.StandardIntervalPrice value)

public PrivateOffer.SingleProductOffer.Builder setStandardIntervalPrice(PrivateOffer.SingleProductOffer.StandardIntervalPrice value)

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	PrivateOffer.SingleProductOffer.StandardIntervalPrice

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder

setStandardIntervalPrice(PrivateOffer.SingleProductOffer.StandardIntervalPrice.Builder builderForValue)

public PrivateOffer.SingleProductOffer.Builder setStandardIntervalPrice(PrivateOffer.SingleProductOffer.StandardIntervalPrice.Builder builderForValue)

Optional. Price configurations for offers with standard intervals. A price must be set when publishing the offer.

.google.cloud.commerceproducer.v1beta.PrivateOffer.SingleProductOffer.StandardIntervalPrice standard_interval_price = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	PrivateOffer.SingleProductOffer.StandardIntervalPrice.Builder

Returns
Type	Description
PrivateOffer.SingleProductOffer.Builder