Class PrivateOffer.SingleProductOffer.AdditionalContractValue (0.5.0)

public static final class PrivateOffer.SingleProductOffer.AdditionalContractValue extends GeneratedMessage 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

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

Static Fields

CONTRACT_VALUE_FIELD_NUMBER

public static final int CONTRACT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

ELIGIBLE_SKUS_FIELD_NUMBER

public static final int ELIGIBLE_SKUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PrivateOffer.SingleProductOffer.AdditionalContractValue getDefaultInstance()
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue

getDescriptor()

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

newBuilder()

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

newBuilder(PrivateOffer.SingleProductOffer.AdditionalContractValue prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

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.

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

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder newBuilderForType()
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

public PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder toBuilder()
Returns
Type Description
PrivateOffer.SingleProductOffer.AdditionalContractValue.Builder

writeTo(CodedOutputStream output)

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