Class PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder (0.5.0) 

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

Additional contract value that represents a spend obligation or target contract value tracked out-of-band by the partner.

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

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllEligibleSkus(Iterable<String> values)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder addAllEligibleSkus(Iterable<String> values)

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The eligibleSkus to add.
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

This builder for chaining.

addEligibleSkus(String value)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder addEligibleSkus(String value)

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The eligibleSkus to add.
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

This builder for chaining.

addEligibleSkusBytes(ByteString value)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder addEligibleSkusBytes(ByteString value)

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the eligibleSkus to add.
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

This builder for chaining.

build()

public PrivateOffer.SingleProductOffer.AdditionalContractValue build()
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue

buildPartial()

public PrivateOffer.SingleProductOffer.AdditionalContractValue buildPartial()
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue

clear()

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder clear()
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder
Overrides

clearContractValue()

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder clearContractValue()

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

clearEligibleSkus()

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder clearEligibleSkus()

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

This builder for chaining.

getContractValue()

public Money getContractValue()

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Returns
Type Description
com.google.type.Money

The contractValue.

getContractValueBuilder()

public Money.Builder getContractValueBuilder()

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Returns
Type Description
com.google.type.Money.Builder

getContractValueOrBuilder()

public MoneyOrBuilder getContractValueOrBuilder()

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Returns
Type Description
com.google.type.MoneyOrBuilder

getDefaultInstanceForType()

public PrivateOffer.SingleProductOffer.AdditionalContractValue getDefaultInstanceForType()
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEligibleSkus(int index)

public String getEligibleSkus(int index)

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The eligibleSkus at the given index.

getEligibleSkusBytes(int index)

public ByteString getEligibleSkusBytes(int index)

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the eligibleSkus at the given index.

getEligibleSkusCount()

public int getEligibleSkusCount()

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of eligibleSkus.

getEligibleSkusList()

public ProtocolStringList getEligibleSkusList()

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the eligibleSkus.

hasContractValue()

public boolean hasContractValue()

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Returns
Type Description
boolean

Whether the contractValue field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeContractValue(Money value)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder mergeContractValue(Money value)

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

mergeFrom(PrivateOffer.SingleProductOffer.AdditionalContractValue other)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder mergeFrom(PrivateOffer.SingleProductOffer.AdditionalContractValue other)
Parameter
Name Description
other PrivateOffer.SingleProductOffer.AdditionalContractValue
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder
Overrides

setContractValue(Money value)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder setContractValue(Money value)

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Parameter
Name Description
value com.google.type.Money
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

setContractValue(Money.Builder builderForValue)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder setContractValue(Money.Builder builderForValue)

Optional. The absolute, cumulative contract value of the customer's spend obligation that is added on top of the automatically billed fees from Google. This amount is not automatically billed or invoiced by Google; instead, it is tracked as a legal spend guarantee to be met via usage reporting and manually trued-up by partners.

The overall total contract value of the offer is calculated as the sum of Google-billed fees (from installments), plus this additional contract value.

For amendments, this field must be set to the new cumulative additional total.

For example:

  • Initial Offer: 3 installments of $15 (total $45 billed by Google) plus an additional_contract_value of $100 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the offer is $145 ($45 + $100).

  • Amended Offer: 6 installments of $15 (total $90 billed by Google) plus an additional_contract_value of $70 (billed by Partner, with true-ups happening at the end of the offer's term). The overall total contract value of the amended offer is $160 ($90 + $70).

    Must be non-negative. The maximum allowed value is 1,000,000,000 USD.

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

Parameter
Name Description
builderForValue com.google.type.Money.Builder
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

setEligibleSkus(int index, String value)

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder setEligibleSkus(int index, String value)

Optional. The resource names of the SKUs whose tracked usage is eligible to contribute toward satisfying this additional contract value obligation.

This list explicitly separates core spend obligations from exclusions like overage fees, which do not count toward meeting the customer's legal spend commitment.

Must be non-empty for the offer to be published.

Format: projects/{project}/locations/{location}/services/{service}/skus/{sku}

repeated string eligible_skus = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.
value String

The eligibleSkus to set.
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

This builder for chaining.