Class: Aws::WAFV2::Types::GetRevenueStatisticsTimeSeriesRequest

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::GetRevenueStatisticsTimeSeriesRequest

Defined in:

gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #currency ⇒ String

  The currency for the amounts in the response.

• #filters ⇒ Array<Types::MonetizationFilter>

  Optional filters to narrow the results.

• #group_by ⇒ String

  The dimension to group results by.

• #interval ⇒ String

  The time interval for aggregating data points: MINUTELY, FIVE_MINUTELY, HOURLY, or DAILY.

• #limit ⇒ Integer

  The maximum number of data points to return.

• #next_marker ⇒ String

  When you get a paginated response, this marker indicates that additional results are available.

• #scope ⇒ String

  Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

• #statistic_type ⇒ String

  The type of time series data to retrieve: DATE_HISTOGRAM for revenue over time, or PAYMENT_TRAFFIC for payment traffic patterns.

• #time_window ⇒ Types::TimeWindow

  The time range for the query.

Instance Attribute Details

#currency ⇒ String

The currency for the amounts in the response.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::MonetizationFilter>

Optional filters to narrow the results.

Returns:

• (Array<Types::MonetizationFilter>)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#group_by ⇒ String

The dimension to group results by.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ String

The time interval for aggregating data points: MINUTELY, FIVE_MINUTELY, HOURLY, or DAILY.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of data points to return. Minimum: 1. Maximum: 10000.

Returns:

• (Integer)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#next_marker ⇒ String

When you get a paginated response, this marker indicates that additional results are available.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT) or for a regional application (REGIONAL).

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#statistic_type ⇒ String

The type of time series data to retrieve: DATE_HISTOGRAM for revenue over time, or PAYMENT_TRAFFIC for payment traffic patterns.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end

#time_window ⇒ Types::TimeWindow

The time range for the query. Specify start and end timestamps.

Returns:

• (Types::TimeWindow)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 4055

class GetRevenueStatisticsTimeSeriesRequest < Struct.new(
  :statistic_type,
  :time_window,
  :scope,
  :interval,
  :currency,
  :group_by,
  :filters,
  :limit,
  :next_marker)
  SENSITIVE = []
  include Aws::Structure
end