GoogleCloudApigeeV1RatePlan (Apigee API v1-rev20251125-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.apigee.v1.model.GoogleCloudApigeeV1RatePlan

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudApigeeV1RatePlan
extends com.google.api.client.json.GenericJson
```
Rate plan details.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Apigee API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudApigeeV1RatePlan()

Constructors
Constructor and Description
`GoogleCloudApigeeV1RatePlan()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudApigeeV1RatePlan`	`clone()`
`String`	`getApiproduct()` Name of the API product that the rate plan is associated with.
`String`	`getBillingPeriod()` Frequency at which the customer will be billed.
`List<GoogleCloudApigeeV1RateRange>`	`getConsumptionPricingRates()` API call volume ranges and the fees charged when the total number of API calls is within a given range.
`String`	`getConsumptionPricingType()` Pricing model used for consumption-based charges.
`Long`	`getCreatedAt()` Output only.
`String`	`getCurrencyCode()` Currency to be used for billing.
`String`	`getDescription()` Description of the rate plan.
`String`	`getDisplayName()` Display name of the rate plan.
`Long`	`getEndTime()` Time when the rate plan will expire in milliseconds since epoch.
`Integer`	`getFixedFeeFrequency()` Frequency at which the fixed fee is charged.
`GoogleTypeMoney`	`getFixedRecurringFee()` Fixed amount that is charged at a defined interval and billed in advance of use of the API product.
`Long`	`getLastModifiedAt()` Output only.
`String`	`getName()` Output only.
`String`	`getPaymentFundingModel()` DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported.
`List<GoogleCloudApigeeV1RevenueShareRange>`	`getRevenueShareRates()` Details of the revenue sharing model.
`String`	`getRevenueShareType()` Method used to calculate the revenue that is shared with developers.
`GoogleTypeMoney`	`getSetupFee()` Initial, one-time fee paid when purchasing the API product.
`Long`	`getStartTime()` Time when the rate plan becomes active in milliseconds since epoch.
`String`	`getState()` Current state of the rate plan (draft or published).
`GoogleCloudApigeeV1RatePlan`	`set(String fieldName, Object value)`
`GoogleCloudApigeeV1RatePlan`	`setApiproduct(String apiproduct)` Name of the API product that the rate plan is associated with.
`GoogleCloudApigeeV1RatePlan`	`setBillingPeriod(String billingPeriod)` Frequency at which the customer will be billed.
`GoogleCloudApigeeV1RatePlan`	`setConsumptionPricingRates(List<GoogleCloudApigeeV1RateRange> consumptionPricingRates)` API call volume ranges and the fees charged when the total number of API calls is within a given range.
`GoogleCloudApigeeV1RatePlan`	`setConsumptionPricingType(String consumptionPricingType)` Pricing model used for consumption-based charges.
`GoogleCloudApigeeV1RatePlan`	`setCreatedAt(Long createdAt)` Output only.
`GoogleCloudApigeeV1RatePlan`	`setCurrencyCode(String currencyCode)` Currency to be used for billing.
`GoogleCloudApigeeV1RatePlan`	`setDescription(String description)` Description of the rate plan.
`GoogleCloudApigeeV1RatePlan`	`setDisplayName(String displayName)` Display name of the rate plan.
`GoogleCloudApigeeV1RatePlan`	`setEndTime(Long endTime)` Time when the rate plan will expire in milliseconds since epoch.
`GoogleCloudApigeeV1RatePlan`	`setFixedFeeFrequency(Integer fixedFeeFrequency)` Frequency at which the fixed fee is charged.
`GoogleCloudApigeeV1RatePlan`	`setFixedRecurringFee(GoogleTypeMoney fixedRecurringFee)` Fixed amount that is charged at a defined interval and billed in advance of use of the API product.
`GoogleCloudApigeeV1RatePlan`	`setLastModifiedAt(Long lastModifiedAt)` Output only.
`GoogleCloudApigeeV1RatePlan`	`setName(String name)` Output only.
`GoogleCloudApigeeV1RatePlan`	`setPaymentFundingModel(String paymentFundingModel)` DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported.
`GoogleCloudApigeeV1RatePlan`	`setRevenueShareRates(List<GoogleCloudApigeeV1RevenueShareRange> revenueShareRates)` Details of the revenue sharing model.
`GoogleCloudApigeeV1RatePlan`	`setRevenueShareType(String revenueShareType)` Method used to calculate the revenue that is shared with developers.
`GoogleCloudApigeeV1RatePlan`	`setSetupFee(GoogleTypeMoney setupFee)` Initial, one-time fee paid when purchasing the API product.
`GoogleCloudApigeeV1RatePlan`	`setStartTime(Long startTime)` Time when the rate plan becomes active in milliseconds since epoch.
`GoogleCloudApigeeV1RatePlan`	`setState(String state)` Current state of the rate plan (draft or published).

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudApigeeV1RatePlan
```
public GoogleCloudApigeeV1RatePlan()
```
- Method Detail
  - getApiproduct
```
public String getApiproduct()
```
    Name of the API product that the rate plan is associated with.
    
    Returns:
    
    value or null for none
  - setApiproduct
```
public GoogleCloudApigeeV1RatePlan setApiproduct(String apiproduct)
```
    Name of the API product that the rate plan is associated with.
    
    Parameters:
    
    apiproduct - apiproduct or null for none
  - getBillingPeriod
```
public String getBillingPeriod()
```
    Frequency at which the customer will be billed.
    
    Returns:
    
    value or null for none
  - setBillingPeriod
```
public GoogleCloudApigeeV1RatePlan setBillingPeriod(String billingPeriod)
```
    Frequency at which the customer will be billed.
    
    Parameters:
    
    billingPeriod - billingPeriod or null for none
  - getConsumptionPricingRates
```
public List<GoogleCloudApigeeV1RateRange> getConsumptionPricingRates()
```
    API call volume ranges and the fees charged when the total number of API calls is within a given range. The method used to calculate the final fee depends on the selected pricing model. For example, if the pricing model is `BANDED` and the ranges are defined as follows: ``` { "start": 1, "end": 100, "fee": 2 }, { "start": 101, "end": 200, "fee": 1.50 }, { "start": 201, "end": 0, "fee": 1 }, } ``` Then the following fees would be charged based on the total number of API calls (assuming the currency selected is `USD`): * 50 calls cost 50 x $2 = $100 * 150 calls cost 100 x $2 + 50 x $1.5 = $275 * 250 calls cost 100 x $2 + 100 x $1.5 + 50 x $1 = $400 * 500 calls cost 100 x $2 + 100 x $1.5 + 300 x $1 = $650
    
    Returns:
    
    value or null for none
  - setConsumptionPricingRates
```
public GoogleCloudApigeeV1RatePlan setConsumptionPricingRates(List<GoogleCloudApigeeV1RateRange> consumptionPricingRates)
```
    API call volume ranges and the fees charged when the total number of API calls is within a given range. The method used to calculate the final fee depends on the selected pricing model. For example, if the pricing model is `BANDED` and the ranges are defined as follows: ``` { "start": 1, "end": 100, "fee": 2 }, { "start": 101, "end": 200, "fee": 1.50 }, { "start": 201, "end": 0, "fee": 1 }, } ``` Then the following fees would be charged based on the total number of API calls (assuming the currency selected is `USD`): * 50 calls cost 50 x $2 = $100 * 150 calls cost 100 x $2 + 50 x $1.5 = $275 * 250 calls cost 100 x $2 + 100 x $1.5 + 50 x $1 = $400 * 500 calls cost 100 x $2 + 100 x $1.5 + 300 x $1 = $650
    
    Parameters:
    
    consumptionPricingRates - consumptionPricingRates or null for none
  - getConsumptionPricingType
```
public String getConsumptionPricingType()
```
    Pricing model used for consumption-based charges.
    
    Returns:
    
    value or null for none
  - setConsumptionPricingType
```
public GoogleCloudApigeeV1RatePlan setConsumptionPricingType(String consumptionPricingType)
```
    Pricing model used for consumption-based charges.
    
    Parameters:
    
    consumptionPricingType - consumptionPricingType or null for none
  - getCreatedAt
```
public Long getCreatedAt()
```
    Output only. Time that the rate plan was created in milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setCreatedAt
```
public GoogleCloudApigeeV1RatePlan setCreatedAt(Long createdAt)
```
    Output only. Time that the rate plan was created in milliseconds since epoch.
    
    Parameters:
    
    createdAt - createdAt or null for none
  - getCurrencyCode
```
public String getCurrencyCode()
```
    Currency to be used for billing. Consists of a three-letter code as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard.
    
    Returns:
    
    value or null for none
  - setCurrencyCode
```
public GoogleCloudApigeeV1RatePlan setCurrencyCode(String currencyCode)
```
    Currency to be used for billing. Consists of a three-letter code as defined by the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) standard.
    
    Parameters:
    
    currencyCode - currencyCode or null for none
  - getDescription
```
public String getDescription()
```
    Description of the rate plan.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleCloudApigeeV1RatePlan setDescription(String description)
```
    Description of the rate plan.
    
    Parameters:
    
    description - description or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Display name of the rate plan.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudApigeeV1RatePlan setDisplayName(String displayName)
