Class: Fastly::BillingUsageMetricsApi
- Inherits:
-
Object
- Object
- Fastly::BillingUsageMetricsApi
- Defined in:
- lib/fastly/api/billing_usage_metrics_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_service_level_usage(opts = {}) ⇒ Serviceusagemetrics
Retrieve service-level usage metrics for a product.
-
#get_service_level_usage_with_http_info(opts = {}) ⇒ Array<(Serviceusagemetrics, Integer, Hash)>
Retrieve service-level usage metrics for a product.
-
#get_usage_metrics(opts = {}) ⇒ Usagemetric
Get monthly usage metrics Returns monthly usage metrics for customer by product.
-
#get_usage_metrics_with_http_info(opts = {}) ⇒ Array<(Usagemetric, Integer, Hash)>
Get monthly usage metrics Returns monthly usage metrics for customer by product.
-
#initialize(api_client = ApiClient.default) ⇒ BillingUsageMetricsApi
constructor
A new instance of BillingUsageMetricsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ BillingUsageMetricsApi
Returns a new instance of BillingUsageMetricsApi.
17 18 19 |
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
15 16 17 |
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 15 def api_client @api_client end |
Instance Method Details
#get_service_level_usage(opts = {}) ⇒ Serviceusagemetrics
Retrieve service-level usage metrics for a product. Returns product usage, broken down by service.
29 30 31 32 |
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 29 def get_service_level_usage(opts = {}) data, _status_code, _headers = get_service_level_usage_with_http_info(opts) data end |
#get_service_level_usage_with_http_info(opts = {}) ⇒ Array<(Serviceusagemetrics, Integer, Hash)>
Retrieve service-level usage metrics for a product. Returns product usage, broken down by service.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 43 def get_service_level_usage_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BillingUsageMetricsApi.get_service_level_usage ...' end # unbox the parameters from the hash product_id = opts[:'product_id'] usage_type_name = opts[:'usage_type_name'] # verify the required parameter 'product_id' is set if @api_client.config.client_side_validation && product_id.nil? fail ArgumentError, "Missing the required parameter 'product_id' when calling BillingUsageMetricsApi.get_service_level_usage" end # verify the required parameter 'usage_type_name' is set if @api_client.config.client_side_validation && usage_type_name.nil? fail ArgumentError, "Missing the required parameter 'usage_type_name' when calling BillingUsageMetricsApi.get_service_level_usage" end pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/) if @api_client.config.client_side_validation && !opts[:'start_month'].nil? && opts[:'start_month'] !~ pattern fail ArgumentError, "invalid value for 'opts[:\"start_month\"]' when calling BillingUsageMetricsApi.get_service_level_usage, must conform to the pattern #{pattern}." end pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/) if @api_client.config.client_side_validation && !opts[:'end_month'].nil? && opts[:'end_month'] !~ pattern fail ArgumentError, "invalid value for 'opts[:\"end_month\"]' when calling BillingUsageMetricsApi.get_service_level_usage, must conform to the pattern #{pattern}." end # resource path local_var_path = '/billing/v3/service-usage-metrics' # query parameters query_params = opts[:query_params] || {} query_params[:'product_id'] = product_id query_params[:'usage_type_name'] = usage_type_name query_params[:'start_month'] = opts[:'start_month'] if !opts[:'start_month'].nil? query_params[:'end_month'] = opts[:'end_month'] if !opts[:'end_month'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Serviceusagemetrics' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"BillingUsageMetricsApi.get_service_level_usage", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BillingUsageMetricsApi#get_service_level_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_usage_metrics(opts = {}) ⇒ Usagemetric
Get monthly usage metrics Returns monthly usage metrics for customer by product.
119 120 121 122 |
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 119 def get_usage_metrics(opts = {}) data, _status_code, _headers = get_usage_metrics_with_http_info(opts) data end |
#get_usage_metrics_with_http_info(opts = {}) ⇒ Array<(Usagemetric, Integer, Hash)>
Get monthly usage metrics Returns monthly usage metrics for customer by product.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/fastly/api/billing_usage_metrics_api.rb', line 129 def get_usage_metrics_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BillingUsageMetricsApi.get_usage_metrics ...' end # unbox the parameters from the hash pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/) if @api_client.config.client_side_validation && !opts[:'start_month'].nil? && opts[:'start_month'] !~ pattern fail ArgumentError, "invalid value for 'opts[:\"start_month\"]' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}." end pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/) if @api_client.config.client_side_validation && !opts[:'end_month'].nil? && opts[:'end_month'] !~ pattern fail ArgumentError, "invalid value for 'opts[:\"end_month\"]' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}." end # resource path local_var_path = '/billing/v3/usage-metrics' # query parameters query_params = opts[:query_params] || {} query_params[:'start_month'] = opts[:'start_month'] if !opts[:'start_month'].nil? query_params[:'end_month'] = opts[:'end_month'] if !opts[:'end_month'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Usagemetric' # auth_names auth_names = opts[:debug_auth_names] || ['token'] = opts.merge( :operation => :"BillingUsageMetricsApi.get_usage_metrics", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BillingUsageMetricsApi#get_usage_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |