Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1RatePlan

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Overview

Rate plan details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1RatePlan

Returns a new instance of GoogleCloudApigeeV1RatePlan.



6007
6008
6009
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6007

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#apiproduct ⇒ String

Name of the API product that the rate plan is associated with. Corresponds to the JSON property apiproduct

Returns:

  • (String) 


5903
5904
5905
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5903

def apiproduct
  @apiproduct
end

#billing_period ⇒ String

Frequency at which the customer will be billed. Corresponds to the JSON property billingPeriod

Returns:

  • (String) 


5908
5909
5910
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5908

def billing_period
  @billing_period
end

#consumption_pricing_rates ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1RateRange>

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 STAIRSTEP and the ranges are defined as follows: ` "start": 1, "end": 100, "fee": 75 `, ` "start": 101, "end": 200, "fee": 100 `, ` Then the following fees would be charged based on the total number of API calls (assuming the currency selected is USD): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $ 100 The number of API calls cannot exceed 200. Corresponds to the JSON property consumptionPricingRates

Returns:



5920
5921
5922
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5920

def consumption_pricing_rates
  @consumption_pricing_rates
end

#consumption_pricing_type ⇒ String

Pricing model used for consumption-based charges. Corresponds to the JSON property consumptionPricingType

Returns:

  • (String) 


5925
5926
5927
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5925

def consumption_pricing_type
  @consumption_pricing_type
end

#created_at ⇒ Fixnum

Output only. Time that the rate plan was created in milliseconds since epoch. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


5930
5931
5932
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5930

def created_at
  @created_at
end

#currency_code ⇒ String

Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


5936
5937
5938
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5936

def currency_code
  @currency_code
end

#description ⇒ String

Description of the rate plan. Corresponds to the JSON property description

Returns:

  • (String) 


5941
5942
5943
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5941

def description
  @description
end

#display_name ⇒ String

Display name of the rate plan. Corresponds to the JSON property displayName

Returns:

  • (String) 


5946
5947
5948
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5946

def display_name
  @display_name
end

#end_time ⇒ Fixnum

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. Corresponds to the JSON property endTime

Returns:

  • (Fixnum) 


5952
5953
5954
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5952

def end_time
  @end_time
end

#fixed_fee_frequency ⇒ Fixnum

Frequency at which the fixed fee is charged. Corresponds to the JSON property fixedFeeFrequency

Returns:

  • (Fixnum) 


5957
5958
5959
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5957

def fixed_fee_frequency
  @fixed_fee_frequency
end

#fixed_recurring_fee ⇒ Google::Apis::ApigeeV1::GoogleTypeMoney

Represents an amount of money with its currency type. Corresponds to the JSON property fixedRecurringFee

Returns:



5962
5963
5964
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5962

def fixed_recurring_fee
  @fixed_recurring_fee
end

#last_modified_at ⇒ Fixnum

Output only. Time the rate plan was last modified in milliseconds since epoch. Corresponds to the JSON property lastModifiedAt

Returns:

  • (Fixnum) 


5967
5968
5969
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5967

def last_modified_at
  @last_modified_at
end

#name ⇒ String

Output only. Name of the rate plan. Corresponds to the JSON property name

Returns:

  • (String) 


5972
5973
5974
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5972

def name
  @name
end

#payment_funding_model ⇒ String

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. Corresponds to the JSON property paymentFundingModel

Returns:

  • (String) 


5980
5981
5982
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5980

def payment_funding_model
  @payment_funding_model
end

#revenue_share_rates ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1RevenueShareRange>

Details of the revenue sharing model. Corresponds to the JSON property revenueShareRates

Returns:



5985
5986
5987
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5985

def revenue_share_rates
  @revenue_share_rates
end

#revenue_share_type ⇒ String

Method used to calculate the revenue that is shared with developers. Corresponds to the JSON property revenueShareType

Returns:

  • (String) 


5990
5991
5992
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5990

def revenue_share_type
  @revenue_share_type
end

#setup_fee ⇒ Google::Apis::ApigeeV1::GoogleTypeMoney

Represents an amount of money with its currency type. Corresponds to the JSON property setupFee

Returns:



5995
5996
5997
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5995

def setup_fee
  @setup_fee
end

#start_time ⇒ Fixnum

Time when the rate plan becomes active in milliseconds since epoch. Corresponds to the JSON property startTime

Returns:

  • (Fixnum) 


6000
6001
6002
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6000

def start_time
  @start_time
end

#state ⇒ String

Current state of the rate plan (draft or published). Corresponds to the JSON property state

Returns:

  • (String) 


6005
6006
6007
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6005

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6012

def update!(**args)
  @apiproduct = args[:apiproduct] if args.key?(:apiproduct)
  @billing_period = args[:billing_period] if args.key?(:billing_period)
  @consumption_pricing_rates = args[:consumption_pricing_rates] if args.key?(:consumption_pricing_rates)
  @consumption_pricing_type = args[:consumption_pricing_type] if args.key?(:consumption_pricing_type)
  @created_at = args[:created_at] if args.key?(:created_at)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @end_time = args[:end_time] if args.key?(:end_time)
  @fixed_fee_frequency = args[:fixed_fee_frequency] if args.key?(:fixed_fee_frequency)
  @fixed_recurring_fee = args[:fixed_recurring_fee] if args.key?(:fixed_recurring_fee)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @name = args[:name] if args.key?(:name)
  @payment_funding_model = args[:payment_funding_model] if args.key?(:payment_funding_model)
  @revenue_share_rates = args[:revenue_share_rates] if args.key?(:revenue_share_rates)
  @revenue_share_type = args[:revenue_share_type] if args.key?(:revenue_share_type)
  @setup_fee = args[:setup_fee] if args.key?(:setup_fee)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
end