```
    Display name of the rate plan.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEndTime
```
public Long getEndTime()
```
    Time when the rate plan will expire in milliseconds since epoch. Set to 0 or `null` to indicate that the rate plan should never expire.
    
    Returns:
    
    value or null for none
  - setEndTime
```
public GoogleCloudApigeeV1RatePlan setEndTime(Long endTime)
```
    Time when the rate plan will expire in milliseconds since epoch. Set to 0 or `null` to indicate that the rate plan should never expire.
    
    Parameters:
    
    endTime - endTime or null for none
  - getFixedFeeFrequency
```
public Integer getFixedFeeFrequency()
```
    Frequency at which the fixed fee is charged.
    
    Returns:
    
    value or null for none
  - setFixedFeeFrequency
```
public GoogleCloudApigeeV1RatePlan setFixedFeeFrequency(Integer fixedFeeFrequency)
```
    Frequency at which the fixed fee is charged.
    
    Parameters:
    
    fixedFeeFrequency - fixedFeeFrequency or null for none
  - getFixedRecurringFee
```
public GoogleTypeMoney getFixedRecurringFee()
```
    Fixed amount that is charged at a defined interval and billed in advance of use of the API product. The fee will be prorated for the first billing period.
    
    Returns:
    
    value or null for none
  - setFixedRecurringFee
```
public GoogleCloudApigeeV1RatePlan setFixedRecurringFee(GoogleTypeMoney fixedRecurringFee)
```
    Fixed amount that is charged at a defined interval and billed in advance of use of the API product. The fee will be prorated for the first billing period.
    
    Parameters:
    
    fixedRecurringFee - fixedRecurringFee or null for none
  - getLastModifiedAt
```
public Long getLastModifiedAt()
```
    Output only. Time the rate plan was last modified in milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setLastModifiedAt
```
public GoogleCloudApigeeV1RatePlan setLastModifiedAt(Long lastModifiedAt)
```
    Output only. Time the rate plan was last modified in milliseconds since epoch.
    
    Parameters:
    
    lastModifiedAt - lastModifiedAt or null for none
  - getName
```
public String getName()
```
    Output only. Name of the rate plan.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudApigeeV1RatePlan setName(String name)
```
    Output only. Name of the rate plan.
    
    Parameters:
    
    name - name or null for none
  - getPaymentFundingModel
