lib/fastly/api/historical_api.rb in fastly-4.1.0 vs lib/fastly/api/historical_api.rb in fastly-4.2.0
- old
+ new
@@ -20,11 +20,11 @@
# Get historical stats
# Fetches historical stats for each of your Fastly services and groups the results by service ID.
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalResponse]
def get_hist_stats(opts = {})
data, _status_code, _headers = get_hist_stats_with_http_info(opts)
data
end
@@ -32,11 +32,11 @@
# Get historical stats
# Fetches historical stats for each of your Fastly services and groups the results by service ID.
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalResponse, Integer, Hash)>] HistoricalResponse data, response status code and response headers
def get_hist_stats_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats ...'
end
@@ -96,11 +96,11 @@
# Get aggregated historical stats
# Fetches historical stats information aggregated across all of your Fastly services.
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalAggregateResponse]
def get_hist_stats_aggregated(opts = {})
data, _status_code, _headers = get_hist_stats_aggregated_with_http_info(opts)
data
end
@@ -108,11 +108,11 @@
# Get aggregated historical stats
# Fetches historical stats information aggregated across all of your Fastly services.
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalAggregateResponse, Integer, Hash)>] HistoricalAggregateResponse data, response status code and response headers
def get_hist_stats_aggregated_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_aggregated ...'
end
@@ -173,11 +173,11 @@
# Fetches the specified field from the historical stats for each of your services and groups the results by service ID.
# @option opts [String] :field Name of the stats field. (required)
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalFieldResponse]
def get_hist_stats_field(opts = {})
data, _status_code, _headers = get_hist_stats_field_with_http_info(opts)
data
end
@@ -186,11 +186,11 @@
# Fetches the specified field from the historical stats for each of your services and groups the results by service ID.
# @option opts [String] :field Name of the stats field. (required)
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalFieldResponse, Integer, Hash)>] HistoricalFieldResponse data, response status code and response headers
def get_hist_stats_field_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_field ...'
end
@@ -256,11 +256,11 @@
# Fetches historical stats for a given service.
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalAggregateResponse]
def get_hist_stats_service(opts = {})
data, _status_code, _headers = get_hist_stats_service_with_http_info(opts)
data
end
@@ -269,11 +269,11 @@
# Fetches historical stats for a given service.
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalAggregateResponse, Integer, Hash)>] HistoricalAggregateResponse data, response status code and response headers
def get_hist_stats_service_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_service ...'
end
@@ -340,11 +340,11 @@
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
# @option opts [String] :field Name of the stats field. (required)
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalFieldAggregateResponse]
def get_hist_stats_service_field(opts = {})
data, _status_code, _headers = get_hist_stats_service_field_with_http_info(opts)
data
end
@@ -354,10 +354,10 @@
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
# @option opts [String] :field Name of the stats field. (required)
# @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
# @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
- # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
+ # @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalFieldAggregateResponse, Integer, Hash)>] HistoricalFieldAggregateResponse data, response status code and response headers
def get_hist_stats_service_field_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: HistoricalApi.get_hist_stats_service_field ...'
end