```
public String getPaymentFundingModel()
```
    DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, use the `billingType` field inside `DeveloperMonetizationConfig` resource. Flag that specifies the billing account type, prepaid or postpaid.
    
    Returns:
    
    value or null for none
  - setPaymentFundingModel
```
public GoogleCloudApigeeV1RatePlan setPaymentFundingModel(String paymentFundingModel)
```
    DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, use the `billingType` field inside `DeveloperMonetizationConfig` resource. Flag that specifies the billing account type, prepaid or postpaid.
    
    Parameters:
    
    paymentFundingModel - paymentFundingModel or null for none
  - getRevenueShareRates
```
public List<GoogleCloudApigeeV1RevenueShareRange> getRevenueShareRates()
```
    Details of the revenue sharing model.
    
    Returns:
    
    value or null for none
  - setRevenueShareRates
```
public GoogleCloudApigeeV1RatePlan setRevenueShareRates(List<GoogleCloudApigeeV1RevenueShareRange> revenueShareRates)
```
    Details of the revenue sharing model.
    
    Parameters:
    
    revenueShareRates - revenueShareRates or null for none
  - getRevenueShareType
```
public String getRevenueShareType()
```
    Method used to calculate the revenue that is shared with developers.
    
    Returns:
    
    value or null for none
  - setRevenueShareType
```
public GoogleCloudApigeeV1RatePlan setRevenueShareType(String revenueShareType)
```
    Method used to calculate the revenue that is shared with developers.
    
    Parameters:
    
    revenueShareType - revenueShareType or null for none
  - getSetupFee
```
public GoogleTypeMoney getSetupFee()
```
    Initial, one-time fee paid when purchasing the API product.
    
    Returns:
    
    value or null for none
  - setSetupFee
```
public GoogleCloudApigeeV1RatePlan setSetupFee(GoogleTypeMoney setupFee)
```
    Initial, one-time fee paid when purchasing the API product.
    
    Parameters:
    
    setupFee - setupFee or null for none
  - getStartTime
```
public Long getStartTime()
```
    Time when the rate plan becomes active in milliseconds since epoch.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public GoogleCloudApigeeV1RatePlan setStartTime(Long startTime)
```
    Time when the rate plan becomes active in milliseconds since epoch.
    
    Parameters:
    
    startTime - startTime or null for none
  - getState
```
public String getState()
```
    Current state of the rate plan (draft or published).
    
    Returns:
    
    value or null for none
  - setState
```
public GoogleCloudApigeeV1RatePlan setState(String state)
```
    Current state of the rate plan (draft or published).
    
    Parameters:
    
    state - state or null for none
  - set
```
public GoogleCloudApigeeV1RatePlan set(String fieldName,
                                       Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudApigeeV1RatePlan clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudApigeeV1RatePlan

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudApigeeV1RatePlan

Method Detail

getApiproduct

setApiproduct

getBillingPeriod

setBillingPeriod

getConsumptionPricingRates

setConsumptionPricingRates

getConsumptionPricingType

setConsumptionPricingType

getCreatedAt

setCreatedAt

getCurrencyCode

setCurrencyCode

getDescription

setDescription

getDisplayName

setDisplayName

getEndTime

setEndTime

getFixedFeeFrequency

setFixedFeeFrequency

getFixedRecurringFee

setFixedRecurringFee

getLastModifiedAt

setLastModifiedAt

getName

setName

getPaymentFundingModel

setPaymentFundingModel

getRevenueShareRates

setRevenueShareRates

getRevenueShareType

setRevenueShareType

getSetupFee

setSetupFee

getStartTime

setStartTime

getState

setState

set

clone