radar

package
v3.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type AIGatewayService

type AIGatewayService struct {
	Options          []option.RequestOption
	Summary          *AIGatewaySummaryService
	TimeseriesGroups *AIGatewayTimeseriesGroupService
}

AIGatewayService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAIGatewayService method instead.

func NewAIGatewayService

func NewAIGatewayService(opts ...option.RequestOption) (r *AIGatewayService)

NewAIGatewayService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AIGatewaySummaryService

type AIGatewaySummaryService struct {
	Options []option.RequestOption
}

AIGatewaySummaryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAIGatewaySummaryService method instead.

func NewAIGatewaySummaryService

func NewAIGatewaySummaryService(opts ...option.RequestOption) (r *AIGatewaySummaryService)

NewAIGatewaySummaryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AIGatewayTimeseriesGroupService

type AIGatewayTimeseriesGroupService struct {
	Options []option.RequestOption
}

AIGatewayTimeseriesGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAIGatewayTimeseriesGroupService method instead.

func NewAIGatewayTimeseriesGroupService

func NewAIGatewayTimeseriesGroupService(opts ...option.RequestOption) (r *AIGatewayTimeseriesGroupService)

NewAIGatewayTimeseriesGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AIService

type AIService struct {
	Options []option.RequestOption
	Gateway *AIGatewayService
}

AIService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAIService method instead.

func NewAIService

func NewAIService(opts ...option.RequestOption) (r *AIService)

NewAIService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AS112Service

type AS112Service struct {
	Options          []option.RequestOption
	Summary          *AS112SummaryService
	TimeseriesGroups *AS112TimeseriesGroupService
	Top              *AS112TopService
}

AS112Service contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAS112Service method instead.

func NewAS112Service

func NewAS112Service(opts ...option.RequestOption) (r *AS112Service)

NewAS112Service generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AS112Service) Timeseries

func (r *AS112Service) Timeseries(ctx context.Context, query AS112TimeseriesParams, opts ...option.RequestOption) (res *AS112TimeseriesResponse, err error)

Get AS112 queries change over time.

type AS112SummaryDNSSECParams

type AS112SummaryDNSSECParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112SummaryDNSSECParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112SummaryDNSSECParams) URLQuery

func (r AS112SummaryDNSSECParams) URLQuery() (v url.Values)

URLQuery serializes AS112SummaryDNSSECParams's query parameters as `url.Values`.

type AS112SummaryDNSSECParamsFormat

type AS112SummaryDNSSECParamsFormat string

Format results are returned in.

const (
	AS112SummaryDNSSECParamsFormatJson AS112SummaryDNSSECParamsFormat = "JSON"
	AS112SummaryDNSSECParamsFormatCsv  AS112SummaryDNSSECParamsFormat = "CSV"
)

func (AS112SummaryDNSSECParamsFormat) IsKnown

type AS112SummaryDNSSECResponse

type AS112SummaryDNSSECResponse struct {
	Meta     AS112SummaryDNSSECResponseMeta     `json:"meta,required"`
	Summary0 AS112SummaryDNSSECResponseSummary0 `json:"summary_0,required"`
	JSON     as112SummaryDNSSECResponseJSON     `json:"-"`
}

func (*AS112SummaryDNSSECResponse) UnmarshalJSON

func (r *AS112SummaryDNSSECResponse) UnmarshalJSON(data []byte) (err error)

type AS112SummaryDNSSECResponseEnvelope

type AS112SummaryDNSSECResponseEnvelope struct {
	Result  AS112SummaryDNSSECResponse             `json:"result,required"`
	Success bool                                   `json:"success,required"`
	JSON    as112SummaryDNSSECResponseEnvelopeJSON `json:"-"`
}

func (*AS112SummaryDNSSECResponseEnvelope) UnmarshalJSON

func (r *AS112SummaryDNSSECResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112SummaryDNSSECResponseMeta

type AS112SummaryDNSSECResponseMeta struct {
	DateRange      []AS112SummaryDNSSECResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                       `json:"lastUpdated,required"`
	Normalization  string                                       `json:"normalization,required"`
	ConfidenceInfo AS112SummaryDNSSECResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112SummaryDNSSECResponseMetaJSON           `json:"-"`
}

func (*AS112SummaryDNSSECResponseMeta) UnmarshalJSON

func (r *AS112SummaryDNSSECResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112SummaryDNSSECResponseMetaConfidenceInfo

type AS112SummaryDNSSECResponseMetaConfidenceInfo struct {
	Annotations []AS112SummaryDNSSECResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                    `json:"level"`
	JSON        as112SummaryDNSSECResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112SummaryDNSSECResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112SummaryDNSSECResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112SummaryDNSSECResponseMetaConfidenceInfoAnnotation

type AS112SummaryDNSSECResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                     `json:"dataSource,required"`
	Description     string                                                     `json:"description,required"`
	EventType       string                                                     `json:"eventType,required"`
	IsInstantaneous bool                                                       `json:"isInstantaneous,required"`
	EndTime         time.Time                                                  `json:"endTime" format:"date-time"`
	LinkedURL       string                                                     `json:"linkedUrl"`
	StartTime       time.Time                                                  `json:"startTime" format:"date-time"`
	JSON            as112SummaryDNSSECResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112SummaryDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *AS112SummaryDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type AS112SummaryDNSSECResponseMetaDateRange

type AS112SummaryDNSSECResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                   `json:"startTime,required" format:"date-time"`
	JSON      as112SummaryDNSSECResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112SummaryDNSSECResponseMetaDateRange) UnmarshalJSON

func (r *AS112SummaryDNSSECResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112SummaryDNSSECResponseSummary0

type AS112SummaryDNSSECResponseSummary0 struct {
	NotSupported string                                 `json:"NOT_SUPPORTED,required"`
	Supported    string                                 `json:"SUPPORTED,required"`
	JSON         as112SummaryDNSSECResponseSummary0JSON `json:"-"`
}

func (*AS112SummaryDNSSECResponseSummary0) UnmarshalJSON

func (r *AS112SummaryDNSSECResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AS112SummaryEdnsParams

type AS112SummaryEdnsParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112SummaryEdnsParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112SummaryEdnsParams) URLQuery

func (r AS112SummaryEdnsParams) URLQuery() (v url.Values)

URLQuery serializes AS112SummaryEdnsParams's query parameters as `url.Values`.

type AS112SummaryEdnsParamsFormat

type AS112SummaryEdnsParamsFormat string

Format results are returned in.

const (
	AS112SummaryEdnsParamsFormatJson AS112SummaryEdnsParamsFormat = "JSON"
	AS112SummaryEdnsParamsFormatCsv  AS112SummaryEdnsParamsFormat = "CSV"
)

func (AS112SummaryEdnsParamsFormat) IsKnown

func (r AS112SummaryEdnsParamsFormat) IsKnown() bool

type AS112SummaryEdnsResponse

type AS112SummaryEdnsResponse struct {
	Meta     AS112SummaryEdnsResponseMeta     `json:"meta,required"`
	Summary0 AS112SummaryEdnsResponseSummary0 `json:"summary_0,required"`
	JSON     as112SummaryEdnsResponseJSON     `json:"-"`
}

func (*AS112SummaryEdnsResponse) UnmarshalJSON

func (r *AS112SummaryEdnsResponse) UnmarshalJSON(data []byte) (err error)

type AS112SummaryEdnsResponseEnvelope

type AS112SummaryEdnsResponseEnvelope struct {
	Result  AS112SummaryEdnsResponse             `json:"result,required"`
	Success bool                                 `json:"success,required"`
	JSON    as112SummaryEdnsResponseEnvelopeJSON `json:"-"`
}

func (*AS112SummaryEdnsResponseEnvelope) UnmarshalJSON

func (r *AS112SummaryEdnsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112SummaryEdnsResponseMeta

type AS112SummaryEdnsResponseMeta struct {
	DateRange      []AS112SummaryEdnsResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                     `json:"lastUpdated,required"`
	Normalization  string                                     `json:"normalization,required"`
	ConfidenceInfo AS112SummaryEdnsResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112SummaryEdnsResponseMetaJSON           `json:"-"`
}

func (*AS112SummaryEdnsResponseMeta) UnmarshalJSON

func (r *AS112SummaryEdnsResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112SummaryEdnsResponseMetaConfidenceInfo

type AS112SummaryEdnsResponseMetaConfidenceInfo struct {
	Annotations []AS112SummaryEdnsResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                  `json:"level"`
	JSON        as112SummaryEdnsResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112SummaryEdnsResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112SummaryEdnsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112SummaryEdnsResponseMetaConfidenceInfoAnnotation

type AS112SummaryEdnsResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                   `json:"dataSource,required"`
	Description     string                                                   `json:"description,required"`
	EventType       string                                                   `json:"eventType,required"`
	IsInstantaneous bool                                                     `json:"isInstantaneous,required"`
	EndTime         time.Time                                                `json:"endTime" format:"date-time"`
	LinkedURL       string                                                   `json:"linkedUrl"`
	StartTime       time.Time                                                `json:"startTime" format:"date-time"`
	JSON            as112SummaryEdnsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112SummaryEdnsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *AS112SummaryEdnsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type AS112SummaryEdnsResponseMetaDateRange

type AS112SummaryEdnsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                 `json:"startTime,required" format:"date-time"`
	JSON      as112SummaryEdnsResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112SummaryEdnsResponseMetaDateRange) UnmarshalJSON

func (r *AS112SummaryEdnsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112SummaryEdnsResponseSummary0

type AS112SummaryEdnsResponseSummary0 struct {
	NotSupported string                               `json:"NOT_SUPPORTED,required"`
	Supported    string                               `json:"SUPPORTED,required"`
	JSON         as112SummaryEdnsResponseSummary0JSON `json:"-"`
}

func (*AS112SummaryEdnsResponseSummary0) UnmarshalJSON

func (r *AS112SummaryEdnsResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AS112SummaryIPVersionParams

type AS112SummaryIPVersionParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112SummaryIPVersionParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112SummaryIPVersionParams) URLQuery

func (r AS112SummaryIPVersionParams) URLQuery() (v url.Values)

URLQuery serializes AS112SummaryIPVersionParams's query parameters as `url.Values`.

type AS112SummaryIPVersionParamsFormat

type AS112SummaryIPVersionParamsFormat string

Format results are returned in.

const (
	AS112SummaryIPVersionParamsFormatJson AS112SummaryIPVersionParamsFormat = "JSON"
	AS112SummaryIPVersionParamsFormatCsv  AS112SummaryIPVersionParamsFormat = "CSV"
)

func (AS112SummaryIPVersionParamsFormat) IsKnown

type AS112SummaryIPVersionResponse

type AS112SummaryIPVersionResponse struct {
	Meta     AS112SummaryIPVersionResponseMeta     `json:"meta,required"`
	Summary0 AS112SummaryIPVersionResponseSummary0 `json:"summary_0,required"`
	JSON     as112SummaryIPVersionResponseJSON     `json:"-"`
}

func (*AS112SummaryIPVersionResponse) UnmarshalJSON

func (r *AS112SummaryIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AS112SummaryIPVersionResponseEnvelope

type AS112SummaryIPVersionResponseEnvelope struct {
	Result  AS112SummaryIPVersionResponse             `json:"result,required"`
	Success bool                                      `json:"success,required"`
	JSON    as112SummaryIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AS112SummaryIPVersionResponseEnvelope) UnmarshalJSON

func (r *AS112SummaryIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112SummaryIPVersionResponseMeta

type AS112SummaryIPVersionResponseMeta struct {
	DateRange      []AS112SummaryIPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                          `json:"lastUpdated,required"`
	Normalization  string                                          `json:"normalization,required"`
	ConfidenceInfo AS112SummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112SummaryIPVersionResponseMetaJSON           `json:"-"`
}

func (*AS112SummaryIPVersionResponseMeta) UnmarshalJSON

func (r *AS112SummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112SummaryIPVersionResponseMetaConfidenceInfo

type AS112SummaryIPVersionResponseMetaConfidenceInfo struct {
	Annotations []AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                       `json:"level"`
	JSON        as112SummaryIPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112SummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112SummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation

type AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                        `json:"dataSource,required"`
	Description     string                                                        `json:"description,required"`
	EventType       string                                                        `json:"eventType,required"`
	IsInstantaneous bool                                                          `json:"isInstantaneous,required"`
	EndTime         time.Time                                                     `json:"endTime" format:"date-time"`
	LinkedURL       string                                                        `json:"linkedUrl"`
	StartTime       time.Time                                                     `json:"startTime" format:"date-time"`
	JSON            as112SummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AS112SummaryIPVersionResponseMetaDateRange

type AS112SummaryIPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                      `json:"startTime,required" format:"date-time"`
	JSON      as112SummaryIPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112SummaryIPVersionResponseMetaDateRange) UnmarshalJSON

func (r *AS112SummaryIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112SummaryIPVersionResponseSummary0

type AS112SummaryIPVersionResponseSummary0 struct {
	IPv4 string                                    `json:"IPv4,required"`
	IPv6 string                                    `json:"IPv6,required"`
	JSON as112SummaryIPVersionResponseSummary0JSON `json:"-"`
}

func (*AS112SummaryIPVersionResponseSummary0) UnmarshalJSON

func (r *AS112SummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AS112SummaryProtocolParams

type AS112SummaryProtocolParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112SummaryProtocolParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112SummaryProtocolParams) URLQuery

func (r AS112SummaryProtocolParams) URLQuery() (v url.Values)

URLQuery serializes AS112SummaryProtocolParams's query parameters as `url.Values`.

type AS112SummaryProtocolParamsFormat

type AS112SummaryProtocolParamsFormat string

Format results are returned in.

const (
	AS112SummaryProtocolParamsFormatJson AS112SummaryProtocolParamsFormat = "JSON"
	AS112SummaryProtocolParamsFormatCsv  AS112SummaryProtocolParamsFormat = "CSV"
)

func (AS112SummaryProtocolParamsFormat) IsKnown

type AS112SummaryProtocolResponse

type AS112SummaryProtocolResponse struct {
	Meta     AS112SummaryProtocolResponseMeta     `json:"meta,required"`
	Summary0 AS112SummaryProtocolResponseSummary0 `json:"summary_0,required"`
	JSON     as112SummaryProtocolResponseJSON     `json:"-"`
}

func (*AS112SummaryProtocolResponse) UnmarshalJSON

func (r *AS112SummaryProtocolResponse) UnmarshalJSON(data []byte) (err error)

type AS112SummaryProtocolResponseEnvelope

type AS112SummaryProtocolResponseEnvelope struct {
	Result  AS112SummaryProtocolResponse             `json:"result,required"`
	Success bool                                     `json:"success,required"`
	JSON    as112SummaryProtocolResponseEnvelopeJSON `json:"-"`
}

func (*AS112SummaryProtocolResponseEnvelope) UnmarshalJSON

func (r *AS112SummaryProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112SummaryProtocolResponseMeta

type AS112SummaryProtocolResponseMeta struct {
	DateRange      []AS112SummaryProtocolResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                         `json:"lastUpdated,required"`
	Normalization  string                                         `json:"normalization,required"`
	ConfidenceInfo AS112SummaryProtocolResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112SummaryProtocolResponseMetaJSON           `json:"-"`
}

func (*AS112SummaryProtocolResponseMeta) UnmarshalJSON

func (r *AS112SummaryProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112SummaryProtocolResponseMetaConfidenceInfo

type AS112SummaryProtocolResponseMetaConfidenceInfo struct {
	Annotations []AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                      `json:"level"`
	JSON        as112SummaryProtocolResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112SummaryProtocolResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112SummaryProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation

type AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                       `json:"dataSource,required"`
	Description     string                                                       `json:"description,required"`
	EventType       string                                                       `json:"eventType,required"`
	IsInstantaneous bool                                                         `json:"isInstantaneous,required"`
	EndTime         time.Time                                                    `json:"endTime" format:"date-time"`
	LinkedURL       string                                                       `json:"linkedUrl"`
	StartTime       time.Time                                                    `json:"startTime" format:"date-time"`
	JSON            as112SummaryProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AS112SummaryProtocolResponseMetaDateRange

type AS112SummaryProtocolResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                     `json:"startTime,required" format:"date-time"`
	JSON      as112SummaryProtocolResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112SummaryProtocolResponseMetaDateRange) UnmarshalJSON

func (r *AS112SummaryProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112SummaryProtocolResponseSummary0

type AS112SummaryProtocolResponseSummary0 struct {
	TCP  string                                   `json:"tcp,required"`
	Udp  string                                   `json:"udp,required"`
	JSON as112SummaryProtocolResponseSummary0JSON `json:"-"`
}

func (*AS112SummaryProtocolResponseSummary0) UnmarshalJSON

func (r *AS112SummaryProtocolResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AS112SummaryQueryTypeParams

type AS112SummaryQueryTypeParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112SummaryQueryTypeParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112SummaryQueryTypeParams) URLQuery

func (r AS112SummaryQueryTypeParams) URLQuery() (v url.Values)

URLQuery serializes AS112SummaryQueryTypeParams's query parameters as `url.Values`.

type AS112SummaryQueryTypeParamsFormat

type AS112SummaryQueryTypeParamsFormat string

Format results are returned in.

const (
	AS112SummaryQueryTypeParamsFormatJson AS112SummaryQueryTypeParamsFormat = "JSON"
	AS112SummaryQueryTypeParamsFormatCsv  AS112SummaryQueryTypeParamsFormat = "CSV"
)

func (AS112SummaryQueryTypeParamsFormat) IsKnown

type AS112SummaryQueryTypeResponse

type AS112SummaryQueryTypeResponse struct {
	Meta     AS112SummaryQueryTypeResponseMeta     `json:"meta,required"`
	Summary0 AS112SummaryQueryTypeResponseSummary0 `json:"summary_0,required"`
	JSON     as112SummaryQueryTypeResponseJSON     `json:"-"`
}

func (*AS112SummaryQueryTypeResponse) UnmarshalJSON

func (r *AS112SummaryQueryTypeResponse) UnmarshalJSON(data []byte) (err error)

type AS112SummaryQueryTypeResponseEnvelope

type AS112SummaryQueryTypeResponseEnvelope struct {
	Result  AS112SummaryQueryTypeResponse             `json:"result,required"`
	Success bool                                      `json:"success,required"`
	JSON    as112SummaryQueryTypeResponseEnvelopeJSON `json:"-"`
}

func (*AS112SummaryQueryTypeResponseEnvelope) UnmarshalJSON

func (r *AS112SummaryQueryTypeResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112SummaryQueryTypeResponseMeta

type AS112SummaryQueryTypeResponseMeta struct {
	DateRange      []AS112SummaryQueryTypeResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                          `json:"lastUpdated,required"`
	Normalization  string                                          `json:"normalization,required"`
	ConfidenceInfo AS112SummaryQueryTypeResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112SummaryQueryTypeResponseMetaJSON           `json:"-"`
}

func (*AS112SummaryQueryTypeResponseMeta) UnmarshalJSON

func (r *AS112SummaryQueryTypeResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112SummaryQueryTypeResponseMetaConfidenceInfo

type AS112SummaryQueryTypeResponseMetaConfidenceInfo struct {
	Annotations []AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                       `json:"level"`
	JSON        as112SummaryQueryTypeResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112SummaryQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112SummaryQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation

type AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                        `json:"dataSource,required"`
	Description     string                                                        `json:"description,required"`
	EventType       string                                                        `json:"eventType,required"`
	IsInstantaneous bool                                                          `json:"isInstantaneous,required"`
	EndTime         time.Time                                                     `json:"endTime" format:"date-time"`
	LinkedURL       string                                                        `json:"linkedUrl"`
	StartTime       time.Time                                                     `json:"startTime" format:"date-time"`
	JSON            as112SummaryQueryTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AS112SummaryQueryTypeResponseMetaDateRange

type AS112SummaryQueryTypeResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                      `json:"startTime,required" format:"date-time"`
	JSON      as112SummaryQueryTypeResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112SummaryQueryTypeResponseMetaDateRange) UnmarshalJSON

func (r *AS112SummaryQueryTypeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112SummaryQueryTypeResponseSummary0

type AS112SummaryQueryTypeResponseSummary0 struct {
	A    string                                    `json:"A,required"`
	AAAA string                                    `json:"AAAA,required"`
	PTR  string                                    `json:"PTR,required"`
	SOA  string                                    `json:"SOA,required"`
	SRV  string                                    `json:"SRV,required"`
	JSON as112SummaryQueryTypeResponseSummary0JSON `json:"-"`
}

func (*AS112SummaryQueryTypeResponseSummary0) UnmarshalJSON

func (r *AS112SummaryQueryTypeResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AS112SummaryResponseCodesParams

type AS112SummaryResponseCodesParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112SummaryResponseCodesParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112SummaryResponseCodesParams) URLQuery

func (r AS112SummaryResponseCodesParams) URLQuery() (v url.Values)

URLQuery serializes AS112SummaryResponseCodesParams's query parameters as `url.Values`.

type AS112SummaryResponseCodesParamsFormat

type AS112SummaryResponseCodesParamsFormat string

Format results are returned in.

const (
	AS112SummaryResponseCodesParamsFormatJson AS112SummaryResponseCodesParamsFormat = "JSON"
	AS112SummaryResponseCodesParamsFormatCsv  AS112SummaryResponseCodesParamsFormat = "CSV"
)

func (AS112SummaryResponseCodesParamsFormat) IsKnown

type AS112SummaryResponseCodesResponse

type AS112SummaryResponseCodesResponse struct {
	Meta     AS112SummaryResponseCodesResponseMeta     `json:"meta,required"`
	Summary0 AS112SummaryResponseCodesResponseSummary0 `json:"summary_0,required"`
	JSON     as112SummaryResponseCodesResponseJSON     `json:"-"`
}

func (*AS112SummaryResponseCodesResponse) UnmarshalJSON

func (r *AS112SummaryResponseCodesResponse) UnmarshalJSON(data []byte) (err error)

type AS112SummaryResponseCodesResponseEnvelope

type AS112SummaryResponseCodesResponseEnvelope struct {
	Result  AS112SummaryResponseCodesResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    as112SummaryResponseCodesResponseEnvelopeJSON `json:"-"`
}

func (*AS112SummaryResponseCodesResponseEnvelope) UnmarshalJSON

func (r *AS112SummaryResponseCodesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112SummaryResponseCodesResponseMeta

type AS112SummaryResponseCodesResponseMeta struct {
	DateRange      []AS112SummaryResponseCodesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                              `json:"lastUpdated,required"`
	Normalization  string                                              `json:"normalization,required"`
	ConfidenceInfo AS112SummaryResponseCodesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112SummaryResponseCodesResponseMetaJSON           `json:"-"`
}

func (*AS112SummaryResponseCodesResponseMeta) UnmarshalJSON

func (r *AS112SummaryResponseCodesResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112SummaryResponseCodesResponseMetaConfidenceInfo

type AS112SummaryResponseCodesResponseMetaConfidenceInfo struct {
	Annotations []AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                           `json:"level"`
	JSON        as112SummaryResponseCodesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112SummaryResponseCodesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112SummaryResponseCodesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation

type AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                            `json:"dataSource,required"`
	Description     string                                                            `json:"description,required"`
	EventType       string                                                            `json:"eventType,required"`
	IsInstantaneous bool                                                              `json:"isInstantaneous,required"`
	EndTime         time.Time                                                         `json:"endTime" format:"date-time"`
	LinkedURL       string                                                            `json:"linkedUrl"`
	StartTime       time.Time                                                         `json:"startTime" format:"date-time"`
	JSON            as112SummaryResponseCodesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AS112SummaryResponseCodesResponseMetaDateRange

type AS112SummaryResponseCodesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                          `json:"startTime,required" format:"date-time"`
	JSON      as112SummaryResponseCodesResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112SummaryResponseCodesResponseMetaDateRange) UnmarshalJSON

func (r *AS112SummaryResponseCodesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112SummaryResponseCodesResponseSummary0

type AS112SummaryResponseCodesResponseSummary0 struct {
	Noerror  string                                        `json:"NOERROR,required"`
	Nxdomain string                                        `json:"NXDOMAIN,required"`
	JSON     as112SummaryResponseCodesResponseSummary0JSON `json:"-"`
}

func (*AS112SummaryResponseCodesResponseSummary0) UnmarshalJSON

func (r *AS112SummaryResponseCodesResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AS112SummaryService

type AS112SummaryService struct {
	Options []option.RequestOption
}

AS112SummaryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAS112SummaryService method instead.

func NewAS112SummaryService

func NewAS112SummaryService(opts ...option.RequestOption) (r *AS112SummaryService)

NewAS112SummaryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AS112SummaryService) DNSSEC

Percentage distribution of DNS queries to AS112 by DNSSEC support.

func (*AS112SummaryService) Edns

Percentage distribution of DNS queries to AS112 by EDNS support.

func (*AS112SummaryService) IPVersion

Percentage distribution of DNS queries to AS112 per IP Version.

func (*AS112SummaryService) Protocol

Percentage distribution of DNS queries to AS112 per protocol.

func (*AS112SummaryService) QueryType

Percentage distribution of DNS queries to AS112 by query type.

func (*AS112SummaryService) ResponseCodes

Percentage distribution of AS112 DNS requests classified by response code.

type AS112TimeseriesGroupDNSSECParams

type AS112TimeseriesGroupDNSSECParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AS112TimeseriesGroupDNSSECParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TimeseriesGroupDNSSECParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TimeseriesGroupDNSSECParams) URLQuery

func (r AS112TimeseriesGroupDNSSECParams) URLQuery() (v url.Values)

URLQuery serializes AS112TimeseriesGroupDNSSECParams's query parameters as `url.Values`.

type AS112TimeseriesGroupDNSSECParamsAggInterval

type AS112TimeseriesGroupDNSSECParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AS112TimeseriesGroupDNSSECParamsAggInterval15m AS112TimeseriesGroupDNSSECParamsAggInterval = "15m"
	AS112TimeseriesGroupDNSSECParamsAggInterval1h  AS112TimeseriesGroupDNSSECParamsAggInterval = "1h"
	AS112TimeseriesGroupDNSSECParamsAggInterval1d  AS112TimeseriesGroupDNSSECParamsAggInterval = "1d"
	AS112TimeseriesGroupDNSSECParamsAggInterval1w  AS112TimeseriesGroupDNSSECParamsAggInterval = "1w"
)

func (AS112TimeseriesGroupDNSSECParamsAggInterval) IsKnown

type AS112TimeseriesGroupDNSSECParamsFormat

type AS112TimeseriesGroupDNSSECParamsFormat string

Format results are returned in.

const (
	AS112TimeseriesGroupDNSSECParamsFormatJson AS112TimeseriesGroupDNSSECParamsFormat = "JSON"
	AS112TimeseriesGroupDNSSECParamsFormatCsv  AS112TimeseriesGroupDNSSECParamsFormat = "CSV"
)

func (AS112TimeseriesGroupDNSSECParamsFormat) IsKnown

type AS112TimeseriesGroupDNSSECResponse

type AS112TimeseriesGroupDNSSECResponse struct {
	Meta   interface{}                              `json:"meta,required"`
	Serie0 AS112TimeseriesGroupDNSSECResponseSerie0 `json:"serie_0,required"`
	JSON   as112TimeseriesGroupDNSSECResponseJSON   `json:"-"`
}

func (*AS112TimeseriesGroupDNSSECResponse) UnmarshalJSON

func (r *AS112TimeseriesGroupDNSSECResponse) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupDNSSECResponseEnvelope

type AS112TimeseriesGroupDNSSECResponseEnvelope struct {
	Result  AS112TimeseriesGroupDNSSECResponse             `json:"result,required"`
	Success bool                                           `json:"success,required"`
	JSON    as112TimeseriesGroupDNSSECResponseEnvelopeJSON `json:"-"`
}

func (*AS112TimeseriesGroupDNSSECResponseEnvelope) UnmarshalJSON

func (r *AS112TimeseriesGroupDNSSECResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupDNSSECResponseSerie0

type AS112TimeseriesGroupDNSSECResponseSerie0 struct {
	NotSupported []string                                     `json:"NOT_SUPPORTED,required"`
	Supported    []string                                     `json:"SUPPORTED,required"`
	JSON         as112TimeseriesGroupDNSSECResponseSerie0JSON `json:"-"`
}

func (*AS112TimeseriesGroupDNSSECResponseSerie0) UnmarshalJSON

func (r *AS112TimeseriesGroupDNSSECResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupEdnsParams

type AS112TimeseriesGroupEdnsParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AS112TimeseriesGroupEdnsParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TimeseriesGroupEdnsParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TimeseriesGroupEdnsParams) URLQuery

func (r AS112TimeseriesGroupEdnsParams) URLQuery() (v url.Values)

URLQuery serializes AS112TimeseriesGroupEdnsParams's query parameters as `url.Values`.

type AS112TimeseriesGroupEdnsParamsAggInterval

type AS112TimeseriesGroupEdnsParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AS112TimeseriesGroupEdnsParamsAggInterval15m AS112TimeseriesGroupEdnsParamsAggInterval = "15m"
	AS112TimeseriesGroupEdnsParamsAggInterval1h  AS112TimeseriesGroupEdnsParamsAggInterval = "1h"
	AS112TimeseriesGroupEdnsParamsAggInterval1d  AS112TimeseriesGroupEdnsParamsAggInterval = "1d"
	AS112TimeseriesGroupEdnsParamsAggInterval1w  AS112TimeseriesGroupEdnsParamsAggInterval = "1w"
)

func (AS112TimeseriesGroupEdnsParamsAggInterval) IsKnown

type AS112TimeseriesGroupEdnsParamsFormat

type AS112TimeseriesGroupEdnsParamsFormat string

Format results are returned in.

const (
	AS112TimeseriesGroupEdnsParamsFormatJson AS112TimeseriesGroupEdnsParamsFormat = "JSON"
	AS112TimeseriesGroupEdnsParamsFormatCsv  AS112TimeseriesGroupEdnsParamsFormat = "CSV"
)

func (AS112TimeseriesGroupEdnsParamsFormat) IsKnown

type AS112TimeseriesGroupEdnsResponse

type AS112TimeseriesGroupEdnsResponse struct {
	Meta   interface{}                            `json:"meta,required"`
	Serie0 AS112TimeseriesGroupEdnsResponseSerie0 `json:"serie_0,required"`
	JSON   as112TimeseriesGroupEdnsResponseJSON   `json:"-"`
}

func (*AS112TimeseriesGroupEdnsResponse) UnmarshalJSON

func (r *AS112TimeseriesGroupEdnsResponse) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupEdnsResponseEnvelope

type AS112TimeseriesGroupEdnsResponseEnvelope struct {
	Result  AS112TimeseriesGroupEdnsResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    as112TimeseriesGroupEdnsResponseEnvelopeJSON `json:"-"`
}

func (*AS112TimeseriesGroupEdnsResponseEnvelope) UnmarshalJSON

func (r *AS112TimeseriesGroupEdnsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupEdnsResponseSerie0

type AS112TimeseriesGroupEdnsResponseSerie0 struct {
	NotSupported []string                                   `json:"NOT_SUPPORTED,required"`
	Supported    []string                                   `json:"SUPPORTED,required"`
	JSON         as112TimeseriesGroupEdnsResponseSerie0JSON `json:"-"`
}

func (*AS112TimeseriesGroupEdnsResponseSerie0) UnmarshalJSON

func (r *AS112TimeseriesGroupEdnsResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupIPVersionParams

type AS112TimeseriesGroupIPVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AS112TimeseriesGroupIPVersionParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TimeseriesGroupIPVersionParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TimeseriesGroupIPVersionParams) URLQuery

URLQuery serializes AS112TimeseriesGroupIPVersionParams's query parameters as `url.Values`.

type AS112TimeseriesGroupIPVersionParamsAggInterval

type AS112TimeseriesGroupIPVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AS112TimeseriesGroupIPVersionParamsAggInterval15m AS112TimeseriesGroupIPVersionParamsAggInterval = "15m"
	AS112TimeseriesGroupIPVersionParamsAggInterval1h  AS112TimeseriesGroupIPVersionParamsAggInterval = "1h"
	AS112TimeseriesGroupIPVersionParamsAggInterval1d  AS112TimeseriesGroupIPVersionParamsAggInterval = "1d"
	AS112TimeseriesGroupIPVersionParamsAggInterval1w  AS112TimeseriesGroupIPVersionParamsAggInterval = "1w"
)

func (AS112TimeseriesGroupIPVersionParamsAggInterval) IsKnown

type AS112TimeseriesGroupIPVersionParamsFormat

type AS112TimeseriesGroupIPVersionParamsFormat string

Format results are returned in.

const (
	AS112TimeseriesGroupIPVersionParamsFormatJson AS112TimeseriesGroupIPVersionParamsFormat = "JSON"
	AS112TimeseriesGroupIPVersionParamsFormatCsv  AS112TimeseriesGroupIPVersionParamsFormat = "CSV"
)

func (AS112TimeseriesGroupIPVersionParamsFormat) IsKnown

type AS112TimeseriesGroupIPVersionResponse

type AS112TimeseriesGroupIPVersionResponse struct {
	Meta   interface{}                                 `json:"meta,required"`
	Serie0 AS112TimeseriesGroupIPVersionResponseSerie0 `json:"serie_0,required"`
	JSON   as112TimeseriesGroupIPVersionResponseJSON   `json:"-"`
}

func (*AS112TimeseriesGroupIPVersionResponse) UnmarshalJSON

func (r *AS112TimeseriesGroupIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupIPVersionResponseEnvelope

type AS112TimeseriesGroupIPVersionResponseEnvelope struct {
	Result  AS112TimeseriesGroupIPVersionResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    as112TimeseriesGroupIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AS112TimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON

func (r *AS112TimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupIPVersionResponseSerie0

type AS112TimeseriesGroupIPVersionResponseSerie0 struct {
	IPv4 []string                                        `json:"IPv4,required"`
	IPv6 []string                                        `json:"IPv6,required"`
	JSON as112TimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}

func (*AS112TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON

func (r *AS112TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupProtocolParams

type AS112TimeseriesGroupProtocolParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AS112TimeseriesGroupProtocolParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TimeseriesGroupProtocolParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TimeseriesGroupProtocolParams) URLQuery

URLQuery serializes AS112TimeseriesGroupProtocolParams's query parameters as `url.Values`.

type AS112TimeseriesGroupProtocolParamsAggInterval

type AS112TimeseriesGroupProtocolParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AS112TimeseriesGroupProtocolParamsAggInterval15m AS112TimeseriesGroupProtocolParamsAggInterval = "15m"
	AS112TimeseriesGroupProtocolParamsAggInterval1h  AS112TimeseriesGroupProtocolParamsAggInterval = "1h"
	AS112TimeseriesGroupProtocolParamsAggInterval1d  AS112TimeseriesGroupProtocolParamsAggInterval = "1d"
	AS112TimeseriesGroupProtocolParamsAggInterval1w  AS112TimeseriesGroupProtocolParamsAggInterval = "1w"
)

func (AS112TimeseriesGroupProtocolParamsAggInterval) IsKnown

type AS112TimeseriesGroupProtocolParamsFormat

type AS112TimeseriesGroupProtocolParamsFormat string

Format results are returned in.

const (
	AS112TimeseriesGroupProtocolParamsFormatJson AS112TimeseriesGroupProtocolParamsFormat = "JSON"
	AS112TimeseriesGroupProtocolParamsFormatCsv  AS112TimeseriesGroupProtocolParamsFormat = "CSV"
)

func (AS112TimeseriesGroupProtocolParamsFormat) IsKnown

type AS112TimeseriesGroupProtocolResponse

type AS112TimeseriesGroupProtocolResponse struct {
	Meta   interface{}                                `json:"meta,required"`
	Serie0 AS112TimeseriesGroupProtocolResponseSerie0 `json:"serie_0,required"`
	JSON   as112TimeseriesGroupProtocolResponseJSON   `json:"-"`
}

func (*AS112TimeseriesGroupProtocolResponse) UnmarshalJSON

func (r *AS112TimeseriesGroupProtocolResponse) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupProtocolResponseEnvelope

type AS112TimeseriesGroupProtocolResponseEnvelope struct {
	Result  AS112TimeseriesGroupProtocolResponse             `json:"result,required"`
	Success bool                                             `json:"success,required"`
	JSON    as112TimeseriesGroupProtocolResponseEnvelopeJSON `json:"-"`
}

func (*AS112TimeseriesGroupProtocolResponseEnvelope) UnmarshalJSON

func (r *AS112TimeseriesGroupProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupProtocolResponseSerie0

type AS112TimeseriesGroupProtocolResponseSerie0 struct {
	TCP  []string                                       `json:"tcp,required"`
	Udp  []string                                       `json:"udp,required"`
	JSON as112TimeseriesGroupProtocolResponseSerie0JSON `json:"-"`
}

func (*AS112TimeseriesGroupProtocolResponseSerie0) UnmarshalJSON

func (r *AS112TimeseriesGroupProtocolResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupQueryTypeParams

type AS112TimeseriesGroupQueryTypeParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AS112TimeseriesGroupQueryTypeParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TimeseriesGroupQueryTypeParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TimeseriesGroupQueryTypeParams) URLQuery

URLQuery serializes AS112TimeseriesGroupQueryTypeParams's query parameters as `url.Values`.

type AS112TimeseriesGroupQueryTypeParamsAggInterval

type AS112TimeseriesGroupQueryTypeParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AS112TimeseriesGroupQueryTypeParamsAggInterval15m AS112TimeseriesGroupQueryTypeParamsAggInterval = "15m"
	AS112TimeseriesGroupQueryTypeParamsAggInterval1h  AS112TimeseriesGroupQueryTypeParamsAggInterval = "1h"
	AS112TimeseriesGroupQueryTypeParamsAggInterval1d  AS112TimeseriesGroupQueryTypeParamsAggInterval = "1d"
	AS112TimeseriesGroupQueryTypeParamsAggInterval1w  AS112TimeseriesGroupQueryTypeParamsAggInterval = "1w"
)

func (AS112TimeseriesGroupQueryTypeParamsAggInterval) IsKnown

type AS112TimeseriesGroupQueryTypeParamsFormat

type AS112TimeseriesGroupQueryTypeParamsFormat string

Format results are returned in.

const (
	AS112TimeseriesGroupQueryTypeParamsFormatJson AS112TimeseriesGroupQueryTypeParamsFormat = "JSON"
	AS112TimeseriesGroupQueryTypeParamsFormatCsv  AS112TimeseriesGroupQueryTypeParamsFormat = "CSV"
)

func (AS112TimeseriesGroupQueryTypeParamsFormat) IsKnown

type AS112TimeseriesGroupQueryTypeResponse

type AS112TimeseriesGroupQueryTypeResponse struct {
	Meta   interface{}                                 `json:"meta,required"`
	Serie0 AS112TimeseriesGroupQueryTypeResponseSerie0 `json:"serie_0,required"`
	JSON   as112TimeseriesGroupQueryTypeResponseJSON   `json:"-"`
}

func (*AS112TimeseriesGroupQueryTypeResponse) UnmarshalJSON

func (r *AS112TimeseriesGroupQueryTypeResponse) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupQueryTypeResponseEnvelope

type AS112TimeseriesGroupQueryTypeResponseEnvelope struct {
	Result  AS112TimeseriesGroupQueryTypeResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    as112TimeseriesGroupQueryTypeResponseEnvelopeJSON `json:"-"`
}

func (*AS112TimeseriesGroupQueryTypeResponseEnvelope) UnmarshalJSON

func (r *AS112TimeseriesGroupQueryTypeResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupQueryTypeResponseSerie0

type AS112TimeseriesGroupQueryTypeResponseSerie0 struct {
	A    []string                                        `json:"A,required"`
	AAAA []string                                        `json:"AAAA,required"`
	PTR  []string                                        `json:"PTR,required"`
	SOA  []string                                        `json:"SOA,required"`
	SRV  []string                                        `json:"SRV,required"`
	JSON as112TimeseriesGroupQueryTypeResponseSerie0JSON `json:"-"`
}

func (*AS112TimeseriesGroupQueryTypeResponseSerie0) UnmarshalJSON

func (r *AS112TimeseriesGroupQueryTypeResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupResponseCodesParams

type AS112TimeseriesGroupResponseCodesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AS112TimeseriesGroupResponseCodesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TimeseriesGroupResponseCodesParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TimeseriesGroupResponseCodesParams) URLQuery

URLQuery serializes AS112TimeseriesGroupResponseCodesParams's query parameters as `url.Values`.

type AS112TimeseriesGroupResponseCodesParamsAggInterval

type AS112TimeseriesGroupResponseCodesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AS112TimeseriesGroupResponseCodesParamsAggInterval15m AS112TimeseriesGroupResponseCodesParamsAggInterval = "15m"
	AS112TimeseriesGroupResponseCodesParamsAggInterval1h  AS112TimeseriesGroupResponseCodesParamsAggInterval = "1h"
	AS112TimeseriesGroupResponseCodesParamsAggInterval1d  AS112TimeseriesGroupResponseCodesParamsAggInterval = "1d"
	AS112TimeseriesGroupResponseCodesParamsAggInterval1w  AS112TimeseriesGroupResponseCodesParamsAggInterval = "1w"
)

func (AS112TimeseriesGroupResponseCodesParamsAggInterval) IsKnown

type AS112TimeseriesGroupResponseCodesParamsFormat

type AS112TimeseriesGroupResponseCodesParamsFormat string

Format results are returned in.

const (
	AS112TimeseriesGroupResponseCodesParamsFormatJson AS112TimeseriesGroupResponseCodesParamsFormat = "JSON"
	AS112TimeseriesGroupResponseCodesParamsFormatCsv  AS112TimeseriesGroupResponseCodesParamsFormat = "CSV"
)

func (AS112TimeseriesGroupResponseCodesParamsFormat) IsKnown

type AS112TimeseriesGroupResponseCodesResponse

type AS112TimeseriesGroupResponseCodesResponse struct {
	Meta   interface{}                                     `json:"meta,required"`
	Serie0 AS112TimeseriesGroupResponseCodesResponseSerie0 `json:"serie_0,required"`
	JSON   as112TimeseriesGroupResponseCodesResponseJSON   `json:"-"`
}

func (*AS112TimeseriesGroupResponseCodesResponse) UnmarshalJSON

func (r *AS112TimeseriesGroupResponseCodesResponse) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupResponseCodesResponseEnvelope

type AS112TimeseriesGroupResponseCodesResponseEnvelope struct {
	Result  AS112TimeseriesGroupResponseCodesResponse             `json:"result,required"`
	Success bool                                                  `json:"success,required"`
	JSON    as112TimeseriesGroupResponseCodesResponseEnvelopeJSON `json:"-"`
}

func (*AS112TimeseriesGroupResponseCodesResponseEnvelope) UnmarshalJSON

func (r *AS112TimeseriesGroupResponseCodesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupResponseCodesResponseSerie0

type AS112TimeseriesGroupResponseCodesResponseSerie0 struct {
	Noerror  []string                                            `json:"NOERROR,required"`
	Nxdomain []string                                            `json:"NXDOMAIN,required"`
	JSON     as112TimeseriesGroupResponseCodesResponseSerie0JSON `json:"-"`
}

func (*AS112TimeseriesGroupResponseCodesResponseSerie0) UnmarshalJSON

func (r *AS112TimeseriesGroupResponseCodesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesGroupService

type AS112TimeseriesGroupService struct {
	Options []option.RequestOption
}

AS112TimeseriesGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAS112TimeseriesGroupService method instead.

func NewAS112TimeseriesGroupService

func NewAS112TimeseriesGroupService(opts ...option.RequestOption) (r *AS112TimeseriesGroupService)

NewAS112TimeseriesGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AS112TimeseriesGroupService) DNSSEC

Percentage distribution of DNS AS112 queries by DNSSEC support over time.

func (*AS112TimeseriesGroupService) Edns

Percentage distribution of AS112 DNS queries by EDNS support over time.

func (*AS112TimeseriesGroupService) IPVersion

Percentage distribution of AS112 DNS queries by IP version over time.

func (*AS112TimeseriesGroupService) Protocol

Percentage distribution of AS112 DNS requests classified by protocol over time.

func (*AS112TimeseriesGroupService) QueryType

Percentage distribution of AS112 DNS queries by query type over time.

func (*AS112TimeseriesGroupService) ResponseCodes

Percentage distribution of AS112 DNS requests classified by response code over time.

type AS112TimeseriesParams

type AS112TimeseriesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AS112TimeseriesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TimeseriesParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TimeseriesParams) URLQuery

func (r AS112TimeseriesParams) URLQuery() (v url.Values)

URLQuery serializes AS112TimeseriesParams's query parameters as `url.Values`.

type AS112TimeseriesParamsAggInterval

type AS112TimeseriesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AS112TimeseriesParamsAggInterval15m AS112TimeseriesParamsAggInterval = "15m"
	AS112TimeseriesParamsAggInterval1h  AS112TimeseriesParamsAggInterval = "1h"
	AS112TimeseriesParamsAggInterval1d  AS112TimeseriesParamsAggInterval = "1d"
	AS112TimeseriesParamsAggInterval1w  AS112TimeseriesParamsAggInterval = "1w"
)

func (AS112TimeseriesParamsAggInterval) IsKnown

type AS112TimeseriesParamsFormat

type AS112TimeseriesParamsFormat string

Format results are returned in.

const (
	AS112TimeseriesParamsFormatJson AS112TimeseriesParamsFormat = "JSON"
	AS112TimeseriesParamsFormatCsv  AS112TimeseriesParamsFormat = "CSV"
)

func (AS112TimeseriesParamsFormat) IsKnown

func (r AS112TimeseriesParamsFormat) IsKnown() bool

type AS112TimeseriesResponse

type AS112TimeseriesResponse struct {
	Meta   AS112TimeseriesResponseMeta   `json:"meta,required"`
	Serie0 AS112TimeseriesResponseSerie0 `json:"serie_0,required"`
	JSON   as112TimeseriesResponseJSON   `json:"-"`
}

func (*AS112TimeseriesResponse) UnmarshalJSON

func (r *AS112TimeseriesResponse) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesResponseEnvelope

type AS112TimeseriesResponseEnvelope struct {
	Result  AS112TimeseriesResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    as112TimeseriesResponseEnvelopeJSON `json:"-"`
}

func (*AS112TimeseriesResponseEnvelope) UnmarshalJSON

func (r *AS112TimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesResponseMeta

type AS112TimeseriesResponseMeta struct {
	AggInterval    string                                    `json:"aggInterval,required"`
	DateRange      []AS112TimeseriesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                                 `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo AS112TimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112TimeseriesResponseMetaJSON           `json:"-"`
}

func (*AS112TimeseriesResponseMeta) UnmarshalJSON

func (r *AS112TimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesResponseMetaConfidenceInfo

type AS112TimeseriesResponseMetaConfidenceInfo struct {
	Annotations []AS112TimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                 `json:"level"`
	JSON        as112TimeseriesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112TimeseriesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112TimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesResponseMetaConfidenceInfoAnnotation

type AS112TimeseriesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                  `json:"dataSource,required"`
	Description     string                                                  `json:"description,required"`
	EventType       string                                                  `json:"eventType,required"`
	IsInstantaneous bool                                                    `json:"isInstantaneous,required"`
	EndTime         time.Time                                               `json:"endTime" format:"date-time"`
	LinkedURL       string                                                  `json:"linkedUrl"`
	StartTime       time.Time                                               `json:"startTime" format:"date-time"`
	JSON            as112TimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112TimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *AS112TimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesResponseMetaDateRange

type AS112TimeseriesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                `json:"startTime,required" format:"date-time"`
	JSON      as112TimeseriesResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112TimeseriesResponseMetaDateRange) UnmarshalJSON

func (r *AS112TimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112TimeseriesResponseSerie0

type AS112TimeseriesResponseSerie0 struct {
	Timestamps []time.Time                       `json:"timestamps,required" format:"date-time"`
	Values     []string                          `json:"values,required"`
	JSON       as112TimeseriesResponseSerie0JSON `json:"-"`
}

func (*AS112TimeseriesResponseSerie0) UnmarshalJSON

func (r *AS112TimeseriesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AS112TopDNSSECParams

type AS112TopDNSSECParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TopDNSSECParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TopDNSSECParams) URLQuery

func (r AS112TopDNSSECParams) URLQuery() (v url.Values)

URLQuery serializes AS112TopDNSSECParams's query parameters as `url.Values`.

type AS112TopDNSSECParamsDNSSEC

type AS112TopDNSSECParamsDNSSEC string

DNSSEC.

const (
	AS112TopDNSSECParamsDNSSECSupported    AS112TopDNSSECParamsDNSSEC = "SUPPORTED"
	AS112TopDNSSECParamsDNSSECNotSupported AS112TopDNSSECParamsDNSSEC = "NOT_SUPPORTED"
)

func (AS112TopDNSSECParamsDNSSEC) IsKnown

func (r AS112TopDNSSECParamsDNSSEC) IsKnown() bool

type AS112TopDNSSECParamsFormat

type AS112TopDNSSECParamsFormat string

Format results are returned in.

const (
	AS112TopDNSSECParamsFormatJson AS112TopDNSSECParamsFormat = "JSON"
	AS112TopDNSSECParamsFormatCsv  AS112TopDNSSECParamsFormat = "CSV"
)

func (AS112TopDNSSECParamsFormat) IsKnown

func (r AS112TopDNSSECParamsFormat) IsKnown() bool

type AS112TopDNSSECResponse

type AS112TopDNSSECResponse struct {
	Meta AS112TopDNSSECResponseMeta   `json:"meta,required"`
	Top0 []AS112TopDNSSECResponseTop0 `json:"top_0,required"`
	JSON as112TopDNSSECResponseJSON   `json:"-"`
}

func (*AS112TopDNSSECResponse) UnmarshalJSON

func (r *AS112TopDNSSECResponse) UnmarshalJSON(data []byte) (err error)

type AS112TopDNSSECResponseEnvelope

type AS112TopDNSSECResponseEnvelope struct {
	Result  AS112TopDNSSECResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    as112TopDNSSECResponseEnvelopeJSON `json:"-"`
}

func (*AS112TopDNSSECResponseEnvelope) UnmarshalJSON

func (r *AS112TopDNSSECResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TopDNSSECResponseMeta

type AS112TopDNSSECResponseMeta struct {
	DateRange      []AS112TopDNSSECResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                   `json:"lastUpdated,required"`
	ConfidenceInfo AS112TopDNSSECResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112TopDNSSECResponseMetaJSON           `json:"-"`
}

func (*AS112TopDNSSECResponseMeta) UnmarshalJSON

func (r *AS112TopDNSSECResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112TopDNSSECResponseMetaConfidenceInfo

type AS112TopDNSSECResponseMetaConfidenceInfo struct {
	Annotations []AS112TopDNSSECResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                `json:"level"`
	JSON        as112TopDNSSECResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112TopDNSSECResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112TopDNSSECResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112TopDNSSECResponseMetaConfidenceInfoAnnotation

type AS112TopDNSSECResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                 `json:"dataSource,required"`
	Description     string                                                 `json:"description,required"`
	EventType       string                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                 `json:"linkedUrl"`
	StartTime       time.Time                                              `json:"startTime" format:"date-time"`
	JSON            as112TopDNSSECResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112TopDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *AS112TopDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type AS112TopDNSSECResponseMetaDateRange

type AS112TopDNSSECResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                               `json:"startTime,required" format:"date-time"`
	JSON      as112TopDNSSECResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112TopDNSSECResponseMetaDateRange) UnmarshalJSON

func (r *AS112TopDNSSECResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112TopDNSSECResponseTop0

type AS112TopDNSSECResponseTop0 struct {
	ClientCountryAlpha2 string                         `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                         `json:"clientCountryName,required"`
	Value               string                         `json:"value,required"`
	JSON                as112TopDNSSECResponseTop0JSON `json:"-"`
}

func (*AS112TopDNSSECResponseTop0) UnmarshalJSON

func (r *AS112TopDNSSECResponseTop0) UnmarshalJSON(data []byte) (err error)

type AS112TopEdnsParams

type AS112TopEdnsParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TopEdnsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TopEdnsParams) URLQuery

func (r AS112TopEdnsParams) URLQuery() (v url.Values)

URLQuery serializes AS112TopEdnsParams's query parameters as `url.Values`.

type AS112TopEdnsParamsEdns

type AS112TopEdnsParamsEdns string

EDNS.

const (
	AS112TopEdnsParamsEdnsSupported    AS112TopEdnsParamsEdns = "SUPPORTED"
	AS112TopEdnsParamsEdnsNotSupported AS112TopEdnsParamsEdns = "NOT_SUPPORTED"
)

func (AS112TopEdnsParamsEdns) IsKnown

func (r AS112TopEdnsParamsEdns) IsKnown() bool

type AS112TopEdnsParamsFormat

type AS112TopEdnsParamsFormat string

Format results are returned in.

const (
	AS112TopEdnsParamsFormatJson AS112TopEdnsParamsFormat = "JSON"
	AS112TopEdnsParamsFormatCsv  AS112TopEdnsParamsFormat = "CSV"
)

func (AS112TopEdnsParamsFormat) IsKnown

func (r AS112TopEdnsParamsFormat) IsKnown() bool

type AS112TopEdnsResponse

type AS112TopEdnsResponse struct {
	Meta AS112TopEdnsResponseMeta   `json:"meta,required"`
	Top0 []AS112TopEdnsResponseTop0 `json:"top_0,required"`
	JSON as112TopEdnsResponseJSON   `json:"-"`
}

func (*AS112TopEdnsResponse) UnmarshalJSON

func (r *AS112TopEdnsResponse) UnmarshalJSON(data []byte) (err error)

type AS112TopEdnsResponseEnvelope

type AS112TopEdnsResponseEnvelope struct {
	Result  AS112TopEdnsResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    as112TopEdnsResponseEnvelopeJSON `json:"-"`
}

func (*AS112TopEdnsResponseEnvelope) UnmarshalJSON

func (r *AS112TopEdnsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TopEdnsResponseMeta

type AS112TopEdnsResponseMeta struct {
	DateRange      []AS112TopEdnsResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                 `json:"lastUpdated,required"`
	ConfidenceInfo AS112TopEdnsResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112TopEdnsResponseMetaJSON           `json:"-"`
}

func (*AS112TopEdnsResponseMeta) UnmarshalJSON

func (r *AS112TopEdnsResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112TopEdnsResponseMetaConfidenceInfo

type AS112TopEdnsResponseMetaConfidenceInfo struct {
	Annotations []AS112TopEdnsResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                              `json:"level"`
	JSON        as112TopEdnsResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112TopEdnsResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112TopEdnsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112TopEdnsResponseMetaConfidenceInfoAnnotation

type AS112TopEdnsResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                               `json:"dataSource,required"`
	Description     string                                               `json:"description,required"`
	EventType       string                                               `json:"eventType,required"`
	IsInstantaneous bool                                                 `json:"isInstantaneous,required"`
	EndTime         time.Time                                            `json:"endTime" format:"date-time"`
	LinkedURL       string                                               `json:"linkedUrl"`
	StartTime       time.Time                                            `json:"startTime" format:"date-time"`
	JSON            as112TopEdnsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112TopEdnsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *AS112TopEdnsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type AS112TopEdnsResponseMetaDateRange

type AS112TopEdnsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                             `json:"startTime,required" format:"date-time"`
	JSON      as112TopEdnsResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112TopEdnsResponseMetaDateRange) UnmarshalJSON

func (r *AS112TopEdnsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112TopEdnsResponseTop0

type AS112TopEdnsResponseTop0 struct {
	ClientCountryAlpha2 string                       `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                       `json:"clientCountryName,required"`
	Value               string                       `json:"value,required"`
	JSON                as112TopEdnsResponseTop0JSON `json:"-"`
}

func (*AS112TopEdnsResponseTop0) UnmarshalJSON

func (r *AS112TopEdnsResponseTop0) UnmarshalJSON(data []byte) (err error)

type AS112TopIPVersionParams

type AS112TopIPVersionParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TopIPVersionParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TopIPVersionParams) URLQuery

func (r AS112TopIPVersionParams) URLQuery() (v url.Values)

URLQuery serializes AS112TopIPVersionParams's query parameters as `url.Values`.

type AS112TopIPVersionParamsFormat

type AS112TopIPVersionParamsFormat string

Format results are returned in.

const (
	AS112TopIPVersionParamsFormatJson AS112TopIPVersionParamsFormat = "JSON"
	AS112TopIPVersionParamsFormatCsv  AS112TopIPVersionParamsFormat = "CSV"
)

func (AS112TopIPVersionParamsFormat) IsKnown

func (r AS112TopIPVersionParamsFormat) IsKnown() bool

type AS112TopIPVersionParamsIPVersion

type AS112TopIPVersionParamsIPVersion string

IP Version.

const (
	AS112TopIPVersionParamsIPVersionIPv4 AS112TopIPVersionParamsIPVersion = "IPv4"
	AS112TopIPVersionParamsIPVersionIPv6 AS112TopIPVersionParamsIPVersion = "IPv6"
)

func (AS112TopIPVersionParamsIPVersion) IsKnown

type AS112TopIPVersionResponse

type AS112TopIPVersionResponse struct {
	Meta AS112TopIPVersionResponseMeta   `json:"meta,required"`
	Top0 []AS112TopIPVersionResponseTop0 `json:"top_0,required"`
	JSON as112TopIPVersionResponseJSON   `json:"-"`
}

func (*AS112TopIPVersionResponse) UnmarshalJSON

func (r *AS112TopIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AS112TopIPVersionResponseEnvelope

type AS112TopIPVersionResponseEnvelope struct {
	Result  AS112TopIPVersionResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    as112TopIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AS112TopIPVersionResponseEnvelope) UnmarshalJSON

func (r *AS112TopIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TopIPVersionResponseMeta

type AS112TopIPVersionResponseMeta struct {
	DateRange      []AS112TopIPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                      `json:"lastUpdated,required"`
	ConfidenceInfo AS112TopIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112TopIPVersionResponseMetaJSON           `json:"-"`
}

func (*AS112TopIPVersionResponseMeta) UnmarshalJSON

func (r *AS112TopIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112TopIPVersionResponseMetaConfidenceInfo

type AS112TopIPVersionResponseMetaConfidenceInfo struct {
	Annotations []AS112TopIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                   `json:"level"`
	JSON        as112TopIPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112TopIPVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112TopIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112TopIPVersionResponseMetaConfidenceInfoAnnotation

type AS112TopIPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                    `json:"dataSource,required"`
	Description     string                                                    `json:"description,required"`
	EventType       string                                                    `json:"eventType,required"`
	IsInstantaneous bool                                                      `json:"isInstantaneous,required"`
	EndTime         time.Time                                                 `json:"endTime" format:"date-time"`
	LinkedURL       string                                                    `json:"linkedUrl"`
	StartTime       time.Time                                                 `json:"startTime" format:"date-time"`
	JSON            as112TopIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112TopIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *AS112TopIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type AS112TopIPVersionResponseMetaDateRange

type AS112TopIPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                  `json:"startTime,required" format:"date-time"`
	JSON      as112TopIPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112TopIPVersionResponseMetaDateRange) UnmarshalJSON

func (r *AS112TopIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112TopIPVersionResponseTop0

type AS112TopIPVersionResponseTop0 struct {
	ClientCountryAlpha2 string                            `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                            `json:"clientCountryName,required"`
	Value               string                            `json:"value,required"`
	JSON                as112TopIPVersionResponseTop0JSON `json:"-"`
}

func (*AS112TopIPVersionResponseTop0) UnmarshalJSON

func (r *AS112TopIPVersionResponseTop0) UnmarshalJSON(data []byte) (err error)

type AS112TopLocationsParams

type AS112TopLocationsParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AS112TopLocationsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AS112TopLocationsParams) URLQuery

func (r AS112TopLocationsParams) URLQuery() (v url.Values)

URLQuery serializes AS112TopLocationsParams's query parameters as `url.Values`.

type AS112TopLocationsParamsFormat

type AS112TopLocationsParamsFormat string

Format results are returned in.

const (
	AS112TopLocationsParamsFormatJson AS112TopLocationsParamsFormat = "JSON"
	AS112TopLocationsParamsFormatCsv  AS112TopLocationsParamsFormat = "CSV"
)

func (AS112TopLocationsParamsFormat) IsKnown

func (r AS112TopLocationsParamsFormat) IsKnown() bool

type AS112TopLocationsResponse

type AS112TopLocationsResponse struct {
	Meta AS112TopLocationsResponseMeta   `json:"meta,required"`
	Top0 []AS112TopLocationsResponseTop0 `json:"top_0,required"`
	JSON as112TopLocationsResponseJSON   `json:"-"`
}

func (*AS112TopLocationsResponse) UnmarshalJSON

func (r *AS112TopLocationsResponse) UnmarshalJSON(data []byte) (err error)

type AS112TopLocationsResponseEnvelope

type AS112TopLocationsResponseEnvelope struct {
	Result  AS112TopLocationsResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    as112TopLocationsResponseEnvelopeJSON `json:"-"`
}

func (*AS112TopLocationsResponseEnvelope) UnmarshalJSON

func (r *AS112TopLocationsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AS112TopLocationsResponseMeta

type AS112TopLocationsResponseMeta struct {
	DateRange      []AS112TopLocationsResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                      `json:"lastUpdated,required"`
	ConfidenceInfo AS112TopLocationsResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           as112TopLocationsResponseMetaJSON           `json:"-"`
}

func (*AS112TopLocationsResponseMeta) UnmarshalJSON

func (r *AS112TopLocationsResponseMeta) UnmarshalJSON(data []byte) (err error)

type AS112TopLocationsResponseMetaConfidenceInfo

type AS112TopLocationsResponseMetaConfidenceInfo struct {
	Annotations []AS112TopLocationsResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                   `json:"level"`
	JSON        as112TopLocationsResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AS112TopLocationsResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AS112TopLocationsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AS112TopLocationsResponseMetaConfidenceInfoAnnotation

type AS112TopLocationsResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                    `json:"dataSource,required"`
	Description     string                                                    `json:"description,required"`
	EventType       string                                                    `json:"eventType,required"`
	IsInstantaneous bool                                                      `json:"isInstantaneous,required"`
	EndTime         time.Time                                                 `json:"endTime" format:"date-time"`
	LinkedURL       string                                                    `json:"linkedUrl"`
	StartTime       time.Time                                                 `json:"startTime" format:"date-time"`
	JSON            as112TopLocationsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AS112TopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *AS112TopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type AS112TopLocationsResponseMetaDateRange

type AS112TopLocationsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                  `json:"startTime,required" format:"date-time"`
	JSON      as112TopLocationsResponseMetaDateRangeJSON `json:"-"`
}

func (*AS112TopLocationsResponseMetaDateRange) UnmarshalJSON

func (r *AS112TopLocationsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AS112TopLocationsResponseTop0

type AS112TopLocationsResponseTop0 struct {
	ClientCountryAlpha2 string                            `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                            `json:"clientCountryName,required"`
	Value               string                            `json:"value,required"`
	JSON                as112TopLocationsResponseTop0JSON `json:"-"`
}

func (*AS112TopLocationsResponseTop0) UnmarshalJSON

func (r *AS112TopLocationsResponseTop0) UnmarshalJSON(data []byte) (err error)

type AS112TopService

type AS112TopService struct {
	Options []option.RequestOption
}

AS112TopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAS112TopService method instead.

func NewAS112TopService

func NewAS112TopService(opts ...option.RequestOption) (r *AS112TopService)

NewAS112TopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AS112TopService) DNSSEC

Get the top locations of DNS queries to AS112 with DNSSEC.

func (*AS112TopService) Edns

Get the top locations of DNS queries to AS112 with EDNS support.

func (*AS112TopService) IPVersion

Get the top locations of DNS queries to AS112 by IP version.

func (*AS112TopService) Locations

Get the top locations by AS112 DNS queries. Values are a percentage out of the total queries.

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AnnotationListParams

type AnnotationListParams struct {
	// Single ASN as integer.
	ASN param.Field[int64] `query:"asn"`
	// End of the date range (inclusive).
	DateEnd param.Field[time.Time] `query:"dateEnd" format:"date-time"`
	// Shorthand date ranges for the last X days - use when you don't need specific
	// start and end dates.
	DateRange param.Field[string] `query:"dateRange"`
	// Start of the date range (inclusive).
	DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AnnotationListParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Location Alpha2 code.
	Location param.Field[string] `query:"location"`
	// Number of objects to skip before grabbing results.
	Offset param.Field[int64] `query:"offset"`
}

func (AnnotationListParams) URLQuery

func (r AnnotationListParams) URLQuery() (v url.Values)

URLQuery serializes AnnotationListParams's query parameters as `url.Values`.

type AnnotationListParamsFormat

type AnnotationListParamsFormat string

Format results are returned in.

const (
	AnnotationListParamsFormatJson AnnotationListParamsFormat = "JSON"
	AnnotationListParamsFormatCsv  AnnotationListParamsFormat = "CSV"
)

func (AnnotationListParamsFormat) IsKnown

func (r AnnotationListParamsFormat) IsKnown() bool

type AnnotationListResponse

type AnnotationListResponse struct {
	Annotations []AnnotationListResponseAnnotation `json:"annotations,required"`
	JSON        annotationListResponseJSON         `json:"-"`
}

func (*AnnotationListResponse) UnmarshalJSON

func (r *AnnotationListResponse) UnmarshalJSON(data []byte) (err error)

type AnnotationListResponseAnnotation

type AnnotationListResponseAnnotation struct {
	ID               string                                             `json:"id,required"`
	ASNs             []int64                                            `json:"asns,required"`
	ASNsDetails      []AnnotationListResponseAnnotationsASNsDetail      `json:"asnsDetails,required"`
	DataSource       string                                             `json:"dataSource,required"`
	EventType        string                                             `json:"eventType,required"`
	Locations        []string                                           `json:"locations,required"`
	LocationsDetails []AnnotationListResponseAnnotationsLocationsDetail `json:"locationsDetails,required"`
	Outage           AnnotationListResponseAnnotationsOutage            `json:"outage,required"`
	StartDate        string                                             `json:"startDate,required"`
	Description      string                                             `json:"description"`
	EndDate          string                                             `json:"endDate"`
	LinkedURL        string                                             `json:"linkedUrl"`
	Scope            string                                             `json:"scope"`
	JSON             annotationListResponseAnnotationJSON               `json:"-"`
}

func (*AnnotationListResponseAnnotation) UnmarshalJSON

func (r *AnnotationListResponseAnnotation) UnmarshalJSON(data []byte) (err error)

type AnnotationListResponseAnnotationsASNsDetail

type AnnotationListResponseAnnotationsASNsDetail struct {
	ASN       string                                                `json:"asn,required"`
	Name      string                                                `json:"name,required"`
	Locations AnnotationListResponseAnnotationsASNsDetailsLocations `json:"locations"`
	JSON      annotationListResponseAnnotationsASNsDetailJSON       `json:"-"`
}

func (*AnnotationListResponseAnnotationsASNsDetail) UnmarshalJSON

func (r *AnnotationListResponseAnnotationsASNsDetail) UnmarshalJSON(data []byte) (err error)

type AnnotationListResponseAnnotationsASNsDetailsLocations

type AnnotationListResponseAnnotationsASNsDetailsLocations struct {
	Code string                                                    `json:"code,required"`
	Name string                                                    `json:"name,required"`
	JSON annotationListResponseAnnotationsASNsDetailsLocationsJSON `json:"-"`
}

func (*AnnotationListResponseAnnotationsASNsDetailsLocations) UnmarshalJSON

func (r *AnnotationListResponseAnnotationsASNsDetailsLocations) UnmarshalJSON(data []byte) (err error)

type AnnotationListResponseAnnotationsLocationsDetail

type AnnotationListResponseAnnotationsLocationsDetail struct {
	Code string                                               `json:"code,required"`
	Name string                                               `json:"name,required"`
	JSON annotationListResponseAnnotationsLocationsDetailJSON `json:"-"`
}

func (*AnnotationListResponseAnnotationsLocationsDetail) UnmarshalJSON

func (r *AnnotationListResponseAnnotationsLocationsDetail) UnmarshalJSON(data []byte) (err error)

type AnnotationListResponseAnnotationsOutage

type AnnotationListResponseAnnotationsOutage struct {
	OutageCause string                                      `json:"outageCause,required"`
	OutageType  string                                      `json:"outageType,required"`
	JSON        annotationListResponseAnnotationsOutageJSON `json:"-"`
}

func (*AnnotationListResponseAnnotationsOutage) UnmarshalJSON

func (r *AnnotationListResponseAnnotationsOutage) UnmarshalJSON(data []byte) (err error)

type AnnotationListResponseEnvelope

type AnnotationListResponseEnvelope struct {
	Result  AnnotationListResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    annotationListResponseEnvelopeJSON `json:"-"`
}

func (*AnnotationListResponseEnvelope) UnmarshalJSON

func (r *AnnotationListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageGetParams

type AnnotationOutageGetParams struct {
	// Single ASN as integer.
	ASN param.Field[int64] `query:"asn"`
	// End of the date range (inclusive).
	DateEnd param.Field[time.Time] `query:"dateEnd" format:"date-time"`
	// Shorthand date ranges for the last X days - use when you don't need specific
	// start and end dates.
	DateRange param.Field[string] `query:"dateRange"`
	// Start of the date range (inclusive).
	DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AnnotationOutageGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Location Alpha2 code.
	Location param.Field[string] `query:"location"`
	// Number of objects to skip before grabbing results.
	Offset param.Field[int64] `query:"offset"`
}

func (AnnotationOutageGetParams) URLQuery

func (r AnnotationOutageGetParams) URLQuery() (v url.Values)

URLQuery serializes AnnotationOutageGetParams's query parameters as `url.Values`.

type AnnotationOutageGetParamsFormat

type AnnotationOutageGetParamsFormat string

Format results are returned in.

const (
	AnnotationOutageGetParamsFormatJson AnnotationOutageGetParamsFormat = "JSON"
	AnnotationOutageGetParamsFormatCsv  AnnotationOutageGetParamsFormat = "CSV"
)

func (AnnotationOutageGetParamsFormat) IsKnown

type AnnotationOutageGetResponse

type AnnotationOutageGetResponse struct {
	Annotations []AnnotationOutageGetResponseAnnotation `json:"annotations,required"`
	JSON        annotationOutageGetResponseJSON         `json:"-"`
}

func (*AnnotationOutageGetResponse) UnmarshalJSON

func (r *AnnotationOutageGetResponse) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageGetResponseAnnotation

type AnnotationOutageGetResponseAnnotation struct {
	ID               string                                                  `json:"id,required"`
	ASNs             []int64                                                 `json:"asns,required"`
	ASNsDetails      []AnnotationOutageGetResponseAnnotationsASNsDetail      `json:"asnsDetails,required"`
	DataSource       string                                                  `json:"dataSource,required"`
	EventType        string                                                  `json:"eventType,required"`
	Locations        []string                                                `json:"locations,required"`
	LocationsDetails []AnnotationOutageGetResponseAnnotationsLocationsDetail `json:"locationsDetails,required"`
	Outage           AnnotationOutageGetResponseAnnotationsOutage            `json:"outage,required"`
	StartDate        string                                                  `json:"startDate,required"`
	Description      string                                                  `json:"description"`
	EndDate          string                                                  `json:"endDate"`
	LinkedURL        string                                                  `json:"linkedUrl"`
	Scope            string                                                  `json:"scope"`
	JSON             annotationOutageGetResponseAnnotationJSON               `json:"-"`
}

func (*AnnotationOutageGetResponseAnnotation) UnmarshalJSON

func (r *AnnotationOutageGetResponseAnnotation) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageGetResponseAnnotationsASNsDetail

type AnnotationOutageGetResponseAnnotationsASNsDetail struct {
	ASN       string                                                     `json:"asn,required"`
	Name      string                                                     `json:"name,required"`
	Locations AnnotationOutageGetResponseAnnotationsASNsDetailsLocations `json:"locations"`
	JSON      annotationOutageGetResponseAnnotationsASNsDetailJSON       `json:"-"`
}

func (*AnnotationOutageGetResponseAnnotationsASNsDetail) UnmarshalJSON

func (r *AnnotationOutageGetResponseAnnotationsASNsDetail) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageGetResponseAnnotationsASNsDetailsLocations

type AnnotationOutageGetResponseAnnotationsASNsDetailsLocations struct {
	Code string                                                         `json:"code,required"`
	Name string                                                         `json:"name,required"`
	JSON annotationOutageGetResponseAnnotationsASNsDetailsLocationsJSON `json:"-"`
}

func (*AnnotationOutageGetResponseAnnotationsASNsDetailsLocations) UnmarshalJSON

type AnnotationOutageGetResponseAnnotationsLocationsDetail

type AnnotationOutageGetResponseAnnotationsLocationsDetail struct {
	Code string                                                    `json:"code,required"`
	Name string                                                    `json:"name,required"`
	JSON annotationOutageGetResponseAnnotationsLocationsDetailJSON `json:"-"`
}

func (*AnnotationOutageGetResponseAnnotationsLocationsDetail) UnmarshalJSON

func (r *AnnotationOutageGetResponseAnnotationsLocationsDetail) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageGetResponseAnnotationsOutage

type AnnotationOutageGetResponseAnnotationsOutage struct {
	OutageCause string                                           `json:"outageCause,required"`
	OutageType  string                                           `json:"outageType,required"`
	JSON        annotationOutageGetResponseAnnotationsOutageJSON `json:"-"`
}

func (*AnnotationOutageGetResponseAnnotationsOutage) UnmarshalJSON

func (r *AnnotationOutageGetResponseAnnotationsOutage) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageGetResponseEnvelope

type AnnotationOutageGetResponseEnvelope struct {
	Result  AnnotationOutageGetResponse             `json:"result,required"`
	Success bool                                    `json:"success,required"`
	JSON    annotationOutageGetResponseEnvelopeJSON `json:"-"`
}

func (*AnnotationOutageGetResponseEnvelope) UnmarshalJSON

func (r *AnnotationOutageGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageLocationsParams

type AnnotationOutageLocationsParams struct {
	// End of the date range (inclusive).
	DateEnd param.Field[time.Time] `query:"dateEnd" format:"date-time"`
	// Shorthand date ranges for the last X days - use when you don't need specific
	// start and end dates.
	DateRange param.Field[string] `query:"dateRange"`
	// Start of the date range (inclusive).
	DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AnnotationOutageLocationsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
}

func (AnnotationOutageLocationsParams) URLQuery

func (r AnnotationOutageLocationsParams) URLQuery() (v url.Values)

URLQuery serializes AnnotationOutageLocationsParams's query parameters as `url.Values`.

type AnnotationOutageLocationsParamsFormat

type AnnotationOutageLocationsParamsFormat string

Format results are returned in.

const (
	AnnotationOutageLocationsParamsFormatJson AnnotationOutageLocationsParamsFormat = "JSON"
	AnnotationOutageLocationsParamsFormatCsv  AnnotationOutageLocationsParamsFormat = "CSV"
)

func (AnnotationOutageLocationsParamsFormat) IsKnown

type AnnotationOutageLocationsResponse

type AnnotationOutageLocationsResponse struct {
	Annotations []AnnotationOutageLocationsResponseAnnotation `json:"annotations,required"`
	JSON        annotationOutageLocationsResponseJSON         `json:"-"`
}

func (*AnnotationOutageLocationsResponse) UnmarshalJSON

func (r *AnnotationOutageLocationsResponse) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageLocationsResponseAnnotation

type AnnotationOutageLocationsResponseAnnotation struct {
	ClientCountryAlpha2 string                                          `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                          `json:"clientCountryName,required"`
	Value               string                                          `json:"value,required"`
	JSON                annotationOutageLocationsResponseAnnotationJSON `json:"-"`
}

func (*AnnotationOutageLocationsResponseAnnotation) UnmarshalJSON

func (r *AnnotationOutageLocationsResponseAnnotation) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageLocationsResponseEnvelope

type AnnotationOutageLocationsResponseEnvelope struct {
	Result  AnnotationOutageLocationsResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    annotationOutageLocationsResponseEnvelopeJSON `json:"-"`
}

func (*AnnotationOutageLocationsResponseEnvelope) UnmarshalJSON

func (r *AnnotationOutageLocationsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AnnotationOutageService

type AnnotationOutageService struct {
	Options []option.RequestOption
}

AnnotationOutageService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAnnotationOutageService method instead.

func NewAnnotationOutageService

func NewAnnotationOutageService(opts ...option.RequestOption) (r *AnnotationOutageService)

NewAnnotationOutageService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AnnotationOutageService) Get

Get latest Internet outages and anomalies.

func (*AnnotationOutageService) Locations

Get the number of outages by location.

type AnnotationService

type AnnotationService struct {
	Options []option.RequestOption
	Outages *AnnotationOutageService
}

AnnotationService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAnnotationService method instead.

func NewAnnotationService

func NewAnnotationService(opts ...option.RequestOption) (r *AnnotationService)

NewAnnotationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AnnotationService) List

Get the latest annotations.

type AttackLayer3Service

type AttackLayer3Service struct {
	Options          []option.RequestOption
	Summary          *AttackLayer3SummaryService
	TimeseriesGroups *AttackLayer3TimeseriesGroupService
	Top              *AttackLayer3TopService
}

AttackLayer3Service contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer3Service method instead.

func NewAttackLayer3Service

func NewAttackLayer3Service(opts ...option.RequestOption) (r *AttackLayer3Service)

NewAttackLayer3Service generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer3Service) Timeseries

Get attacks change over time by bytes.

type AttackLayer3SummaryBitrateParams

type AttackLayer3SummaryBitrateParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3SummaryBitrateParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3SummaryBitrateParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3SummaryBitrateParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3SummaryBitrateParamsProtocol] `query:"protocol"`
}

func (AttackLayer3SummaryBitrateParams) URLQuery

func (r AttackLayer3SummaryBitrateParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3SummaryBitrateParams's query parameters as `url.Values`.

type AttackLayer3SummaryBitrateParamsDirection

type AttackLayer3SummaryBitrateParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3SummaryBitrateParamsDirectionOrigin AttackLayer3SummaryBitrateParamsDirection = "ORIGIN"
	AttackLayer3SummaryBitrateParamsDirectionTarget AttackLayer3SummaryBitrateParamsDirection = "TARGET"
)

func (AttackLayer3SummaryBitrateParamsDirection) IsKnown

type AttackLayer3SummaryBitrateParamsFormat

type AttackLayer3SummaryBitrateParamsFormat string

Format results are returned in.

const (
	AttackLayer3SummaryBitrateParamsFormatJson AttackLayer3SummaryBitrateParamsFormat = "JSON"
	AttackLayer3SummaryBitrateParamsFormatCsv  AttackLayer3SummaryBitrateParamsFormat = "CSV"
)

func (AttackLayer3SummaryBitrateParamsFormat) IsKnown

type AttackLayer3SummaryBitrateParamsIPVersion

type AttackLayer3SummaryBitrateParamsIPVersion string
const (
	AttackLayer3SummaryBitrateParamsIPVersionIPv4 AttackLayer3SummaryBitrateParamsIPVersion = "IPv4"
	AttackLayer3SummaryBitrateParamsIPVersionIPv6 AttackLayer3SummaryBitrateParamsIPVersion = "IPv6"
)

func (AttackLayer3SummaryBitrateParamsIPVersion) IsKnown

type AttackLayer3SummaryBitrateParamsProtocol

type AttackLayer3SummaryBitrateParamsProtocol string
const (
	AttackLayer3SummaryBitrateParamsProtocolUdp  AttackLayer3SummaryBitrateParamsProtocol = "UDP"
	AttackLayer3SummaryBitrateParamsProtocolTCP  AttackLayer3SummaryBitrateParamsProtocol = "TCP"
	AttackLayer3SummaryBitrateParamsProtocolIcmp AttackLayer3SummaryBitrateParamsProtocol = "ICMP"
	AttackLayer3SummaryBitrateParamsProtocolGRE  AttackLayer3SummaryBitrateParamsProtocol = "GRE"
)

func (AttackLayer3SummaryBitrateParamsProtocol) IsKnown

type AttackLayer3SummaryBitrateResponse

type AttackLayer3SummaryBitrateResponse struct {
	Meta     AttackLayer3SummaryBitrateResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer3SummaryBitrateResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer3SummaryBitrateResponseJSON     `json:"-"`
}

func (*AttackLayer3SummaryBitrateResponse) UnmarshalJSON

func (r *AttackLayer3SummaryBitrateResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryBitrateResponseEnvelope

type AttackLayer3SummaryBitrateResponseEnvelope struct {
	Result  AttackLayer3SummaryBitrateResponse             `json:"result,required"`
	Success bool                                           `json:"success,required"`
	JSON    attackLayer3SummaryBitrateResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3SummaryBitrateResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3SummaryBitrateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryBitrateResponseMeta

type AttackLayer3SummaryBitrateResponseMeta struct {
	DateRange      []AttackLayer3SummaryBitrateResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                               `json:"lastUpdated,required"`
	Normalization  string                                               `json:"normalization,required"`
	ConfidenceInfo AttackLayer3SummaryBitrateResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3SummaryBitrateResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3SummaryBitrateResponseMeta) UnmarshalJSON

func (r *AttackLayer3SummaryBitrateResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryBitrateResponseMetaConfidenceInfo

type AttackLayer3SummaryBitrateResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                            `json:"level"`
	JSON        attackLayer3SummaryBitrateResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3SummaryBitrateResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3SummaryBitrateResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation

type AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                             `json:"dataSource,required"`
	Description     string                                                             `json:"description,required"`
	EventType       string                                                             `json:"eventType,required"`
	IsInstantaneous bool                                                               `json:"isInstantaneous,required"`
	EndTime         time.Time                                                          `json:"endTime" format:"date-time"`
	LinkedURL       string                                                             `json:"linkedUrl"`
	StartTime       time.Time                                                          `json:"startTime" format:"date-time"`
	JSON            attackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3SummaryBitrateResponseMetaDateRange

type AttackLayer3SummaryBitrateResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                           `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3SummaryBitrateResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3SummaryBitrateResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3SummaryBitrateResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryBitrateResponseSummary0

type AttackLayer3SummaryBitrateResponseSummary0 struct {
	OneGBPSToTenGBPS         string                                         `json:"_1_GBPS_TO_10_GBPS,required"`
	TenGBPSToOneHundredGBPS  string                                         `json:"_10_GBPS_TO_100_GBPS,required"`
	FiveHundredMBPSToOneGBPS string                                         `json:"_500_MBPS_TO_1_GBPS,required"`
	Over100GBPS              string                                         `json:"OVER_100_GBPS,required"`
	Under500MBPS             string                                         `json:"UNDER_500_MBPS,required"`
	JSON                     attackLayer3SummaryBitrateResponseSummary0JSON `json:"-"`
}

func (*AttackLayer3SummaryBitrateResponseSummary0) UnmarshalJSON

func (r *AttackLayer3SummaryBitrateResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryDurationParams

type AttackLayer3SummaryDurationParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3SummaryDurationParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3SummaryDurationParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3SummaryDurationParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3SummaryDurationParamsProtocol] `query:"protocol"`
}

func (AttackLayer3SummaryDurationParams) URLQuery

func (r AttackLayer3SummaryDurationParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3SummaryDurationParams's query parameters as `url.Values`.

type AttackLayer3SummaryDurationParamsDirection

type AttackLayer3SummaryDurationParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3SummaryDurationParamsDirectionOrigin AttackLayer3SummaryDurationParamsDirection = "ORIGIN"
	AttackLayer3SummaryDurationParamsDirectionTarget AttackLayer3SummaryDurationParamsDirection = "TARGET"
)

func (AttackLayer3SummaryDurationParamsDirection) IsKnown

type AttackLayer3SummaryDurationParamsFormat

type AttackLayer3SummaryDurationParamsFormat string

Format results are returned in.

const (
	AttackLayer3SummaryDurationParamsFormatJson AttackLayer3SummaryDurationParamsFormat = "JSON"
	AttackLayer3SummaryDurationParamsFormatCsv  AttackLayer3SummaryDurationParamsFormat = "CSV"
)

func (AttackLayer3SummaryDurationParamsFormat) IsKnown

type AttackLayer3SummaryDurationParamsIPVersion

type AttackLayer3SummaryDurationParamsIPVersion string
const (
	AttackLayer3SummaryDurationParamsIPVersionIPv4 AttackLayer3SummaryDurationParamsIPVersion = "IPv4"
	AttackLayer3SummaryDurationParamsIPVersionIPv6 AttackLayer3SummaryDurationParamsIPVersion = "IPv6"
)

func (AttackLayer3SummaryDurationParamsIPVersion) IsKnown

type AttackLayer3SummaryDurationParamsProtocol

type AttackLayer3SummaryDurationParamsProtocol string
const (
	AttackLayer3SummaryDurationParamsProtocolUdp  AttackLayer3SummaryDurationParamsProtocol = "UDP"
	AttackLayer3SummaryDurationParamsProtocolTCP  AttackLayer3SummaryDurationParamsProtocol = "TCP"
	AttackLayer3SummaryDurationParamsProtocolIcmp AttackLayer3SummaryDurationParamsProtocol = "ICMP"
	AttackLayer3SummaryDurationParamsProtocolGRE  AttackLayer3SummaryDurationParamsProtocol = "GRE"
)

func (AttackLayer3SummaryDurationParamsProtocol) IsKnown

type AttackLayer3SummaryDurationResponse

type AttackLayer3SummaryDurationResponse struct {
	Meta     AttackLayer3SummaryDurationResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer3SummaryDurationResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer3SummaryDurationResponseJSON     `json:"-"`
}

func (*AttackLayer3SummaryDurationResponse) UnmarshalJSON

func (r *AttackLayer3SummaryDurationResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryDurationResponseEnvelope

type AttackLayer3SummaryDurationResponseEnvelope struct {
	Result  AttackLayer3SummaryDurationResponse             `json:"result,required"`
	Success bool                                            `json:"success,required"`
	JSON    attackLayer3SummaryDurationResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3SummaryDurationResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3SummaryDurationResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryDurationResponseMeta

type AttackLayer3SummaryDurationResponseMeta struct {
	DateRange      []AttackLayer3SummaryDurationResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                `json:"lastUpdated,required"`
	Normalization  string                                                `json:"normalization,required"`
	ConfidenceInfo AttackLayer3SummaryDurationResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3SummaryDurationResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3SummaryDurationResponseMeta) UnmarshalJSON

func (r *AttackLayer3SummaryDurationResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryDurationResponseMetaConfidenceInfo

type AttackLayer3SummaryDurationResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                             `json:"level"`
	JSON        attackLayer3SummaryDurationResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3SummaryDurationResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3SummaryDurationResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation

type AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                              `json:"dataSource,required"`
	Description     string                                                              `json:"description,required"`
	EventType       string                                                              `json:"eventType,required"`
	IsInstantaneous bool                                                                `json:"isInstantaneous,required"`
	EndTime         time.Time                                                           `json:"endTime" format:"date-time"`
	LinkedURL       string                                                              `json:"linkedUrl"`
	StartTime       time.Time                                                           `json:"startTime" format:"date-time"`
	JSON            attackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3SummaryDurationResponseMetaDateRange

type AttackLayer3SummaryDurationResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                            `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3SummaryDurationResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3SummaryDurationResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3SummaryDurationResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryDurationResponseSummary0

type AttackLayer3SummaryDurationResponseSummary0 struct {
	OneHourToThreeHours     string                                          `json:"_1_HOUR_TO_3_HOURS,required"`
	TenMinsToTwentyMinds    string                                          `json:"_10_MINS_TO_20_MINS,required"`
	TwentyMindsToFortyMinds string                                          `json:"_20_MINS_TO_40_MINS,required"`
	FortyMinsToOneHour      string                                          `json:"_40_MINS_TO_1_HOUR,required"`
	Over3Hours              string                                          `json:"OVER_3_HOURS,required"`
	Under10Mins             string                                          `json:"UNDER_10_MINS,required"`
	JSON                    attackLayer3SummaryDurationResponseSummary0JSON `json:"-"`
}

func (*AttackLayer3SummaryDurationResponseSummary0) UnmarshalJSON

func (r *AttackLayer3SummaryDurationResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryGetParams

type AttackLayer3SummaryGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer3SummaryGetParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer3SummaryGetParams) URLQuery

func (r AttackLayer3SummaryGetParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3SummaryGetParams's query parameters as `url.Values`.

type AttackLayer3SummaryGetParamsFormat

type AttackLayer3SummaryGetParamsFormat string

Format results are returned in.

const (
	AttackLayer3SummaryGetParamsFormatJson AttackLayer3SummaryGetParamsFormat = "JSON"
	AttackLayer3SummaryGetParamsFormatCsv  AttackLayer3SummaryGetParamsFormat = "CSV"
)

func (AttackLayer3SummaryGetParamsFormat) IsKnown

type AttackLayer3SummaryGetResponse

type AttackLayer3SummaryGetResponse struct {
	Meta     AttackLayer3SummaryGetResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer3SummaryGetResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer3SummaryGetResponseJSON     `json:"-"`
}

func (*AttackLayer3SummaryGetResponse) UnmarshalJSON

func (r *AttackLayer3SummaryGetResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryGetResponseEnvelope

type AttackLayer3SummaryGetResponseEnvelope struct {
	Result  AttackLayer3SummaryGetResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    attackLayer3SummaryGetResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3SummaryGetResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3SummaryGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryGetResponseMeta

type AttackLayer3SummaryGetResponseMeta struct {
	DateRange      []AttackLayer3SummaryGetResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo AttackLayer3SummaryGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3SummaryGetResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3SummaryGetResponseMeta) UnmarshalJSON

func (r *AttackLayer3SummaryGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryGetResponseMetaConfidenceInfo

type AttackLayer3SummaryGetResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3SummaryGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        attackLayer3SummaryGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3SummaryGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3SummaryGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryGetResponseMetaConfidenceInfoAnnotation

type AttackLayer3SummaryGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            attackLayer3SummaryGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3SummaryGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3SummaryGetResponseMetaDateRange

type AttackLayer3SummaryGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3SummaryGetResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3SummaryGetResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3SummaryGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryGetResponseSummary0

type AttackLayer3SummaryGetResponseSummary0 struct {
	GRE  string                                     `json:"gre,required"`
	Icmp string                                     `json:"icmp,required"`
	TCP  string                                     `json:"tcp,required"`
	Udp  string                                     `json:"udp,required"`
	JSON attackLayer3SummaryGetResponseSummary0JSON `json:"-"`
}

func (*AttackLayer3SummaryGetResponseSummary0) UnmarshalJSON

func (r *AttackLayer3SummaryGetResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryIPVersionParams

type AttackLayer3SummaryIPVersionParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3SummaryIPVersionParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3SummaryIPVersionParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3SummaryIPVersionParamsProtocol] `query:"protocol"`
}

func (AttackLayer3SummaryIPVersionParams) URLQuery

URLQuery serializes AttackLayer3SummaryIPVersionParams's query parameters as `url.Values`.

type AttackLayer3SummaryIPVersionParamsDirection

type AttackLayer3SummaryIPVersionParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3SummaryIPVersionParamsDirectionOrigin AttackLayer3SummaryIPVersionParamsDirection = "ORIGIN"
	AttackLayer3SummaryIPVersionParamsDirectionTarget AttackLayer3SummaryIPVersionParamsDirection = "TARGET"
)

func (AttackLayer3SummaryIPVersionParamsDirection) IsKnown

type AttackLayer3SummaryIPVersionParamsFormat

type AttackLayer3SummaryIPVersionParamsFormat string

Format results are returned in.

const (
	AttackLayer3SummaryIPVersionParamsFormatJson AttackLayer3SummaryIPVersionParamsFormat = "JSON"
	AttackLayer3SummaryIPVersionParamsFormatCsv  AttackLayer3SummaryIPVersionParamsFormat = "CSV"
)

func (AttackLayer3SummaryIPVersionParamsFormat) IsKnown

type AttackLayer3SummaryIPVersionParamsProtocol

type AttackLayer3SummaryIPVersionParamsProtocol string
const (
	AttackLayer3SummaryIPVersionParamsProtocolUdp  AttackLayer3SummaryIPVersionParamsProtocol = "UDP"
	AttackLayer3SummaryIPVersionParamsProtocolTCP  AttackLayer3SummaryIPVersionParamsProtocol = "TCP"
	AttackLayer3SummaryIPVersionParamsProtocolIcmp AttackLayer3SummaryIPVersionParamsProtocol = "ICMP"
	AttackLayer3SummaryIPVersionParamsProtocolGRE  AttackLayer3SummaryIPVersionParamsProtocol = "GRE"
)

func (AttackLayer3SummaryIPVersionParamsProtocol) IsKnown

type AttackLayer3SummaryIPVersionResponse

type AttackLayer3SummaryIPVersionResponse struct {
	Meta     AttackLayer3SummaryIPVersionResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer3SummaryIPVersionResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer3SummaryIPVersionResponseJSON     `json:"-"`
}

func (*AttackLayer3SummaryIPVersionResponse) UnmarshalJSON

func (r *AttackLayer3SummaryIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryIPVersionResponseEnvelope

type AttackLayer3SummaryIPVersionResponseEnvelope struct {
	Result  AttackLayer3SummaryIPVersionResponse             `json:"result,required"`
	Success bool                                             `json:"success,required"`
	JSON    attackLayer3SummaryIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3SummaryIPVersionResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3SummaryIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryIPVersionResponseMeta

type AttackLayer3SummaryIPVersionResponseMeta struct {
	DateRange      []AttackLayer3SummaryIPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                 `json:"lastUpdated,required"`
	Normalization  string                                                 `json:"normalization,required"`
	ConfidenceInfo AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3SummaryIPVersionResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3SummaryIPVersionResponseMeta) UnmarshalJSON

func (r *AttackLayer3SummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo

type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                              `json:"level"`
	JSON        attackLayer3SummaryIPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation

type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                               `json:"dataSource,required"`
	Description     string                                                               `json:"description,required"`
	EventType       string                                                               `json:"eventType,required"`
	IsInstantaneous bool                                                                 `json:"isInstantaneous,required"`
	EndTime         time.Time                                                            `json:"endTime" format:"date-time"`
	LinkedURL       string                                                               `json:"linkedUrl"`
	StartTime       time.Time                                                            `json:"startTime" format:"date-time"`
	JSON            attackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3SummaryIPVersionResponseMetaDateRange

type AttackLayer3SummaryIPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                             `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3SummaryIPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3SummaryIPVersionResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3SummaryIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryIPVersionResponseSummary0

type AttackLayer3SummaryIPVersionResponseSummary0 struct {
	IPv4 string                                           `json:"IPv4,required"`
	IPv6 string                                           `json:"IPv6,required"`
	JSON attackLayer3SummaryIPVersionResponseSummary0JSON `json:"-"`
}

func (*AttackLayer3SummaryIPVersionResponseSummary0) UnmarshalJSON

func (r *AttackLayer3SummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryProtocolParams

type AttackLayer3SummaryProtocolParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3SummaryProtocolParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3SummaryProtocolParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3SummaryProtocolParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer3SummaryProtocolParams) URLQuery

func (r AttackLayer3SummaryProtocolParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3SummaryProtocolParams's query parameters as `url.Values`.

type AttackLayer3SummaryProtocolParamsDirection

type AttackLayer3SummaryProtocolParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3SummaryProtocolParamsDirectionOrigin AttackLayer3SummaryProtocolParamsDirection = "ORIGIN"
	AttackLayer3SummaryProtocolParamsDirectionTarget AttackLayer3SummaryProtocolParamsDirection = "TARGET"
)

func (AttackLayer3SummaryProtocolParamsDirection) IsKnown

type AttackLayer3SummaryProtocolParamsFormat

type AttackLayer3SummaryProtocolParamsFormat string

Format results are returned in.

const (
	AttackLayer3SummaryProtocolParamsFormatJson AttackLayer3SummaryProtocolParamsFormat = "JSON"
	AttackLayer3SummaryProtocolParamsFormatCsv  AttackLayer3SummaryProtocolParamsFormat = "CSV"
)

func (AttackLayer3SummaryProtocolParamsFormat) IsKnown

type AttackLayer3SummaryProtocolParamsIPVersion

type AttackLayer3SummaryProtocolParamsIPVersion string
const (
	AttackLayer3SummaryProtocolParamsIPVersionIPv4 AttackLayer3SummaryProtocolParamsIPVersion = "IPv4"
	AttackLayer3SummaryProtocolParamsIPVersionIPv6 AttackLayer3SummaryProtocolParamsIPVersion = "IPv6"
)

func (AttackLayer3SummaryProtocolParamsIPVersion) IsKnown

type AttackLayer3SummaryProtocolResponse

type AttackLayer3SummaryProtocolResponse struct {
	Meta     AttackLayer3SummaryProtocolResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer3SummaryProtocolResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer3SummaryProtocolResponseJSON     `json:"-"`
}

func (*AttackLayer3SummaryProtocolResponse) UnmarshalJSON

func (r *AttackLayer3SummaryProtocolResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryProtocolResponseEnvelope

type AttackLayer3SummaryProtocolResponseEnvelope struct {
	Result  AttackLayer3SummaryProtocolResponse             `json:"result,required"`
	Success bool                                            `json:"success,required"`
	JSON    attackLayer3SummaryProtocolResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3SummaryProtocolResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3SummaryProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryProtocolResponseMeta

type AttackLayer3SummaryProtocolResponseMeta struct {
	DateRange      []AttackLayer3SummaryProtocolResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                `json:"lastUpdated,required"`
	Normalization  string                                                `json:"normalization,required"`
	ConfidenceInfo AttackLayer3SummaryProtocolResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3SummaryProtocolResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3SummaryProtocolResponseMeta) UnmarshalJSON

func (r *AttackLayer3SummaryProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryProtocolResponseMetaConfidenceInfo

type AttackLayer3SummaryProtocolResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                             `json:"level"`
	JSON        attackLayer3SummaryProtocolResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3SummaryProtocolResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3SummaryProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation

type AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                              `json:"dataSource,required"`
	Description     string                                                              `json:"description,required"`
	EventType       string                                                              `json:"eventType,required"`
	IsInstantaneous bool                                                                `json:"isInstantaneous,required"`
	EndTime         time.Time                                                           `json:"endTime" format:"date-time"`
	LinkedURL       string                                                              `json:"linkedUrl"`
	StartTime       time.Time                                                           `json:"startTime" format:"date-time"`
	JSON            attackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3SummaryProtocolResponseMetaDateRange

type AttackLayer3SummaryProtocolResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                            `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3SummaryProtocolResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3SummaryProtocolResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3SummaryProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryProtocolResponseSummary0

type AttackLayer3SummaryProtocolResponseSummary0 struct {
	GRE  string                                          `json:"GRE,required"`
	Icmp string                                          `json:"ICMP,required"`
	TCP  string                                          `json:"TCP,required"`
	Udp  string                                          `json:"UDP,required"`
	JSON attackLayer3SummaryProtocolResponseSummary0JSON `json:"-"`
}

func (*AttackLayer3SummaryProtocolResponseSummary0) UnmarshalJSON

func (r *AttackLayer3SummaryProtocolResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryService

type AttackLayer3SummaryService struct {
	Options []option.RequestOption
}

AttackLayer3SummaryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer3SummaryService method instead.

func NewAttackLayer3SummaryService

func NewAttackLayer3SummaryService(opts ...option.RequestOption) (r *AttackLayer3SummaryService)

NewAttackLayer3SummaryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer3SummaryService) Bitrate

Percentage distribution of attacks by bitrate.

func (*AttackLayer3SummaryService) Duration

Percentage distribution of attacks by duration.

func (*AttackLayer3SummaryService) Get

Percentage distribution of network protocols in Layer 3/4 attacks over a given time period.

func (*AttackLayer3SummaryService) IPVersion

Percentage distribution of attacks by ip version used.

func (*AttackLayer3SummaryService) Protocol

Percentage distribution of attacks by protocol used.

func (*AttackLayer3SummaryService) Vector

Percentage distribution of attacks by vector.

type AttackLayer3SummaryVectorParams

type AttackLayer3SummaryVectorParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3SummaryVectorParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3SummaryVectorParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3SummaryVectorParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3SummaryVectorParamsProtocol] `query:"protocol"`
}

func (AttackLayer3SummaryVectorParams) URLQuery

func (r AttackLayer3SummaryVectorParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3SummaryVectorParams's query parameters as `url.Values`.

type AttackLayer3SummaryVectorParamsDirection

type AttackLayer3SummaryVectorParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3SummaryVectorParamsDirectionOrigin AttackLayer3SummaryVectorParamsDirection = "ORIGIN"
	AttackLayer3SummaryVectorParamsDirectionTarget AttackLayer3SummaryVectorParamsDirection = "TARGET"
)

func (AttackLayer3SummaryVectorParamsDirection) IsKnown

type AttackLayer3SummaryVectorParamsFormat

type AttackLayer3SummaryVectorParamsFormat string

Format results are returned in.

const (
	AttackLayer3SummaryVectorParamsFormatJson AttackLayer3SummaryVectorParamsFormat = "JSON"
	AttackLayer3SummaryVectorParamsFormatCsv  AttackLayer3SummaryVectorParamsFormat = "CSV"
)

func (AttackLayer3SummaryVectorParamsFormat) IsKnown

type AttackLayer3SummaryVectorParamsIPVersion

type AttackLayer3SummaryVectorParamsIPVersion string
const (
	AttackLayer3SummaryVectorParamsIPVersionIPv4 AttackLayer3SummaryVectorParamsIPVersion = "IPv4"
	AttackLayer3SummaryVectorParamsIPVersionIPv6 AttackLayer3SummaryVectorParamsIPVersion = "IPv6"
)

func (AttackLayer3SummaryVectorParamsIPVersion) IsKnown

type AttackLayer3SummaryVectorParamsProtocol

type AttackLayer3SummaryVectorParamsProtocol string
const (
	AttackLayer3SummaryVectorParamsProtocolUdp  AttackLayer3SummaryVectorParamsProtocol = "UDP"
	AttackLayer3SummaryVectorParamsProtocolTCP  AttackLayer3SummaryVectorParamsProtocol = "TCP"
	AttackLayer3SummaryVectorParamsProtocolIcmp AttackLayer3SummaryVectorParamsProtocol = "ICMP"
	AttackLayer3SummaryVectorParamsProtocolGRE  AttackLayer3SummaryVectorParamsProtocol = "GRE"
)

func (AttackLayer3SummaryVectorParamsProtocol) IsKnown

type AttackLayer3SummaryVectorResponse

type AttackLayer3SummaryVectorResponse struct {
	Meta     AttackLayer3SummaryVectorResponseMeta `json:"meta,required"`
	Summary0 map[string][]string                   `json:"summary_0,required"`
	JSON     attackLayer3SummaryVectorResponseJSON `json:"-"`
}

func (*AttackLayer3SummaryVectorResponse) UnmarshalJSON

func (r *AttackLayer3SummaryVectorResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryVectorResponseEnvelope

type AttackLayer3SummaryVectorResponseEnvelope struct {
	Result  AttackLayer3SummaryVectorResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    attackLayer3SummaryVectorResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3SummaryVectorResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3SummaryVectorResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryVectorResponseMeta

type AttackLayer3SummaryVectorResponseMeta struct {
	DateRange      []AttackLayer3SummaryVectorResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                              `json:"lastUpdated,required"`
	Normalization  string                                              `json:"normalization,required"`
	ConfidenceInfo AttackLayer3SummaryVectorResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3SummaryVectorResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3SummaryVectorResponseMeta) UnmarshalJSON

func (r *AttackLayer3SummaryVectorResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryVectorResponseMetaConfidenceInfo

type AttackLayer3SummaryVectorResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                           `json:"level"`
	JSON        attackLayer3SummaryVectorResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3SummaryVectorResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3SummaryVectorResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation

type AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                            `json:"dataSource,required"`
	Description     string                                                            `json:"description,required"`
	EventType       string                                                            `json:"eventType,required"`
	IsInstantaneous bool                                                              `json:"isInstantaneous,required"`
	EndTime         time.Time                                                         `json:"endTime" format:"date-time"`
	LinkedURL       string                                                            `json:"linkedUrl"`
	StartTime       time.Time                                                         `json:"startTime" format:"date-time"`
	JSON            attackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3SummaryVectorResponseMetaDateRange

type AttackLayer3SummaryVectorResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                          `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3SummaryVectorResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3SummaryVectorResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3SummaryVectorResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupBitrateParams

type AttackLayer3TimeseriesGroupBitrateParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupBitrateParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesGroupBitrateParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupBitrateParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TimeseriesGroupBitrateParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesGroupBitrateParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TimeseriesGroupBitrateParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TimeseriesGroupBitrateParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupBitrateParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupBitrateParamsAggInterval

type AttackLayer3TimeseriesGroupBitrateParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupBitrateParamsAggInterval15m AttackLayer3TimeseriesGroupBitrateParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupBitrateParamsAggInterval1h  AttackLayer3TimeseriesGroupBitrateParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupBitrateParamsAggInterval1d  AttackLayer3TimeseriesGroupBitrateParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupBitrateParamsAggInterval1w  AttackLayer3TimeseriesGroupBitrateParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupBitrateParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupBitrateParamsDirection

type AttackLayer3TimeseriesGroupBitrateParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesGroupBitrateParamsDirectionOrigin AttackLayer3TimeseriesGroupBitrateParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesGroupBitrateParamsDirectionTarget AttackLayer3TimeseriesGroupBitrateParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesGroupBitrateParamsDirection) IsKnown

type AttackLayer3TimeseriesGroupBitrateParamsFormat

type AttackLayer3TimeseriesGroupBitrateParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupBitrateParamsFormatJson AttackLayer3TimeseriesGroupBitrateParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupBitrateParamsFormatCsv  AttackLayer3TimeseriesGroupBitrateParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupBitrateParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupBitrateParamsIPVersion

type AttackLayer3TimeseriesGroupBitrateParamsIPVersion string
const (
	AttackLayer3TimeseriesGroupBitrateParamsIPVersionIPv4 AttackLayer3TimeseriesGroupBitrateParamsIPVersion = "IPv4"
	AttackLayer3TimeseriesGroupBitrateParamsIPVersionIPv6 AttackLayer3TimeseriesGroupBitrateParamsIPVersion = "IPv6"
)

func (AttackLayer3TimeseriesGroupBitrateParamsIPVersion) IsKnown

type AttackLayer3TimeseriesGroupBitrateParamsNormalization

type AttackLayer3TimeseriesGroupBitrateParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesGroupBitrateParamsNormalizationPercentage AttackLayer3TimeseriesGroupBitrateParamsNormalization = "PERCENTAGE"
	AttackLayer3TimeseriesGroupBitrateParamsNormalizationMin0Max    AttackLayer3TimeseriesGroupBitrateParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesGroupBitrateParamsNormalization) IsKnown

type AttackLayer3TimeseriesGroupBitrateParamsProtocol

type AttackLayer3TimeseriesGroupBitrateParamsProtocol string
const (
	AttackLayer3TimeseriesGroupBitrateParamsProtocolUdp  AttackLayer3TimeseriesGroupBitrateParamsProtocol = "UDP"
	AttackLayer3TimeseriesGroupBitrateParamsProtocolTCP  AttackLayer3TimeseriesGroupBitrateParamsProtocol = "TCP"
	AttackLayer3TimeseriesGroupBitrateParamsProtocolIcmp AttackLayer3TimeseriesGroupBitrateParamsProtocol = "ICMP"
	AttackLayer3TimeseriesGroupBitrateParamsProtocolGRE  AttackLayer3TimeseriesGroupBitrateParamsProtocol = "GRE"
)

func (AttackLayer3TimeseriesGroupBitrateParamsProtocol) IsKnown

type AttackLayer3TimeseriesGroupBitrateResponse

type AttackLayer3TimeseriesGroupBitrateResponse struct {
	Meta   interface{}                                      `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupBitrateResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupBitrateResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupBitrateResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupBitrateResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupBitrateResponseEnvelope

type AttackLayer3TimeseriesGroupBitrateResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupBitrateResponse             `json:"result,required"`
	Success bool                                                   `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupBitrateResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupBitrateResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupBitrateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupBitrateResponseSerie0

type AttackLayer3TimeseriesGroupBitrateResponseSerie0 struct {
	OneGBPSToTenGBPS         []string                                             `json:"_1_GBPS_TO_10_GBPS,required"`
	TenGBPSToOneHundredGBPS  []string                                             `json:"_10_GBPS_TO_100_GBPS,required"`
	FiveHundredMBPSToOneGBPS []string                                             `json:"_500_MBPS_TO_1_GBPS,required"`
	Over100GBPS              []string                                             `json:"OVER_100_GBPS,required"`
	Timestamps               []string                                             `json:"timestamps,required"`
	Under500MBPS             []string                                             `json:"UNDER_500_MBPS,required"`
	JSON                     attackLayer3TimeseriesGroupBitrateResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupBitrateResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupBitrateResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupDurationParams

type AttackLayer3TimeseriesGroupDurationParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupDurationParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesGroupDurationParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupDurationParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TimeseriesGroupDurationParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesGroupDurationParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TimeseriesGroupDurationParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TimeseriesGroupDurationParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupDurationParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupDurationParamsAggInterval

type AttackLayer3TimeseriesGroupDurationParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupDurationParamsAggInterval15m AttackLayer3TimeseriesGroupDurationParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupDurationParamsAggInterval1h  AttackLayer3TimeseriesGroupDurationParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupDurationParamsAggInterval1d  AttackLayer3TimeseriesGroupDurationParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupDurationParamsAggInterval1w  AttackLayer3TimeseriesGroupDurationParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupDurationParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupDurationParamsDirection

type AttackLayer3TimeseriesGroupDurationParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesGroupDurationParamsDirectionOrigin AttackLayer3TimeseriesGroupDurationParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesGroupDurationParamsDirectionTarget AttackLayer3TimeseriesGroupDurationParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesGroupDurationParamsDirection) IsKnown

type AttackLayer3TimeseriesGroupDurationParamsFormat

type AttackLayer3TimeseriesGroupDurationParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupDurationParamsFormatJson AttackLayer3TimeseriesGroupDurationParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupDurationParamsFormatCsv  AttackLayer3TimeseriesGroupDurationParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupDurationParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupDurationParamsIPVersion

type AttackLayer3TimeseriesGroupDurationParamsIPVersion string
const (
	AttackLayer3TimeseriesGroupDurationParamsIPVersionIPv4 AttackLayer3TimeseriesGroupDurationParamsIPVersion = "IPv4"
	AttackLayer3TimeseriesGroupDurationParamsIPVersionIPv6 AttackLayer3TimeseriesGroupDurationParamsIPVersion = "IPv6"
)

func (AttackLayer3TimeseriesGroupDurationParamsIPVersion) IsKnown

type AttackLayer3TimeseriesGroupDurationParamsNormalization

type AttackLayer3TimeseriesGroupDurationParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesGroupDurationParamsNormalizationPercentage AttackLayer3TimeseriesGroupDurationParamsNormalization = "PERCENTAGE"
	AttackLayer3TimeseriesGroupDurationParamsNormalizationMin0Max    AttackLayer3TimeseriesGroupDurationParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesGroupDurationParamsNormalization) IsKnown

type AttackLayer3TimeseriesGroupDurationParamsProtocol

type AttackLayer3TimeseriesGroupDurationParamsProtocol string
const (
	AttackLayer3TimeseriesGroupDurationParamsProtocolUdp  AttackLayer3TimeseriesGroupDurationParamsProtocol = "UDP"
	AttackLayer3TimeseriesGroupDurationParamsProtocolTCP  AttackLayer3TimeseriesGroupDurationParamsProtocol = "TCP"
	AttackLayer3TimeseriesGroupDurationParamsProtocolIcmp AttackLayer3TimeseriesGroupDurationParamsProtocol = "ICMP"
	AttackLayer3TimeseriesGroupDurationParamsProtocolGRE  AttackLayer3TimeseriesGroupDurationParamsProtocol = "GRE"
)

func (AttackLayer3TimeseriesGroupDurationParamsProtocol) IsKnown

type AttackLayer3TimeseriesGroupDurationResponse

type AttackLayer3TimeseriesGroupDurationResponse struct {
	Meta   interface{}                                       `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupDurationResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupDurationResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupDurationResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupDurationResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupDurationResponseEnvelope

type AttackLayer3TimeseriesGroupDurationResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupDurationResponse             `json:"result,required"`
	Success bool                                                    `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupDurationResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupDurationResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupDurationResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupDurationResponseSerie0

type AttackLayer3TimeseriesGroupDurationResponseSerie0 struct {
	OneHourToThreeHours     []string                                              `json:"_1_HOUR_TO_3_HOURS,required"`
	TenMinsToTwentyMinds    []string                                              `json:"_10_MINS_TO_20_MINS,required"`
	TwentyMindsToFortyMinds []string                                              `json:"_20_MINS_TO_40_MINS,required"`
	FortyMinsToOneHour      []string                                              `json:"_40_MINS_TO_1_HOUR,required"`
	Over3Hours              []string                                              `json:"OVER_3_HOURS,required"`
	Timestamps              []string                                              `json:"timestamps,required"`
	Under10Mins             []string                                              `json:"UNDER_10_MINS,required"`
	JSON                    attackLayer3TimeseriesGroupDurationResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupDurationResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupDurationResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupGetParams

type AttackLayer3TimeseriesGroupGetParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupGetParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupGetParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer3TimeseriesGroupGetParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupGetParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupGetParamsAggInterval

type AttackLayer3TimeseriesGroupGetParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupGetParamsAggInterval15m AttackLayer3TimeseriesGroupGetParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupGetParamsAggInterval1h  AttackLayer3TimeseriesGroupGetParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupGetParamsAggInterval1d  AttackLayer3TimeseriesGroupGetParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupGetParamsAggInterval1w  AttackLayer3TimeseriesGroupGetParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupGetParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupGetParamsFormat

type AttackLayer3TimeseriesGroupGetParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupGetParamsFormatJson AttackLayer3TimeseriesGroupGetParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupGetParamsFormatCsv  AttackLayer3TimeseriesGroupGetParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupGetParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupGetResponse

type AttackLayer3TimeseriesGroupGetResponse struct {
	Meta   AttackLayer3TimeseriesGroupGetResponseMeta   `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupGetResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupGetResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupGetResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupGetResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupGetResponseEnvelope

type AttackLayer3TimeseriesGroupGetResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupGetResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupGetResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupGetResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupGetResponseMeta

type AttackLayer3TimeseriesGroupGetResponseMeta struct {
	AggInterval    string                                                   `json:"aggInterval,required"`
	DateRange      []AttackLayer3TimeseriesGroupGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                                                `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3TimeseriesGroupGetResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3TimeseriesGroupGetResponseMeta) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfo

type AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                `json:"level"`
	JSON        attackLayer3TimeseriesGroupGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation

type AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                 `json:"dataSource,required"`
	Description     string                                                                 `json:"description,required"`
	EventType       string                                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                 `json:"linkedUrl"`
	StartTime       time.Time                                                              `json:"startTime" format:"date-time"`
	JSON            attackLayer3TimeseriesGroupGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3TimeseriesGroupGetResponseMetaDateRange

type AttackLayer3TimeseriesGroupGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                               `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3TimeseriesGroupGetResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupGetResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupGetResponseSerie0

type AttackLayer3TimeseriesGroupGetResponseSerie0 struct {
	GRE        []string                                         `json:"gre,required"`
	Icmp       []string                                         `json:"icmp,required"`
	TCP        []string                                         `json:"tcp,required"`
	Timestamps []string                                         `json:"timestamps,required"`
	Udp        []string                                         `json:"udp,required"`
	JSON       attackLayer3TimeseriesGroupGetResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupGetResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupGetResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupIPVersionParams

type AttackLayer3TimeseriesGroupIPVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupIPVersionParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesGroupIPVersionParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupIPVersionParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesGroupIPVersionParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TimeseriesGroupIPVersionParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TimeseriesGroupIPVersionParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupIPVersionParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupIPVersionParamsAggInterval

type AttackLayer3TimeseriesGroupIPVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupIPVersionParamsAggInterval15m AttackLayer3TimeseriesGroupIPVersionParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupIPVersionParamsAggInterval1h  AttackLayer3TimeseriesGroupIPVersionParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupIPVersionParamsAggInterval1d  AttackLayer3TimeseriesGroupIPVersionParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupIPVersionParamsAggInterval1w  AttackLayer3TimeseriesGroupIPVersionParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupIPVersionParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupIPVersionParamsDirection

type AttackLayer3TimeseriesGroupIPVersionParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesGroupIPVersionParamsDirectionOrigin AttackLayer3TimeseriesGroupIPVersionParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesGroupIPVersionParamsDirectionTarget AttackLayer3TimeseriesGroupIPVersionParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesGroupIPVersionParamsDirection) IsKnown

type AttackLayer3TimeseriesGroupIPVersionParamsFormat

type AttackLayer3TimeseriesGroupIPVersionParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupIPVersionParamsFormatJson AttackLayer3TimeseriesGroupIPVersionParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupIPVersionParamsFormatCsv  AttackLayer3TimeseriesGroupIPVersionParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupIPVersionParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupIPVersionParamsNormalization

type AttackLayer3TimeseriesGroupIPVersionParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesGroupIPVersionParamsNormalizationPercentage AttackLayer3TimeseriesGroupIPVersionParamsNormalization = "PERCENTAGE"
	AttackLayer3TimeseriesGroupIPVersionParamsNormalizationMin0Max    AttackLayer3TimeseriesGroupIPVersionParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesGroupIPVersionParamsNormalization) IsKnown

type AttackLayer3TimeseriesGroupIPVersionParamsProtocol

type AttackLayer3TimeseriesGroupIPVersionParamsProtocol string
const (
	AttackLayer3TimeseriesGroupIPVersionParamsProtocolUdp  AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "UDP"
	AttackLayer3TimeseriesGroupIPVersionParamsProtocolTCP  AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "TCP"
	AttackLayer3TimeseriesGroupIPVersionParamsProtocolIcmp AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "ICMP"
	AttackLayer3TimeseriesGroupIPVersionParamsProtocolGRE  AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "GRE"
)

func (AttackLayer3TimeseriesGroupIPVersionParamsProtocol) IsKnown

type AttackLayer3TimeseriesGroupIPVersionResponse

type AttackLayer3TimeseriesGroupIPVersionResponse struct {
	Meta   interface{}                                        `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupIPVersionResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupIPVersionResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupIPVersionResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupIPVersionResponseEnvelope

type AttackLayer3TimeseriesGroupIPVersionResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupIPVersionResponse             `json:"result,required"`
	Success bool                                                     `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupIPVersionResponseSerie0

type AttackLayer3TimeseriesGroupIPVersionResponseSerie0 struct {
	IPv4       []string                                               `json:"IPv4,required"`
	IPv6       []string                                               `json:"IPv6,required"`
	Timestamps []string                                               `json:"timestamps,required"`
	JSON       attackLayer3TimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupIndustryParams

type AttackLayer3TimeseriesGroupIndustryParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupIndustryParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesGroupIndustryParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupIndustryParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TimeseriesGroupIndustryParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects (eg browsers, verticals, etc) to the top items over
	// the time range.
	LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesGroupIndustryParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TimeseriesGroupIndustryParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TimeseriesGroupIndustryParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupIndustryParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupIndustryParamsAggInterval

type AttackLayer3TimeseriesGroupIndustryParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupIndustryParamsAggInterval15m AttackLayer3TimeseriesGroupIndustryParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupIndustryParamsAggInterval1h  AttackLayer3TimeseriesGroupIndustryParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupIndustryParamsAggInterval1d  AttackLayer3TimeseriesGroupIndustryParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupIndustryParamsAggInterval1w  AttackLayer3TimeseriesGroupIndustryParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupIndustryParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupIndustryParamsDirection

type AttackLayer3TimeseriesGroupIndustryParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesGroupIndustryParamsDirectionOrigin AttackLayer3TimeseriesGroupIndustryParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesGroupIndustryParamsDirectionTarget AttackLayer3TimeseriesGroupIndustryParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesGroupIndustryParamsDirection) IsKnown

type AttackLayer3TimeseriesGroupIndustryParamsFormat

type AttackLayer3TimeseriesGroupIndustryParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupIndustryParamsFormatJson AttackLayer3TimeseriesGroupIndustryParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupIndustryParamsFormatCsv  AttackLayer3TimeseriesGroupIndustryParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupIndustryParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupIndustryParamsIPVersion

type AttackLayer3TimeseriesGroupIndustryParamsIPVersion string
const (
	AttackLayer3TimeseriesGroupIndustryParamsIPVersionIPv4 AttackLayer3TimeseriesGroupIndustryParamsIPVersion = "IPv4"
	AttackLayer3TimeseriesGroupIndustryParamsIPVersionIPv6 AttackLayer3TimeseriesGroupIndustryParamsIPVersion = "IPv6"
)

func (AttackLayer3TimeseriesGroupIndustryParamsIPVersion) IsKnown

type AttackLayer3TimeseriesGroupIndustryParamsNormalization

type AttackLayer3TimeseriesGroupIndustryParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesGroupIndustryParamsNormalizationPercentage AttackLayer3TimeseriesGroupIndustryParamsNormalization = "PERCENTAGE"
	AttackLayer3TimeseriesGroupIndustryParamsNormalizationMin0Max    AttackLayer3TimeseriesGroupIndustryParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesGroupIndustryParamsNormalization) IsKnown

type AttackLayer3TimeseriesGroupIndustryParamsProtocol

type AttackLayer3TimeseriesGroupIndustryParamsProtocol string
const (
	AttackLayer3TimeseriesGroupIndustryParamsProtocolUdp  AttackLayer3TimeseriesGroupIndustryParamsProtocol = "UDP"
	AttackLayer3TimeseriesGroupIndustryParamsProtocolTCP  AttackLayer3TimeseriesGroupIndustryParamsProtocol = "TCP"
	AttackLayer3TimeseriesGroupIndustryParamsProtocolIcmp AttackLayer3TimeseriesGroupIndustryParamsProtocol = "ICMP"
	AttackLayer3TimeseriesGroupIndustryParamsProtocolGRE  AttackLayer3TimeseriesGroupIndustryParamsProtocol = "GRE"
)

func (AttackLayer3TimeseriesGroupIndustryParamsProtocol) IsKnown

type AttackLayer3TimeseriesGroupIndustryResponse

type AttackLayer3TimeseriesGroupIndustryResponse struct {
	Meta   interface{}                                       `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupIndustryResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupIndustryResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupIndustryResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupIndustryResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupIndustryResponseEnvelope

type AttackLayer3TimeseriesGroupIndustryResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupIndustryResponse             `json:"result,required"`
	Success bool                                                    `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupIndustryResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupIndustryResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupIndustryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupIndustryResponseSerie0

type AttackLayer3TimeseriesGroupIndustryResponseSerie0 struct {
	Timestamps  []string                                              `json:"timestamps,required"`
	ExtraFields map[string][]string                                   `json:"-,extras"`
	JSON        attackLayer3TimeseriesGroupIndustryResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupIndustryResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupIndustryResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupProtocolParams

type AttackLayer3TimeseriesGroupProtocolParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupProtocolParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesGroupProtocolParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupProtocolParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TimeseriesGroupProtocolParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesGroupProtocolParamsNormalization] `query:"normalization"`
}

func (AttackLayer3TimeseriesGroupProtocolParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupProtocolParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupProtocolParamsAggInterval

type AttackLayer3TimeseriesGroupProtocolParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupProtocolParamsAggInterval15m AttackLayer3TimeseriesGroupProtocolParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupProtocolParamsAggInterval1h  AttackLayer3TimeseriesGroupProtocolParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupProtocolParamsAggInterval1d  AttackLayer3TimeseriesGroupProtocolParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupProtocolParamsAggInterval1w  AttackLayer3TimeseriesGroupProtocolParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupProtocolParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupProtocolParamsDirection

type AttackLayer3TimeseriesGroupProtocolParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesGroupProtocolParamsDirectionOrigin AttackLayer3TimeseriesGroupProtocolParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesGroupProtocolParamsDirectionTarget AttackLayer3TimeseriesGroupProtocolParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesGroupProtocolParamsDirection) IsKnown

type AttackLayer3TimeseriesGroupProtocolParamsFormat

type AttackLayer3TimeseriesGroupProtocolParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupProtocolParamsFormatJson AttackLayer3TimeseriesGroupProtocolParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupProtocolParamsFormatCsv  AttackLayer3TimeseriesGroupProtocolParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupProtocolParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupProtocolParamsIPVersion

type AttackLayer3TimeseriesGroupProtocolParamsIPVersion string
const (
	AttackLayer3TimeseriesGroupProtocolParamsIPVersionIPv4 AttackLayer3TimeseriesGroupProtocolParamsIPVersion = "IPv4"
	AttackLayer3TimeseriesGroupProtocolParamsIPVersionIPv6 AttackLayer3TimeseriesGroupProtocolParamsIPVersion = "IPv6"
)

func (AttackLayer3TimeseriesGroupProtocolParamsIPVersion) IsKnown

type AttackLayer3TimeseriesGroupProtocolParamsNormalization

type AttackLayer3TimeseriesGroupProtocolParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesGroupProtocolParamsNormalizationPercentage AttackLayer3TimeseriesGroupProtocolParamsNormalization = "PERCENTAGE"
	AttackLayer3TimeseriesGroupProtocolParamsNormalizationMin0Max    AttackLayer3TimeseriesGroupProtocolParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesGroupProtocolParamsNormalization) IsKnown

type AttackLayer3TimeseriesGroupProtocolResponse

type AttackLayer3TimeseriesGroupProtocolResponse struct {
	Meta   interface{}                                       `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupProtocolResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupProtocolResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupProtocolResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupProtocolResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupProtocolResponseEnvelope

type AttackLayer3TimeseriesGroupProtocolResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupProtocolResponse             `json:"result,required"`
	Success bool                                                    `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupProtocolResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupProtocolResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupProtocolResponseSerie0

type AttackLayer3TimeseriesGroupProtocolResponseSerie0 struct {
	GRE        []string                                              `json:"GRE,required"`
	Icmp       []string                                              `json:"ICMP,required"`
	TCP        []string                                              `json:"TCP,required"`
	Timestamps []string                                              `json:"timestamps,required"`
	Udp        []string                                              `json:"UDP,required"`
	JSON       attackLayer3TimeseriesGroupProtocolResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupProtocolResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupProtocolResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupService

type AttackLayer3TimeseriesGroupService struct {
	Options []option.RequestOption
}

AttackLayer3TimeseriesGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer3TimeseriesGroupService method instead.

func NewAttackLayer3TimeseriesGroupService

func NewAttackLayer3TimeseriesGroupService(opts ...option.RequestOption) (r *AttackLayer3TimeseriesGroupService)

NewAttackLayer3TimeseriesGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer3TimeseriesGroupService) Bitrate

Percentage distribution of attacks by bitrate over time.

func (*AttackLayer3TimeseriesGroupService) Duration

Percentage distribution of attacks by duration over time.

func (*AttackLayer3TimeseriesGroupService) Get

Get a time series of the percentage distribution of network protocols in Layer 3/4 attacks.

func (*AttackLayer3TimeseriesGroupService) IPVersion

Percentage distribution of attacks by ip version used over time.

func (*AttackLayer3TimeseriesGroupService) Industry

Percentage distribution of attacks by industry used over time.

func (*AttackLayer3TimeseriesGroupService) Protocol

Percentage distribution of attacks by protocol used over time.

func (*AttackLayer3TimeseriesGroupService) Vector

Percentage distribution of attacks by vector used over time.

func (*AttackLayer3TimeseriesGroupService) Vertical

Percentage distribution of attacks by vertical used over time.

type AttackLayer3TimeseriesGroupVectorParams

type AttackLayer3TimeseriesGroupVectorParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupVectorParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesGroupVectorParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupVectorParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TimeseriesGroupVectorParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects (eg browsers, verticals, etc) to the top items over
	// the time range.
	LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesGroupVectorParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TimeseriesGroupVectorParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TimeseriesGroupVectorParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupVectorParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupVectorParamsAggInterval

type AttackLayer3TimeseriesGroupVectorParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupVectorParamsAggInterval15m AttackLayer3TimeseriesGroupVectorParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupVectorParamsAggInterval1h  AttackLayer3TimeseriesGroupVectorParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupVectorParamsAggInterval1d  AttackLayer3TimeseriesGroupVectorParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupVectorParamsAggInterval1w  AttackLayer3TimeseriesGroupVectorParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupVectorParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupVectorParamsDirection

type AttackLayer3TimeseriesGroupVectorParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesGroupVectorParamsDirectionOrigin AttackLayer3TimeseriesGroupVectorParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesGroupVectorParamsDirectionTarget AttackLayer3TimeseriesGroupVectorParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesGroupVectorParamsDirection) IsKnown

type AttackLayer3TimeseriesGroupVectorParamsFormat

type AttackLayer3TimeseriesGroupVectorParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupVectorParamsFormatJson AttackLayer3TimeseriesGroupVectorParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupVectorParamsFormatCsv  AttackLayer3TimeseriesGroupVectorParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupVectorParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupVectorParamsIPVersion

type AttackLayer3TimeseriesGroupVectorParamsIPVersion string
const (
	AttackLayer3TimeseriesGroupVectorParamsIPVersionIPv4 AttackLayer3TimeseriesGroupVectorParamsIPVersion = "IPv4"
	AttackLayer3TimeseriesGroupVectorParamsIPVersionIPv6 AttackLayer3TimeseriesGroupVectorParamsIPVersion = "IPv6"
)

func (AttackLayer3TimeseriesGroupVectorParamsIPVersion) IsKnown

type AttackLayer3TimeseriesGroupVectorParamsNormalization

type AttackLayer3TimeseriesGroupVectorParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesGroupVectorParamsNormalizationPercentage AttackLayer3TimeseriesGroupVectorParamsNormalization = "PERCENTAGE"
	AttackLayer3TimeseriesGroupVectorParamsNormalizationMin0Max    AttackLayer3TimeseriesGroupVectorParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesGroupVectorParamsNormalization) IsKnown

type AttackLayer3TimeseriesGroupVectorParamsProtocol

type AttackLayer3TimeseriesGroupVectorParamsProtocol string
const (
	AttackLayer3TimeseriesGroupVectorParamsProtocolUdp  AttackLayer3TimeseriesGroupVectorParamsProtocol = "UDP"
	AttackLayer3TimeseriesGroupVectorParamsProtocolTCP  AttackLayer3TimeseriesGroupVectorParamsProtocol = "TCP"
	AttackLayer3TimeseriesGroupVectorParamsProtocolIcmp AttackLayer3TimeseriesGroupVectorParamsProtocol = "ICMP"
	AttackLayer3TimeseriesGroupVectorParamsProtocolGRE  AttackLayer3TimeseriesGroupVectorParamsProtocol = "GRE"
)

func (AttackLayer3TimeseriesGroupVectorParamsProtocol) IsKnown

type AttackLayer3TimeseriesGroupVectorResponse

type AttackLayer3TimeseriesGroupVectorResponse struct {
	Meta   interface{}                                     `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupVectorResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupVectorResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupVectorResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupVectorResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupVectorResponseEnvelope

type AttackLayer3TimeseriesGroupVectorResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupVectorResponse             `json:"result,required"`
	Success bool                                                  `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupVectorResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupVectorResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupVectorResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupVectorResponseSerie0

type AttackLayer3TimeseriesGroupVectorResponseSerie0 struct {
	Timestamps  []string                                            `json:"timestamps,required"`
	ExtraFields map[string][]string                                 `json:"-,extras"`
	JSON        attackLayer3TimeseriesGroupVectorResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupVectorResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupVectorResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupVerticalParams

type AttackLayer3TimeseriesGroupVerticalParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesGroupVerticalParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesGroupVerticalParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesGroupVerticalParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TimeseriesGroupVerticalParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects (eg browsers, verticals, etc) to the top items over
	// the time range.
	LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesGroupVerticalParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TimeseriesGroupVerticalParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TimeseriesGroupVerticalParams) URLQuery

URLQuery serializes AttackLayer3TimeseriesGroupVerticalParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesGroupVerticalParamsAggInterval

type AttackLayer3TimeseriesGroupVerticalParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesGroupVerticalParamsAggInterval15m AttackLayer3TimeseriesGroupVerticalParamsAggInterval = "15m"
	AttackLayer3TimeseriesGroupVerticalParamsAggInterval1h  AttackLayer3TimeseriesGroupVerticalParamsAggInterval = "1h"
	AttackLayer3TimeseriesGroupVerticalParamsAggInterval1d  AttackLayer3TimeseriesGroupVerticalParamsAggInterval = "1d"
	AttackLayer3TimeseriesGroupVerticalParamsAggInterval1w  AttackLayer3TimeseriesGroupVerticalParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesGroupVerticalParamsAggInterval) IsKnown

type AttackLayer3TimeseriesGroupVerticalParamsDirection

type AttackLayer3TimeseriesGroupVerticalParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesGroupVerticalParamsDirectionOrigin AttackLayer3TimeseriesGroupVerticalParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesGroupVerticalParamsDirectionTarget AttackLayer3TimeseriesGroupVerticalParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesGroupVerticalParamsDirection) IsKnown

type AttackLayer3TimeseriesGroupVerticalParamsFormat

type AttackLayer3TimeseriesGroupVerticalParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesGroupVerticalParamsFormatJson AttackLayer3TimeseriesGroupVerticalParamsFormat = "JSON"
	AttackLayer3TimeseriesGroupVerticalParamsFormatCsv  AttackLayer3TimeseriesGroupVerticalParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesGroupVerticalParamsFormat) IsKnown

type AttackLayer3TimeseriesGroupVerticalParamsIPVersion

type AttackLayer3TimeseriesGroupVerticalParamsIPVersion string
const (
	AttackLayer3TimeseriesGroupVerticalParamsIPVersionIPv4 AttackLayer3TimeseriesGroupVerticalParamsIPVersion = "IPv4"
	AttackLayer3TimeseriesGroupVerticalParamsIPVersionIPv6 AttackLayer3TimeseriesGroupVerticalParamsIPVersion = "IPv6"
)

func (AttackLayer3TimeseriesGroupVerticalParamsIPVersion) IsKnown

type AttackLayer3TimeseriesGroupVerticalParamsNormalization

type AttackLayer3TimeseriesGroupVerticalParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesGroupVerticalParamsNormalizationPercentage AttackLayer3TimeseriesGroupVerticalParamsNormalization = "PERCENTAGE"
	AttackLayer3TimeseriesGroupVerticalParamsNormalizationMin0Max    AttackLayer3TimeseriesGroupVerticalParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesGroupVerticalParamsNormalization) IsKnown

type AttackLayer3TimeseriesGroupVerticalParamsProtocol

type AttackLayer3TimeseriesGroupVerticalParamsProtocol string
const (
	AttackLayer3TimeseriesGroupVerticalParamsProtocolUdp  AttackLayer3TimeseriesGroupVerticalParamsProtocol = "UDP"
	AttackLayer3TimeseriesGroupVerticalParamsProtocolTCP  AttackLayer3TimeseriesGroupVerticalParamsProtocol = "TCP"
	AttackLayer3TimeseriesGroupVerticalParamsProtocolIcmp AttackLayer3TimeseriesGroupVerticalParamsProtocol = "ICMP"
	AttackLayer3TimeseriesGroupVerticalParamsProtocolGRE  AttackLayer3TimeseriesGroupVerticalParamsProtocol = "GRE"
)

func (AttackLayer3TimeseriesGroupVerticalParamsProtocol) IsKnown

type AttackLayer3TimeseriesGroupVerticalResponse

type AttackLayer3TimeseriesGroupVerticalResponse struct {
	Meta   interface{}                                       `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesGroupVerticalResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesGroupVerticalResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesGroupVerticalResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupVerticalResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupVerticalResponseEnvelope

type AttackLayer3TimeseriesGroupVerticalResponseEnvelope struct {
	Result  AttackLayer3TimeseriesGroupVerticalResponse             `json:"result,required"`
	Success bool                                                    `json:"success,required"`
	JSON    attackLayer3TimeseriesGroupVerticalResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupVerticalResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupVerticalResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesGroupVerticalResponseSerie0

type AttackLayer3TimeseriesGroupVerticalResponseSerie0 struct {
	Timestamps  []string                                              `json:"timestamps,required"`
	ExtraFields map[string][]string                                   `json:"-,extras"`
	JSON        attackLayer3TimeseriesGroupVerticalResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesGroupVerticalResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesGroupVerticalResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesParams

type AttackLayer3TimeseriesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer3TimeseriesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Together with the `location` parameter, will apply the filter to origin or
	// target location.
	Direction param.Field[AttackLayer3TimeseriesParamsDirection] `query:"direction"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TimeseriesParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TimeseriesParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Measurement units, eg. bytes.
	Metric param.Field[AttackLayer3TimeseriesParamsMetric] `query:"metric"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TimeseriesParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TimeseriesParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TimeseriesParams) URLQuery

func (r AttackLayer3TimeseriesParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3TimeseriesParams's query parameters as `url.Values`.

type AttackLayer3TimeseriesParamsAggInterval

type AttackLayer3TimeseriesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer3TimeseriesParamsAggInterval15m AttackLayer3TimeseriesParamsAggInterval = "15m"
	AttackLayer3TimeseriesParamsAggInterval1h  AttackLayer3TimeseriesParamsAggInterval = "1h"
	AttackLayer3TimeseriesParamsAggInterval1d  AttackLayer3TimeseriesParamsAggInterval = "1d"
	AttackLayer3TimeseriesParamsAggInterval1w  AttackLayer3TimeseriesParamsAggInterval = "1w"
)

func (AttackLayer3TimeseriesParamsAggInterval) IsKnown

type AttackLayer3TimeseriesParamsDirection

type AttackLayer3TimeseriesParamsDirection string

Together with the `location` parameter, will apply the filter to origin or target location.

const (
	AttackLayer3TimeseriesParamsDirectionOrigin AttackLayer3TimeseriesParamsDirection = "ORIGIN"
	AttackLayer3TimeseriesParamsDirectionTarget AttackLayer3TimeseriesParamsDirection = "TARGET"
)

func (AttackLayer3TimeseriesParamsDirection) IsKnown

type AttackLayer3TimeseriesParamsFormat

type AttackLayer3TimeseriesParamsFormat string

Format results are returned in.

const (
	AttackLayer3TimeseriesParamsFormatJson AttackLayer3TimeseriesParamsFormat = "JSON"
	AttackLayer3TimeseriesParamsFormatCsv  AttackLayer3TimeseriesParamsFormat = "CSV"
)

func (AttackLayer3TimeseriesParamsFormat) IsKnown

type AttackLayer3TimeseriesParamsIPVersion

type AttackLayer3TimeseriesParamsIPVersion string
const (
	AttackLayer3TimeseriesParamsIPVersionIPv4 AttackLayer3TimeseriesParamsIPVersion = "IPv4"
	AttackLayer3TimeseriesParamsIPVersionIPv6 AttackLayer3TimeseriesParamsIPVersion = "IPv6"
)

func (AttackLayer3TimeseriesParamsIPVersion) IsKnown

type AttackLayer3TimeseriesParamsMetric

type AttackLayer3TimeseriesParamsMetric string

Measurement units, eg. bytes.

const (
	AttackLayer3TimeseriesParamsMetricBytes    AttackLayer3TimeseriesParamsMetric = "BYTES"
	AttackLayer3TimeseriesParamsMetricBytesOld AttackLayer3TimeseriesParamsMetric = "BYTES_OLD"
)

func (AttackLayer3TimeseriesParamsMetric) IsKnown

type AttackLayer3TimeseriesParamsNormalization

type AttackLayer3TimeseriesParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TimeseriesParamsNormalizationPercentageChange AttackLayer3TimeseriesParamsNormalization = "PERCENTAGE_CHANGE"
	AttackLayer3TimeseriesParamsNormalizationMin0Max          AttackLayer3TimeseriesParamsNormalization = "MIN0_MAX"
)

func (AttackLayer3TimeseriesParamsNormalization) IsKnown

type AttackLayer3TimeseriesParamsProtocol

type AttackLayer3TimeseriesParamsProtocol string
const (
	AttackLayer3TimeseriesParamsProtocolUdp  AttackLayer3TimeseriesParamsProtocol = "UDP"
	AttackLayer3TimeseriesParamsProtocolTCP  AttackLayer3TimeseriesParamsProtocol = "TCP"
	AttackLayer3TimeseriesParamsProtocolIcmp AttackLayer3TimeseriesParamsProtocol = "ICMP"
	AttackLayer3TimeseriesParamsProtocolGRE  AttackLayer3TimeseriesParamsProtocol = "GRE"
)

func (AttackLayer3TimeseriesParamsProtocol) IsKnown

type AttackLayer3TimeseriesResponse

type AttackLayer3TimeseriesResponse struct {
	Meta   interface{}                          `json:"meta,required"`
	Serie0 AttackLayer3TimeseriesResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer3TimeseriesResponseJSON   `json:"-"`
}

func (*AttackLayer3TimeseriesResponse) UnmarshalJSON

func (r *AttackLayer3TimeseriesResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesResponseEnvelope

type AttackLayer3TimeseriesResponseEnvelope struct {
	Result  AttackLayer3TimeseriesResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    attackLayer3TimeseriesResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TimeseriesResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TimeseriesResponseSerie0

type AttackLayer3TimeseriesResponseSerie0 struct {
	Timestamps []time.Time                              `json:"timestamps,required" format:"date-time"`
	Values     []string                                 `json:"values,required"`
	JSON       attackLayer3TimeseriesResponseSerie0JSON `json:"-"`
}

func (*AttackLayer3TimeseriesResponseSerie0) UnmarshalJSON

func (r *AttackLayer3TimeseriesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopAttacksParams

type AttackLayer3TopAttacksParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TopAttacksParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TopAttacksParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of attack origin/target location attack limits. Together with
	// `limitPerLocation`, limits how many objects will be fetched per origin/target
	// location.
	LimitDirection param.Field[AttackLayer3TopAttacksParamsLimitDirection] `query:"limitDirection"`
	// Limit the number of attacks per origin/target (refer to `limitDirection`
	// parameter) location.
	LimitPerLocation param.Field[int64] `query:"limitPerLocation"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer3TopAttacksParamsNormalization] `query:"normalization"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TopAttacksParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TopAttacksParams) URLQuery

func (r AttackLayer3TopAttacksParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3TopAttacksParams's query parameters as `url.Values`.

type AttackLayer3TopAttacksParamsFormat

type AttackLayer3TopAttacksParamsFormat string

Format results are returned in.

const (
	AttackLayer3TopAttacksParamsFormatJson AttackLayer3TopAttacksParamsFormat = "JSON"
	AttackLayer3TopAttacksParamsFormatCsv  AttackLayer3TopAttacksParamsFormat = "CSV"
)

func (AttackLayer3TopAttacksParamsFormat) IsKnown

type AttackLayer3TopAttacksParamsIPVersion

type AttackLayer3TopAttacksParamsIPVersion string
const (
	AttackLayer3TopAttacksParamsIPVersionIPv4 AttackLayer3TopAttacksParamsIPVersion = "IPv4"
	AttackLayer3TopAttacksParamsIPVersionIPv6 AttackLayer3TopAttacksParamsIPVersion = "IPv6"
)

func (AttackLayer3TopAttacksParamsIPVersion) IsKnown

type AttackLayer3TopAttacksParamsLimitDirection

type AttackLayer3TopAttacksParamsLimitDirection string

Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.

const (
	AttackLayer3TopAttacksParamsLimitDirectionOrigin AttackLayer3TopAttacksParamsLimitDirection = "ORIGIN"
	AttackLayer3TopAttacksParamsLimitDirectionTarget AttackLayer3TopAttacksParamsLimitDirection = "TARGET"
)

func (AttackLayer3TopAttacksParamsLimitDirection) IsKnown

type AttackLayer3TopAttacksParamsNormalization

type AttackLayer3TopAttacksParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer3TopAttacksParamsNormalizationPercentage AttackLayer3TopAttacksParamsNormalization = "PERCENTAGE"
	AttackLayer3TopAttacksParamsNormalizationMinMax     AttackLayer3TopAttacksParamsNormalization = "MIN_MAX"
)

func (AttackLayer3TopAttacksParamsNormalization) IsKnown

type AttackLayer3TopAttacksParamsProtocol

type AttackLayer3TopAttacksParamsProtocol string
const (
	AttackLayer3TopAttacksParamsProtocolUdp  AttackLayer3TopAttacksParamsProtocol = "UDP"
	AttackLayer3TopAttacksParamsProtocolTCP  AttackLayer3TopAttacksParamsProtocol = "TCP"
	AttackLayer3TopAttacksParamsProtocolIcmp AttackLayer3TopAttacksParamsProtocol = "ICMP"
	AttackLayer3TopAttacksParamsProtocolGRE  AttackLayer3TopAttacksParamsProtocol = "GRE"
)

func (AttackLayer3TopAttacksParamsProtocol) IsKnown

type AttackLayer3TopAttacksResponse

type AttackLayer3TopAttacksResponse struct {
	Meta AttackLayer3TopAttacksResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer3TopAttacksResponseTop0 `json:"top_0,required"`
	JSON attackLayer3TopAttacksResponseJSON   `json:"-"`
}

func (*AttackLayer3TopAttacksResponse) UnmarshalJSON

func (r *AttackLayer3TopAttacksResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopAttacksResponseEnvelope

type AttackLayer3TopAttacksResponseEnvelope struct {
	Result  AttackLayer3TopAttacksResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    attackLayer3TopAttacksResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TopAttacksResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TopAttacksResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopAttacksResponseMeta

type AttackLayer3TopAttacksResponseMeta struct {
	DateRange      []AttackLayer3TopAttacksResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer3TopAttacksResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3TopAttacksResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3TopAttacksResponseMeta) UnmarshalJSON

func (r *AttackLayer3TopAttacksResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopAttacksResponseMetaConfidenceInfo

type AttackLayer3TopAttacksResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        attackLayer3TopAttacksResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3TopAttacksResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3TopAttacksResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation

type AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            attackLayer3TopAttacksResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3TopAttacksResponseMetaDateRange

type AttackLayer3TopAttacksResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3TopAttacksResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3TopAttacksResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3TopAttacksResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopAttacksResponseTop0

type AttackLayer3TopAttacksResponseTop0 struct {
	OriginCountryAlpha2 string                                 `json:"originCountryAlpha2,required"`
	OriginCountryName   string                                 `json:"originCountryName,required"`
	Value               string                                 `json:"value,required"`
	JSON                attackLayer3TopAttacksResponseTop0JSON `json:"-"`
}

func (*AttackLayer3TopAttacksResponseTop0) UnmarshalJSON

func (r *AttackLayer3TopAttacksResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopIndustryParams

type AttackLayer3TopIndustryParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TopIndustryParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TopIndustryParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TopIndustryParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TopIndustryParams) URLQuery

func (r AttackLayer3TopIndustryParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3TopIndustryParams's query parameters as `url.Values`.

type AttackLayer3TopIndustryParamsFormat

type AttackLayer3TopIndustryParamsFormat string

Format results are returned in.

const (
	AttackLayer3TopIndustryParamsFormatJson AttackLayer3TopIndustryParamsFormat = "JSON"
	AttackLayer3TopIndustryParamsFormatCsv  AttackLayer3TopIndustryParamsFormat = "CSV"
)

func (AttackLayer3TopIndustryParamsFormat) IsKnown

type AttackLayer3TopIndustryParamsIPVersion

type AttackLayer3TopIndustryParamsIPVersion string
const (
	AttackLayer3TopIndustryParamsIPVersionIPv4 AttackLayer3TopIndustryParamsIPVersion = "IPv4"
	AttackLayer3TopIndustryParamsIPVersionIPv6 AttackLayer3TopIndustryParamsIPVersion = "IPv6"
)

func (AttackLayer3TopIndustryParamsIPVersion) IsKnown

type AttackLayer3TopIndustryParamsProtocol

type AttackLayer3TopIndustryParamsProtocol string
const (
	AttackLayer3TopIndustryParamsProtocolUdp  AttackLayer3TopIndustryParamsProtocol = "UDP"
	AttackLayer3TopIndustryParamsProtocolTCP  AttackLayer3TopIndustryParamsProtocol = "TCP"
	AttackLayer3TopIndustryParamsProtocolIcmp AttackLayer3TopIndustryParamsProtocol = "ICMP"
	AttackLayer3TopIndustryParamsProtocolGRE  AttackLayer3TopIndustryParamsProtocol = "GRE"
)

func (AttackLayer3TopIndustryParamsProtocol) IsKnown

type AttackLayer3TopIndustryResponse

type AttackLayer3TopIndustryResponse struct {
	Meta AttackLayer3TopIndustryResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer3TopIndustryResponseTop0 `json:"top_0,required"`
	JSON attackLayer3TopIndustryResponseJSON   `json:"-"`
}

func (*AttackLayer3TopIndustryResponse) UnmarshalJSON

func (r *AttackLayer3TopIndustryResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopIndustryResponseEnvelope

type AttackLayer3TopIndustryResponseEnvelope struct {
	Result  AttackLayer3TopIndustryResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    attackLayer3TopIndustryResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TopIndustryResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TopIndustryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopIndustryResponseMeta

type AttackLayer3TopIndustryResponseMeta struct {
	DateRange      []AttackLayer3TopIndustryResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer3TopIndustryResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3TopIndustryResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3TopIndustryResponseMeta) UnmarshalJSON

func (r *AttackLayer3TopIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopIndustryResponseMetaConfidenceInfo

type AttackLayer3TopIndustryResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        attackLayer3TopIndustryResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3TopIndustryResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3TopIndustryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation

type AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            attackLayer3TopIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3TopIndustryResponseMetaDateRange

type AttackLayer3TopIndustryResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3TopIndustryResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3TopIndustryResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3TopIndustryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopIndustryResponseTop0

type AttackLayer3TopIndustryResponseTop0 struct {
	Name  string                                  `json:"name,required"`
	Value string                                  `json:"value,required"`
	JSON  attackLayer3TopIndustryResponseTop0JSON `json:"-"`
}

func (*AttackLayer3TopIndustryResponseTop0) UnmarshalJSON

func (r *AttackLayer3TopIndustryResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationOriginParams

type AttackLayer3TopLocationOriginParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TopLocationOriginParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TopLocationOriginParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TopLocationOriginParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TopLocationOriginParams) URLQuery

URLQuery serializes AttackLayer3TopLocationOriginParams's query parameters as `url.Values`.

type AttackLayer3TopLocationOriginParamsFormat

type AttackLayer3TopLocationOriginParamsFormat string

Format results are returned in.

const (
	AttackLayer3TopLocationOriginParamsFormatJson AttackLayer3TopLocationOriginParamsFormat = "JSON"
	AttackLayer3TopLocationOriginParamsFormatCsv  AttackLayer3TopLocationOriginParamsFormat = "CSV"
)

func (AttackLayer3TopLocationOriginParamsFormat) IsKnown

type AttackLayer3TopLocationOriginParamsIPVersion

type AttackLayer3TopLocationOriginParamsIPVersion string
const (
	AttackLayer3TopLocationOriginParamsIPVersionIPv4 AttackLayer3TopLocationOriginParamsIPVersion = "IPv4"
	AttackLayer3TopLocationOriginParamsIPVersionIPv6 AttackLayer3TopLocationOriginParamsIPVersion = "IPv6"
)

func (AttackLayer3TopLocationOriginParamsIPVersion) IsKnown

type AttackLayer3TopLocationOriginParamsProtocol

type AttackLayer3TopLocationOriginParamsProtocol string
const (
	AttackLayer3TopLocationOriginParamsProtocolUdp  AttackLayer3TopLocationOriginParamsProtocol = "UDP"
	AttackLayer3TopLocationOriginParamsProtocolTCP  AttackLayer3TopLocationOriginParamsProtocol = "TCP"
	AttackLayer3TopLocationOriginParamsProtocolIcmp AttackLayer3TopLocationOriginParamsProtocol = "ICMP"
	AttackLayer3TopLocationOriginParamsProtocolGRE  AttackLayer3TopLocationOriginParamsProtocol = "GRE"
)

func (AttackLayer3TopLocationOriginParamsProtocol) IsKnown

type AttackLayer3TopLocationOriginResponse

type AttackLayer3TopLocationOriginResponse struct {
	Meta AttackLayer3TopLocationOriginResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer3TopLocationOriginResponseTop0 `json:"top_0,required"`
	JSON attackLayer3TopLocationOriginResponseJSON   `json:"-"`
}

func (*AttackLayer3TopLocationOriginResponse) UnmarshalJSON

func (r *AttackLayer3TopLocationOriginResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationOriginResponseEnvelope

type AttackLayer3TopLocationOriginResponseEnvelope struct {
	Result  AttackLayer3TopLocationOriginResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    attackLayer3TopLocationOriginResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TopLocationOriginResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TopLocationOriginResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationOriginResponseMeta

type AttackLayer3TopLocationOriginResponseMeta struct {
	DateRange      []AttackLayer3TopLocationOriginResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                  `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer3TopLocationOriginResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3TopLocationOriginResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3TopLocationOriginResponseMeta) UnmarshalJSON

func (r *AttackLayer3TopLocationOriginResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationOriginResponseMetaConfidenceInfo

type AttackLayer3TopLocationOriginResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                               `json:"level"`
	JSON        attackLayer3TopLocationOriginResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3TopLocationOriginResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation

type AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                `json:"dataSource,required"`
	Description     string                                                                `json:"description,required"`
	EventType       string                                                                `json:"eventType,required"`
	IsInstantaneous bool                                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                `json:"linkedUrl"`
	StartTime       time.Time                                                             `json:"startTime" format:"date-time"`
	JSON            attackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3TopLocationOriginResponseMetaDateRange

type AttackLayer3TopLocationOriginResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                              `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3TopLocationOriginResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3TopLocationOriginResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3TopLocationOriginResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationOriginResponseTop0

type AttackLayer3TopLocationOriginResponseTop0 struct {
	OriginCountryAlpha2 string                                        `json:"originCountryAlpha2,required"`
	OriginCountryName   string                                        `json:"originCountryName,required"`
	Rank                float64                                       `json:"rank,required"`
	Value               string                                        `json:"value,required"`
	JSON                attackLayer3TopLocationOriginResponseTop0JSON `json:"-"`
}

func (*AttackLayer3TopLocationOriginResponseTop0) UnmarshalJSON

func (r *AttackLayer3TopLocationOriginResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationService

type AttackLayer3TopLocationService struct {
	Options []option.RequestOption
}

AttackLayer3TopLocationService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer3TopLocationService method instead.

func NewAttackLayer3TopLocationService

func NewAttackLayer3TopLocationService(opts ...option.RequestOption) (r *AttackLayer3TopLocationService)

NewAttackLayer3TopLocationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer3TopLocationService) Origin

Get the origin locations of attacks.

func (*AttackLayer3TopLocationService) Target

Get the target locations of attacks.

type AttackLayer3TopLocationTargetParams

type AttackLayer3TopLocationTargetParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TopLocationTargetParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TopLocationTargetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TopLocationTargetParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TopLocationTargetParams) URLQuery

URLQuery serializes AttackLayer3TopLocationTargetParams's query parameters as `url.Values`.

type AttackLayer3TopLocationTargetParamsFormat

type AttackLayer3TopLocationTargetParamsFormat string

Format results are returned in.

const (
	AttackLayer3TopLocationTargetParamsFormatJson AttackLayer3TopLocationTargetParamsFormat = "JSON"
	AttackLayer3TopLocationTargetParamsFormatCsv  AttackLayer3TopLocationTargetParamsFormat = "CSV"
)

func (AttackLayer3TopLocationTargetParamsFormat) IsKnown

type AttackLayer3TopLocationTargetParamsIPVersion

type AttackLayer3TopLocationTargetParamsIPVersion string
const (
	AttackLayer3TopLocationTargetParamsIPVersionIPv4 AttackLayer3TopLocationTargetParamsIPVersion = "IPv4"
	AttackLayer3TopLocationTargetParamsIPVersionIPv6 AttackLayer3TopLocationTargetParamsIPVersion = "IPv6"
)

func (AttackLayer3TopLocationTargetParamsIPVersion) IsKnown

type AttackLayer3TopLocationTargetParamsProtocol

type AttackLayer3TopLocationTargetParamsProtocol string
const (
	AttackLayer3TopLocationTargetParamsProtocolUdp  AttackLayer3TopLocationTargetParamsProtocol = "UDP"
	AttackLayer3TopLocationTargetParamsProtocolTCP  AttackLayer3TopLocationTargetParamsProtocol = "TCP"
	AttackLayer3TopLocationTargetParamsProtocolIcmp AttackLayer3TopLocationTargetParamsProtocol = "ICMP"
	AttackLayer3TopLocationTargetParamsProtocolGRE  AttackLayer3TopLocationTargetParamsProtocol = "GRE"
)

func (AttackLayer3TopLocationTargetParamsProtocol) IsKnown

type AttackLayer3TopLocationTargetResponse

type AttackLayer3TopLocationTargetResponse struct {
	Meta AttackLayer3TopLocationTargetResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer3TopLocationTargetResponseTop0 `json:"top_0,required"`
	JSON attackLayer3TopLocationTargetResponseJSON   `json:"-"`
}

func (*AttackLayer3TopLocationTargetResponse) UnmarshalJSON

func (r *AttackLayer3TopLocationTargetResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationTargetResponseEnvelope

type AttackLayer3TopLocationTargetResponseEnvelope struct {
	Result  AttackLayer3TopLocationTargetResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    attackLayer3TopLocationTargetResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TopLocationTargetResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TopLocationTargetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationTargetResponseMeta

type AttackLayer3TopLocationTargetResponseMeta struct {
	DateRange      []AttackLayer3TopLocationTargetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                  `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer3TopLocationTargetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3TopLocationTargetResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3TopLocationTargetResponseMeta) UnmarshalJSON

func (r *AttackLayer3TopLocationTargetResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationTargetResponseMetaConfidenceInfo

type AttackLayer3TopLocationTargetResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                               `json:"level"`
	JSON        attackLayer3TopLocationTargetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3TopLocationTargetResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation

type AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                `json:"dataSource,required"`
	Description     string                                                                `json:"description,required"`
	EventType       string                                                                `json:"eventType,required"`
	IsInstantaneous bool                                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                `json:"linkedUrl"`
	StartTime       time.Time                                                             `json:"startTime" format:"date-time"`
	JSON            attackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3TopLocationTargetResponseMetaDateRange

type AttackLayer3TopLocationTargetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                              `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3TopLocationTargetResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3TopLocationTargetResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3TopLocationTargetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopLocationTargetResponseTop0

type AttackLayer3TopLocationTargetResponseTop0 struct {
	Rank                float64                                       `json:"rank,required"`
	TargetCountryAlpha2 string                                        `json:"targetCountryAlpha2,required"`
	TargetCountryName   string                                        `json:"targetCountryName,required"`
	Value               string                                        `json:"value,required"`
	JSON                attackLayer3TopLocationTargetResponseTop0JSON `json:"-"`
}

func (*AttackLayer3TopLocationTargetResponseTop0) UnmarshalJSON

func (r *AttackLayer3TopLocationTargetResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopService

type AttackLayer3TopService struct {
	Options   []option.RequestOption
	Locations *AttackLayer3TopLocationService
}

AttackLayer3TopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer3TopService method instead.

func NewAttackLayer3TopService

func NewAttackLayer3TopService(opts ...option.RequestOption) (r *AttackLayer3TopService)

NewAttackLayer3TopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer3TopService) Attacks

Get the top attacks from origin to target location. Values are a percentage out of the total layer 3 attacks (with billing country). You can optionally limit the number of attacks per origin/target location (useful if all the top attacks are from or to the same location).

func (*AttackLayer3TopService) Industry

Get the industries targeted by attacks.

func (*AttackLayer3TopService) Vertical

Get the verticals targeted by attacks.

type AttackLayer3TopVerticalParams

type AttackLayer3TopVerticalParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer3TopVerticalParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer3TopVerticalParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of L3/4 attack types.
	Protocol param.Field[[]AttackLayer3TopVerticalParamsProtocol] `query:"protocol"`
}

func (AttackLayer3TopVerticalParams) URLQuery

func (r AttackLayer3TopVerticalParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer3TopVerticalParams's query parameters as `url.Values`.

type AttackLayer3TopVerticalParamsFormat

type AttackLayer3TopVerticalParamsFormat string

Format results are returned in.

const (
	AttackLayer3TopVerticalParamsFormatJson AttackLayer3TopVerticalParamsFormat = "JSON"
	AttackLayer3TopVerticalParamsFormatCsv  AttackLayer3TopVerticalParamsFormat = "CSV"
)

func (AttackLayer3TopVerticalParamsFormat) IsKnown

type AttackLayer3TopVerticalParamsIPVersion

type AttackLayer3TopVerticalParamsIPVersion string
const (
	AttackLayer3TopVerticalParamsIPVersionIPv4 AttackLayer3TopVerticalParamsIPVersion = "IPv4"
	AttackLayer3TopVerticalParamsIPVersionIPv6 AttackLayer3TopVerticalParamsIPVersion = "IPv6"
)

func (AttackLayer3TopVerticalParamsIPVersion) IsKnown

type AttackLayer3TopVerticalParamsProtocol

type AttackLayer3TopVerticalParamsProtocol string
const (
	AttackLayer3TopVerticalParamsProtocolUdp  AttackLayer3TopVerticalParamsProtocol = "UDP"
	AttackLayer3TopVerticalParamsProtocolTCP  AttackLayer3TopVerticalParamsProtocol = "TCP"
	AttackLayer3TopVerticalParamsProtocolIcmp AttackLayer3TopVerticalParamsProtocol = "ICMP"
	AttackLayer3TopVerticalParamsProtocolGRE  AttackLayer3TopVerticalParamsProtocol = "GRE"
)

func (AttackLayer3TopVerticalParamsProtocol) IsKnown

type AttackLayer3TopVerticalResponse

type AttackLayer3TopVerticalResponse struct {
	Meta AttackLayer3TopVerticalResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer3TopVerticalResponseTop0 `json:"top_0,required"`
	JSON attackLayer3TopVerticalResponseJSON   `json:"-"`
}

func (*AttackLayer3TopVerticalResponse) UnmarshalJSON

func (r *AttackLayer3TopVerticalResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopVerticalResponseEnvelope

type AttackLayer3TopVerticalResponseEnvelope struct {
	Result  AttackLayer3TopVerticalResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    attackLayer3TopVerticalResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer3TopVerticalResponseEnvelope) UnmarshalJSON

func (r *AttackLayer3TopVerticalResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopVerticalResponseMeta

type AttackLayer3TopVerticalResponseMeta struct {
	DateRange      []AttackLayer3TopVerticalResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer3TopVerticalResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer3TopVerticalResponseMetaJSON           `json:"-"`
}

func (*AttackLayer3TopVerticalResponseMeta) UnmarshalJSON

func (r *AttackLayer3TopVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopVerticalResponseMetaConfidenceInfo

type AttackLayer3TopVerticalResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        attackLayer3TopVerticalResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer3TopVerticalResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer3TopVerticalResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation

type AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            attackLayer3TopVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer3TopVerticalResponseMetaDateRange

type AttackLayer3TopVerticalResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      attackLayer3TopVerticalResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer3TopVerticalResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer3TopVerticalResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer3TopVerticalResponseTop0

type AttackLayer3TopVerticalResponseTop0 struct {
	Name  string                                  `json:"name,required"`
	Value string                                  `json:"value,required"`
	JSON  attackLayer3TopVerticalResponseTop0JSON `json:"-"`
}

func (*AttackLayer3TopVerticalResponseTop0) UnmarshalJSON

func (r *AttackLayer3TopVerticalResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7Service

type AttackLayer7Service struct {
	Options          []option.RequestOption
	Summary          *AttackLayer7SummaryService
	TimeseriesGroups *AttackLayer7TimeseriesGroupService
	Top              *AttackLayer7TopService
}

AttackLayer7Service contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer7Service method instead.

func NewAttackLayer7Service

func NewAttackLayer7Service(opts ...option.RequestOption) (r *AttackLayer7Service)

NewAttackLayer7Service generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer7Service) Timeseries

Get a timeseries of Layer 7 attacks. Values represent HTTP requests and are normalized using min-max by default.

type AttackLayer7SummaryGetParams

type AttackLayer7SummaryGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7SummaryGetParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7SummaryGetParams) URLQuery

func (r AttackLayer7SummaryGetParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer7SummaryGetParams's query parameters as `url.Values`.

type AttackLayer7SummaryGetParamsFormat

type AttackLayer7SummaryGetParamsFormat string

Format results are returned in.

const (
	AttackLayer7SummaryGetParamsFormatJson AttackLayer7SummaryGetParamsFormat = "JSON"
	AttackLayer7SummaryGetParamsFormatCsv  AttackLayer7SummaryGetParamsFormat = "CSV"
)

func (AttackLayer7SummaryGetParamsFormat) IsKnown

type AttackLayer7SummaryGetResponse

type AttackLayer7SummaryGetResponse struct {
	Meta     AttackLayer7SummaryGetResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer7SummaryGetResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer7SummaryGetResponseJSON     `json:"-"`
}

func (*AttackLayer7SummaryGetResponse) UnmarshalJSON

func (r *AttackLayer7SummaryGetResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryGetResponseEnvelope

type AttackLayer7SummaryGetResponseEnvelope struct {
	Result  AttackLayer7SummaryGetResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    attackLayer7SummaryGetResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7SummaryGetResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7SummaryGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryGetResponseMeta

type AttackLayer7SummaryGetResponseMeta struct {
	DateRange      []AttackLayer7SummaryGetResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo AttackLayer7SummaryGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7SummaryGetResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7SummaryGetResponseMeta) UnmarshalJSON

func (r *AttackLayer7SummaryGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryGetResponseMetaConfidenceInfo

type AttackLayer7SummaryGetResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7SummaryGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        attackLayer7SummaryGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7SummaryGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer7SummaryGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryGetResponseMetaConfidenceInfoAnnotation

type AttackLayer7SummaryGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            attackLayer7SummaryGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7SummaryGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7SummaryGetResponseMetaDateRange

type AttackLayer7SummaryGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7SummaryGetResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7SummaryGetResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7SummaryGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryGetResponseSummary0

type AttackLayer7SummaryGetResponseSummary0 struct {
	AccessRules        string                                     `json:"ACCESS_RULES,required"`
	APIShield          string                                     `json:"API_SHIELD,required"`
	BotManagement      string                                     `json:"BOT_MANAGEMENT,required"`
	DataLossPrevention string                                     `json:"DATA_LOSS_PREVENTION,required"`
	DDoS               string                                     `json:"DDOS,required"`
	IPReputation       string                                     `json:"IP_REPUTATION,required"`
	WAF                string                                     `json:"WAF,required"`
	JSON               attackLayer7SummaryGetResponseSummary0JSON `json:"-"`
}

func (*AttackLayer7SummaryGetResponseSummary0) UnmarshalJSON

func (r *AttackLayer7SummaryGetResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPMethodParams

type AttackLayer7SummaryHTTPMethodParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7SummaryHTTPMethodParamsFormat] `query:"format"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7SummaryHTTPMethodParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7SummaryHTTPMethodParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7SummaryHTTPMethodParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7SummaryHTTPMethodParams) URLQuery

URLQuery serializes AttackLayer7SummaryHTTPMethodParams's query parameters as `url.Values`.

type AttackLayer7SummaryHTTPMethodParamsFormat

type AttackLayer7SummaryHTTPMethodParamsFormat string

Format results are returned in.

const (
	AttackLayer7SummaryHTTPMethodParamsFormatJson AttackLayer7SummaryHTTPMethodParamsFormat = "JSON"
	AttackLayer7SummaryHTTPMethodParamsFormatCsv  AttackLayer7SummaryHTTPMethodParamsFormat = "CSV"
)

func (AttackLayer7SummaryHTTPMethodParamsFormat) IsKnown

type AttackLayer7SummaryHTTPMethodParamsHTTPVersion

type AttackLayer7SummaryHTTPMethodParamsHTTPVersion string
const (
	AttackLayer7SummaryHTTPMethodParamsHTTPVersionHttPv1 AttackLayer7SummaryHTTPMethodParamsHTTPVersion = "HTTPv1"
	AttackLayer7SummaryHTTPMethodParamsHTTPVersionHttPv2 AttackLayer7SummaryHTTPMethodParamsHTTPVersion = "HTTPv2"
	AttackLayer7SummaryHTTPMethodParamsHTTPVersionHttPv3 AttackLayer7SummaryHTTPMethodParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7SummaryHTTPMethodParamsHTTPVersion) IsKnown

type AttackLayer7SummaryHTTPMethodParamsIPVersion

type AttackLayer7SummaryHTTPMethodParamsIPVersion string
const (
	AttackLayer7SummaryHTTPMethodParamsIPVersionIPv4 AttackLayer7SummaryHTTPMethodParamsIPVersion = "IPv4"
	AttackLayer7SummaryHTTPMethodParamsIPVersionIPv6 AttackLayer7SummaryHTTPMethodParamsIPVersion = "IPv6"
)

func (AttackLayer7SummaryHTTPMethodParamsIPVersion) IsKnown

type AttackLayer7SummaryHTTPMethodParamsMitigationProduct

type AttackLayer7SummaryHTTPMethodParamsMitigationProduct string
const (
	AttackLayer7SummaryHTTPMethodParamsMitigationProductDDoS               AttackLayer7SummaryHTTPMethodParamsMitigationProduct = "DDOS"
	AttackLayer7SummaryHTTPMethodParamsMitigationProductWAF                AttackLayer7SummaryHTTPMethodParamsMitigationProduct = "WAF"
	AttackLayer7SummaryHTTPMethodParamsMitigationProductBotManagement      AttackLayer7SummaryHTTPMethodParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7SummaryHTTPMethodParamsMitigationProductAccessRules        AttackLayer7SummaryHTTPMethodParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7SummaryHTTPMethodParamsMitigationProductIPReputation       AttackLayer7SummaryHTTPMethodParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7SummaryHTTPMethodParamsMitigationProductAPIShield          AttackLayer7SummaryHTTPMethodParamsMitigationProduct = "API_SHIELD"
	AttackLayer7SummaryHTTPMethodParamsMitigationProductDataLossPrevention AttackLayer7SummaryHTTPMethodParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7SummaryHTTPMethodParamsMitigationProduct) IsKnown

type AttackLayer7SummaryHTTPMethodResponse

type AttackLayer7SummaryHTTPMethodResponse struct {
	Meta     AttackLayer7SummaryHTTPMethodResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer7SummaryHTTPMethodResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer7SummaryHTTPMethodResponseJSON     `json:"-"`
}

func (*AttackLayer7SummaryHTTPMethodResponse) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPMethodResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPMethodResponseEnvelope

type AttackLayer7SummaryHTTPMethodResponseEnvelope struct {
	Result  AttackLayer7SummaryHTTPMethodResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    attackLayer7SummaryHTTPMethodResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPMethodResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPMethodResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPMethodResponseMeta

type AttackLayer7SummaryHTTPMethodResponseMeta struct {
	DateRange      []AttackLayer7SummaryHTTPMethodResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                  `json:"lastUpdated,required"`
	Normalization  string                                                  `json:"normalization,required"`
	ConfidenceInfo AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7SummaryHTTPMethodResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7SummaryHTTPMethodResponseMeta) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPMethodResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo

type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                               `json:"level"`
	JSON        attackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation

type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                `json:"dataSource,required"`
	Description     string                                                                `json:"description,required"`
	EventType       string                                                                `json:"eventType,required"`
	IsInstantaneous bool                                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                `json:"linkedUrl"`
	StartTime       time.Time                                                             `json:"startTime" format:"date-time"`
	JSON            attackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7SummaryHTTPMethodResponseMetaDateRange

type AttackLayer7SummaryHTTPMethodResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                              `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7SummaryHTTPMethodResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPMethodResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPMethodResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPMethodResponseSummary0

type AttackLayer7SummaryHTTPMethodResponseSummary0 struct {
	Get  string                                            `json:"GET,required"`
	Post string                                            `json:"POST,required"`
	JSON attackLayer7SummaryHTTPMethodResponseSummary0JSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPMethodResponseSummary0) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPMethodResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPVersionParams

type AttackLayer7SummaryHTTPVersionParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7SummaryHTTPVersionParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7SummaryHTTPVersionParamsHTTPMethod] `query:"httpMethod"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7SummaryHTTPVersionParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7SummaryHTTPVersionParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7SummaryHTTPVersionParams) URLQuery

URLQuery serializes AttackLayer7SummaryHTTPVersionParams's query parameters as `url.Values`.

type AttackLayer7SummaryHTTPVersionParamsFormat

type AttackLayer7SummaryHTTPVersionParamsFormat string

Format results are returned in.

const (
	AttackLayer7SummaryHTTPVersionParamsFormatJson AttackLayer7SummaryHTTPVersionParamsFormat = "JSON"
	AttackLayer7SummaryHTTPVersionParamsFormatCsv  AttackLayer7SummaryHTTPVersionParamsFormat = "CSV"
)

func (AttackLayer7SummaryHTTPVersionParamsFormat) IsKnown

type AttackLayer7SummaryHTTPVersionParamsHTTPMethod

type AttackLayer7SummaryHTTPVersionParamsHTTPMethod string
const (
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodGet             AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "GET"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodPost            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "POST"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodDelete          AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "DELETE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodPut             AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "PUT"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodHead            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "HEAD"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodPurge           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "PURGE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodOptions         AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "OPTIONS"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodPropfind        AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "PROPFIND"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodMkcol           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "MKCOL"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodPatch           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "PATCH"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodACL             AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "ACL"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodBcopy           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "BCOPY"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodBdelete         AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "BDELETE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodBmove           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "BMOVE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodBpropfind       AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "BPROPFIND"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodBproppatch      AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodCheckin         AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "CHECKIN"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodCheckout        AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "CHECKOUT"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodConnect         AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "CONNECT"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodCopy            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "COPY"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodLabel           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "LABEL"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodLock            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "LOCK"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodMerge           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "MERGE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodMkactivity      AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodMkworkspace     AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodMove            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "MOVE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodNotify          AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "NOTIFY"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodOrderpatch      AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodPoll            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "POLL"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodProppatch       AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "PROPPATCH"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodReport          AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "REPORT"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodSearch          AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "SEARCH"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodSubscribe       AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodTrace           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "TRACE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodUncheckout      AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodUnlock          AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "UNLOCK"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodUnsubscribe     AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodUpdate          AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "UPDATE"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodVersioncontrol  AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodBaselinecontrol AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodXmsenumatts     AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodRpcOutData      AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodRpcInData       AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodJson            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "JSON"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodCook            AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "COOK"
	AttackLayer7SummaryHTTPVersionParamsHTTPMethodTrack           AttackLayer7SummaryHTTPVersionParamsHTTPMethod = "TRACK"
)

func (AttackLayer7SummaryHTTPVersionParamsHTTPMethod) IsKnown

type AttackLayer7SummaryHTTPVersionParamsIPVersion

type AttackLayer7SummaryHTTPVersionParamsIPVersion string
const (
	AttackLayer7SummaryHTTPVersionParamsIPVersionIPv4 AttackLayer7SummaryHTTPVersionParamsIPVersion = "IPv4"
	AttackLayer7SummaryHTTPVersionParamsIPVersionIPv6 AttackLayer7SummaryHTTPVersionParamsIPVersion = "IPv6"
)

func (AttackLayer7SummaryHTTPVersionParamsIPVersion) IsKnown

type AttackLayer7SummaryHTTPVersionParamsMitigationProduct

type AttackLayer7SummaryHTTPVersionParamsMitigationProduct string
const (
	AttackLayer7SummaryHTTPVersionParamsMitigationProductDDoS               AttackLayer7SummaryHTTPVersionParamsMitigationProduct = "DDOS"
	AttackLayer7SummaryHTTPVersionParamsMitigationProductWAF                AttackLayer7SummaryHTTPVersionParamsMitigationProduct = "WAF"
	AttackLayer7SummaryHTTPVersionParamsMitigationProductBotManagement      AttackLayer7SummaryHTTPVersionParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7SummaryHTTPVersionParamsMitigationProductAccessRules        AttackLayer7SummaryHTTPVersionParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7SummaryHTTPVersionParamsMitigationProductIPReputation       AttackLayer7SummaryHTTPVersionParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7SummaryHTTPVersionParamsMitigationProductAPIShield          AttackLayer7SummaryHTTPVersionParamsMitigationProduct = "API_SHIELD"
	AttackLayer7SummaryHTTPVersionParamsMitigationProductDataLossPrevention AttackLayer7SummaryHTTPVersionParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7SummaryHTTPVersionParamsMitigationProduct) IsKnown

type AttackLayer7SummaryHTTPVersionResponse

type AttackLayer7SummaryHTTPVersionResponse struct {
	Meta     AttackLayer7SummaryHTTPVersionResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer7SummaryHTTPVersionResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer7SummaryHTTPVersionResponseJSON     `json:"-"`
}

func (*AttackLayer7SummaryHTTPVersionResponse) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPVersionResponseEnvelope

type AttackLayer7SummaryHTTPVersionResponseEnvelope struct {
	Result  AttackLayer7SummaryHTTPVersionResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    attackLayer7SummaryHTTPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPVersionResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPVersionResponseMeta

type AttackLayer7SummaryHTTPVersionResponseMeta struct {
	DateRange      []AttackLayer7SummaryHTTPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                   `json:"lastUpdated,required"`
	Normalization  string                                                   `json:"normalization,required"`
	ConfidenceInfo AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7SummaryHTTPVersionResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7SummaryHTTPVersionResponseMeta) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo

type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                `json:"level"`
	JSON        attackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation

type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                 `json:"dataSource,required"`
	Description     string                                                                 `json:"description,required"`
	EventType       string                                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                 `json:"linkedUrl"`
	StartTime       time.Time                                                              `json:"startTime" format:"date-time"`
	JSON            attackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7SummaryHTTPVersionResponseMetaDateRange

type AttackLayer7SummaryHTTPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                               `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7SummaryHTTPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPVersionResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryHTTPVersionResponseSummary0

type AttackLayer7SummaryHTTPVersionResponseSummary0 struct {
	HTTP1X string                                             `json:"HTTP/1.x,required"`
	HTTP2  string                                             `json:"HTTP/2,required"`
	HTTP3  string                                             `json:"HTTP/3,required"`
	JSON   attackLayer7SummaryHTTPVersionResponseSummary0JSON `json:"-"`
}

func (*AttackLayer7SummaryHTTPVersionResponseSummary0) UnmarshalJSON

func (r *AttackLayer7SummaryHTTPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryIPVersionParams

type AttackLayer7SummaryIPVersionParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7SummaryIPVersionParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7SummaryIPVersionParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7SummaryIPVersionParamsHTTPVersion] `query:"httpVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7SummaryIPVersionParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7SummaryIPVersionParams) URLQuery

URLQuery serializes AttackLayer7SummaryIPVersionParams's query parameters as `url.Values`.

type AttackLayer7SummaryIPVersionParamsFormat

type AttackLayer7SummaryIPVersionParamsFormat string

Format results are returned in.

const (
	AttackLayer7SummaryIPVersionParamsFormatJson AttackLayer7SummaryIPVersionParamsFormat = "JSON"
	AttackLayer7SummaryIPVersionParamsFormatCsv  AttackLayer7SummaryIPVersionParamsFormat = "CSV"
)

func (AttackLayer7SummaryIPVersionParamsFormat) IsKnown

type AttackLayer7SummaryIPVersionParamsHTTPMethod

type AttackLayer7SummaryIPVersionParamsHTTPMethod string
const (
	AttackLayer7SummaryIPVersionParamsHTTPMethodGet             AttackLayer7SummaryIPVersionParamsHTTPMethod = "GET"
	AttackLayer7SummaryIPVersionParamsHTTPMethodPost            AttackLayer7SummaryIPVersionParamsHTTPMethod = "POST"
	AttackLayer7SummaryIPVersionParamsHTTPMethodDelete          AttackLayer7SummaryIPVersionParamsHTTPMethod = "DELETE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodPut             AttackLayer7SummaryIPVersionParamsHTTPMethod = "PUT"
	AttackLayer7SummaryIPVersionParamsHTTPMethodHead            AttackLayer7SummaryIPVersionParamsHTTPMethod = "HEAD"
	AttackLayer7SummaryIPVersionParamsHTTPMethodPurge           AttackLayer7SummaryIPVersionParamsHTTPMethod = "PURGE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodOptions         AttackLayer7SummaryIPVersionParamsHTTPMethod = "OPTIONS"
	AttackLayer7SummaryIPVersionParamsHTTPMethodPropfind        AttackLayer7SummaryIPVersionParamsHTTPMethod = "PROPFIND"
	AttackLayer7SummaryIPVersionParamsHTTPMethodMkcol           AttackLayer7SummaryIPVersionParamsHTTPMethod = "MKCOL"
	AttackLayer7SummaryIPVersionParamsHTTPMethodPatch           AttackLayer7SummaryIPVersionParamsHTTPMethod = "PATCH"
	AttackLayer7SummaryIPVersionParamsHTTPMethodACL             AttackLayer7SummaryIPVersionParamsHTTPMethod = "ACL"
	AttackLayer7SummaryIPVersionParamsHTTPMethodBcopy           AttackLayer7SummaryIPVersionParamsHTTPMethod = "BCOPY"
	AttackLayer7SummaryIPVersionParamsHTTPMethodBdelete         AttackLayer7SummaryIPVersionParamsHTTPMethod = "BDELETE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodBmove           AttackLayer7SummaryIPVersionParamsHTTPMethod = "BMOVE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodBpropfind       AttackLayer7SummaryIPVersionParamsHTTPMethod = "BPROPFIND"
	AttackLayer7SummaryIPVersionParamsHTTPMethodBproppatch      AttackLayer7SummaryIPVersionParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7SummaryIPVersionParamsHTTPMethodCheckin         AttackLayer7SummaryIPVersionParamsHTTPMethod = "CHECKIN"
	AttackLayer7SummaryIPVersionParamsHTTPMethodCheckout        AttackLayer7SummaryIPVersionParamsHTTPMethod = "CHECKOUT"
	AttackLayer7SummaryIPVersionParamsHTTPMethodConnect         AttackLayer7SummaryIPVersionParamsHTTPMethod = "CONNECT"
	AttackLayer7SummaryIPVersionParamsHTTPMethodCopy            AttackLayer7SummaryIPVersionParamsHTTPMethod = "COPY"
	AttackLayer7SummaryIPVersionParamsHTTPMethodLabel           AttackLayer7SummaryIPVersionParamsHTTPMethod = "LABEL"
	AttackLayer7SummaryIPVersionParamsHTTPMethodLock            AttackLayer7SummaryIPVersionParamsHTTPMethod = "LOCK"
	AttackLayer7SummaryIPVersionParamsHTTPMethodMerge           AttackLayer7SummaryIPVersionParamsHTTPMethod = "MERGE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodMkactivity      AttackLayer7SummaryIPVersionParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7SummaryIPVersionParamsHTTPMethodMkworkspace     AttackLayer7SummaryIPVersionParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodMove            AttackLayer7SummaryIPVersionParamsHTTPMethod = "MOVE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodNotify          AttackLayer7SummaryIPVersionParamsHTTPMethod = "NOTIFY"
	AttackLayer7SummaryIPVersionParamsHTTPMethodOrderpatch      AttackLayer7SummaryIPVersionParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7SummaryIPVersionParamsHTTPMethodPoll            AttackLayer7SummaryIPVersionParamsHTTPMethod = "POLL"
	AttackLayer7SummaryIPVersionParamsHTTPMethodProppatch       AttackLayer7SummaryIPVersionParamsHTTPMethod = "PROPPATCH"
	AttackLayer7SummaryIPVersionParamsHTTPMethodReport          AttackLayer7SummaryIPVersionParamsHTTPMethod = "REPORT"
	AttackLayer7SummaryIPVersionParamsHTTPMethodSearch          AttackLayer7SummaryIPVersionParamsHTTPMethod = "SEARCH"
	AttackLayer7SummaryIPVersionParamsHTTPMethodSubscribe       AttackLayer7SummaryIPVersionParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodTrace           AttackLayer7SummaryIPVersionParamsHTTPMethod = "TRACE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodUncheckout      AttackLayer7SummaryIPVersionParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7SummaryIPVersionParamsHTTPMethodUnlock          AttackLayer7SummaryIPVersionParamsHTTPMethod = "UNLOCK"
	AttackLayer7SummaryIPVersionParamsHTTPMethodUnsubscribe     AttackLayer7SummaryIPVersionParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodUpdate          AttackLayer7SummaryIPVersionParamsHTTPMethod = "UPDATE"
	AttackLayer7SummaryIPVersionParamsHTTPMethodVersioncontrol  AttackLayer7SummaryIPVersionParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7SummaryIPVersionParamsHTTPMethodBaselinecontrol AttackLayer7SummaryIPVersionParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7SummaryIPVersionParamsHTTPMethodXmsenumatts     AttackLayer7SummaryIPVersionParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7SummaryIPVersionParamsHTTPMethodRpcOutData      AttackLayer7SummaryIPVersionParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7SummaryIPVersionParamsHTTPMethodRpcInData       AttackLayer7SummaryIPVersionParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7SummaryIPVersionParamsHTTPMethodJson            AttackLayer7SummaryIPVersionParamsHTTPMethod = "JSON"
	AttackLayer7SummaryIPVersionParamsHTTPMethodCook            AttackLayer7SummaryIPVersionParamsHTTPMethod = "COOK"
	AttackLayer7SummaryIPVersionParamsHTTPMethodTrack           AttackLayer7SummaryIPVersionParamsHTTPMethod = "TRACK"
)

func (AttackLayer7SummaryIPVersionParamsHTTPMethod) IsKnown

type AttackLayer7SummaryIPVersionParamsHTTPVersion

type AttackLayer7SummaryIPVersionParamsHTTPVersion string
const (
	AttackLayer7SummaryIPVersionParamsHTTPVersionHttPv1 AttackLayer7SummaryIPVersionParamsHTTPVersion = "HTTPv1"
	AttackLayer7SummaryIPVersionParamsHTTPVersionHttPv2 AttackLayer7SummaryIPVersionParamsHTTPVersion = "HTTPv2"
	AttackLayer7SummaryIPVersionParamsHTTPVersionHttPv3 AttackLayer7SummaryIPVersionParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7SummaryIPVersionParamsHTTPVersion) IsKnown

type AttackLayer7SummaryIPVersionParamsMitigationProduct

type AttackLayer7SummaryIPVersionParamsMitigationProduct string
const (
	AttackLayer7SummaryIPVersionParamsMitigationProductDDoS               AttackLayer7SummaryIPVersionParamsMitigationProduct = "DDOS"
	AttackLayer7SummaryIPVersionParamsMitigationProductWAF                AttackLayer7SummaryIPVersionParamsMitigationProduct = "WAF"
	AttackLayer7SummaryIPVersionParamsMitigationProductBotManagement      AttackLayer7SummaryIPVersionParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7SummaryIPVersionParamsMitigationProductAccessRules        AttackLayer7SummaryIPVersionParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7SummaryIPVersionParamsMitigationProductIPReputation       AttackLayer7SummaryIPVersionParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7SummaryIPVersionParamsMitigationProductAPIShield          AttackLayer7SummaryIPVersionParamsMitigationProduct = "API_SHIELD"
	AttackLayer7SummaryIPVersionParamsMitigationProductDataLossPrevention AttackLayer7SummaryIPVersionParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7SummaryIPVersionParamsMitigationProduct) IsKnown

type AttackLayer7SummaryIPVersionResponse

type AttackLayer7SummaryIPVersionResponse struct {
	Meta     AttackLayer7SummaryIPVersionResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer7SummaryIPVersionResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer7SummaryIPVersionResponseJSON     `json:"-"`
}

func (*AttackLayer7SummaryIPVersionResponse) UnmarshalJSON

func (r *AttackLayer7SummaryIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryIPVersionResponseEnvelope

type AttackLayer7SummaryIPVersionResponseEnvelope struct {
	Result  AttackLayer7SummaryIPVersionResponse             `json:"result,required"`
	Success bool                                             `json:"success,required"`
	JSON    attackLayer7SummaryIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7SummaryIPVersionResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7SummaryIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryIPVersionResponseMeta

type AttackLayer7SummaryIPVersionResponseMeta struct {
	DateRange      []AttackLayer7SummaryIPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                 `json:"lastUpdated,required"`
	Normalization  string                                                 `json:"normalization,required"`
	ConfidenceInfo AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7SummaryIPVersionResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7SummaryIPVersionResponseMeta) UnmarshalJSON

func (r *AttackLayer7SummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo

type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                              `json:"level"`
	JSON        attackLayer7SummaryIPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation

type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                               `json:"dataSource,required"`
	Description     string                                                               `json:"description,required"`
	EventType       string                                                               `json:"eventType,required"`
	IsInstantaneous bool                                                                 `json:"isInstantaneous,required"`
	EndTime         time.Time                                                            `json:"endTime" format:"date-time"`
	LinkedURL       string                                                               `json:"linkedUrl"`
	StartTime       time.Time                                                            `json:"startTime" format:"date-time"`
	JSON            attackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7SummaryIPVersionResponseMetaDateRange

type AttackLayer7SummaryIPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                             `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7SummaryIPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7SummaryIPVersionResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7SummaryIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryIPVersionResponseSummary0

type AttackLayer7SummaryIPVersionResponseSummary0 struct {
	IPv4 string                                           `json:"IPv4,required"`
	IPv6 string                                           `json:"IPv6,required"`
	JSON attackLayer7SummaryIPVersionResponseSummary0JSON `json:"-"`
}

func (*AttackLayer7SummaryIPVersionResponseSummary0) UnmarshalJSON

func (r *AttackLayer7SummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryManagedRulesParams

type AttackLayer7SummaryManagedRulesParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7SummaryManagedRulesParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7SummaryManagedRulesParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7SummaryManagedRulesParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7SummaryManagedRulesParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7SummaryManagedRulesParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7SummaryManagedRulesParams) URLQuery

URLQuery serializes AttackLayer7SummaryManagedRulesParams's query parameters as `url.Values`.

type AttackLayer7SummaryManagedRulesParamsFormat

type AttackLayer7SummaryManagedRulesParamsFormat string

Format results are returned in.

const (
	AttackLayer7SummaryManagedRulesParamsFormatJson AttackLayer7SummaryManagedRulesParamsFormat = "JSON"
	AttackLayer7SummaryManagedRulesParamsFormatCsv  AttackLayer7SummaryManagedRulesParamsFormat = "CSV"
)

func (AttackLayer7SummaryManagedRulesParamsFormat) IsKnown

type AttackLayer7SummaryManagedRulesParamsHTTPMethod

type AttackLayer7SummaryManagedRulesParamsHTTPMethod string
const (
	AttackLayer7SummaryManagedRulesParamsHTTPMethodGet             AttackLayer7SummaryManagedRulesParamsHTTPMethod = "GET"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodPost            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "POST"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodDelete          AttackLayer7SummaryManagedRulesParamsHTTPMethod = "DELETE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodPut             AttackLayer7SummaryManagedRulesParamsHTTPMethod = "PUT"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodHead            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "HEAD"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodPurge           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "PURGE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodOptions         AttackLayer7SummaryManagedRulesParamsHTTPMethod = "OPTIONS"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodPropfind        AttackLayer7SummaryManagedRulesParamsHTTPMethod = "PROPFIND"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodMkcol           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "MKCOL"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodPatch           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "PATCH"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodACL             AttackLayer7SummaryManagedRulesParamsHTTPMethod = "ACL"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodBcopy           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "BCOPY"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodBdelete         AttackLayer7SummaryManagedRulesParamsHTTPMethod = "BDELETE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodBmove           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "BMOVE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodBpropfind       AttackLayer7SummaryManagedRulesParamsHTTPMethod = "BPROPFIND"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodBproppatch      AttackLayer7SummaryManagedRulesParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodCheckin         AttackLayer7SummaryManagedRulesParamsHTTPMethod = "CHECKIN"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodCheckout        AttackLayer7SummaryManagedRulesParamsHTTPMethod = "CHECKOUT"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodConnect         AttackLayer7SummaryManagedRulesParamsHTTPMethod = "CONNECT"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodCopy            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "COPY"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodLabel           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "LABEL"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodLock            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "LOCK"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodMerge           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "MERGE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodMkactivity      AttackLayer7SummaryManagedRulesParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodMkworkspace     AttackLayer7SummaryManagedRulesParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodMove            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "MOVE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodNotify          AttackLayer7SummaryManagedRulesParamsHTTPMethod = "NOTIFY"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodOrderpatch      AttackLayer7SummaryManagedRulesParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodPoll            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "POLL"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodProppatch       AttackLayer7SummaryManagedRulesParamsHTTPMethod = "PROPPATCH"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodReport          AttackLayer7SummaryManagedRulesParamsHTTPMethod = "REPORT"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodSearch          AttackLayer7SummaryManagedRulesParamsHTTPMethod = "SEARCH"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodSubscribe       AttackLayer7SummaryManagedRulesParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodTrace           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "TRACE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodUncheckout      AttackLayer7SummaryManagedRulesParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodUnlock          AttackLayer7SummaryManagedRulesParamsHTTPMethod = "UNLOCK"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodUnsubscribe     AttackLayer7SummaryManagedRulesParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodUpdate          AttackLayer7SummaryManagedRulesParamsHTTPMethod = "UPDATE"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodVersioncontrol  AttackLayer7SummaryManagedRulesParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodBaselinecontrol AttackLayer7SummaryManagedRulesParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodXmsenumatts     AttackLayer7SummaryManagedRulesParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodRpcOutData      AttackLayer7SummaryManagedRulesParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodRpcInData       AttackLayer7SummaryManagedRulesParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodJson            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "JSON"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodCook            AttackLayer7SummaryManagedRulesParamsHTTPMethod = "COOK"
	AttackLayer7SummaryManagedRulesParamsHTTPMethodTrack           AttackLayer7SummaryManagedRulesParamsHTTPMethod = "TRACK"
)

func (AttackLayer7SummaryManagedRulesParamsHTTPMethod) IsKnown

type AttackLayer7SummaryManagedRulesParamsHTTPVersion

type AttackLayer7SummaryManagedRulesParamsHTTPVersion string
const (
	AttackLayer7SummaryManagedRulesParamsHTTPVersionHttPv1 AttackLayer7SummaryManagedRulesParamsHTTPVersion = "HTTPv1"
	AttackLayer7SummaryManagedRulesParamsHTTPVersionHttPv2 AttackLayer7SummaryManagedRulesParamsHTTPVersion = "HTTPv2"
	AttackLayer7SummaryManagedRulesParamsHTTPVersionHttPv3 AttackLayer7SummaryManagedRulesParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7SummaryManagedRulesParamsHTTPVersion) IsKnown

type AttackLayer7SummaryManagedRulesParamsIPVersion

type AttackLayer7SummaryManagedRulesParamsIPVersion string
const (
	AttackLayer7SummaryManagedRulesParamsIPVersionIPv4 AttackLayer7SummaryManagedRulesParamsIPVersion = "IPv4"
	AttackLayer7SummaryManagedRulesParamsIPVersionIPv6 AttackLayer7SummaryManagedRulesParamsIPVersion = "IPv6"
)

func (AttackLayer7SummaryManagedRulesParamsIPVersion) IsKnown

type AttackLayer7SummaryManagedRulesParamsMitigationProduct

type AttackLayer7SummaryManagedRulesParamsMitigationProduct string
const (
	AttackLayer7SummaryManagedRulesParamsMitigationProductDDoS               AttackLayer7SummaryManagedRulesParamsMitigationProduct = "DDOS"
	AttackLayer7SummaryManagedRulesParamsMitigationProductWAF                AttackLayer7SummaryManagedRulesParamsMitigationProduct = "WAF"
	AttackLayer7SummaryManagedRulesParamsMitigationProductBotManagement      AttackLayer7SummaryManagedRulesParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7SummaryManagedRulesParamsMitigationProductAccessRules        AttackLayer7SummaryManagedRulesParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7SummaryManagedRulesParamsMitigationProductIPReputation       AttackLayer7SummaryManagedRulesParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7SummaryManagedRulesParamsMitigationProductAPIShield          AttackLayer7SummaryManagedRulesParamsMitigationProduct = "API_SHIELD"
	AttackLayer7SummaryManagedRulesParamsMitigationProductDataLossPrevention AttackLayer7SummaryManagedRulesParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7SummaryManagedRulesParamsMitigationProduct) IsKnown

type AttackLayer7SummaryManagedRulesResponse

type AttackLayer7SummaryManagedRulesResponse struct {
	Meta     AttackLayer7SummaryManagedRulesResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer7SummaryManagedRulesResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer7SummaryManagedRulesResponseJSON     `json:"-"`
}

func (*AttackLayer7SummaryManagedRulesResponse) UnmarshalJSON

func (r *AttackLayer7SummaryManagedRulesResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryManagedRulesResponseEnvelope

type AttackLayer7SummaryManagedRulesResponseEnvelope struct {
	Result  AttackLayer7SummaryManagedRulesResponse             `json:"result,required"`
	Success bool                                                `json:"success,required"`
	JSON    attackLayer7SummaryManagedRulesResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7SummaryManagedRulesResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7SummaryManagedRulesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryManagedRulesResponseMeta

type AttackLayer7SummaryManagedRulesResponseMeta struct {
	DateRange      []AttackLayer7SummaryManagedRulesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                    `json:"lastUpdated,required"`
	Normalization  string                                                    `json:"normalization,required"`
	ConfidenceInfo AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7SummaryManagedRulesResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7SummaryManagedRulesResponseMeta) UnmarshalJSON

func (r *AttackLayer7SummaryManagedRulesResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo

type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                 `json:"level"`
	JSON        attackLayer7SummaryManagedRulesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation

type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                  `json:"dataSource,required"`
	Description     string                                                                  `json:"description,required"`
	EventType       string                                                                  `json:"eventType,required"`
	IsInstantaneous bool                                                                    `json:"isInstantaneous,required"`
	EndTime         time.Time                                                               `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                  `json:"linkedUrl"`
	StartTime       time.Time                                                               `json:"startTime" format:"date-time"`
	JSON            attackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7SummaryManagedRulesResponseMetaDateRange

type AttackLayer7SummaryManagedRulesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                                `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7SummaryManagedRulesResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7SummaryManagedRulesResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7SummaryManagedRulesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryManagedRulesResponseSummary0

type AttackLayer7SummaryManagedRulesResponseSummary0 struct {
	Bot         string                                              `json:"Bot,required"`
	HTTPAnomaly string                                              `json:"HTTP Anomaly,required"`
	JSON        attackLayer7SummaryManagedRulesResponseSummary0JSON `json:"-"`
}

func (*AttackLayer7SummaryManagedRulesResponseSummary0) UnmarshalJSON

func (r *AttackLayer7SummaryManagedRulesResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryMitigationProductParams

type AttackLayer7SummaryMitigationProductParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7SummaryMitigationProductParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7SummaryMitigationProductParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7SummaryMitigationProductParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7SummaryMitigationProductParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7SummaryMitigationProductParams) URLQuery

URLQuery serializes AttackLayer7SummaryMitigationProductParams's query parameters as `url.Values`.

type AttackLayer7SummaryMitigationProductParamsFormat

type AttackLayer7SummaryMitigationProductParamsFormat string

Format results are returned in.

const (
	AttackLayer7SummaryMitigationProductParamsFormatJson AttackLayer7SummaryMitigationProductParamsFormat = "JSON"
	AttackLayer7SummaryMitigationProductParamsFormatCsv  AttackLayer7SummaryMitigationProductParamsFormat = "CSV"
)

func (AttackLayer7SummaryMitigationProductParamsFormat) IsKnown

type AttackLayer7SummaryMitigationProductParamsHTTPMethod

type AttackLayer7SummaryMitigationProductParamsHTTPMethod string
const (
	AttackLayer7SummaryMitigationProductParamsHTTPMethodGet             AttackLayer7SummaryMitigationProductParamsHTTPMethod = "GET"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodPost            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "POST"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodDelete          AttackLayer7SummaryMitigationProductParamsHTTPMethod = "DELETE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodPut             AttackLayer7SummaryMitigationProductParamsHTTPMethod = "PUT"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodHead            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "HEAD"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodPurge           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "PURGE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodOptions         AttackLayer7SummaryMitigationProductParamsHTTPMethod = "OPTIONS"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodPropfind        AttackLayer7SummaryMitigationProductParamsHTTPMethod = "PROPFIND"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodMkcol           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "MKCOL"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodPatch           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "PATCH"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodACL             AttackLayer7SummaryMitigationProductParamsHTTPMethod = "ACL"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodBcopy           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "BCOPY"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodBdelete         AttackLayer7SummaryMitigationProductParamsHTTPMethod = "BDELETE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodBmove           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "BMOVE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodBpropfind       AttackLayer7SummaryMitigationProductParamsHTTPMethod = "BPROPFIND"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodBproppatch      AttackLayer7SummaryMitigationProductParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodCheckin         AttackLayer7SummaryMitigationProductParamsHTTPMethod = "CHECKIN"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodCheckout        AttackLayer7SummaryMitigationProductParamsHTTPMethod = "CHECKOUT"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodConnect         AttackLayer7SummaryMitigationProductParamsHTTPMethod = "CONNECT"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodCopy            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "COPY"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodLabel           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "LABEL"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodLock            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "LOCK"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodMerge           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "MERGE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodMkactivity      AttackLayer7SummaryMitigationProductParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodMkworkspace     AttackLayer7SummaryMitigationProductParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodMove            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "MOVE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodNotify          AttackLayer7SummaryMitigationProductParamsHTTPMethod = "NOTIFY"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodOrderpatch      AttackLayer7SummaryMitigationProductParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodPoll            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "POLL"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodProppatch       AttackLayer7SummaryMitigationProductParamsHTTPMethod = "PROPPATCH"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodReport          AttackLayer7SummaryMitigationProductParamsHTTPMethod = "REPORT"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodSearch          AttackLayer7SummaryMitigationProductParamsHTTPMethod = "SEARCH"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodSubscribe       AttackLayer7SummaryMitigationProductParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodTrace           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "TRACE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodUncheckout      AttackLayer7SummaryMitigationProductParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodUnlock          AttackLayer7SummaryMitigationProductParamsHTTPMethod = "UNLOCK"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodUnsubscribe     AttackLayer7SummaryMitigationProductParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodUpdate          AttackLayer7SummaryMitigationProductParamsHTTPMethod = "UPDATE"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodVersioncontrol  AttackLayer7SummaryMitigationProductParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodBaselinecontrol AttackLayer7SummaryMitigationProductParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodXmsenumatts     AttackLayer7SummaryMitigationProductParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodRpcOutData      AttackLayer7SummaryMitigationProductParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodRpcInData       AttackLayer7SummaryMitigationProductParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodJson            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "JSON"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodCook            AttackLayer7SummaryMitigationProductParamsHTTPMethod = "COOK"
	AttackLayer7SummaryMitigationProductParamsHTTPMethodTrack           AttackLayer7SummaryMitigationProductParamsHTTPMethod = "TRACK"
)

func (AttackLayer7SummaryMitigationProductParamsHTTPMethod) IsKnown

type AttackLayer7SummaryMitigationProductParamsHTTPVersion

type AttackLayer7SummaryMitigationProductParamsHTTPVersion string
const (
	AttackLayer7SummaryMitigationProductParamsHTTPVersionHttPv1 AttackLayer7SummaryMitigationProductParamsHTTPVersion = "HTTPv1"
	AttackLayer7SummaryMitigationProductParamsHTTPVersionHttPv2 AttackLayer7SummaryMitigationProductParamsHTTPVersion = "HTTPv2"
	AttackLayer7SummaryMitigationProductParamsHTTPVersionHttPv3 AttackLayer7SummaryMitigationProductParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7SummaryMitigationProductParamsHTTPVersion) IsKnown

type AttackLayer7SummaryMitigationProductParamsIPVersion

type AttackLayer7SummaryMitigationProductParamsIPVersion string
const (
	AttackLayer7SummaryMitigationProductParamsIPVersionIPv4 AttackLayer7SummaryMitigationProductParamsIPVersion = "IPv4"
	AttackLayer7SummaryMitigationProductParamsIPVersionIPv6 AttackLayer7SummaryMitigationProductParamsIPVersion = "IPv6"
)

func (AttackLayer7SummaryMitigationProductParamsIPVersion) IsKnown

type AttackLayer7SummaryMitigationProductResponse

type AttackLayer7SummaryMitigationProductResponse struct {
	Meta     AttackLayer7SummaryMitigationProductResponseMeta     `json:"meta,required"`
	Summary0 AttackLayer7SummaryMitigationProductResponseSummary0 `json:"summary_0,required"`
	JSON     attackLayer7SummaryMitigationProductResponseJSON     `json:"-"`
}

func (*AttackLayer7SummaryMitigationProductResponse) UnmarshalJSON

func (r *AttackLayer7SummaryMitigationProductResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryMitigationProductResponseEnvelope

type AttackLayer7SummaryMitigationProductResponseEnvelope struct {
	Result  AttackLayer7SummaryMitigationProductResponse             `json:"result,required"`
	Success bool                                                     `json:"success,required"`
	JSON    attackLayer7SummaryMitigationProductResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7SummaryMitigationProductResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7SummaryMitigationProductResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryMitigationProductResponseMeta

type AttackLayer7SummaryMitigationProductResponseMeta struct {
	DateRange      []AttackLayer7SummaryMitigationProductResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                         `json:"lastUpdated,required"`
	Normalization  string                                                         `json:"normalization,required"`
	ConfidenceInfo AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7SummaryMitigationProductResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7SummaryMitigationProductResponseMeta) UnmarshalJSON

func (r *AttackLayer7SummaryMitigationProductResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo

type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                      `json:"level"`
	JSON        attackLayer7SummaryMitigationProductResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation

type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                       `json:"dataSource,required"`
	Description     string                                                                       `json:"description,required"`
	EventType       string                                                                       `json:"eventType,required"`
	IsInstantaneous bool                                                                         `json:"isInstantaneous,required"`
	EndTime         time.Time                                                                    `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                       `json:"linkedUrl"`
	StartTime       time.Time                                                                    `json:"startTime" format:"date-time"`
	JSON            attackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7SummaryMitigationProductResponseMetaDateRange

type AttackLayer7SummaryMitigationProductResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                                     `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7SummaryMitigationProductResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7SummaryMitigationProductResponseMetaDateRange) UnmarshalJSON

type AttackLayer7SummaryMitigationProductResponseSummary0

type AttackLayer7SummaryMitigationProductResponseSummary0 struct {
	DDoS string                                                   `json:"DDOS,required"`
	WAF  string                                                   `json:"WAF,required"`
	JSON attackLayer7SummaryMitigationProductResponseSummary0JSON `json:"-"`
}

func (*AttackLayer7SummaryMitigationProductResponseSummary0) UnmarshalJSON

func (r *AttackLayer7SummaryMitigationProductResponseSummary0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7SummaryService

type AttackLayer7SummaryService struct {
	Options []option.RequestOption
}

AttackLayer7SummaryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer7SummaryService method instead.

func NewAttackLayer7SummaryService

func NewAttackLayer7SummaryService(opts ...option.RequestOption) (r *AttackLayer7SummaryService)

NewAttackLayer7SummaryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer7SummaryService) Get

Percentage distribution of mitigation techniques in Layer 7 attacks.

func (*AttackLayer7SummaryService) HTTPMethod

Percentage distribution of attacks by http method used.

func (*AttackLayer7SummaryService) HTTPVersion

Percentage distribution of attacks by http version used.

func (*AttackLayer7SummaryService) IPVersion

Percentage distribution of attacks by ip version used.

func (*AttackLayer7SummaryService) ManagedRules

Percentage distribution of attacks by managed rules used.

func (*AttackLayer7SummaryService) MitigationProduct

Percentage distribution of attacks by mitigation product used.

type AttackLayer7TimeseriesGroupGetParams

type AttackLayer7TimeseriesGroupGetParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupGetParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupGetParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7TimeseriesGroupGetParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupGetParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupGetParamsAggInterval

type AttackLayer7TimeseriesGroupGetParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupGetParamsAggInterval15m AttackLayer7TimeseriesGroupGetParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupGetParamsAggInterval1h  AttackLayer7TimeseriesGroupGetParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupGetParamsAggInterval1d  AttackLayer7TimeseriesGroupGetParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupGetParamsAggInterval1w  AttackLayer7TimeseriesGroupGetParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupGetParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupGetParamsFormat

type AttackLayer7TimeseriesGroupGetParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupGetParamsFormatJson AttackLayer7TimeseriesGroupGetParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupGetParamsFormatCsv  AttackLayer7TimeseriesGroupGetParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupGetParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupGetResponse

type AttackLayer7TimeseriesGroupGetResponse struct {
	Meta   AttackLayer7TimeseriesGroupGetResponseMeta   `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupGetResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupGetResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupGetResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupGetResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupGetResponseEnvelope

type AttackLayer7TimeseriesGroupGetResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupGetResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupGetResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupGetResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupGetResponseMeta

type AttackLayer7TimeseriesGroupGetResponseMeta struct {
	AggInterval    string                                                   `json:"aggInterval,required"`
	DateRange      []AttackLayer7TimeseriesGroupGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                                                `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TimeseriesGroupGetResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TimeseriesGroupGetResponseMeta) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfo

type AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                `json:"level"`
	JSON        attackLayer7TimeseriesGroupGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation

type AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                 `json:"dataSource,required"`
	Description     string                                                                 `json:"description,required"`
	EventType       string                                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                 `json:"linkedUrl"`
	StartTime       time.Time                                                              `json:"startTime" format:"date-time"`
	JSON            attackLayer7TimeseriesGroupGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TimeseriesGroupGetResponseMetaDateRange

type AttackLayer7TimeseriesGroupGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                               `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TimeseriesGroupGetResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupGetResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupGetResponseSerie0

type AttackLayer7TimeseriesGroupGetResponseSerie0 struct {
	AccessRules        []string                                         `json:"ACCESS_RULES,required"`
	APIShield          []string                                         `json:"API_SHIELD,required"`
	BotManagement      []string                                         `json:"BOT_MANAGEMENT,required"`
	DataLossPrevention []string                                         `json:"DATA_LOSS_PREVENTION,required"`
	DDoS               []string                                         `json:"DDOS,required"`
	IPReputation       []string                                         `json:"IP_REPUTATION,required"`
	Timestamps         []time.Time                                      `json:"timestamps,required" format:"date-time"`
	WAF                []string                                         `json:"WAF,required"`
	JSON               attackLayer7TimeseriesGroupGetResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupGetResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupGetResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupHTTPMethodParams

type AttackLayer7TimeseriesGroupHTTPMethodParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupHTTPMethodParamsFormat] `query:"format"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesGroupHTTPMethodParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupHTTPMethodParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval

type AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval15m AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval1h  AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval1d  AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval1w  AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupHTTPMethodParamsFormat

type AttackLayer7TimeseriesGroupHTTPMethodParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupHTTPMethodParamsFormatJson AttackLayer7TimeseriesGroupHTTPMethodParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupHTTPMethodParamsFormatCsv  AttackLayer7TimeseriesGroupHTTPMethodParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupHTTPMethodParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion

type AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion string
const (
	AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion = "HTTPv1"
	AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion = "HTTPv2"
	AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion) IsKnown

type AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion

type AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion string
const (
	AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersionIPv4 AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion = "IPv4"
	AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersionIPv6 AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion = "IPv6"
)

func (AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion) IsKnown

type AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct

type AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct string
const (
	AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProductDDoS               AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct = "DDOS"
	AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProductWAF                AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct = "WAF"
	AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProductBotManagement      AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProductAccessRules        AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProductIPReputation       AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProductAPIShield          AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProductDataLossPrevention AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct) IsKnown

type AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization

type AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesGroupHTTPMethodParamsNormalizationPercentage AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization = "PERCENTAGE"
	AttackLayer7TimeseriesGroupHTTPMethodParamsNormalizationMin0Max    AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization) IsKnown

type AttackLayer7TimeseriesGroupHTTPMethodResponse

type AttackLayer7TimeseriesGroupHTTPMethodResponse struct {
	Meta   interface{}                                         `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupHTTPMethodResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupHTTPMethodResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupHTTPMethodResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupHTTPMethodResponseEnvelope

type AttackLayer7TimeseriesGroupHTTPMethodResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupHTTPMethodResponse             `json:"result,required"`
	Success bool                                                      `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupHTTPMethodResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupHTTPMethodResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0

type AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0 struct {
	Get        []string                                                `json:"GET,required"`
	Timestamps []string                                                `json:"timestamps,required"`
	JSON       attackLayer7TimeseriesGroupHTTPMethodResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupHTTPVersionParams

type AttackLayer7TimeseriesGroupHTTPVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupHTTPVersionParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod] `query:"httpMethod"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesGroupHTTPVersionParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupHTTPVersionParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval

type AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval15m AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval1h  AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval1d  AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval1w  AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupHTTPVersionParamsFormat

type AttackLayer7TimeseriesGroupHTTPVersionParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupHTTPVersionParamsFormatJson AttackLayer7TimeseriesGroupHTTPVersionParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupHTTPVersionParamsFormatCsv  AttackLayer7TimeseriesGroupHTTPVersionParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupHTTPVersionParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod

type AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod string
const (
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodGet             AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "GET"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodPost            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "POST"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodDelete          AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "DELETE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodPut             AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "PUT"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodHead            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "HEAD"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodPurge           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "PURGE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodOptions         AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "OPTIONS"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodPropfind        AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "PROPFIND"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodMkcol           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "MKCOL"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodPatch           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "PATCH"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodACL             AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "ACL"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodBcopy           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "BCOPY"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodBdelete         AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "BDELETE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodBmove           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "BMOVE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodBpropfind       AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodBproppatch      AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodCheckin         AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "CHECKIN"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodCheckout        AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodConnect         AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "CONNECT"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodCopy            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "COPY"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodLabel           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "LABEL"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodLock            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "LOCK"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodMerge           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "MERGE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodMkactivity      AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodMkworkspace     AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodMove            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "MOVE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodNotify          AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "NOTIFY"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodOrderpatch      AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodPoll            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "POLL"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodProppatch       AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodReport          AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "REPORT"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodSearch          AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "SEARCH"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodSubscribe       AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodTrace           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "TRACE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodUncheckout      AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodUnlock          AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "UNLOCK"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodUnsubscribe     AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodUpdate          AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "UPDATE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodVersioncontrol  AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodBaselinecontrol AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodXmsenumatts     AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodRpcOutData      AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodRpcInData       AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodJson            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "JSON"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodCook            AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "COOK"
	AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethodTrack           AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod) IsKnown

type AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion

type AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion string
const (
	AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersionIPv4 AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion = "IPv4"
	AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersionIPv6 AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion = "IPv6"
)

func (AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion) IsKnown

type AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct

type AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct string
const (
	AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProductDDoS               AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct = "DDOS"
	AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProductWAF                AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct = "WAF"
	AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProductBotManagement      AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProductAccessRules        AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProductIPReputation       AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProductAPIShield          AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProductDataLossPrevention AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct) IsKnown

type AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization

type AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesGroupHTTPVersionParamsNormalizationPercentage AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization = "PERCENTAGE"
	AttackLayer7TimeseriesGroupHTTPVersionParamsNormalizationMin0Max    AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization) IsKnown

type AttackLayer7TimeseriesGroupHTTPVersionResponse

type AttackLayer7TimeseriesGroupHTTPVersionResponse struct {
	Meta   interface{}                                          `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupHTTPVersionResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupHTTPVersionResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupHTTPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupHTTPVersionResponseEnvelope

type AttackLayer7TimeseriesGroupHTTPVersionResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupHTTPVersionResponse             `json:"result,required"`
	Success bool                                                       `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupHTTPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupHTTPVersionResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0

type AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0 struct {
	HTTP1X     []string                                                 `json:"HTTP/1.x,required"`
	Timestamps []string                                                 `json:"timestamps,required"`
	JSON       attackLayer7TimeseriesGroupHTTPVersionResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupIPVersionParams

type AttackLayer7TimeseriesGroupIPVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupIPVersionParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupIPVersionParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion] `query:"httpVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesGroupIPVersionParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesGroupIPVersionParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupIPVersionParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupIPVersionParamsAggInterval

type AttackLayer7TimeseriesGroupIPVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupIPVersionParamsAggInterval15m AttackLayer7TimeseriesGroupIPVersionParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupIPVersionParamsAggInterval1h  AttackLayer7TimeseriesGroupIPVersionParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupIPVersionParamsAggInterval1d  AttackLayer7TimeseriesGroupIPVersionParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupIPVersionParamsAggInterval1w  AttackLayer7TimeseriesGroupIPVersionParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupIPVersionParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupIPVersionParamsFormat

type AttackLayer7TimeseriesGroupIPVersionParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupIPVersionParamsFormatJson AttackLayer7TimeseriesGroupIPVersionParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupIPVersionParamsFormatCsv  AttackLayer7TimeseriesGroupIPVersionParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupIPVersionParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod

type AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod string
const (
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodGet             AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "GET"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodPost            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "POST"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodDelete          AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "DELETE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodPut             AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "PUT"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodHead            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "HEAD"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodPurge           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "PURGE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodOptions         AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "OPTIONS"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodPropfind        AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "PROPFIND"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodMkcol           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "MKCOL"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodPatch           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "PATCH"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodACL             AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "ACL"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodBcopy           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "BCOPY"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodBdelete         AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "BDELETE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodBmove           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "BMOVE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodBpropfind       AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodBproppatch      AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodCheckin         AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "CHECKIN"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodCheckout        AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodConnect         AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "CONNECT"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodCopy            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "COPY"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodLabel           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "LABEL"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodLock            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "LOCK"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodMerge           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "MERGE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodMkactivity      AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodMkworkspace     AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodMove            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "MOVE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodNotify          AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "NOTIFY"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodOrderpatch      AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodPoll            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "POLL"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodProppatch       AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodReport          AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "REPORT"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodSearch          AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "SEARCH"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodSubscribe       AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodTrace           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "TRACE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodUncheckout      AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodUnlock          AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "UNLOCK"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodUnsubscribe     AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodUpdate          AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "UPDATE"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodVersioncontrol  AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodBaselinecontrol AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodXmsenumatts     AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodRpcOutData      AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodRpcInData       AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodJson            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "JSON"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodCook            AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "COOK"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethodTrack           AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod) IsKnown

type AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion

type AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion string
const (
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv1"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv2"
	AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion) IsKnown

type AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct

type AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct string
const (
	AttackLayer7TimeseriesGroupIPVersionParamsMitigationProductDDoS               AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct = "DDOS"
	AttackLayer7TimeseriesGroupIPVersionParamsMitigationProductWAF                AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct = "WAF"
	AttackLayer7TimeseriesGroupIPVersionParamsMitigationProductBotManagement      AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesGroupIPVersionParamsMitigationProductAccessRules        AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TimeseriesGroupIPVersionParamsMitigationProductIPReputation       AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TimeseriesGroupIPVersionParamsMitigationProductAPIShield          AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TimeseriesGroupIPVersionParamsMitigationProductDataLossPrevention AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct) IsKnown

type AttackLayer7TimeseriesGroupIPVersionParamsNormalization

type AttackLayer7TimeseriesGroupIPVersionParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesGroupIPVersionParamsNormalizationPercentage AttackLayer7TimeseriesGroupIPVersionParamsNormalization = "PERCENTAGE"
	AttackLayer7TimeseriesGroupIPVersionParamsNormalizationMin0Max    AttackLayer7TimeseriesGroupIPVersionParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesGroupIPVersionParamsNormalization) IsKnown

type AttackLayer7TimeseriesGroupIPVersionResponse

type AttackLayer7TimeseriesGroupIPVersionResponse struct {
	Meta   interface{}                                        `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupIPVersionResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupIPVersionResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupIPVersionResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupIPVersionResponseEnvelope

type AttackLayer7TimeseriesGroupIPVersionResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupIPVersionResponse             `json:"result,required"`
	Success bool                                                     `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupIPVersionResponseSerie0

type AttackLayer7TimeseriesGroupIPVersionResponseSerie0 struct {
	IPv4       []string                                               `json:"IPv4,required"`
	IPv6       []string                                               `json:"IPv6,required"`
	Timestamps []string                                               `json:"timestamps,required"`
	JSON       attackLayer7TimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupIndustryParams

type AttackLayer7TimeseriesGroupIndustryParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupIndustryParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupIndustryParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects (eg browsers, verticals, etc) to the top items over
	// the time range.
	LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesGroupIndustryParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesGroupIndustryParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupIndustryParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupIndustryParamsAggInterval

type AttackLayer7TimeseriesGroupIndustryParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupIndustryParamsAggInterval15m AttackLayer7TimeseriesGroupIndustryParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupIndustryParamsAggInterval1h  AttackLayer7TimeseriesGroupIndustryParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupIndustryParamsAggInterval1d  AttackLayer7TimeseriesGroupIndustryParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupIndustryParamsAggInterval1w  AttackLayer7TimeseriesGroupIndustryParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupIndustryParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupIndustryParamsFormat

type AttackLayer7TimeseriesGroupIndustryParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupIndustryParamsFormatJson AttackLayer7TimeseriesGroupIndustryParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupIndustryParamsFormatCsv  AttackLayer7TimeseriesGroupIndustryParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupIndustryParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod

type AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod string
const (
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodGet             AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "GET"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodPost            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "POST"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodDelete          AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "DELETE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodPut             AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "PUT"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodHead            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "HEAD"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodPurge           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "PURGE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodOptions         AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "OPTIONS"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodPropfind        AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "PROPFIND"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodMkcol           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "MKCOL"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodPatch           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "PATCH"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodACL             AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "ACL"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodBcopy           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "BCOPY"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodBdelete         AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "BDELETE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodBmove           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "BMOVE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodBpropfind       AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodBproppatch      AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodCheckin         AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "CHECKIN"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodCheckout        AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodConnect         AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "CONNECT"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodCopy            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "COPY"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodLabel           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "LABEL"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodLock            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "LOCK"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodMerge           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "MERGE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodMkactivity      AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodMkworkspace     AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodMove            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "MOVE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodNotify          AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "NOTIFY"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodOrderpatch      AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodPoll            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "POLL"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodProppatch       AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodReport          AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "REPORT"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodSearch          AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "SEARCH"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodSubscribe       AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodTrace           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "TRACE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodUncheckout      AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodUnlock          AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "UNLOCK"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodUnsubscribe     AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodUpdate          AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "UPDATE"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodVersioncontrol  AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodBaselinecontrol AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodXmsenumatts     AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodRpcOutData      AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodRpcInData       AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodJson            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "JSON"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodCook            AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "COOK"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPMethodTrack           AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod) IsKnown

type AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion

type AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion string
const (
	AttackLayer7TimeseriesGroupIndustryParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion = "HTTPv1"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion = "HTTPv2"
	AttackLayer7TimeseriesGroupIndustryParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion) IsKnown

type AttackLayer7TimeseriesGroupIndustryParamsIPVersion

type AttackLayer7TimeseriesGroupIndustryParamsIPVersion string
const (
	AttackLayer7TimeseriesGroupIndustryParamsIPVersionIPv4 AttackLayer7TimeseriesGroupIndustryParamsIPVersion = "IPv4"
	AttackLayer7TimeseriesGroupIndustryParamsIPVersionIPv6 AttackLayer7TimeseriesGroupIndustryParamsIPVersion = "IPv6"
)

func (AttackLayer7TimeseriesGroupIndustryParamsIPVersion) IsKnown

type AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct

type AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct string
const (
	AttackLayer7TimeseriesGroupIndustryParamsMitigationProductDDoS               AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct = "DDOS"
	AttackLayer7TimeseriesGroupIndustryParamsMitigationProductWAF                AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct = "WAF"
	AttackLayer7TimeseriesGroupIndustryParamsMitigationProductBotManagement      AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesGroupIndustryParamsMitigationProductAccessRules        AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TimeseriesGroupIndustryParamsMitigationProductIPReputation       AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TimeseriesGroupIndustryParamsMitigationProductAPIShield          AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TimeseriesGroupIndustryParamsMitigationProductDataLossPrevention AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct) IsKnown

type AttackLayer7TimeseriesGroupIndustryParamsNormalization

type AttackLayer7TimeseriesGroupIndustryParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesGroupIndustryParamsNormalizationPercentage AttackLayer7TimeseriesGroupIndustryParamsNormalization = "PERCENTAGE"
	AttackLayer7TimeseriesGroupIndustryParamsNormalizationMin0Max    AttackLayer7TimeseriesGroupIndustryParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesGroupIndustryParamsNormalization) IsKnown

type AttackLayer7TimeseriesGroupIndustryResponse

type AttackLayer7TimeseriesGroupIndustryResponse struct {
	Meta   interface{}                                       `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupIndustryResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupIndustryResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupIndustryResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupIndustryResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupIndustryResponseEnvelope

type AttackLayer7TimeseriesGroupIndustryResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupIndustryResponse             `json:"result,required"`
	Success bool                                                    `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupIndustryResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupIndustryResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupIndustryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupIndustryResponseSerie0

type AttackLayer7TimeseriesGroupIndustryResponseSerie0 struct {
	Timestamps  []string                                              `json:"timestamps,required"`
	ExtraFields map[string][]string                                   `json:"-,extras"`
	JSON        attackLayer7TimeseriesGroupIndustryResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupIndustryResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupIndustryResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupManagedRulesParams

type AttackLayer7TimeseriesGroupManagedRulesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupManagedRulesParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesGroupManagedRulesParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesGroupManagedRulesParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupManagedRulesParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval

type AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval15m AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval1h  AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval1d  AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval1w  AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupManagedRulesParamsFormat

type AttackLayer7TimeseriesGroupManagedRulesParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupManagedRulesParamsFormatJson AttackLayer7TimeseriesGroupManagedRulesParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupManagedRulesParamsFormatCsv  AttackLayer7TimeseriesGroupManagedRulesParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupManagedRulesParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod

type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod string
const (
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodGet             AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "GET"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodPost            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "POST"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodDelete          AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "DELETE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodPut             AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "PUT"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodHead            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "HEAD"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodPurge           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "PURGE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodOptions         AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "OPTIONS"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodPropfind        AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "PROPFIND"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodMkcol           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "MKCOL"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodPatch           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "PATCH"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodACL             AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "ACL"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodBcopy           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "BCOPY"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodBdelete         AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "BDELETE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodBmove           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "BMOVE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodBpropfind       AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodBproppatch      AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodCheckin         AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "CHECKIN"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodCheckout        AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodConnect         AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "CONNECT"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodCopy            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "COPY"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodLabel           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "LABEL"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodLock            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "LOCK"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodMerge           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "MERGE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodMkactivity      AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodMkworkspace     AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodMove            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "MOVE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodNotify          AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "NOTIFY"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodOrderpatch      AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodPoll            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "POLL"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodProppatch       AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodReport          AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "REPORT"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodSearch          AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "SEARCH"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodSubscribe       AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodTrace           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "TRACE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodUncheckout      AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodUnlock          AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "UNLOCK"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodUnsubscribe     AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodUpdate          AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "UPDATE"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodVersioncontrol  AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodBaselinecontrol AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodXmsenumatts     AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodRpcOutData      AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodRpcInData       AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodJson            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "JSON"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodCook            AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "COOK"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethodTrack           AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod) IsKnown

type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion

type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion string
const (
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion = "HTTPv1"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion = "HTTPv2"
	AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion) IsKnown

type AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion

type AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion string
const (
	AttackLayer7TimeseriesGroupManagedRulesParamsIPVersionIPv4 AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion = "IPv4"
	AttackLayer7TimeseriesGroupManagedRulesParamsIPVersionIPv6 AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion = "IPv6"
)

func (AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion) IsKnown

type AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct

type AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct string
const (
	AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProductDDoS               AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct = "DDOS"
	AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProductWAF                AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct = "WAF"
	AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProductBotManagement      AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProductAccessRules        AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProductIPReputation       AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProductAPIShield          AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProductDataLossPrevention AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct) IsKnown

type AttackLayer7TimeseriesGroupManagedRulesParamsNormalization

type AttackLayer7TimeseriesGroupManagedRulesParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesGroupManagedRulesParamsNormalizationPercentage AttackLayer7TimeseriesGroupManagedRulesParamsNormalization = "PERCENTAGE"
	AttackLayer7TimeseriesGroupManagedRulesParamsNormalizationMin0Max    AttackLayer7TimeseriesGroupManagedRulesParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesGroupManagedRulesParamsNormalization) IsKnown

type AttackLayer7TimeseriesGroupManagedRulesResponse

type AttackLayer7TimeseriesGroupManagedRulesResponse struct {
	Meta   interface{}                                           `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupManagedRulesResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupManagedRulesResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupManagedRulesResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupManagedRulesResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupManagedRulesResponseEnvelope

type AttackLayer7TimeseriesGroupManagedRulesResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupManagedRulesResponse             `json:"result,required"`
	Success bool                                                        `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupManagedRulesResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupManagedRulesResponseEnvelope) UnmarshalJSON

type AttackLayer7TimeseriesGroupManagedRulesResponseSerie0

type AttackLayer7TimeseriesGroupManagedRulesResponseSerie0 struct {
	Bot        []string                                                  `json:"Bot,required"`
	Timestamps []string                                                  `json:"timestamps,required"`
	JSON       attackLayer7TimeseriesGroupManagedRulesResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupManagedRulesResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupManagedRulesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupMitigationProductParams

type AttackLayer7TimeseriesGroupMitigationProductParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupMitigationProductParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesGroupMitigationProductParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesGroupMitigationProductParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupMitigationProductParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval

type AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval15m AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval1h  AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval1d  AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval1w  AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupMitigationProductParamsFormat

type AttackLayer7TimeseriesGroupMitigationProductParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupMitigationProductParamsFormatJson AttackLayer7TimeseriesGroupMitigationProductParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupMitigationProductParamsFormatCsv  AttackLayer7TimeseriesGroupMitigationProductParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupMitigationProductParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod

type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod string
const (
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodGet             AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "GET"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodPost            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "POST"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodDelete          AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "DELETE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodPut             AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "PUT"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodHead            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "HEAD"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodPurge           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "PURGE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodOptions         AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "OPTIONS"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodPropfind        AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "PROPFIND"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodMkcol           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "MKCOL"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodPatch           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "PATCH"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodACL             AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "ACL"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodBcopy           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "BCOPY"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodBdelete         AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "BDELETE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodBmove           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "BMOVE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodBpropfind       AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodBproppatch      AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodCheckin         AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "CHECKIN"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodCheckout        AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodConnect         AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "CONNECT"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodCopy            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "COPY"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodLabel           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "LABEL"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodLock            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "LOCK"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodMerge           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "MERGE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodMkactivity      AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodMkworkspace     AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodMove            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "MOVE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodNotify          AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "NOTIFY"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodOrderpatch      AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodPoll            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "POLL"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodProppatch       AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodReport          AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "REPORT"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodSearch          AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "SEARCH"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodSubscribe       AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodTrace           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "TRACE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodUncheckout      AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodUnlock          AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "UNLOCK"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodUnsubscribe     AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodUpdate          AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "UPDATE"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodVersioncontrol  AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodBaselinecontrol AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodXmsenumatts     AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodRpcOutData      AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodRpcInData       AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodJson            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "JSON"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodCook            AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "COOK"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethodTrack           AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod) IsKnown

type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion

type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion string
const (
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion = "HTTPv1"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion = "HTTPv2"
	AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion) IsKnown

type AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion

type AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion string
const (
	AttackLayer7TimeseriesGroupMitigationProductParamsIPVersionIPv4 AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion = "IPv4"
	AttackLayer7TimeseriesGroupMitigationProductParamsIPVersionIPv6 AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion = "IPv6"
)

func (AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion) IsKnown

type AttackLayer7TimeseriesGroupMitigationProductParamsNormalization

type AttackLayer7TimeseriesGroupMitigationProductParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesGroupMitigationProductParamsNormalizationPercentage AttackLayer7TimeseriesGroupMitigationProductParamsNormalization = "PERCENTAGE"
	AttackLayer7TimeseriesGroupMitigationProductParamsNormalizationMin0Max    AttackLayer7TimeseriesGroupMitigationProductParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesGroupMitigationProductParamsNormalization) IsKnown

type AttackLayer7TimeseriesGroupMitigationProductResponse

type AttackLayer7TimeseriesGroupMitigationProductResponse struct {
	Meta   interface{}                                                `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupMitigationProductResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupMitigationProductResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupMitigationProductResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupMitigationProductResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupMitigationProductResponseEnvelope

type AttackLayer7TimeseriesGroupMitigationProductResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupMitigationProductResponse             `json:"result,required"`
	Success bool                                                             `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupMitigationProductResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupMitigationProductResponseEnvelope) UnmarshalJSON

type AttackLayer7TimeseriesGroupMitigationProductResponseSerie0

type AttackLayer7TimeseriesGroupMitigationProductResponseSerie0 struct {
	DDoS       []string                                                       `json:"DDOS,required"`
	Timestamps []string                                                       `json:"timestamps,required"`
	JSON       attackLayer7TimeseriesGroupMitigationProductResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupMitigationProductResponseSerie0) UnmarshalJSON

type AttackLayer7TimeseriesGroupService

type AttackLayer7TimeseriesGroupService struct {
	Options []option.RequestOption
}

AttackLayer7TimeseriesGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer7TimeseriesGroupService method instead.

func NewAttackLayer7TimeseriesGroupService

func NewAttackLayer7TimeseriesGroupService(opts ...option.RequestOption) (r *AttackLayer7TimeseriesGroupService)

NewAttackLayer7TimeseriesGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer7TimeseriesGroupService) Get

Get a time series of the distribution of mitigation techniques over time.

func (*AttackLayer7TimeseriesGroupService) HTTPMethod

Percentage distribution of attacks by http method used over time.

func (*AttackLayer7TimeseriesGroupService) HTTPVersion

Percentage distribution of attacks by http version used over time.

func (*AttackLayer7TimeseriesGroupService) IPVersion

Percentage distribution of attacks by ip version used over time.

func (*AttackLayer7TimeseriesGroupService) Industry

Percentage distribution of attacks by targeted industry over time.

func (*AttackLayer7TimeseriesGroupService) ManagedRules

Percentage distribution of attacks by managed rules used over time.

func (*AttackLayer7TimeseriesGroupService) MitigationProduct

Percentage distribution of attacks by mitigation product used over time.

func (*AttackLayer7TimeseriesGroupService) Vertical

Percentage distribution of attacks by targeted vertical over time.

type AttackLayer7TimeseriesGroupVerticalParams

type AttackLayer7TimeseriesGroupVerticalParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesGroupVerticalParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesGroupVerticalParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects (eg browsers, verticals, etc) to the top items over
	// the time range.
	LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesGroupVerticalParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesGroupVerticalParams) URLQuery

URLQuery serializes AttackLayer7TimeseriesGroupVerticalParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesGroupVerticalParamsAggInterval

type AttackLayer7TimeseriesGroupVerticalParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesGroupVerticalParamsAggInterval15m AttackLayer7TimeseriesGroupVerticalParamsAggInterval = "15m"
	AttackLayer7TimeseriesGroupVerticalParamsAggInterval1h  AttackLayer7TimeseriesGroupVerticalParamsAggInterval = "1h"
	AttackLayer7TimeseriesGroupVerticalParamsAggInterval1d  AttackLayer7TimeseriesGroupVerticalParamsAggInterval = "1d"
	AttackLayer7TimeseriesGroupVerticalParamsAggInterval1w  AttackLayer7TimeseriesGroupVerticalParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesGroupVerticalParamsAggInterval) IsKnown

type AttackLayer7TimeseriesGroupVerticalParamsFormat

type AttackLayer7TimeseriesGroupVerticalParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesGroupVerticalParamsFormatJson AttackLayer7TimeseriesGroupVerticalParamsFormat = "JSON"
	AttackLayer7TimeseriesGroupVerticalParamsFormatCsv  AttackLayer7TimeseriesGroupVerticalParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesGroupVerticalParamsFormat) IsKnown

type AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod

type AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod string
const (
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodGet             AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "GET"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodPost            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "POST"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodDelete          AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "DELETE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodPut             AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "PUT"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodHead            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "HEAD"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodPurge           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "PURGE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodOptions         AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "OPTIONS"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodPropfind        AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "PROPFIND"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodMkcol           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "MKCOL"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodPatch           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "PATCH"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodACL             AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "ACL"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodBcopy           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "BCOPY"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodBdelete         AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "BDELETE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodBmove           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "BMOVE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodBpropfind       AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodBproppatch      AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodCheckin         AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "CHECKIN"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodCheckout        AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodConnect         AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "CONNECT"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodCopy            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "COPY"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodLabel           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "LABEL"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodLock            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "LOCK"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodMerge           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "MERGE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodMkactivity      AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodMkworkspace     AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodMove            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "MOVE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodNotify          AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "NOTIFY"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodOrderpatch      AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodPoll            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "POLL"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodProppatch       AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodReport          AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "REPORT"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodSearch          AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "SEARCH"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodSubscribe       AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodTrace           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "TRACE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodUncheckout      AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodUnlock          AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "UNLOCK"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodUnsubscribe     AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodUpdate          AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "UPDATE"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodVersioncontrol  AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodBaselinecontrol AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodXmsenumatts     AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodRpcOutData      AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodRpcInData       AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodJson            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "JSON"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodCook            AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "COOK"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPMethodTrack           AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod) IsKnown

type AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion

type AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion string
const (
	AttackLayer7TimeseriesGroupVerticalParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion = "HTTPv1"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion = "HTTPv2"
	AttackLayer7TimeseriesGroupVerticalParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion) IsKnown

type AttackLayer7TimeseriesGroupVerticalParamsIPVersion

type AttackLayer7TimeseriesGroupVerticalParamsIPVersion string
const (
	AttackLayer7TimeseriesGroupVerticalParamsIPVersionIPv4 AttackLayer7TimeseriesGroupVerticalParamsIPVersion = "IPv4"
	AttackLayer7TimeseriesGroupVerticalParamsIPVersionIPv6 AttackLayer7TimeseriesGroupVerticalParamsIPVersion = "IPv6"
)

func (AttackLayer7TimeseriesGroupVerticalParamsIPVersion) IsKnown

type AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct

type AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct string
const (
	AttackLayer7TimeseriesGroupVerticalParamsMitigationProductDDoS               AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct = "DDOS"
	AttackLayer7TimeseriesGroupVerticalParamsMitigationProductWAF                AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct = "WAF"
	AttackLayer7TimeseriesGroupVerticalParamsMitigationProductBotManagement      AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesGroupVerticalParamsMitigationProductAccessRules        AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TimeseriesGroupVerticalParamsMitigationProductIPReputation       AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TimeseriesGroupVerticalParamsMitigationProductAPIShield          AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TimeseriesGroupVerticalParamsMitigationProductDataLossPrevention AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct) IsKnown

type AttackLayer7TimeseriesGroupVerticalParamsNormalization

type AttackLayer7TimeseriesGroupVerticalParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesGroupVerticalParamsNormalizationPercentage AttackLayer7TimeseriesGroupVerticalParamsNormalization = "PERCENTAGE"
	AttackLayer7TimeseriesGroupVerticalParamsNormalizationMin0Max    AttackLayer7TimeseriesGroupVerticalParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesGroupVerticalParamsNormalization) IsKnown

type AttackLayer7TimeseriesGroupVerticalResponse

type AttackLayer7TimeseriesGroupVerticalResponse struct {
	Meta   interface{}                                       `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesGroupVerticalResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesGroupVerticalResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesGroupVerticalResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupVerticalResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupVerticalResponseEnvelope

type AttackLayer7TimeseriesGroupVerticalResponseEnvelope struct {
	Result  AttackLayer7TimeseriesGroupVerticalResponse             `json:"result,required"`
	Success bool                                                    `json:"success,required"`
	JSON    attackLayer7TimeseriesGroupVerticalResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupVerticalResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupVerticalResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesGroupVerticalResponseSerie0

type AttackLayer7TimeseriesGroupVerticalResponseSerie0 struct {
	Timestamps  []string                                              `json:"timestamps,required"`
	ExtraFields map[string][]string                                   `json:"-,extras"`
	JSON        attackLayer7TimeseriesGroupVerticalResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesGroupVerticalResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesGroupVerticalResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesParams

type AttackLayer7TimeseriesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[AttackLayer7TimeseriesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// This field is deprecated, please use the new `mitigationProduct`.
	Attack param.Field[[]AttackLayer7TimeseriesParamsAttack] `query:"attack"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TimeseriesParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TimeseriesParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TimeseriesParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TimeseriesParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TimeseriesParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TimeseriesParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TimeseriesParams) URLQuery

func (r AttackLayer7TimeseriesParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer7TimeseriesParams's query parameters as `url.Values`.

type AttackLayer7TimeseriesParamsAggInterval

type AttackLayer7TimeseriesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	AttackLayer7TimeseriesParamsAggInterval15m AttackLayer7TimeseriesParamsAggInterval = "15m"
	AttackLayer7TimeseriesParamsAggInterval1h  AttackLayer7TimeseriesParamsAggInterval = "1h"
	AttackLayer7TimeseriesParamsAggInterval1d  AttackLayer7TimeseriesParamsAggInterval = "1d"
	AttackLayer7TimeseriesParamsAggInterval1w  AttackLayer7TimeseriesParamsAggInterval = "1w"
)

func (AttackLayer7TimeseriesParamsAggInterval) IsKnown

type AttackLayer7TimeseriesParamsAttack

type AttackLayer7TimeseriesParamsAttack string
const (
	AttackLayer7TimeseriesParamsAttackDDoS               AttackLayer7TimeseriesParamsAttack = "DDOS"
	AttackLayer7TimeseriesParamsAttackWAF                AttackLayer7TimeseriesParamsAttack = "WAF"
	AttackLayer7TimeseriesParamsAttackBotManagement      AttackLayer7TimeseriesParamsAttack = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesParamsAttackAccessRules        AttackLayer7TimeseriesParamsAttack = "ACCESS_RULES"
	AttackLayer7TimeseriesParamsAttackIPReputation       AttackLayer7TimeseriesParamsAttack = "IP_REPUTATION"
	AttackLayer7TimeseriesParamsAttackAPIShield          AttackLayer7TimeseriesParamsAttack = "API_SHIELD"
	AttackLayer7TimeseriesParamsAttackDataLossPrevention AttackLayer7TimeseriesParamsAttack = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesParamsAttack) IsKnown

type AttackLayer7TimeseriesParamsFormat

type AttackLayer7TimeseriesParamsFormat string

Format results are returned in.

const (
	AttackLayer7TimeseriesParamsFormatJson AttackLayer7TimeseriesParamsFormat = "JSON"
	AttackLayer7TimeseriesParamsFormatCsv  AttackLayer7TimeseriesParamsFormat = "CSV"
)

func (AttackLayer7TimeseriesParamsFormat) IsKnown

type AttackLayer7TimeseriesParamsHTTPMethod

type AttackLayer7TimeseriesParamsHTTPMethod string
const (
	AttackLayer7TimeseriesParamsHTTPMethodGet             AttackLayer7TimeseriesParamsHTTPMethod = "GET"
	AttackLayer7TimeseriesParamsHTTPMethodPost            AttackLayer7TimeseriesParamsHTTPMethod = "POST"
	AttackLayer7TimeseriesParamsHTTPMethodDelete          AttackLayer7TimeseriesParamsHTTPMethod = "DELETE"
	AttackLayer7TimeseriesParamsHTTPMethodPut             AttackLayer7TimeseriesParamsHTTPMethod = "PUT"
	AttackLayer7TimeseriesParamsHTTPMethodHead            AttackLayer7TimeseriesParamsHTTPMethod = "HEAD"
	AttackLayer7TimeseriesParamsHTTPMethodPurge           AttackLayer7TimeseriesParamsHTTPMethod = "PURGE"
	AttackLayer7TimeseriesParamsHTTPMethodOptions         AttackLayer7TimeseriesParamsHTTPMethod = "OPTIONS"
	AttackLayer7TimeseriesParamsHTTPMethodPropfind        AttackLayer7TimeseriesParamsHTTPMethod = "PROPFIND"
	AttackLayer7TimeseriesParamsHTTPMethodMkcol           AttackLayer7TimeseriesParamsHTTPMethod = "MKCOL"
	AttackLayer7TimeseriesParamsHTTPMethodPatch           AttackLayer7TimeseriesParamsHTTPMethod = "PATCH"
	AttackLayer7TimeseriesParamsHTTPMethodACL             AttackLayer7TimeseriesParamsHTTPMethod = "ACL"
	AttackLayer7TimeseriesParamsHTTPMethodBcopy           AttackLayer7TimeseriesParamsHTTPMethod = "BCOPY"
	AttackLayer7TimeseriesParamsHTTPMethodBdelete         AttackLayer7TimeseriesParamsHTTPMethod = "BDELETE"
	AttackLayer7TimeseriesParamsHTTPMethodBmove           AttackLayer7TimeseriesParamsHTTPMethod = "BMOVE"
	AttackLayer7TimeseriesParamsHTTPMethodBpropfind       AttackLayer7TimeseriesParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TimeseriesParamsHTTPMethodBproppatch      AttackLayer7TimeseriesParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TimeseriesParamsHTTPMethodCheckin         AttackLayer7TimeseriesParamsHTTPMethod = "CHECKIN"
	AttackLayer7TimeseriesParamsHTTPMethodCheckout        AttackLayer7TimeseriesParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TimeseriesParamsHTTPMethodConnect         AttackLayer7TimeseriesParamsHTTPMethod = "CONNECT"
	AttackLayer7TimeseriesParamsHTTPMethodCopy            AttackLayer7TimeseriesParamsHTTPMethod = "COPY"
	AttackLayer7TimeseriesParamsHTTPMethodLabel           AttackLayer7TimeseriesParamsHTTPMethod = "LABEL"
	AttackLayer7TimeseriesParamsHTTPMethodLock            AttackLayer7TimeseriesParamsHTTPMethod = "LOCK"
	AttackLayer7TimeseriesParamsHTTPMethodMerge           AttackLayer7TimeseriesParamsHTTPMethod = "MERGE"
	AttackLayer7TimeseriesParamsHTTPMethodMkactivity      AttackLayer7TimeseriesParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TimeseriesParamsHTTPMethodMkworkspace     AttackLayer7TimeseriesParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TimeseriesParamsHTTPMethodMove            AttackLayer7TimeseriesParamsHTTPMethod = "MOVE"
	AttackLayer7TimeseriesParamsHTTPMethodNotify          AttackLayer7TimeseriesParamsHTTPMethod = "NOTIFY"
	AttackLayer7TimeseriesParamsHTTPMethodOrderpatch      AttackLayer7TimeseriesParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TimeseriesParamsHTTPMethodPoll            AttackLayer7TimeseriesParamsHTTPMethod = "POLL"
	AttackLayer7TimeseriesParamsHTTPMethodProppatch       AttackLayer7TimeseriesParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TimeseriesParamsHTTPMethodReport          AttackLayer7TimeseriesParamsHTTPMethod = "REPORT"
	AttackLayer7TimeseriesParamsHTTPMethodSearch          AttackLayer7TimeseriesParamsHTTPMethod = "SEARCH"
	AttackLayer7TimeseriesParamsHTTPMethodSubscribe       AttackLayer7TimeseriesParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TimeseriesParamsHTTPMethodTrace           AttackLayer7TimeseriesParamsHTTPMethod = "TRACE"
	AttackLayer7TimeseriesParamsHTTPMethodUncheckout      AttackLayer7TimeseriesParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TimeseriesParamsHTTPMethodUnlock          AttackLayer7TimeseriesParamsHTTPMethod = "UNLOCK"
	AttackLayer7TimeseriesParamsHTTPMethodUnsubscribe     AttackLayer7TimeseriesParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TimeseriesParamsHTTPMethodUpdate          AttackLayer7TimeseriesParamsHTTPMethod = "UPDATE"
	AttackLayer7TimeseriesParamsHTTPMethodVersioncontrol  AttackLayer7TimeseriesParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TimeseriesParamsHTTPMethodBaselinecontrol AttackLayer7TimeseriesParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TimeseriesParamsHTTPMethodXmsenumatts     AttackLayer7TimeseriesParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TimeseriesParamsHTTPMethodRpcOutData      AttackLayer7TimeseriesParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TimeseriesParamsHTTPMethodRpcInData       AttackLayer7TimeseriesParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TimeseriesParamsHTTPMethodJson            AttackLayer7TimeseriesParamsHTTPMethod = "JSON"
	AttackLayer7TimeseriesParamsHTTPMethodCook            AttackLayer7TimeseriesParamsHTTPMethod = "COOK"
	AttackLayer7TimeseriesParamsHTTPMethodTrack           AttackLayer7TimeseriesParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TimeseriesParamsHTTPMethod) IsKnown

type AttackLayer7TimeseriesParamsHTTPVersion

type AttackLayer7TimeseriesParamsHTTPVersion string
const (
	AttackLayer7TimeseriesParamsHTTPVersionHttPv1 AttackLayer7TimeseriesParamsHTTPVersion = "HTTPv1"
	AttackLayer7TimeseriesParamsHTTPVersionHttPv2 AttackLayer7TimeseriesParamsHTTPVersion = "HTTPv2"
	AttackLayer7TimeseriesParamsHTTPVersionHttPv3 AttackLayer7TimeseriesParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TimeseriesParamsHTTPVersion) IsKnown

type AttackLayer7TimeseriesParamsIPVersion

type AttackLayer7TimeseriesParamsIPVersion string
const (
	AttackLayer7TimeseriesParamsIPVersionIPv4 AttackLayer7TimeseriesParamsIPVersion = "IPv4"
	AttackLayer7TimeseriesParamsIPVersionIPv6 AttackLayer7TimeseriesParamsIPVersion = "IPv6"
)

func (AttackLayer7TimeseriesParamsIPVersion) IsKnown

type AttackLayer7TimeseriesParamsMitigationProduct

type AttackLayer7TimeseriesParamsMitigationProduct string
const (
	AttackLayer7TimeseriesParamsMitigationProductDDoS               AttackLayer7TimeseriesParamsMitigationProduct = "DDOS"
	AttackLayer7TimeseriesParamsMitigationProductWAF                AttackLayer7TimeseriesParamsMitigationProduct = "WAF"
	AttackLayer7TimeseriesParamsMitigationProductBotManagement      AttackLayer7TimeseriesParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TimeseriesParamsMitigationProductAccessRules        AttackLayer7TimeseriesParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TimeseriesParamsMitigationProductIPReputation       AttackLayer7TimeseriesParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TimeseriesParamsMitigationProductAPIShield          AttackLayer7TimeseriesParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TimeseriesParamsMitigationProductDataLossPrevention AttackLayer7TimeseriesParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TimeseriesParamsMitigationProduct) IsKnown

type AttackLayer7TimeseriesParamsNormalization

type AttackLayer7TimeseriesParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TimeseriesParamsNormalizationPercentageChange AttackLayer7TimeseriesParamsNormalization = "PERCENTAGE_CHANGE"
	AttackLayer7TimeseriesParamsNormalizationMin0Max          AttackLayer7TimeseriesParamsNormalization = "MIN0_MAX"
)

func (AttackLayer7TimeseriesParamsNormalization) IsKnown

type AttackLayer7TimeseriesResponse

type AttackLayer7TimeseriesResponse struct {
	Meta   AttackLayer7TimeseriesResponseMeta   `json:"meta,required"`
	Serie0 AttackLayer7TimeseriesResponseSerie0 `json:"serie_0,required"`
	JSON   attackLayer7TimeseriesResponseJSON   `json:"-"`
}

func (*AttackLayer7TimeseriesResponse) UnmarshalJSON

func (r *AttackLayer7TimeseriesResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesResponseEnvelope

type AttackLayer7TimeseriesResponseEnvelope struct {
	Result  AttackLayer7TimeseriesResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    attackLayer7TimeseriesResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesResponseMeta

type AttackLayer7TimeseriesResponseMeta struct {
	AggInterval    string                                           `json:"aggInterval,required"`
	DateRange      []AttackLayer7TimeseriesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                                        `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo AttackLayer7TimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TimeseriesResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TimeseriesResponseMeta) UnmarshalJSON

func (r *AttackLayer7TimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesResponseMetaConfidenceInfo

type AttackLayer7TimeseriesResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        attackLayer7TimeseriesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TimeseriesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer7TimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation

type AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            attackLayer7TimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TimeseriesResponseMetaDateRange

type AttackLayer7TimeseriesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TimeseriesResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TimeseriesResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TimeseriesResponseSerie0

type AttackLayer7TimeseriesResponseSerie0 struct {
	Timestamps []time.Time                              `json:"timestamps,required" format:"date-time"`
	Values     []string                                 `json:"values,required"`
	JSON       attackLayer7TimeseriesResponseSerie0JSON `json:"-"`
}

func (*AttackLayer7TimeseriesResponseSerie0) UnmarshalJSON

func (r *AttackLayer7TimeseriesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAseOriginParams

type AttackLayer7TopAseOriginParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TopAseOriginParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TopAseOriginParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TopAseOriginParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TopAseOriginParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TopAseOriginParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7TopAseOriginParams) URLQuery

func (r AttackLayer7TopAseOriginParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer7TopAseOriginParams's query parameters as `url.Values`.

type AttackLayer7TopAseOriginParamsFormat

type AttackLayer7TopAseOriginParamsFormat string

Format results are returned in.

const (
	AttackLayer7TopAseOriginParamsFormatJson AttackLayer7TopAseOriginParamsFormat = "JSON"
	AttackLayer7TopAseOriginParamsFormatCsv  AttackLayer7TopAseOriginParamsFormat = "CSV"
)

func (AttackLayer7TopAseOriginParamsFormat) IsKnown

type AttackLayer7TopAseOriginParamsHTTPMethod

type AttackLayer7TopAseOriginParamsHTTPMethod string
const (
	AttackLayer7TopAseOriginParamsHTTPMethodGet             AttackLayer7TopAseOriginParamsHTTPMethod = "GET"
	AttackLayer7TopAseOriginParamsHTTPMethodPost            AttackLayer7TopAseOriginParamsHTTPMethod = "POST"
	AttackLayer7TopAseOriginParamsHTTPMethodDelete          AttackLayer7TopAseOriginParamsHTTPMethod = "DELETE"
	AttackLayer7TopAseOriginParamsHTTPMethodPut             AttackLayer7TopAseOriginParamsHTTPMethod = "PUT"
	AttackLayer7TopAseOriginParamsHTTPMethodHead            AttackLayer7TopAseOriginParamsHTTPMethod = "HEAD"
	AttackLayer7TopAseOriginParamsHTTPMethodPurge           AttackLayer7TopAseOriginParamsHTTPMethod = "PURGE"
	AttackLayer7TopAseOriginParamsHTTPMethodOptions         AttackLayer7TopAseOriginParamsHTTPMethod = "OPTIONS"
	AttackLayer7TopAseOriginParamsHTTPMethodPropfind        AttackLayer7TopAseOriginParamsHTTPMethod = "PROPFIND"
	AttackLayer7TopAseOriginParamsHTTPMethodMkcol           AttackLayer7TopAseOriginParamsHTTPMethod = "MKCOL"
	AttackLayer7TopAseOriginParamsHTTPMethodPatch           AttackLayer7TopAseOriginParamsHTTPMethod = "PATCH"
	AttackLayer7TopAseOriginParamsHTTPMethodACL             AttackLayer7TopAseOriginParamsHTTPMethod = "ACL"
	AttackLayer7TopAseOriginParamsHTTPMethodBcopy           AttackLayer7TopAseOriginParamsHTTPMethod = "BCOPY"
	AttackLayer7TopAseOriginParamsHTTPMethodBdelete         AttackLayer7TopAseOriginParamsHTTPMethod = "BDELETE"
	AttackLayer7TopAseOriginParamsHTTPMethodBmove           AttackLayer7TopAseOriginParamsHTTPMethod = "BMOVE"
	AttackLayer7TopAseOriginParamsHTTPMethodBpropfind       AttackLayer7TopAseOriginParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TopAseOriginParamsHTTPMethodBproppatch      AttackLayer7TopAseOriginParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TopAseOriginParamsHTTPMethodCheckin         AttackLayer7TopAseOriginParamsHTTPMethod = "CHECKIN"
	AttackLayer7TopAseOriginParamsHTTPMethodCheckout        AttackLayer7TopAseOriginParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TopAseOriginParamsHTTPMethodConnect         AttackLayer7TopAseOriginParamsHTTPMethod = "CONNECT"
	AttackLayer7TopAseOriginParamsHTTPMethodCopy            AttackLayer7TopAseOriginParamsHTTPMethod = "COPY"
	AttackLayer7TopAseOriginParamsHTTPMethodLabel           AttackLayer7TopAseOriginParamsHTTPMethod = "LABEL"
	AttackLayer7TopAseOriginParamsHTTPMethodLock            AttackLayer7TopAseOriginParamsHTTPMethod = "LOCK"
	AttackLayer7TopAseOriginParamsHTTPMethodMerge           AttackLayer7TopAseOriginParamsHTTPMethod = "MERGE"
	AttackLayer7TopAseOriginParamsHTTPMethodMkactivity      AttackLayer7TopAseOriginParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TopAseOriginParamsHTTPMethodMkworkspace     AttackLayer7TopAseOriginParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TopAseOriginParamsHTTPMethodMove            AttackLayer7TopAseOriginParamsHTTPMethod = "MOVE"
	AttackLayer7TopAseOriginParamsHTTPMethodNotify          AttackLayer7TopAseOriginParamsHTTPMethod = "NOTIFY"
	AttackLayer7TopAseOriginParamsHTTPMethodOrderpatch      AttackLayer7TopAseOriginParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TopAseOriginParamsHTTPMethodPoll            AttackLayer7TopAseOriginParamsHTTPMethod = "POLL"
	AttackLayer7TopAseOriginParamsHTTPMethodProppatch       AttackLayer7TopAseOriginParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TopAseOriginParamsHTTPMethodReport          AttackLayer7TopAseOriginParamsHTTPMethod = "REPORT"
	AttackLayer7TopAseOriginParamsHTTPMethodSearch          AttackLayer7TopAseOriginParamsHTTPMethod = "SEARCH"
	AttackLayer7TopAseOriginParamsHTTPMethodSubscribe       AttackLayer7TopAseOriginParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TopAseOriginParamsHTTPMethodTrace           AttackLayer7TopAseOriginParamsHTTPMethod = "TRACE"
	AttackLayer7TopAseOriginParamsHTTPMethodUncheckout      AttackLayer7TopAseOriginParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TopAseOriginParamsHTTPMethodUnlock          AttackLayer7TopAseOriginParamsHTTPMethod = "UNLOCK"
	AttackLayer7TopAseOriginParamsHTTPMethodUnsubscribe     AttackLayer7TopAseOriginParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TopAseOriginParamsHTTPMethodUpdate          AttackLayer7TopAseOriginParamsHTTPMethod = "UPDATE"
	AttackLayer7TopAseOriginParamsHTTPMethodVersioncontrol  AttackLayer7TopAseOriginParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TopAseOriginParamsHTTPMethodBaselinecontrol AttackLayer7TopAseOriginParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TopAseOriginParamsHTTPMethodXmsenumatts     AttackLayer7TopAseOriginParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TopAseOriginParamsHTTPMethodRpcOutData      AttackLayer7TopAseOriginParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TopAseOriginParamsHTTPMethodRpcInData       AttackLayer7TopAseOriginParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TopAseOriginParamsHTTPMethodJson            AttackLayer7TopAseOriginParamsHTTPMethod = "JSON"
	AttackLayer7TopAseOriginParamsHTTPMethodCook            AttackLayer7TopAseOriginParamsHTTPMethod = "COOK"
	AttackLayer7TopAseOriginParamsHTTPMethodTrack           AttackLayer7TopAseOriginParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TopAseOriginParamsHTTPMethod) IsKnown

type AttackLayer7TopAseOriginParamsHTTPVersion

type AttackLayer7TopAseOriginParamsHTTPVersion string
const (
	AttackLayer7TopAseOriginParamsHTTPVersionHttPv1 AttackLayer7TopAseOriginParamsHTTPVersion = "HTTPv1"
	AttackLayer7TopAseOriginParamsHTTPVersionHttPv2 AttackLayer7TopAseOriginParamsHTTPVersion = "HTTPv2"
	AttackLayer7TopAseOriginParamsHTTPVersionHttPv3 AttackLayer7TopAseOriginParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TopAseOriginParamsHTTPVersion) IsKnown

type AttackLayer7TopAseOriginParamsIPVersion

type AttackLayer7TopAseOriginParamsIPVersion string
const (
	AttackLayer7TopAseOriginParamsIPVersionIPv4 AttackLayer7TopAseOriginParamsIPVersion = "IPv4"
	AttackLayer7TopAseOriginParamsIPVersionIPv6 AttackLayer7TopAseOriginParamsIPVersion = "IPv6"
)

func (AttackLayer7TopAseOriginParamsIPVersion) IsKnown

type AttackLayer7TopAseOriginParamsMitigationProduct

type AttackLayer7TopAseOriginParamsMitigationProduct string
const (
	AttackLayer7TopAseOriginParamsMitigationProductDDoS               AttackLayer7TopAseOriginParamsMitigationProduct = "DDOS"
	AttackLayer7TopAseOriginParamsMitigationProductWAF                AttackLayer7TopAseOriginParamsMitigationProduct = "WAF"
	AttackLayer7TopAseOriginParamsMitigationProductBotManagement      AttackLayer7TopAseOriginParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TopAseOriginParamsMitigationProductAccessRules        AttackLayer7TopAseOriginParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TopAseOriginParamsMitigationProductIPReputation       AttackLayer7TopAseOriginParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TopAseOriginParamsMitigationProductAPIShield          AttackLayer7TopAseOriginParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TopAseOriginParamsMitigationProductDataLossPrevention AttackLayer7TopAseOriginParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TopAseOriginParamsMitigationProduct) IsKnown

type AttackLayer7TopAseOriginResponse

type AttackLayer7TopAseOriginResponse struct {
	Meta AttackLayer7TopAseOriginResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer7TopAseOriginResponseTop0 `json:"top_0,required"`
	JSON attackLayer7TopAseOriginResponseJSON   `json:"-"`
}

func (*AttackLayer7TopAseOriginResponse) UnmarshalJSON

func (r *AttackLayer7TopAseOriginResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAseOriginResponseEnvelope

type AttackLayer7TopAseOriginResponseEnvelope struct {
	Result  AttackLayer7TopAseOriginResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    attackLayer7TopAseOriginResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TopAseOriginResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TopAseOriginResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAseOriginResponseMeta

type AttackLayer7TopAseOriginResponseMeta struct {
	DateRange      []AttackLayer7TopAseOriginResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                             `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer7TopAseOriginResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TopAseOriginResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TopAseOriginResponseMeta) UnmarshalJSON

func (r *AttackLayer7TopAseOriginResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAseOriginResponseMetaConfidenceInfo

type AttackLayer7TopAseOriginResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                          `json:"level"`
	JSON        attackLayer7TopAseOriginResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TopAseOriginResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer7TopAseOriginResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation

type AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                           `json:"dataSource,required"`
	Description     string                                                           `json:"description,required"`
	EventType       string                                                           `json:"eventType,required"`
	IsInstantaneous bool                                                             `json:"isInstantaneous,required"`
	EndTime         time.Time                                                        `json:"endTime" format:"date-time"`
	LinkedURL       string                                                           `json:"linkedUrl"`
	StartTime       time.Time                                                        `json:"startTime" format:"date-time"`
	JSON            attackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TopAseOriginResponseMetaDateRange

type AttackLayer7TopAseOriginResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                         `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TopAseOriginResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TopAseOriginResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TopAseOriginResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAseOriginResponseTop0

type AttackLayer7TopAseOriginResponseTop0 struct {
	OriginASN     string                                   `json:"originAsn,required"`
	OriginASNName string                                   `json:"originAsnName,required"`
	Rank          float64                                  `json:"rank,required"`
	Value         string                                   `json:"value,required"`
	JSON          attackLayer7TopAseOriginResponseTop0JSON `json:"-"`
}

func (*AttackLayer7TopAseOriginResponseTop0) UnmarshalJSON

func (r *AttackLayer7TopAseOriginResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAseService

type AttackLayer7TopAseService struct {
	Options []option.RequestOption
}

AttackLayer7TopAseService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer7TopAseService method instead.

func NewAttackLayer7TopAseService

func NewAttackLayer7TopAseService(opts ...option.RequestOption) (r *AttackLayer7TopAseService)

NewAttackLayer7TopAseService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer7TopAseService) Origin

Get the top origin Autonomous Systems of and by Layer 7 attacks. Values are a percentage out of the total Layer 7 attacks. The origin Autonomous Systems is determined by the client IP address.

type AttackLayer7TopAttacksParams

type AttackLayer7TopAttacksParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TopAttacksParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TopAttacksParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TopAttacksParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TopAttacksParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of attack origin/target location attack limits. Together with
	// `limitPerLocation`, limits how many objects will be fetched per origin/target
	// location.
	LimitDirection param.Field[AttackLayer7TopAttacksParamsLimitDirection] `query:"limitDirection"`
	// Limit the number of attacks per origin/target (refer to `limitDirection`
	// parameter) location.
	LimitPerLocation param.Field[int64] `query:"limitPerLocation"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Attack magnitude can be defined by total requests mitigated or by total zones
	// attacked.
	Magnitude param.Field[AttackLayer7TopAttacksParamsMagnitude] `query:"magnitude"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TopAttacksParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[AttackLayer7TopAttacksParamsNormalization] `query:"normalization"`
}

func (AttackLayer7TopAttacksParams) URLQuery

func (r AttackLayer7TopAttacksParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer7TopAttacksParams's query parameters as `url.Values`.

type AttackLayer7TopAttacksParamsFormat

type AttackLayer7TopAttacksParamsFormat string

Format results are returned in.

const (
	AttackLayer7TopAttacksParamsFormatJson AttackLayer7TopAttacksParamsFormat = "JSON"
	AttackLayer7TopAttacksParamsFormatCsv  AttackLayer7TopAttacksParamsFormat = "CSV"
)

func (AttackLayer7TopAttacksParamsFormat) IsKnown

type AttackLayer7TopAttacksParamsHTTPMethod

type AttackLayer7TopAttacksParamsHTTPMethod string
const (
	AttackLayer7TopAttacksParamsHTTPMethodGet             AttackLayer7TopAttacksParamsHTTPMethod = "GET"
	AttackLayer7TopAttacksParamsHTTPMethodPost            AttackLayer7TopAttacksParamsHTTPMethod = "POST"
	AttackLayer7TopAttacksParamsHTTPMethodDelete          AttackLayer7TopAttacksParamsHTTPMethod = "DELETE"
	AttackLayer7TopAttacksParamsHTTPMethodPut             AttackLayer7TopAttacksParamsHTTPMethod = "PUT"
	AttackLayer7TopAttacksParamsHTTPMethodHead            AttackLayer7TopAttacksParamsHTTPMethod = "HEAD"
	AttackLayer7TopAttacksParamsHTTPMethodPurge           AttackLayer7TopAttacksParamsHTTPMethod = "PURGE"
	AttackLayer7TopAttacksParamsHTTPMethodOptions         AttackLayer7TopAttacksParamsHTTPMethod = "OPTIONS"
	AttackLayer7TopAttacksParamsHTTPMethodPropfind        AttackLayer7TopAttacksParamsHTTPMethod = "PROPFIND"
	AttackLayer7TopAttacksParamsHTTPMethodMkcol           AttackLayer7TopAttacksParamsHTTPMethod = "MKCOL"
	AttackLayer7TopAttacksParamsHTTPMethodPatch           AttackLayer7TopAttacksParamsHTTPMethod = "PATCH"
	AttackLayer7TopAttacksParamsHTTPMethodACL             AttackLayer7TopAttacksParamsHTTPMethod = "ACL"
	AttackLayer7TopAttacksParamsHTTPMethodBcopy           AttackLayer7TopAttacksParamsHTTPMethod = "BCOPY"
	AttackLayer7TopAttacksParamsHTTPMethodBdelete         AttackLayer7TopAttacksParamsHTTPMethod = "BDELETE"
	AttackLayer7TopAttacksParamsHTTPMethodBmove           AttackLayer7TopAttacksParamsHTTPMethod = "BMOVE"
	AttackLayer7TopAttacksParamsHTTPMethodBpropfind       AttackLayer7TopAttacksParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TopAttacksParamsHTTPMethodBproppatch      AttackLayer7TopAttacksParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TopAttacksParamsHTTPMethodCheckin         AttackLayer7TopAttacksParamsHTTPMethod = "CHECKIN"
	AttackLayer7TopAttacksParamsHTTPMethodCheckout        AttackLayer7TopAttacksParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TopAttacksParamsHTTPMethodConnect         AttackLayer7TopAttacksParamsHTTPMethod = "CONNECT"
	AttackLayer7TopAttacksParamsHTTPMethodCopy            AttackLayer7TopAttacksParamsHTTPMethod = "COPY"
	AttackLayer7TopAttacksParamsHTTPMethodLabel           AttackLayer7TopAttacksParamsHTTPMethod = "LABEL"
	AttackLayer7TopAttacksParamsHTTPMethodLock            AttackLayer7TopAttacksParamsHTTPMethod = "LOCK"
	AttackLayer7TopAttacksParamsHTTPMethodMerge           AttackLayer7TopAttacksParamsHTTPMethod = "MERGE"
	AttackLayer7TopAttacksParamsHTTPMethodMkactivity      AttackLayer7TopAttacksParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TopAttacksParamsHTTPMethodMkworkspace     AttackLayer7TopAttacksParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TopAttacksParamsHTTPMethodMove            AttackLayer7TopAttacksParamsHTTPMethod = "MOVE"
	AttackLayer7TopAttacksParamsHTTPMethodNotify          AttackLayer7TopAttacksParamsHTTPMethod = "NOTIFY"
	AttackLayer7TopAttacksParamsHTTPMethodOrderpatch      AttackLayer7TopAttacksParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TopAttacksParamsHTTPMethodPoll            AttackLayer7TopAttacksParamsHTTPMethod = "POLL"
	AttackLayer7TopAttacksParamsHTTPMethodProppatch       AttackLayer7TopAttacksParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TopAttacksParamsHTTPMethodReport          AttackLayer7TopAttacksParamsHTTPMethod = "REPORT"
	AttackLayer7TopAttacksParamsHTTPMethodSearch          AttackLayer7TopAttacksParamsHTTPMethod = "SEARCH"
	AttackLayer7TopAttacksParamsHTTPMethodSubscribe       AttackLayer7TopAttacksParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TopAttacksParamsHTTPMethodTrace           AttackLayer7TopAttacksParamsHTTPMethod = "TRACE"
	AttackLayer7TopAttacksParamsHTTPMethodUncheckout      AttackLayer7TopAttacksParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TopAttacksParamsHTTPMethodUnlock          AttackLayer7TopAttacksParamsHTTPMethod = "UNLOCK"
	AttackLayer7TopAttacksParamsHTTPMethodUnsubscribe     AttackLayer7TopAttacksParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TopAttacksParamsHTTPMethodUpdate          AttackLayer7TopAttacksParamsHTTPMethod = "UPDATE"
	AttackLayer7TopAttacksParamsHTTPMethodVersioncontrol  AttackLayer7TopAttacksParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TopAttacksParamsHTTPMethodBaselinecontrol AttackLayer7TopAttacksParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TopAttacksParamsHTTPMethodXmsenumatts     AttackLayer7TopAttacksParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TopAttacksParamsHTTPMethodRpcOutData      AttackLayer7TopAttacksParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TopAttacksParamsHTTPMethodRpcInData       AttackLayer7TopAttacksParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TopAttacksParamsHTTPMethodJson            AttackLayer7TopAttacksParamsHTTPMethod = "JSON"
	AttackLayer7TopAttacksParamsHTTPMethodCook            AttackLayer7TopAttacksParamsHTTPMethod = "COOK"
	AttackLayer7TopAttacksParamsHTTPMethodTrack           AttackLayer7TopAttacksParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TopAttacksParamsHTTPMethod) IsKnown

type AttackLayer7TopAttacksParamsHTTPVersion

type AttackLayer7TopAttacksParamsHTTPVersion string
const (
	AttackLayer7TopAttacksParamsHTTPVersionHttPv1 AttackLayer7TopAttacksParamsHTTPVersion = "HTTPv1"
	AttackLayer7TopAttacksParamsHTTPVersionHttPv2 AttackLayer7TopAttacksParamsHTTPVersion = "HTTPv2"
	AttackLayer7TopAttacksParamsHTTPVersionHttPv3 AttackLayer7TopAttacksParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TopAttacksParamsHTTPVersion) IsKnown

type AttackLayer7TopAttacksParamsIPVersion

type AttackLayer7TopAttacksParamsIPVersion string
const (
	AttackLayer7TopAttacksParamsIPVersionIPv4 AttackLayer7TopAttacksParamsIPVersion = "IPv4"
	AttackLayer7TopAttacksParamsIPVersionIPv6 AttackLayer7TopAttacksParamsIPVersion = "IPv6"
)

func (AttackLayer7TopAttacksParamsIPVersion) IsKnown

type AttackLayer7TopAttacksParamsLimitDirection

type AttackLayer7TopAttacksParamsLimitDirection string

Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.

const (
	AttackLayer7TopAttacksParamsLimitDirectionOrigin AttackLayer7TopAttacksParamsLimitDirection = "ORIGIN"
	AttackLayer7TopAttacksParamsLimitDirectionTarget AttackLayer7TopAttacksParamsLimitDirection = "TARGET"
)

func (AttackLayer7TopAttacksParamsLimitDirection) IsKnown

type AttackLayer7TopAttacksParamsMagnitude

type AttackLayer7TopAttacksParamsMagnitude string

Attack magnitude can be defined by total requests mitigated or by total zones attacked.

const (
	AttackLayer7TopAttacksParamsMagnitudeAffectedZones     AttackLayer7TopAttacksParamsMagnitude = "AFFECTED_ZONES"
	AttackLayer7TopAttacksParamsMagnitudeMitigatedRequests AttackLayer7TopAttacksParamsMagnitude = "MITIGATED_REQUESTS"
)

func (AttackLayer7TopAttacksParamsMagnitude) IsKnown

type AttackLayer7TopAttacksParamsMitigationProduct

type AttackLayer7TopAttacksParamsMitigationProduct string
const (
	AttackLayer7TopAttacksParamsMitigationProductDDoS               AttackLayer7TopAttacksParamsMitigationProduct = "DDOS"
	AttackLayer7TopAttacksParamsMitigationProductWAF                AttackLayer7TopAttacksParamsMitigationProduct = "WAF"
	AttackLayer7TopAttacksParamsMitigationProductBotManagement      AttackLayer7TopAttacksParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TopAttacksParamsMitigationProductAccessRules        AttackLayer7TopAttacksParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TopAttacksParamsMitigationProductIPReputation       AttackLayer7TopAttacksParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TopAttacksParamsMitigationProductAPIShield          AttackLayer7TopAttacksParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TopAttacksParamsMitigationProductDataLossPrevention AttackLayer7TopAttacksParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TopAttacksParamsMitigationProduct) IsKnown

type AttackLayer7TopAttacksParamsNormalization

type AttackLayer7TopAttacksParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	AttackLayer7TopAttacksParamsNormalizationPercentage AttackLayer7TopAttacksParamsNormalization = "PERCENTAGE"
	AttackLayer7TopAttacksParamsNormalizationMinMax     AttackLayer7TopAttacksParamsNormalization = "MIN_MAX"
)

func (AttackLayer7TopAttacksParamsNormalization) IsKnown

type AttackLayer7TopAttacksResponse

type AttackLayer7TopAttacksResponse struct {
	Meta AttackLayer7TopAttacksResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer7TopAttacksResponseTop0 `json:"top_0,required"`
	JSON attackLayer7TopAttacksResponseJSON   `json:"-"`
}

func (*AttackLayer7TopAttacksResponse) UnmarshalJSON

func (r *AttackLayer7TopAttacksResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAttacksResponseEnvelope

type AttackLayer7TopAttacksResponseEnvelope struct {
	Result  AttackLayer7TopAttacksResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    attackLayer7TopAttacksResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TopAttacksResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TopAttacksResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAttacksResponseMeta

type AttackLayer7TopAttacksResponseMeta struct {
	DateRange      []AttackLayer7TopAttacksResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer7TopAttacksResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TopAttacksResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TopAttacksResponseMeta) UnmarshalJSON

func (r *AttackLayer7TopAttacksResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAttacksResponseMetaConfidenceInfo

type AttackLayer7TopAttacksResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        attackLayer7TopAttacksResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TopAttacksResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer7TopAttacksResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation

type AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            attackLayer7TopAttacksResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TopAttacksResponseMetaDateRange

type AttackLayer7TopAttacksResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TopAttacksResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TopAttacksResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TopAttacksResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopAttacksResponseTop0

type AttackLayer7TopAttacksResponseTop0 struct {
	OriginCountryAlpha2 string                                 `json:"originCountryAlpha2,required"`
	OriginCountryName   string                                 `json:"originCountryName,required"`
	TargetCountryAlpha2 string                                 `json:"targetCountryAlpha2,required"`
	TargetCountryName   string                                 `json:"targetCountryName,required"`
	Value               string                                 `json:"value,required"`
	JSON                attackLayer7TopAttacksResponseTop0JSON `json:"-"`
}

func (*AttackLayer7TopAttacksResponseTop0) UnmarshalJSON

func (r *AttackLayer7TopAttacksResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopIndustryParams

type AttackLayer7TopIndustryParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TopIndustryParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TopIndustryParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TopIndustryParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TopIndustryParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TopIndustryParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7TopIndustryParams) URLQuery

func (r AttackLayer7TopIndustryParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer7TopIndustryParams's query parameters as `url.Values`.

type AttackLayer7TopIndustryParamsFormat

type AttackLayer7TopIndustryParamsFormat string

Format results are returned in.

const (
	AttackLayer7TopIndustryParamsFormatJson AttackLayer7TopIndustryParamsFormat = "JSON"
	AttackLayer7TopIndustryParamsFormatCsv  AttackLayer7TopIndustryParamsFormat = "CSV"
)

func (AttackLayer7TopIndustryParamsFormat) IsKnown

type AttackLayer7TopIndustryParamsHTTPMethod

type AttackLayer7TopIndustryParamsHTTPMethod string
const (
	AttackLayer7TopIndustryParamsHTTPMethodGet             AttackLayer7TopIndustryParamsHTTPMethod = "GET"
	AttackLayer7TopIndustryParamsHTTPMethodPost            AttackLayer7TopIndustryParamsHTTPMethod = "POST"
	AttackLayer7TopIndustryParamsHTTPMethodDelete          AttackLayer7TopIndustryParamsHTTPMethod = "DELETE"
	AttackLayer7TopIndustryParamsHTTPMethodPut             AttackLayer7TopIndustryParamsHTTPMethod = "PUT"
	AttackLayer7TopIndustryParamsHTTPMethodHead            AttackLayer7TopIndustryParamsHTTPMethod = "HEAD"
	AttackLayer7TopIndustryParamsHTTPMethodPurge           AttackLayer7TopIndustryParamsHTTPMethod = "PURGE"
	AttackLayer7TopIndustryParamsHTTPMethodOptions         AttackLayer7TopIndustryParamsHTTPMethod = "OPTIONS"
	AttackLayer7TopIndustryParamsHTTPMethodPropfind        AttackLayer7TopIndustryParamsHTTPMethod = "PROPFIND"
	AttackLayer7TopIndustryParamsHTTPMethodMkcol           AttackLayer7TopIndustryParamsHTTPMethod = "MKCOL"
	AttackLayer7TopIndustryParamsHTTPMethodPatch           AttackLayer7TopIndustryParamsHTTPMethod = "PATCH"
	AttackLayer7TopIndustryParamsHTTPMethodACL             AttackLayer7TopIndustryParamsHTTPMethod = "ACL"
	AttackLayer7TopIndustryParamsHTTPMethodBcopy           AttackLayer7TopIndustryParamsHTTPMethod = "BCOPY"
	AttackLayer7TopIndustryParamsHTTPMethodBdelete         AttackLayer7TopIndustryParamsHTTPMethod = "BDELETE"
	AttackLayer7TopIndustryParamsHTTPMethodBmove           AttackLayer7TopIndustryParamsHTTPMethod = "BMOVE"
	AttackLayer7TopIndustryParamsHTTPMethodBpropfind       AttackLayer7TopIndustryParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TopIndustryParamsHTTPMethodBproppatch      AttackLayer7TopIndustryParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TopIndustryParamsHTTPMethodCheckin         AttackLayer7TopIndustryParamsHTTPMethod = "CHECKIN"
	AttackLayer7TopIndustryParamsHTTPMethodCheckout        AttackLayer7TopIndustryParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TopIndustryParamsHTTPMethodConnect         AttackLayer7TopIndustryParamsHTTPMethod = "CONNECT"
	AttackLayer7TopIndustryParamsHTTPMethodCopy            AttackLayer7TopIndustryParamsHTTPMethod = "COPY"
	AttackLayer7TopIndustryParamsHTTPMethodLabel           AttackLayer7TopIndustryParamsHTTPMethod = "LABEL"
	AttackLayer7TopIndustryParamsHTTPMethodLock            AttackLayer7TopIndustryParamsHTTPMethod = "LOCK"
	AttackLayer7TopIndustryParamsHTTPMethodMerge           AttackLayer7TopIndustryParamsHTTPMethod = "MERGE"
	AttackLayer7TopIndustryParamsHTTPMethodMkactivity      AttackLayer7TopIndustryParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TopIndustryParamsHTTPMethodMkworkspace     AttackLayer7TopIndustryParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TopIndustryParamsHTTPMethodMove            AttackLayer7TopIndustryParamsHTTPMethod = "MOVE"
	AttackLayer7TopIndustryParamsHTTPMethodNotify          AttackLayer7TopIndustryParamsHTTPMethod = "NOTIFY"
	AttackLayer7TopIndustryParamsHTTPMethodOrderpatch      AttackLayer7TopIndustryParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TopIndustryParamsHTTPMethodPoll            AttackLayer7TopIndustryParamsHTTPMethod = "POLL"
	AttackLayer7TopIndustryParamsHTTPMethodProppatch       AttackLayer7TopIndustryParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TopIndustryParamsHTTPMethodReport          AttackLayer7TopIndustryParamsHTTPMethod = "REPORT"
	AttackLayer7TopIndustryParamsHTTPMethodSearch          AttackLayer7TopIndustryParamsHTTPMethod = "SEARCH"
	AttackLayer7TopIndustryParamsHTTPMethodSubscribe       AttackLayer7TopIndustryParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TopIndustryParamsHTTPMethodTrace           AttackLayer7TopIndustryParamsHTTPMethod = "TRACE"
	AttackLayer7TopIndustryParamsHTTPMethodUncheckout      AttackLayer7TopIndustryParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TopIndustryParamsHTTPMethodUnlock          AttackLayer7TopIndustryParamsHTTPMethod = "UNLOCK"
	AttackLayer7TopIndustryParamsHTTPMethodUnsubscribe     AttackLayer7TopIndustryParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TopIndustryParamsHTTPMethodUpdate          AttackLayer7TopIndustryParamsHTTPMethod = "UPDATE"
	AttackLayer7TopIndustryParamsHTTPMethodVersioncontrol  AttackLayer7TopIndustryParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TopIndustryParamsHTTPMethodBaselinecontrol AttackLayer7TopIndustryParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TopIndustryParamsHTTPMethodXmsenumatts     AttackLayer7TopIndustryParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TopIndustryParamsHTTPMethodRpcOutData      AttackLayer7TopIndustryParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TopIndustryParamsHTTPMethodRpcInData       AttackLayer7TopIndustryParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TopIndustryParamsHTTPMethodJson            AttackLayer7TopIndustryParamsHTTPMethod = "JSON"
	AttackLayer7TopIndustryParamsHTTPMethodCook            AttackLayer7TopIndustryParamsHTTPMethod = "COOK"
	AttackLayer7TopIndustryParamsHTTPMethodTrack           AttackLayer7TopIndustryParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TopIndustryParamsHTTPMethod) IsKnown

type AttackLayer7TopIndustryParamsHTTPVersion

type AttackLayer7TopIndustryParamsHTTPVersion string
const (
	AttackLayer7TopIndustryParamsHTTPVersionHttPv1 AttackLayer7TopIndustryParamsHTTPVersion = "HTTPv1"
	AttackLayer7TopIndustryParamsHTTPVersionHttPv2 AttackLayer7TopIndustryParamsHTTPVersion = "HTTPv2"
	AttackLayer7TopIndustryParamsHTTPVersionHttPv3 AttackLayer7TopIndustryParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TopIndustryParamsHTTPVersion) IsKnown

type AttackLayer7TopIndustryParamsIPVersion

type AttackLayer7TopIndustryParamsIPVersion string
const (
	AttackLayer7TopIndustryParamsIPVersionIPv4 AttackLayer7TopIndustryParamsIPVersion = "IPv4"
	AttackLayer7TopIndustryParamsIPVersionIPv6 AttackLayer7TopIndustryParamsIPVersion = "IPv6"
)

func (AttackLayer7TopIndustryParamsIPVersion) IsKnown

type AttackLayer7TopIndustryParamsMitigationProduct

type AttackLayer7TopIndustryParamsMitigationProduct string
const (
	AttackLayer7TopIndustryParamsMitigationProductDDoS               AttackLayer7TopIndustryParamsMitigationProduct = "DDOS"
	AttackLayer7TopIndustryParamsMitigationProductWAF                AttackLayer7TopIndustryParamsMitigationProduct = "WAF"
	AttackLayer7TopIndustryParamsMitigationProductBotManagement      AttackLayer7TopIndustryParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TopIndustryParamsMitigationProductAccessRules        AttackLayer7TopIndustryParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TopIndustryParamsMitigationProductIPReputation       AttackLayer7TopIndustryParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TopIndustryParamsMitigationProductAPIShield          AttackLayer7TopIndustryParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TopIndustryParamsMitigationProductDataLossPrevention AttackLayer7TopIndustryParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TopIndustryParamsMitigationProduct) IsKnown

type AttackLayer7TopIndustryResponse

type AttackLayer7TopIndustryResponse struct {
	Meta AttackLayer7TopIndustryResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer7TopIndustryResponseTop0 `json:"top_0,required"`
	JSON attackLayer7TopIndustryResponseJSON   `json:"-"`
}

func (*AttackLayer7TopIndustryResponse) UnmarshalJSON

func (r *AttackLayer7TopIndustryResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopIndustryResponseEnvelope

type AttackLayer7TopIndustryResponseEnvelope struct {
	Result  AttackLayer7TopIndustryResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    attackLayer7TopIndustryResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TopIndustryResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TopIndustryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopIndustryResponseMeta

type AttackLayer7TopIndustryResponseMeta struct {
	DateRange      []AttackLayer7TopIndustryResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer7TopIndustryResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TopIndustryResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TopIndustryResponseMeta) UnmarshalJSON

func (r *AttackLayer7TopIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopIndustryResponseMetaConfidenceInfo

type AttackLayer7TopIndustryResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        attackLayer7TopIndustryResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TopIndustryResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer7TopIndustryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation

type AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            attackLayer7TopIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TopIndustryResponseMetaDateRange

type AttackLayer7TopIndustryResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TopIndustryResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TopIndustryResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TopIndustryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopIndustryResponseTop0

type AttackLayer7TopIndustryResponseTop0 struct {
	Name  string                                  `json:"name,required"`
	Value string                                  `json:"value,required"`
	JSON  attackLayer7TopIndustryResponseTop0JSON `json:"-"`
}

func (*AttackLayer7TopIndustryResponseTop0) UnmarshalJSON

func (r *AttackLayer7TopIndustryResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationOriginParams

type AttackLayer7TopLocationOriginParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TopLocationOriginParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TopLocationOriginParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TopLocationOriginParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TopLocationOriginParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TopLocationOriginParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7TopLocationOriginParams) URLQuery

URLQuery serializes AttackLayer7TopLocationOriginParams's query parameters as `url.Values`.

type AttackLayer7TopLocationOriginParamsFormat

type AttackLayer7TopLocationOriginParamsFormat string

Format results are returned in.

const (
	AttackLayer7TopLocationOriginParamsFormatJson AttackLayer7TopLocationOriginParamsFormat = "JSON"
	AttackLayer7TopLocationOriginParamsFormatCsv  AttackLayer7TopLocationOriginParamsFormat = "CSV"
)

func (AttackLayer7TopLocationOriginParamsFormat) IsKnown

type AttackLayer7TopLocationOriginParamsHTTPMethod

type AttackLayer7TopLocationOriginParamsHTTPMethod string
const (
	AttackLayer7TopLocationOriginParamsHTTPMethodGet             AttackLayer7TopLocationOriginParamsHTTPMethod = "GET"
	AttackLayer7TopLocationOriginParamsHTTPMethodPost            AttackLayer7TopLocationOriginParamsHTTPMethod = "POST"
	AttackLayer7TopLocationOriginParamsHTTPMethodDelete          AttackLayer7TopLocationOriginParamsHTTPMethod = "DELETE"
	AttackLayer7TopLocationOriginParamsHTTPMethodPut             AttackLayer7TopLocationOriginParamsHTTPMethod = "PUT"
	AttackLayer7TopLocationOriginParamsHTTPMethodHead            AttackLayer7TopLocationOriginParamsHTTPMethod = "HEAD"
	AttackLayer7TopLocationOriginParamsHTTPMethodPurge           AttackLayer7TopLocationOriginParamsHTTPMethod = "PURGE"
	AttackLayer7TopLocationOriginParamsHTTPMethodOptions         AttackLayer7TopLocationOriginParamsHTTPMethod = "OPTIONS"
	AttackLayer7TopLocationOriginParamsHTTPMethodPropfind        AttackLayer7TopLocationOriginParamsHTTPMethod = "PROPFIND"
	AttackLayer7TopLocationOriginParamsHTTPMethodMkcol           AttackLayer7TopLocationOriginParamsHTTPMethod = "MKCOL"
	AttackLayer7TopLocationOriginParamsHTTPMethodPatch           AttackLayer7TopLocationOriginParamsHTTPMethod = "PATCH"
	AttackLayer7TopLocationOriginParamsHTTPMethodACL             AttackLayer7TopLocationOriginParamsHTTPMethod = "ACL"
	AttackLayer7TopLocationOriginParamsHTTPMethodBcopy           AttackLayer7TopLocationOriginParamsHTTPMethod = "BCOPY"
	AttackLayer7TopLocationOriginParamsHTTPMethodBdelete         AttackLayer7TopLocationOriginParamsHTTPMethod = "BDELETE"
	AttackLayer7TopLocationOriginParamsHTTPMethodBmove           AttackLayer7TopLocationOriginParamsHTTPMethod = "BMOVE"
	AttackLayer7TopLocationOriginParamsHTTPMethodBpropfind       AttackLayer7TopLocationOriginParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TopLocationOriginParamsHTTPMethodBproppatch      AttackLayer7TopLocationOriginParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TopLocationOriginParamsHTTPMethodCheckin         AttackLayer7TopLocationOriginParamsHTTPMethod = "CHECKIN"
	AttackLayer7TopLocationOriginParamsHTTPMethodCheckout        AttackLayer7TopLocationOriginParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TopLocationOriginParamsHTTPMethodConnect         AttackLayer7TopLocationOriginParamsHTTPMethod = "CONNECT"
	AttackLayer7TopLocationOriginParamsHTTPMethodCopy            AttackLayer7TopLocationOriginParamsHTTPMethod = "COPY"
	AttackLayer7TopLocationOriginParamsHTTPMethodLabel           AttackLayer7TopLocationOriginParamsHTTPMethod = "LABEL"
	AttackLayer7TopLocationOriginParamsHTTPMethodLock            AttackLayer7TopLocationOriginParamsHTTPMethod = "LOCK"
	AttackLayer7TopLocationOriginParamsHTTPMethodMerge           AttackLayer7TopLocationOriginParamsHTTPMethod = "MERGE"
	AttackLayer7TopLocationOriginParamsHTTPMethodMkactivity      AttackLayer7TopLocationOriginParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TopLocationOriginParamsHTTPMethodMkworkspace     AttackLayer7TopLocationOriginParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TopLocationOriginParamsHTTPMethodMove            AttackLayer7TopLocationOriginParamsHTTPMethod = "MOVE"
	AttackLayer7TopLocationOriginParamsHTTPMethodNotify          AttackLayer7TopLocationOriginParamsHTTPMethod = "NOTIFY"
	AttackLayer7TopLocationOriginParamsHTTPMethodOrderpatch      AttackLayer7TopLocationOriginParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TopLocationOriginParamsHTTPMethodPoll            AttackLayer7TopLocationOriginParamsHTTPMethod = "POLL"
	AttackLayer7TopLocationOriginParamsHTTPMethodProppatch       AttackLayer7TopLocationOriginParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TopLocationOriginParamsHTTPMethodReport          AttackLayer7TopLocationOriginParamsHTTPMethod = "REPORT"
	AttackLayer7TopLocationOriginParamsHTTPMethodSearch          AttackLayer7TopLocationOriginParamsHTTPMethod = "SEARCH"
	AttackLayer7TopLocationOriginParamsHTTPMethodSubscribe       AttackLayer7TopLocationOriginParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TopLocationOriginParamsHTTPMethodTrace           AttackLayer7TopLocationOriginParamsHTTPMethod = "TRACE"
	AttackLayer7TopLocationOriginParamsHTTPMethodUncheckout      AttackLayer7TopLocationOriginParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TopLocationOriginParamsHTTPMethodUnlock          AttackLayer7TopLocationOriginParamsHTTPMethod = "UNLOCK"
	AttackLayer7TopLocationOriginParamsHTTPMethodUnsubscribe     AttackLayer7TopLocationOriginParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TopLocationOriginParamsHTTPMethodUpdate          AttackLayer7TopLocationOriginParamsHTTPMethod = "UPDATE"
	AttackLayer7TopLocationOriginParamsHTTPMethodVersioncontrol  AttackLayer7TopLocationOriginParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TopLocationOriginParamsHTTPMethodBaselinecontrol AttackLayer7TopLocationOriginParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TopLocationOriginParamsHTTPMethodXmsenumatts     AttackLayer7TopLocationOriginParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TopLocationOriginParamsHTTPMethodRpcOutData      AttackLayer7TopLocationOriginParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TopLocationOriginParamsHTTPMethodRpcInData       AttackLayer7TopLocationOriginParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TopLocationOriginParamsHTTPMethodJson            AttackLayer7TopLocationOriginParamsHTTPMethod = "JSON"
	AttackLayer7TopLocationOriginParamsHTTPMethodCook            AttackLayer7TopLocationOriginParamsHTTPMethod = "COOK"
	AttackLayer7TopLocationOriginParamsHTTPMethodTrack           AttackLayer7TopLocationOriginParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TopLocationOriginParamsHTTPMethod) IsKnown

type AttackLayer7TopLocationOriginParamsHTTPVersion

type AttackLayer7TopLocationOriginParamsHTTPVersion string
const (
	AttackLayer7TopLocationOriginParamsHTTPVersionHttPv1 AttackLayer7TopLocationOriginParamsHTTPVersion = "HTTPv1"
	AttackLayer7TopLocationOriginParamsHTTPVersionHttPv2 AttackLayer7TopLocationOriginParamsHTTPVersion = "HTTPv2"
	AttackLayer7TopLocationOriginParamsHTTPVersionHttPv3 AttackLayer7TopLocationOriginParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TopLocationOriginParamsHTTPVersion) IsKnown

type AttackLayer7TopLocationOriginParamsIPVersion

type AttackLayer7TopLocationOriginParamsIPVersion string
const (
	AttackLayer7TopLocationOriginParamsIPVersionIPv4 AttackLayer7TopLocationOriginParamsIPVersion = "IPv4"
	AttackLayer7TopLocationOriginParamsIPVersionIPv6 AttackLayer7TopLocationOriginParamsIPVersion = "IPv6"
)

func (AttackLayer7TopLocationOriginParamsIPVersion) IsKnown

type AttackLayer7TopLocationOriginParamsMitigationProduct

type AttackLayer7TopLocationOriginParamsMitigationProduct string
const (
	AttackLayer7TopLocationOriginParamsMitigationProductDDoS               AttackLayer7TopLocationOriginParamsMitigationProduct = "DDOS"
	AttackLayer7TopLocationOriginParamsMitigationProductWAF                AttackLayer7TopLocationOriginParamsMitigationProduct = "WAF"
	AttackLayer7TopLocationOriginParamsMitigationProductBotManagement      AttackLayer7TopLocationOriginParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TopLocationOriginParamsMitigationProductAccessRules        AttackLayer7TopLocationOriginParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TopLocationOriginParamsMitigationProductIPReputation       AttackLayer7TopLocationOriginParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TopLocationOriginParamsMitigationProductAPIShield          AttackLayer7TopLocationOriginParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TopLocationOriginParamsMitigationProductDataLossPrevention AttackLayer7TopLocationOriginParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TopLocationOriginParamsMitigationProduct) IsKnown

type AttackLayer7TopLocationOriginResponse

type AttackLayer7TopLocationOriginResponse struct {
	Meta AttackLayer7TopLocationOriginResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer7TopLocationOriginResponseTop0 `json:"top_0,required"`
	JSON attackLayer7TopLocationOriginResponseJSON   `json:"-"`
}

func (*AttackLayer7TopLocationOriginResponse) UnmarshalJSON

func (r *AttackLayer7TopLocationOriginResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationOriginResponseEnvelope

type AttackLayer7TopLocationOriginResponseEnvelope struct {
	Result  AttackLayer7TopLocationOriginResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    attackLayer7TopLocationOriginResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TopLocationOriginResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TopLocationOriginResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationOriginResponseMeta

type AttackLayer7TopLocationOriginResponseMeta struct {
	DateRange      []AttackLayer7TopLocationOriginResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                  `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer7TopLocationOriginResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TopLocationOriginResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TopLocationOriginResponseMeta) UnmarshalJSON

func (r *AttackLayer7TopLocationOriginResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationOriginResponseMetaConfidenceInfo

type AttackLayer7TopLocationOriginResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                               `json:"level"`
	JSON        attackLayer7TopLocationOriginResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TopLocationOriginResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation

type AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                `json:"dataSource,required"`
	Description     string                                                                `json:"description,required"`
	EventType       string                                                                `json:"eventType,required"`
	IsInstantaneous bool                                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                `json:"linkedUrl"`
	StartTime       time.Time                                                             `json:"startTime" format:"date-time"`
	JSON            attackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TopLocationOriginResponseMetaDateRange

type AttackLayer7TopLocationOriginResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                              `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TopLocationOriginResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TopLocationOriginResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TopLocationOriginResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationOriginResponseTop0

type AttackLayer7TopLocationOriginResponseTop0 struct {
	OriginCountryAlpha2 string                                        `json:"originCountryAlpha2,required"`
	OriginCountryName   string                                        `json:"originCountryName,required"`
	Rank                float64                                       `json:"rank,required"`
	Value               string                                        `json:"value,required"`
	JSON                attackLayer7TopLocationOriginResponseTop0JSON `json:"-"`
}

func (*AttackLayer7TopLocationOriginResponseTop0) UnmarshalJSON

func (r *AttackLayer7TopLocationOriginResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationService

type AttackLayer7TopLocationService struct {
	Options []option.RequestOption
}

AttackLayer7TopLocationService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer7TopLocationService method instead.

func NewAttackLayer7TopLocationService

func NewAttackLayer7TopLocationService(opts ...option.RequestOption) (r *AttackLayer7TopLocationService)

NewAttackLayer7TopLocationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer7TopLocationService) Origin

Get the top origin locations of and by Layer 7 attacks. Values are a percentage out of the total Layer 7 attacks. The origin location is determined by the client IP address.

func (*AttackLayer7TopLocationService) Target

Get the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available.

type AttackLayer7TopLocationTargetParams

type AttackLayer7TopLocationTargetParams struct {
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TopLocationTargetParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TopLocationTargetParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TopLocationTargetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TopLocationTargetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TopLocationTargetParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7TopLocationTargetParams) URLQuery

URLQuery serializes AttackLayer7TopLocationTargetParams's query parameters as `url.Values`.

type AttackLayer7TopLocationTargetParamsFormat

type AttackLayer7TopLocationTargetParamsFormat string

Format results are returned in.

const (
	AttackLayer7TopLocationTargetParamsFormatJson AttackLayer7TopLocationTargetParamsFormat = "JSON"
	AttackLayer7TopLocationTargetParamsFormatCsv  AttackLayer7TopLocationTargetParamsFormat = "CSV"
)

func (AttackLayer7TopLocationTargetParamsFormat) IsKnown

type AttackLayer7TopLocationTargetParamsHTTPMethod

type AttackLayer7TopLocationTargetParamsHTTPMethod string
const (
	AttackLayer7TopLocationTargetParamsHTTPMethodGet             AttackLayer7TopLocationTargetParamsHTTPMethod = "GET"
	AttackLayer7TopLocationTargetParamsHTTPMethodPost            AttackLayer7TopLocationTargetParamsHTTPMethod = "POST"
	AttackLayer7TopLocationTargetParamsHTTPMethodDelete          AttackLayer7TopLocationTargetParamsHTTPMethod = "DELETE"
	AttackLayer7TopLocationTargetParamsHTTPMethodPut             AttackLayer7TopLocationTargetParamsHTTPMethod = "PUT"
	AttackLayer7TopLocationTargetParamsHTTPMethodHead            AttackLayer7TopLocationTargetParamsHTTPMethod = "HEAD"
	AttackLayer7TopLocationTargetParamsHTTPMethodPurge           AttackLayer7TopLocationTargetParamsHTTPMethod = "PURGE"
	AttackLayer7TopLocationTargetParamsHTTPMethodOptions         AttackLayer7TopLocationTargetParamsHTTPMethod = "OPTIONS"
	AttackLayer7TopLocationTargetParamsHTTPMethodPropfind        AttackLayer7TopLocationTargetParamsHTTPMethod = "PROPFIND"
	AttackLayer7TopLocationTargetParamsHTTPMethodMkcol           AttackLayer7TopLocationTargetParamsHTTPMethod = "MKCOL"
	AttackLayer7TopLocationTargetParamsHTTPMethodPatch           AttackLayer7TopLocationTargetParamsHTTPMethod = "PATCH"
	AttackLayer7TopLocationTargetParamsHTTPMethodACL             AttackLayer7TopLocationTargetParamsHTTPMethod = "ACL"
	AttackLayer7TopLocationTargetParamsHTTPMethodBcopy           AttackLayer7TopLocationTargetParamsHTTPMethod = "BCOPY"
	AttackLayer7TopLocationTargetParamsHTTPMethodBdelete         AttackLayer7TopLocationTargetParamsHTTPMethod = "BDELETE"
	AttackLayer7TopLocationTargetParamsHTTPMethodBmove           AttackLayer7TopLocationTargetParamsHTTPMethod = "BMOVE"
	AttackLayer7TopLocationTargetParamsHTTPMethodBpropfind       AttackLayer7TopLocationTargetParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TopLocationTargetParamsHTTPMethodBproppatch      AttackLayer7TopLocationTargetParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TopLocationTargetParamsHTTPMethodCheckin         AttackLayer7TopLocationTargetParamsHTTPMethod = "CHECKIN"
	AttackLayer7TopLocationTargetParamsHTTPMethodCheckout        AttackLayer7TopLocationTargetParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TopLocationTargetParamsHTTPMethodConnect         AttackLayer7TopLocationTargetParamsHTTPMethod = "CONNECT"
	AttackLayer7TopLocationTargetParamsHTTPMethodCopy            AttackLayer7TopLocationTargetParamsHTTPMethod = "COPY"
	AttackLayer7TopLocationTargetParamsHTTPMethodLabel           AttackLayer7TopLocationTargetParamsHTTPMethod = "LABEL"
	AttackLayer7TopLocationTargetParamsHTTPMethodLock            AttackLayer7TopLocationTargetParamsHTTPMethod = "LOCK"
	AttackLayer7TopLocationTargetParamsHTTPMethodMerge           AttackLayer7TopLocationTargetParamsHTTPMethod = "MERGE"
	AttackLayer7TopLocationTargetParamsHTTPMethodMkactivity      AttackLayer7TopLocationTargetParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TopLocationTargetParamsHTTPMethodMkworkspace     AttackLayer7TopLocationTargetParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TopLocationTargetParamsHTTPMethodMove            AttackLayer7TopLocationTargetParamsHTTPMethod = "MOVE"
	AttackLayer7TopLocationTargetParamsHTTPMethodNotify          AttackLayer7TopLocationTargetParamsHTTPMethod = "NOTIFY"
	AttackLayer7TopLocationTargetParamsHTTPMethodOrderpatch      AttackLayer7TopLocationTargetParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TopLocationTargetParamsHTTPMethodPoll            AttackLayer7TopLocationTargetParamsHTTPMethod = "POLL"
	AttackLayer7TopLocationTargetParamsHTTPMethodProppatch       AttackLayer7TopLocationTargetParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TopLocationTargetParamsHTTPMethodReport          AttackLayer7TopLocationTargetParamsHTTPMethod = "REPORT"
	AttackLayer7TopLocationTargetParamsHTTPMethodSearch          AttackLayer7TopLocationTargetParamsHTTPMethod = "SEARCH"
	AttackLayer7TopLocationTargetParamsHTTPMethodSubscribe       AttackLayer7TopLocationTargetParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TopLocationTargetParamsHTTPMethodTrace           AttackLayer7TopLocationTargetParamsHTTPMethod = "TRACE"
	AttackLayer7TopLocationTargetParamsHTTPMethodUncheckout      AttackLayer7TopLocationTargetParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TopLocationTargetParamsHTTPMethodUnlock          AttackLayer7TopLocationTargetParamsHTTPMethod = "UNLOCK"
	AttackLayer7TopLocationTargetParamsHTTPMethodUnsubscribe     AttackLayer7TopLocationTargetParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TopLocationTargetParamsHTTPMethodUpdate          AttackLayer7TopLocationTargetParamsHTTPMethod = "UPDATE"
	AttackLayer7TopLocationTargetParamsHTTPMethodVersioncontrol  AttackLayer7TopLocationTargetParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TopLocationTargetParamsHTTPMethodBaselinecontrol AttackLayer7TopLocationTargetParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TopLocationTargetParamsHTTPMethodXmsenumatts     AttackLayer7TopLocationTargetParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TopLocationTargetParamsHTTPMethodRpcOutData      AttackLayer7TopLocationTargetParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TopLocationTargetParamsHTTPMethodRpcInData       AttackLayer7TopLocationTargetParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TopLocationTargetParamsHTTPMethodJson            AttackLayer7TopLocationTargetParamsHTTPMethod = "JSON"
	AttackLayer7TopLocationTargetParamsHTTPMethodCook            AttackLayer7TopLocationTargetParamsHTTPMethod = "COOK"
	AttackLayer7TopLocationTargetParamsHTTPMethodTrack           AttackLayer7TopLocationTargetParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TopLocationTargetParamsHTTPMethod) IsKnown

type AttackLayer7TopLocationTargetParamsHTTPVersion

type AttackLayer7TopLocationTargetParamsHTTPVersion string
const (
	AttackLayer7TopLocationTargetParamsHTTPVersionHttPv1 AttackLayer7TopLocationTargetParamsHTTPVersion = "HTTPv1"
	AttackLayer7TopLocationTargetParamsHTTPVersionHttPv2 AttackLayer7TopLocationTargetParamsHTTPVersion = "HTTPv2"
	AttackLayer7TopLocationTargetParamsHTTPVersionHttPv3 AttackLayer7TopLocationTargetParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TopLocationTargetParamsHTTPVersion) IsKnown

type AttackLayer7TopLocationTargetParamsIPVersion

type AttackLayer7TopLocationTargetParamsIPVersion string
const (
	AttackLayer7TopLocationTargetParamsIPVersionIPv4 AttackLayer7TopLocationTargetParamsIPVersion = "IPv4"
	AttackLayer7TopLocationTargetParamsIPVersionIPv6 AttackLayer7TopLocationTargetParamsIPVersion = "IPv6"
)

func (AttackLayer7TopLocationTargetParamsIPVersion) IsKnown

type AttackLayer7TopLocationTargetParamsMitigationProduct

type AttackLayer7TopLocationTargetParamsMitigationProduct string
const (
	AttackLayer7TopLocationTargetParamsMitigationProductDDoS               AttackLayer7TopLocationTargetParamsMitigationProduct = "DDOS"
	AttackLayer7TopLocationTargetParamsMitigationProductWAF                AttackLayer7TopLocationTargetParamsMitigationProduct = "WAF"
	AttackLayer7TopLocationTargetParamsMitigationProductBotManagement      AttackLayer7TopLocationTargetParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TopLocationTargetParamsMitigationProductAccessRules        AttackLayer7TopLocationTargetParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TopLocationTargetParamsMitigationProductIPReputation       AttackLayer7TopLocationTargetParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TopLocationTargetParamsMitigationProductAPIShield          AttackLayer7TopLocationTargetParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TopLocationTargetParamsMitigationProductDataLossPrevention AttackLayer7TopLocationTargetParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TopLocationTargetParamsMitigationProduct) IsKnown

type AttackLayer7TopLocationTargetResponse

type AttackLayer7TopLocationTargetResponse struct {
	Meta AttackLayer7TopLocationTargetResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer7TopLocationTargetResponseTop0 `json:"top_0,required"`
	JSON attackLayer7TopLocationTargetResponseJSON   `json:"-"`
}

func (*AttackLayer7TopLocationTargetResponse) UnmarshalJSON

func (r *AttackLayer7TopLocationTargetResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationTargetResponseEnvelope

type AttackLayer7TopLocationTargetResponseEnvelope struct {
	Result  AttackLayer7TopLocationTargetResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    attackLayer7TopLocationTargetResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TopLocationTargetResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TopLocationTargetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationTargetResponseMeta

type AttackLayer7TopLocationTargetResponseMeta struct {
	DateRange      []AttackLayer7TopLocationTargetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                  `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer7TopLocationTargetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TopLocationTargetResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TopLocationTargetResponseMeta) UnmarshalJSON

func (r *AttackLayer7TopLocationTargetResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationTargetResponseMetaConfidenceInfo

type AttackLayer7TopLocationTargetResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                               `json:"level"`
	JSON        attackLayer7TopLocationTargetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TopLocationTargetResponseMetaConfidenceInfo) UnmarshalJSON

type AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation

type AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                `json:"dataSource,required"`
	Description     string                                                                `json:"description,required"`
	EventType       string                                                                `json:"eventType,required"`
	IsInstantaneous bool                                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                `json:"linkedUrl"`
	StartTime       time.Time                                                             `json:"startTime" format:"date-time"`
	JSON            attackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TopLocationTargetResponseMetaDateRange

type AttackLayer7TopLocationTargetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                              `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TopLocationTargetResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TopLocationTargetResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TopLocationTargetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopLocationTargetResponseTop0

type AttackLayer7TopLocationTargetResponseTop0 struct {
	Rank                float64                                       `json:"rank,required"`
	TargetCountryAlpha2 string                                        `json:"targetCountryAlpha2,required"`
	TargetCountryName   string                                        `json:"targetCountryName,required"`
	Value               string                                        `json:"value,required"`
	JSON                attackLayer7TopLocationTargetResponseTop0JSON `json:"-"`
}

func (*AttackLayer7TopLocationTargetResponseTop0) UnmarshalJSON

func (r *AttackLayer7TopLocationTargetResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopService

type AttackLayer7TopService struct {
	Options   []option.RequestOption
	Locations *AttackLayer7TopLocationService
	Ases      *AttackLayer7TopAseService
}

AttackLayer7TopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackLayer7TopService method instead.

func NewAttackLayer7TopService

func NewAttackLayer7TopService(opts ...option.RequestOption) (r *AttackLayer7TopService)

NewAttackLayer7TopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AttackLayer7TopService) Attacks

Get the top attacks from origin to target location. Values are a percentage out of the total Layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location).

func (*AttackLayer7TopService) Industry

Get the industries targeted by attacks.

func (*AttackLayer7TopService) Vertical

Get the verticals targeted by attacks.

type AttackLayer7TopVerticalParams

type AttackLayer7TopVerticalParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[AttackLayer7TopVerticalParamsFormat] `query:"format"`
	// Filter for http method.
	HTTPMethod param.Field[[]AttackLayer7TopVerticalParamsHTTPMethod] `query:"httpMethod"`
	// Filter for http version.
	HTTPVersion param.Field[[]AttackLayer7TopVerticalParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]AttackLayer7TopVerticalParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of L7 mitigation products.
	MitigationProduct param.Field[[]AttackLayer7TopVerticalParamsMitigationProduct] `query:"mitigationProduct"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (AttackLayer7TopVerticalParams) URLQuery

func (r AttackLayer7TopVerticalParams) URLQuery() (v url.Values)

URLQuery serializes AttackLayer7TopVerticalParams's query parameters as `url.Values`.

type AttackLayer7TopVerticalParamsFormat

type AttackLayer7TopVerticalParamsFormat string

Format results are returned in.

const (
	AttackLayer7TopVerticalParamsFormatJson AttackLayer7TopVerticalParamsFormat = "JSON"
	AttackLayer7TopVerticalParamsFormatCsv  AttackLayer7TopVerticalParamsFormat = "CSV"
)

func (AttackLayer7TopVerticalParamsFormat) IsKnown

type AttackLayer7TopVerticalParamsHTTPMethod

type AttackLayer7TopVerticalParamsHTTPMethod string
const (
	AttackLayer7TopVerticalParamsHTTPMethodGet             AttackLayer7TopVerticalParamsHTTPMethod = "GET"
	AttackLayer7TopVerticalParamsHTTPMethodPost            AttackLayer7TopVerticalParamsHTTPMethod = "POST"
	AttackLayer7TopVerticalParamsHTTPMethodDelete          AttackLayer7TopVerticalParamsHTTPMethod = "DELETE"
	AttackLayer7TopVerticalParamsHTTPMethodPut             AttackLayer7TopVerticalParamsHTTPMethod = "PUT"
	AttackLayer7TopVerticalParamsHTTPMethodHead            AttackLayer7TopVerticalParamsHTTPMethod = "HEAD"
	AttackLayer7TopVerticalParamsHTTPMethodPurge           AttackLayer7TopVerticalParamsHTTPMethod = "PURGE"
	AttackLayer7TopVerticalParamsHTTPMethodOptions         AttackLayer7TopVerticalParamsHTTPMethod = "OPTIONS"
	AttackLayer7TopVerticalParamsHTTPMethodPropfind        AttackLayer7TopVerticalParamsHTTPMethod = "PROPFIND"
	AttackLayer7TopVerticalParamsHTTPMethodMkcol           AttackLayer7TopVerticalParamsHTTPMethod = "MKCOL"
	AttackLayer7TopVerticalParamsHTTPMethodPatch           AttackLayer7TopVerticalParamsHTTPMethod = "PATCH"
	AttackLayer7TopVerticalParamsHTTPMethodACL             AttackLayer7TopVerticalParamsHTTPMethod = "ACL"
	AttackLayer7TopVerticalParamsHTTPMethodBcopy           AttackLayer7TopVerticalParamsHTTPMethod = "BCOPY"
	AttackLayer7TopVerticalParamsHTTPMethodBdelete         AttackLayer7TopVerticalParamsHTTPMethod = "BDELETE"
	AttackLayer7TopVerticalParamsHTTPMethodBmove           AttackLayer7TopVerticalParamsHTTPMethod = "BMOVE"
	AttackLayer7TopVerticalParamsHTTPMethodBpropfind       AttackLayer7TopVerticalParamsHTTPMethod = "BPROPFIND"
	AttackLayer7TopVerticalParamsHTTPMethodBproppatch      AttackLayer7TopVerticalParamsHTTPMethod = "BPROPPATCH"
	AttackLayer7TopVerticalParamsHTTPMethodCheckin         AttackLayer7TopVerticalParamsHTTPMethod = "CHECKIN"
	AttackLayer7TopVerticalParamsHTTPMethodCheckout        AttackLayer7TopVerticalParamsHTTPMethod = "CHECKOUT"
	AttackLayer7TopVerticalParamsHTTPMethodConnect         AttackLayer7TopVerticalParamsHTTPMethod = "CONNECT"
	AttackLayer7TopVerticalParamsHTTPMethodCopy            AttackLayer7TopVerticalParamsHTTPMethod = "COPY"
	AttackLayer7TopVerticalParamsHTTPMethodLabel           AttackLayer7TopVerticalParamsHTTPMethod = "LABEL"
	AttackLayer7TopVerticalParamsHTTPMethodLock            AttackLayer7TopVerticalParamsHTTPMethod = "LOCK"
	AttackLayer7TopVerticalParamsHTTPMethodMerge           AttackLayer7TopVerticalParamsHTTPMethod = "MERGE"
	AttackLayer7TopVerticalParamsHTTPMethodMkactivity      AttackLayer7TopVerticalParamsHTTPMethod = "MKACTIVITY"
	AttackLayer7TopVerticalParamsHTTPMethodMkworkspace     AttackLayer7TopVerticalParamsHTTPMethod = "MKWORKSPACE"
	AttackLayer7TopVerticalParamsHTTPMethodMove            AttackLayer7TopVerticalParamsHTTPMethod = "MOVE"
	AttackLayer7TopVerticalParamsHTTPMethodNotify          AttackLayer7TopVerticalParamsHTTPMethod = "NOTIFY"
	AttackLayer7TopVerticalParamsHTTPMethodOrderpatch      AttackLayer7TopVerticalParamsHTTPMethod = "ORDERPATCH"
	AttackLayer7TopVerticalParamsHTTPMethodPoll            AttackLayer7TopVerticalParamsHTTPMethod = "POLL"
	AttackLayer7TopVerticalParamsHTTPMethodProppatch       AttackLayer7TopVerticalParamsHTTPMethod = "PROPPATCH"
	AttackLayer7TopVerticalParamsHTTPMethodReport          AttackLayer7TopVerticalParamsHTTPMethod = "REPORT"
	AttackLayer7TopVerticalParamsHTTPMethodSearch          AttackLayer7TopVerticalParamsHTTPMethod = "SEARCH"
	AttackLayer7TopVerticalParamsHTTPMethodSubscribe       AttackLayer7TopVerticalParamsHTTPMethod = "SUBSCRIBE"
	AttackLayer7TopVerticalParamsHTTPMethodTrace           AttackLayer7TopVerticalParamsHTTPMethod = "TRACE"
	AttackLayer7TopVerticalParamsHTTPMethodUncheckout      AttackLayer7TopVerticalParamsHTTPMethod = "UNCHECKOUT"
	AttackLayer7TopVerticalParamsHTTPMethodUnlock          AttackLayer7TopVerticalParamsHTTPMethod = "UNLOCK"
	AttackLayer7TopVerticalParamsHTTPMethodUnsubscribe     AttackLayer7TopVerticalParamsHTTPMethod = "UNSUBSCRIBE"
	AttackLayer7TopVerticalParamsHTTPMethodUpdate          AttackLayer7TopVerticalParamsHTTPMethod = "UPDATE"
	AttackLayer7TopVerticalParamsHTTPMethodVersioncontrol  AttackLayer7TopVerticalParamsHTTPMethod = "VERSIONCONTROL"
	AttackLayer7TopVerticalParamsHTTPMethodBaselinecontrol AttackLayer7TopVerticalParamsHTTPMethod = "BASELINECONTROL"
	AttackLayer7TopVerticalParamsHTTPMethodXmsenumatts     AttackLayer7TopVerticalParamsHTTPMethod = "XMSENUMATTS"
	AttackLayer7TopVerticalParamsHTTPMethodRpcOutData      AttackLayer7TopVerticalParamsHTTPMethod = "RPC_OUT_DATA"
	AttackLayer7TopVerticalParamsHTTPMethodRpcInData       AttackLayer7TopVerticalParamsHTTPMethod = "RPC_IN_DATA"
	AttackLayer7TopVerticalParamsHTTPMethodJson            AttackLayer7TopVerticalParamsHTTPMethod = "JSON"
	AttackLayer7TopVerticalParamsHTTPMethodCook            AttackLayer7TopVerticalParamsHTTPMethod = "COOK"
	AttackLayer7TopVerticalParamsHTTPMethodTrack           AttackLayer7TopVerticalParamsHTTPMethod = "TRACK"
)

func (AttackLayer7TopVerticalParamsHTTPMethod) IsKnown

type AttackLayer7TopVerticalParamsHTTPVersion

type AttackLayer7TopVerticalParamsHTTPVersion string
const (
	AttackLayer7TopVerticalParamsHTTPVersionHttPv1 AttackLayer7TopVerticalParamsHTTPVersion = "HTTPv1"
	AttackLayer7TopVerticalParamsHTTPVersionHttPv2 AttackLayer7TopVerticalParamsHTTPVersion = "HTTPv2"
	AttackLayer7TopVerticalParamsHTTPVersionHttPv3 AttackLayer7TopVerticalParamsHTTPVersion = "HTTPv3"
)

func (AttackLayer7TopVerticalParamsHTTPVersion) IsKnown

type AttackLayer7TopVerticalParamsIPVersion

type AttackLayer7TopVerticalParamsIPVersion string
const (
	AttackLayer7TopVerticalParamsIPVersionIPv4 AttackLayer7TopVerticalParamsIPVersion = "IPv4"
	AttackLayer7TopVerticalParamsIPVersionIPv6 AttackLayer7TopVerticalParamsIPVersion = "IPv6"
)

func (AttackLayer7TopVerticalParamsIPVersion) IsKnown

type AttackLayer7TopVerticalParamsMitigationProduct

type AttackLayer7TopVerticalParamsMitigationProduct string
const (
	AttackLayer7TopVerticalParamsMitigationProductDDoS               AttackLayer7TopVerticalParamsMitigationProduct = "DDOS"
	AttackLayer7TopVerticalParamsMitigationProductWAF                AttackLayer7TopVerticalParamsMitigationProduct = "WAF"
	AttackLayer7TopVerticalParamsMitigationProductBotManagement      AttackLayer7TopVerticalParamsMitigationProduct = "BOT_MANAGEMENT"
	AttackLayer7TopVerticalParamsMitigationProductAccessRules        AttackLayer7TopVerticalParamsMitigationProduct = "ACCESS_RULES"
	AttackLayer7TopVerticalParamsMitigationProductIPReputation       AttackLayer7TopVerticalParamsMitigationProduct = "IP_REPUTATION"
	AttackLayer7TopVerticalParamsMitigationProductAPIShield          AttackLayer7TopVerticalParamsMitigationProduct = "API_SHIELD"
	AttackLayer7TopVerticalParamsMitigationProductDataLossPrevention AttackLayer7TopVerticalParamsMitigationProduct = "DATA_LOSS_PREVENTION"
)

func (AttackLayer7TopVerticalParamsMitigationProduct) IsKnown

type AttackLayer7TopVerticalResponse

type AttackLayer7TopVerticalResponse struct {
	Meta AttackLayer7TopVerticalResponseMeta   `json:"meta,required"`
	Top0 []AttackLayer7TopVerticalResponseTop0 `json:"top_0,required"`
	JSON attackLayer7TopVerticalResponseJSON   `json:"-"`
}

func (*AttackLayer7TopVerticalResponse) UnmarshalJSON

func (r *AttackLayer7TopVerticalResponse) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopVerticalResponseEnvelope

type AttackLayer7TopVerticalResponseEnvelope struct {
	Result  AttackLayer7TopVerticalResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    attackLayer7TopVerticalResponseEnvelopeJSON `json:"-"`
}

func (*AttackLayer7TopVerticalResponseEnvelope) UnmarshalJSON

func (r *AttackLayer7TopVerticalResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopVerticalResponseMeta

type AttackLayer7TopVerticalResponseMeta struct {
	DateRange      []AttackLayer7TopVerticalResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	ConfidenceInfo AttackLayer7TopVerticalResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           attackLayer7TopVerticalResponseMetaJSON           `json:"-"`
}

func (*AttackLayer7TopVerticalResponseMeta) UnmarshalJSON

func (r *AttackLayer7TopVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopVerticalResponseMetaConfidenceInfo

type AttackLayer7TopVerticalResponseMetaConfidenceInfo struct {
	Annotations []AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        attackLayer7TopVerticalResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*AttackLayer7TopVerticalResponseMetaConfidenceInfo) UnmarshalJSON

func (r *AttackLayer7TopVerticalResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation

type AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            attackLayer7TopVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type AttackLayer7TopVerticalResponseMetaDateRange

type AttackLayer7TopVerticalResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      attackLayer7TopVerticalResponseMetaDateRangeJSON `json:"-"`
}

func (*AttackLayer7TopVerticalResponseMetaDateRange) UnmarshalJSON

func (r *AttackLayer7TopVerticalResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type AttackLayer7TopVerticalResponseTop0

type AttackLayer7TopVerticalResponseTop0 struct {
	Name  string                                  `json:"name,required"`
	Value string                                  `json:"value,required"`
	JSON  attackLayer7TopVerticalResponseTop0JSON `json:"-"`
}

func (*AttackLayer7TopVerticalResponseTop0) UnmarshalJSON

func (r *AttackLayer7TopVerticalResponseTop0) UnmarshalJSON(data []byte) (err error)

type AttackService

type AttackService struct {
	Options []option.RequestOption
	Layer3  *AttackLayer3Service
	Layer7  *AttackLayer7Service
}

AttackService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAttackService method instead.

func NewAttackService

func NewAttackService(opts ...option.RequestOption) (r *AttackService)

NewAttackService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type BGPHijackEventListParams

type BGPHijackEventListParams struct {
	// End of the date range (inclusive).
	DateEnd param.Field[time.Time] `query:"dateEnd" format:"date-time"`
	// Shorthand date ranges for the last X days - use when you don't need specific
	// start and end dates.
	DateRange param.Field[string] `query:"dateRange"`
	// Start of the date range (inclusive).
	DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
	// The unique identifier of a event
	EventID param.Field[int64] `query:"eventId"`
	// Format results are returned in.
	Format param.Field[BGPHijackEventListParamsFormat] `query:"format"`
	// The potential hijacker AS of a BGP hijack event
	HijackerASN param.Field[int64] `query:"hijackerAsn"`
	// The potential hijacker or victim AS of a BGP hijack event
	InvolvedASN param.Field[int64] `query:"involvedAsn"`
	// The country code of the potential hijacker or victim AS of a BGP hijack event
	InvolvedCountry param.Field[string] `query:"involvedCountry"`
	// The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
	MaxConfidence param.Field[int64] `query:"maxConfidence"`
	// The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)
	MinConfidence param.Field[int64] `query:"minConfidence"`
	// Current page number, starting from 1
	Page param.Field[int64] `query:"page"`
	// Number of entries per page
	PerPage param.Field[int64] `query:"per_page"`
	// Network prefix, IPv4 or IPv6.
	Prefix param.Field[string] `query:"prefix"`
	// Sort events by field
	SortBy param.Field[BGPHijackEventListParamsSortBy] `query:"sortBy"`
	// Sort order
	SortOrder param.Field[BGPHijackEventListParamsSortOrder] `query:"sortOrder"`
	// The potential victim AS of a BGP hijack event
	VictimASN param.Field[int64] `query:"victimAsn"`
}

func (BGPHijackEventListParams) URLQuery

func (r BGPHijackEventListParams) URLQuery() (v url.Values)

URLQuery serializes BGPHijackEventListParams's query parameters as `url.Values`.

type BGPHijackEventListParamsFormat

type BGPHijackEventListParamsFormat string

Format results are returned in.

const (
	BGPHijackEventListParamsFormatJson BGPHijackEventListParamsFormat = "JSON"
	BGPHijackEventListParamsFormatCsv  BGPHijackEventListParamsFormat = "CSV"
)

func (BGPHijackEventListParamsFormat) IsKnown

type BGPHijackEventListParamsSortBy

type BGPHijackEventListParamsSortBy string

Sort events by field

const (
	BGPHijackEventListParamsSortByID         BGPHijackEventListParamsSortBy = "ID"
	BGPHijackEventListParamsSortByTime       BGPHijackEventListParamsSortBy = "TIME"
	BGPHijackEventListParamsSortByConfidence BGPHijackEventListParamsSortBy = "CONFIDENCE"
)

func (BGPHijackEventListParamsSortBy) IsKnown

type BGPHijackEventListParamsSortOrder

type BGPHijackEventListParamsSortOrder string

Sort order

const (
	BGPHijackEventListParamsSortOrderAsc  BGPHijackEventListParamsSortOrder = "ASC"
	BGPHijackEventListParamsSortOrderDesc BGPHijackEventListParamsSortOrder = "DESC"
)

func (BGPHijackEventListParamsSortOrder) IsKnown

type BGPHijackEventListResponse

type BGPHijackEventListResponse struct {
	Result     BGPHijackEventListResponseResult     `json:"result,required"`
	ResultInfo BGPHijackEventListResponseResultInfo `json:"result_info,required"`
	Success    bool                                 `json:"success,required"`
	JSON       bgpHijackEventListResponseJSON       `json:"-"`
}

func (*BGPHijackEventListResponse) UnmarshalJSON

func (r *BGPHijackEventListResponse) UnmarshalJSON(data []byte) (err error)

type BGPHijackEventListResponseResult

type BGPHijackEventListResponseResult struct {
	ASNInfo       []BGPHijackEventListResponseResultASNInfo `json:"asn_info,required"`
	Events        []BGPHijackEventListResponseResultEvent   `json:"events,required"`
	TotalMonitors int64                                     `json:"total_monitors,required"`
	JSON          bgpHijackEventListResponseResultJSON      `json:"-"`
}

func (*BGPHijackEventListResponseResult) UnmarshalJSON

func (r *BGPHijackEventListResponseResult) UnmarshalJSON(data []byte) (err error)

type BGPHijackEventListResponseResultASNInfo

type BGPHijackEventListResponseResultASNInfo struct {
	ASN         int64                                       `json:"asn,required"`
	CountryCode string                                      `json:"country_code,required"`
	OrgName     string                                      `json:"org_name,required"`
	JSON        bgpHijackEventListResponseResultASNInfoJSON `json:"-"`
}

func (*BGPHijackEventListResponseResultASNInfo) UnmarshalJSON

func (r *BGPHijackEventListResponseResultASNInfo) UnmarshalJSON(data []byte) (err error)

type BGPHijackEventListResponseResultEvent

type BGPHijackEventListResponseResultEvent struct {
	ID              int64                                       `json:"id,required"`
	ConfidenceScore int64                                       `json:"confidence_score,required"`
	Duration        int64                                       `json:"duration,required"`
	EventType       int64                                       `json:"event_type,required"`
	HijackMsgsCount int64                                       `json:"hijack_msgs_count,required"`
	HijackerASN     int64                                       `json:"hijacker_asn,required"`
	HijackerCountry string                                      `json:"hijacker_country,required"`
	IsStale         bool                                        `json:"is_stale,required"`
	MaxHijackTs     string                                      `json:"max_hijack_ts,required"`
	MaxMsgTs        string                                      `json:"max_msg_ts,required"`
	MinHijackTs     string                                      `json:"min_hijack_ts,required"`
	OnGoingCount    int64                                       `json:"on_going_count,required"`
	PeerASNs        []int64                                     `json:"peer_asns,required"`
	PeerIPCount     int64                                       `json:"peer_ip_count,required"`
	Prefixes        []string                                    `json:"prefixes,required"`
	Tags            []BGPHijackEventListResponseResultEventsTag `json:"tags,required"`
	VictimASNs      []int64                                     `json:"victim_asns,required"`
	VictimCountries []string                                    `json:"victim_countries,required"`
	JSON            bgpHijackEventListResponseResultEventJSON   `json:"-"`
}

func (*BGPHijackEventListResponseResultEvent) UnmarshalJSON

func (r *BGPHijackEventListResponseResultEvent) UnmarshalJSON(data []byte) (err error)

type BGPHijackEventListResponseResultEventsTag

type BGPHijackEventListResponseResultEventsTag struct {
	Name  string                                        `json:"name,required"`
	Score int64                                         `json:"score,required"`
	JSON  bgpHijackEventListResponseResultEventsTagJSON `json:"-"`
}

func (*BGPHijackEventListResponseResultEventsTag) UnmarshalJSON

func (r *BGPHijackEventListResponseResultEventsTag) UnmarshalJSON(data []byte) (err error)

type BGPHijackEventListResponseResultInfo

type BGPHijackEventListResponseResultInfo struct {
	Count      int64                                    `json:"count,required"`
	Page       int64                                    `json:"page,required"`
	PerPage    int64                                    `json:"per_page,required"`
	TotalCount int64                                    `json:"total_count,required"`
	JSON       bgpHijackEventListResponseResultInfoJSON `json:"-"`
}

func (*BGPHijackEventListResponseResultInfo) UnmarshalJSON

func (r *BGPHijackEventListResponseResultInfo) UnmarshalJSON(data []byte) (err error)

type BGPHijackEventService

type BGPHijackEventService struct {
	Options []option.RequestOption
}

BGPHijackEventService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPHijackEventService method instead.

func NewBGPHijackEventService

func NewBGPHijackEventService(opts ...option.RequestOption) (r *BGPHijackEventService)

NewBGPHijackEventService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BGPHijackEventService) List

Get the BGP hijack events. (Beta)

func (*BGPHijackEventService) ListAutoPaging

Get the BGP hijack events. (Beta)

type BGPHijackService

type BGPHijackService struct {
	Options []option.RequestOption
	Events  *BGPHijackEventService
}

BGPHijackService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPHijackService method instead.

func NewBGPHijackService

func NewBGPHijackService(opts ...option.RequestOption) (r *BGPHijackService)

NewBGPHijackService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type BGPIPService

type BGPIPService struct {
	Options []option.RequestOption
}

BGPIPService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPIPService method instead.

func NewBGPIPService

func NewBGPIPService(opts ...option.RequestOption) (r *BGPIPService)

NewBGPIPService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BGPIPService) Timeseries

func (r *BGPIPService) Timeseries(ctx context.Context, query BGPIPTimeseriesParams, opts ...option.RequestOption) (res *BgpipTimeseriesResponse, err error)

Get time series data for the announced IP space count, represented as the number of IPv4 /24s and IPv6 /48s, for a given ASN.

type BGPIPTimeseriesParams

type BGPIPTimeseriesParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[BgpipTimeseriesParamsFormat] `query:"format"`
	// Include data delay meta information
	IncludeDelay param.Field[bool] `query:"includeDelay"`
	// Filter for ip version.
	IPVersion param.Field[[]BgpipTimeseriesParamsIPVersion] `query:"ipVersion"`
	// Array of locations (alpha-2 country codes).
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (BGPIPTimeseriesParams) URLQuery

func (r BGPIPTimeseriesParams) URLQuery() (v url.Values)

URLQuery serializes BGPIPTimeseriesParams's query parameters as `url.Values`.

type BGPLeakEventListParams

type BGPLeakEventListParams struct {
	// End of the date range (inclusive).
	DateEnd param.Field[time.Time] `query:"dateEnd" format:"date-time"`
	// Shorthand date ranges for the last X days - use when you don't need specific
	// start and end dates.
	DateRange param.Field[string] `query:"dateRange"`
	// Start of the date range (inclusive).
	DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
	// The unique identifier of a event
	EventID param.Field[int64] `query:"eventId"`
	// Format results are returned in.
	Format param.Field[BGPLeakEventListParamsFormat] `query:"format"`
	// ASN that is causing or affected by a route leak event
	InvolvedASN param.Field[int64] `query:"involvedAsn"`
	// Country code of a involved ASN in a route leak event
	InvolvedCountry param.Field[string] `query:"involvedCountry"`
	// The leaking AS of a route leak event
	LeakASN param.Field[int64] `query:"leakAsn"`
	// Current page number, starting from 1
	Page param.Field[int64] `query:"page"`
	// Number of entries per page
	PerPage param.Field[int64] `query:"per_page"`
	// Sort events by field
	SortBy param.Field[BGPLeakEventListParamsSortBy] `query:"sortBy"`
	// Sort order
	SortOrder param.Field[BGPLeakEventListParamsSortOrder] `query:"sortOrder"`
}

func (BGPLeakEventListParams) URLQuery

func (r BGPLeakEventListParams) URLQuery() (v url.Values)

URLQuery serializes BGPLeakEventListParams's query parameters as `url.Values`.

type BGPLeakEventListParamsFormat

type BGPLeakEventListParamsFormat string

Format results are returned in.

const (
	BGPLeakEventListParamsFormatJson BGPLeakEventListParamsFormat = "JSON"
	BGPLeakEventListParamsFormatCsv  BGPLeakEventListParamsFormat = "CSV"
)

func (BGPLeakEventListParamsFormat) IsKnown

func (r BGPLeakEventListParamsFormat) IsKnown() bool

type BGPLeakEventListParamsSortBy

type BGPLeakEventListParamsSortBy string

Sort events by field

const (
	BGPLeakEventListParamsSortByID       BGPLeakEventListParamsSortBy = "ID"
	BGPLeakEventListParamsSortByLeaks    BGPLeakEventListParamsSortBy = "LEAKS"
	BGPLeakEventListParamsSortByPeers    BGPLeakEventListParamsSortBy = "PEERS"
	BGPLeakEventListParamsSortByPrefixes BGPLeakEventListParamsSortBy = "PREFIXES"
	BGPLeakEventListParamsSortByOrigins  BGPLeakEventListParamsSortBy = "ORIGINS"
	BGPLeakEventListParamsSortByTime     BGPLeakEventListParamsSortBy = "TIME"
)

func (BGPLeakEventListParamsSortBy) IsKnown

func (r BGPLeakEventListParamsSortBy) IsKnown() bool

type BGPLeakEventListParamsSortOrder

type BGPLeakEventListParamsSortOrder string

Sort order

const (
	BGPLeakEventListParamsSortOrderAsc  BGPLeakEventListParamsSortOrder = "ASC"
	BGPLeakEventListParamsSortOrderDesc BGPLeakEventListParamsSortOrder = "DESC"
)

func (BGPLeakEventListParamsSortOrder) IsKnown

type BGPLeakEventListResponse

type BGPLeakEventListResponse struct {
	Result     BGPLeakEventListResponseResult     `json:"result,required"`
	ResultInfo BGPLeakEventListResponseResultInfo `json:"result_info,required"`
	Success    bool                               `json:"success,required"`
	JSON       bgpLeakEventListResponseJSON       `json:"-"`
}

func (*BGPLeakEventListResponse) UnmarshalJSON

func (r *BGPLeakEventListResponse) UnmarshalJSON(data []byte) (err error)

type BGPLeakEventListResponseResult

type BGPLeakEventListResponseResult struct {
	ASNInfo []BGPLeakEventListResponseResultASNInfo `json:"asn_info,required"`
	Events  []BGPLeakEventListResponseResultEvent   `json:"events,required"`
	JSON    bgpLeakEventListResponseResultJSON      `json:"-"`
}

func (*BGPLeakEventListResponseResult) UnmarshalJSON

func (r *BGPLeakEventListResponseResult) UnmarshalJSON(data []byte) (err error)

type BGPLeakEventListResponseResultASNInfo

type BGPLeakEventListResponseResultASNInfo struct {
	ASN         int64                                     `json:"asn,required"`
	CountryCode string                                    `json:"country_code,required"`
	OrgName     string                                    `json:"org_name,required"`
	JSON        bgpLeakEventListResponseResultASNInfoJSON `json:"-"`
}

func (*BGPLeakEventListResponseResultASNInfo) UnmarshalJSON

func (r *BGPLeakEventListResponseResultASNInfo) UnmarshalJSON(data []byte) (err error)

type BGPLeakEventListResponseResultEvent

type BGPLeakEventListResponseResultEvent struct {
	ID          int64                                   `json:"id,required"`
	Countries   []string                                `json:"countries,required"`
	DetectedTs  string                                  `json:"detected_ts,required"`
	Finished    bool                                    `json:"finished,required"`
	LeakASN     int64                                   `json:"leak_asn,required"`
	LeakCount   int64                                   `json:"leak_count,required"`
	LeakSeg     []int64                                 `json:"leak_seg,required"`
	LeakType    int64                                   `json:"leak_type,required"`
	MaxTs       string                                  `json:"max_ts,required"`
	MinTs       string                                  `json:"min_ts,required"`
	OriginCount int64                                   `json:"origin_count,required"`
	PeerCount   int64                                   `json:"peer_count,required"`
	PrefixCount int64                                   `json:"prefix_count,required"`
	JSON        bgpLeakEventListResponseResultEventJSON `json:"-"`
}

func (*BGPLeakEventListResponseResultEvent) UnmarshalJSON

func (r *BGPLeakEventListResponseResultEvent) UnmarshalJSON(data []byte) (err error)

type BGPLeakEventListResponseResultInfo

type BGPLeakEventListResponseResultInfo struct {
	Count      int64                                  `json:"count,required"`
	Page       int64                                  `json:"page,required"`
	PerPage    int64                                  `json:"per_page,required"`
	TotalCount int64                                  `json:"total_count,required"`
	JSON       bgpLeakEventListResponseResultInfoJSON `json:"-"`
}

func (*BGPLeakEventListResponseResultInfo) UnmarshalJSON

func (r *BGPLeakEventListResponseResultInfo) UnmarshalJSON(data []byte) (err error)

type BGPLeakEventService

type BGPLeakEventService struct {
	Options []option.RequestOption
}

BGPLeakEventService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPLeakEventService method instead.

func NewBGPLeakEventService

func NewBGPLeakEventService(opts ...option.RequestOption) (r *BGPLeakEventService)

NewBGPLeakEventService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BGPLeakEventService) List

Get the BGP route leak events (Beta).

func (*BGPLeakEventService) ListAutoPaging

Get the BGP route leak events (Beta).

type BGPLeakService

type BGPLeakService struct {
	Options []option.RequestOption
	Events  *BGPLeakEventService
}

BGPLeakService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPLeakService method instead.

func NewBGPLeakService

func NewBGPLeakService(opts ...option.RequestOption) (r *BGPLeakService)

NewBGPLeakService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type BGPRouteAsesParams

type BGPRouteAsesParams struct {
	// Format results are returned in.
	Format param.Field[BGPRouteAsesParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Location Alpha2 code.
	Location param.Field[string] `query:"location"`
	// Return order results by given type
	SortBy param.Field[BGPRouteAsesParamsSortBy] `query:"sortBy"`
	// Sort by value ascending or descending
	SortOrder param.Field[BGPRouteAsesParamsSortOrder] `query:"sortOrder"`
}

func (BGPRouteAsesParams) URLQuery

func (r BGPRouteAsesParams) URLQuery() (v url.Values)

URLQuery serializes BGPRouteAsesParams's query parameters as `url.Values`.

type BGPRouteAsesParamsFormat

type BGPRouteAsesParamsFormat string

Format results are returned in.

const (
	BGPRouteAsesParamsFormatJson BGPRouteAsesParamsFormat = "JSON"
	BGPRouteAsesParamsFormatCsv  BGPRouteAsesParamsFormat = "CSV"
)

func (BGPRouteAsesParamsFormat) IsKnown

func (r BGPRouteAsesParamsFormat) IsKnown() bool

type BGPRouteAsesParamsSortBy

type BGPRouteAsesParamsSortBy string

Return order results by given type

const (
	BGPRouteAsesParamsSortByCone        BGPRouteAsesParamsSortBy = "cone"
	BGPRouteAsesParamsSortByPfxs        BGPRouteAsesParamsSortBy = "pfxs"
	BGPRouteAsesParamsSortByIPV4        BGPRouteAsesParamsSortBy = "ipv4"
	BGPRouteAsesParamsSortByIPV6        BGPRouteAsesParamsSortBy = "ipv6"
	BGPRouteAsesParamsSortByRPKIValid   BGPRouteAsesParamsSortBy = "rpki_valid"
	BGPRouteAsesParamsSortByRPKIInvalid BGPRouteAsesParamsSortBy = "rpki_invalid"
	BGPRouteAsesParamsSortByRPKIUnknown BGPRouteAsesParamsSortBy = "rpki_unknown"
)

func (BGPRouteAsesParamsSortBy) IsKnown

func (r BGPRouteAsesParamsSortBy) IsKnown() bool

type BGPRouteAsesParamsSortOrder

type BGPRouteAsesParamsSortOrder string

Sort by value ascending or descending

const (
	BGPRouteAsesParamsSortOrderAsc  BGPRouteAsesParamsSortOrder = "asc"
	BGPRouteAsesParamsSortOrderDesc BGPRouteAsesParamsSortOrder = "desc"
)

func (BGPRouteAsesParamsSortOrder) IsKnown

func (r BGPRouteAsesParamsSortOrder) IsKnown() bool

type BGPRouteAsesResponse

type BGPRouteAsesResponse struct {
	ASNs []BGPRouteAsesResponseASN `json:"asns,required"`
	Meta BGPRouteAsesResponseMeta  `json:"meta,required"`
	JSON bgpRouteAsesResponseJSON  `json:"-"`
}

func (*BGPRouteAsesResponse) UnmarshalJSON

func (r *BGPRouteAsesResponse) UnmarshalJSON(data []byte) (err error)

type BGPRouteAsesResponseASN

type BGPRouteAsesResponseASN struct {
	ASN int64 `json:"asn,required"`
	// AS's customer cone size
	ConeSize int64 `json:"coneSize,required"`
	// 2-letter country code for the AS's registration country
	Country string `json:"country,required"`
	// number of IPv4 addresses originated by the AS
	IPV4Count int64 `json:"ipv4Count,required"`
	// number of IPv6 addresses originated by the AS
	IPV6Count string `json:"ipv6Count,required"`
	// name of the AS
	Name string `json:"name,required"`
	// number of total IP prefixes originated by the AS
	PfxsCount int64 `json:"pfxsCount,required"`
	// number of RPKI invalid prefixes originated by the AS
	RPKIInvalid int64 `json:"rpkiInvalid,required"`
	// number of RPKI unknown prefixes originated by the AS
	RPKIUnknown int64 `json:"rpkiUnknown,required"`
	// number of RPKI valid prefixes originated by the AS
	RPKIValid int64                       `json:"rpkiValid,required"`
	JSON      bgpRouteAsesResponseASNJSON `json:"-"`
}

func (*BGPRouteAsesResponseASN) UnmarshalJSON

func (r *BGPRouteAsesResponseASN) UnmarshalJSON(data []byte) (err error)

type BGPRouteAsesResponseEnvelope

type BGPRouteAsesResponseEnvelope struct {
	Result  BGPRouteAsesResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    bgpRouteAsesResponseEnvelopeJSON `json:"-"`
}

func (*BGPRouteAsesResponseEnvelope) UnmarshalJSON

func (r *BGPRouteAsesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPRouteAsesResponseMeta

type BGPRouteAsesResponseMeta struct {
	// the timestamp of when the data is generated
	DataTime string `json:"dataTime,required"`
	// the timestamp of the query
	QueryTime string `json:"queryTime,required"`
	// total number of route collector peers used to generate this data
	TotalPeers int64                        `json:"totalPeers,required"`
	JSON       bgpRouteAsesResponseMetaJSON `json:"-"`
}

func (*BGPRouteAsesResponseMeta) UnmarshalJSON

func (r *BGPRouteAsesResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPRouteMoasParams

type BGPRouteMoasParams struct {
	// Format results are returned in.
	Format param.Field[BGPRouteMoasParamsFormat] `query:"format"`
	// Lookup only RPKI invalid MOASes
	InvalidOnly param.Field[bool] `query:"invalid_only"`
	// Lookup MOASes originated by the given ASN
	Origin param.Field[int64] `query:"origin"`
	// Network prefix, IPv4 or IPv6.
	Prefix param.Field[string] `query:"prefix"`
}

func (BGPRouteMoasParams) URLQuery

func (r BGPRouteMoasParams) URLQuery() (v url.Values)

URLQuery serializes BGPRouteMoasParams's query parameters as `url.Values`.

type BGPRouteMoasParamsFormat

type BGPRouteMoasParamsFormat string

Format results are returned in.

const (
	BGPRouteMoasParamsFormatJson BGPRouteMoasParamsFormat = "JSON"
	BGPRouteMoasParamsFormatCsv  BGPRouteMoasParamsFormat = "CSV"
)

func (BGPRouteMoasParamsFormat) IsKnown

func (r BGPRouteMoasParamsFormat) IsKnown() bool

type BGPRouteMoasResponse

type BGPRouteMoasResponse struct {
	Meta BGPRouteMoasResponseMeta  `json:"meta,required"`
	Moas []BGPRouteMoasResponseMoa `json:"moas,required"`
	JSON bgpRouteMoasResponseJSON  `json:"-"`
}

func (*BGPRouteMoasResponse) UnmarshalJSON

func (r *BGPRouteMoasResponse) UnmarshalJSON(data []byte) (err error)

type BGPRouteMoasResponseEnvelope

type BGPRouteMoasResponseEnvelope struct {
	Result  BGPRouteMoasResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    bgpRouteMoasResponseEnvelopeJSON `json:"-"`
}

func (*BGPRouteMoasResponseEnvelope) UnmarshalJSON

func (r *BGPRouteMoasResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPRouteMoasResponseMeta

type BGPRouteMoasResponseMeta struct {
	DataTime   string                       `json:"data_time,required"`
	QueryTime  string                       `json:"query_time,required"`
	TotalPeers int64                        `json:"total_peers,required"`
	JSON       bgpRouteMoasResponseMetaJSON `json:"-"`
}

func (*BGPRouteMoasResponseMeta) UnmarshalJSON

func (r *BGPRouteMoasResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPRouteMoasResponseMoa

type BGPRouteMoasResponseMoa struct {
	Origins []BGPRouteMoasResponseMoasOrigin `json:"origins,required"`
	Prefix  string                           `json:"prefix,required"`
	JSON    bgpRouteMoasResponseMoaJSON      `json:"-"`
}

func (*BGPRouteMoasResponseMoa) UnmarshalJSON

func (r *BGPRouteMoasResponseMoa) UnmarshalJSON(data []byte) (err error)

type BGPRouteMoasResponseMoasOrigin

type BGPRouteMoasResponseMoasOrigin struct {
	Origin         int64                              `json:"origin,required"`
	PeerCount      int64                              `json:"peer_count,required"`
	RPKIValidation string                             `json:"rpki_validation,required"`
	JSON           bgpRouteMoasResponseMoasOriginJSON `json:"-"`
}

func (*BGPRouteMoasResponseMoasOrigin) UnmarshalJSON

func (r *BGPRouteMoasResponseMoasOrigin) UnmarshalJSON(data []byte) (err error)

type BGPRoutePfx2asParams

type BGPRoutePfx2asParams struct {
	// Format results are returned in.
	Format param.Field[BGPRoutePfx2asParamsFormat] `query:"format"`
	// Return only results with the longest prefix match for the given prefix. For
	// example, specify a /32 prefix to lookup the origin ASN for an IPv4 address.
	LongestPrefixMatch param.Field[bool] `query:"longestPrefixMatch"`
	// Lookup prefixes originated by the given ASN
	Origin param.Field[int64] `query:"origin"`
	// Network prefix, IPv4 or IPv6.
	Prefix param.Field[string] `query:"prefix"`
	// Return only results with matching rpki status: valid, invalid or unknown
	RPKIStatus param.Field[BGPRoutePfx2asParamsRPKIStatus] `query:"rpkiStatus"`
}

func (BGPRoutePfx2asParams) URLQuery

func (r BGPRoutePfx2asParams) URLQuery() (v url.Values)

URLQuery serializes BGPRoutePfx2asParams's query parameters as `url.Values`.

type BGPRoutePfx2asParamsFormat

type BGPRoutePfx2asParamsFormat string

Format results are returned in.

const (
	BGPRoutePfx2asParamsFormatJson BGPRoutePfx2asParamsFormat = "JSON"
	BGPRoutePfx2asParamsFormatCsv  BGPRoutePfx2asParamsFormat = "CSV"
)

func (BGPRoutePfx2asParamsFormat) IsKnown

func (r BGPRoutePfx2asParamsFormat) IsKnown() bool

type BGPRoutePfx2asParamsRPKIStatus

type BGPRoutePfx2asParamsRPKIStatus string

Return only results with matching rpki status: valid, invalid or unknown

const (
	BGPRoutePfx2asParamsRPKIStatusValid   BGPRoutePfx2asParamsRPKIStatus = "VALID"
	BGPRoutePfx2asParamsRPKIStatusInvalid BGPRoutePfx2asParamsRPKIStatus = "INVALID"
	BGPRoutePfx2asParamsRPKIStatusUnknown BGPRoutePfx2asParamsRPKIStatus = "UNKNOWN"
)

func (BGPRoutePfx2asParamsRPKIStatus) IsKnown

type BGPRoutePfx2asResponse

type BGPRoutePfx2asResponse struct {
	Meta          BGPRoutePfx2asResponseMeta           `json:"meta,required"`
	PrefixOrigins []BGPRoutePfx2asResponsePrefixOrigin `json:"prefix_origins,required"`
	JSON          bgpRoutePfx2asResponseJSON           `json:"-"`
}

func (*BGPRoutePfx2asResponse) UnmarshalJSON

func (r *BGPRoutePfx2asResponse) UnmarshalJSON(data []byte) (err error)

type BGPRoutePfx2asResponseEnvelope

type BGPRoutePfx2asResponseEnvelope struct {
	Result  BGPRoutePfx2asResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    bgpRoutePfx2asResponseEnvelopeJSON `json:"-"`
}

func (*BGPRoutePfx2asResponseEnvelope) UnmarshalJSON

func (r *BGPRoutePfx2asResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPRoutePfx2asResponseMeta

type BGPRoutePfx2asResponseMeta struct {
	DataTime   string                         `json:"data_time,required"`
	QueryTime  string                         `json:"query_time,required"`
	TotalPeers int64                          `json:"total_peers,required"`
	JSON       bgpRoutePfx2asResponseMetaJSON `json:"-"`
}

func (*BGPRoutePfx2asResponseMeta) UnmarshalJSON

func (r *BGPRoutePfx2asResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPRoutePfx2asResponsePrefixOrigin

type BGPRoutePfx2asResponsePrefixOrigin struct {
	Origin         int64                                  `json:"origin,required"`
	PeerCount      int64                                  `json:"peer_count,required"`
	Prefix         string                                 `json:"prefix,required"`
	RPKIValidation string                                 `json:"rpki_validation,required"`
	JSON           bgpRoutePfx2asResponsePrefixOriginJSON `json:"-"`
}

func (*BGPRoutePfx2asResponsePrefixOrigin) UnmarshalJSON

func (r *BGPRoutePfx2asResponsePrefixOrigin) UnmarshalJSON(data []byte) (err error)

type BGPRouteService

type BGPRouteService struct {
	Options []option.RequestOption
}

BGPRouteService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPRouteService method instead.

func NewBGPRouteService

func NewBGPRouteService(opts ...option.RequestOption) (r *BGPRouteService)

NewBGPRouteService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BGPRouteService) Ases

List all ASes in current global routing tables with routing statistics

func (*BGPRouteService) Moas

List all Multi-Origin AS (MOAS) prefixes on the global routing tables.

func (*BGPRouteService) Pfx2as

Lookup prefix-to-ASN mapping on global routing tables.

func (*BGPRouteService) Stats

Get the BGP routing table stats (Beta).

type BGPRouteStatsParams

type BGPRouteStatsParams struct {
	// Single ASN as integer.
	ASN param.Field[int64] `query:"asn"`
	// Format results are returned in.
	Format param.Field[BGPRouteStatsParamsFormat] `query:"format"`
	// Location Alpha2 code.
	Location param.Field[string] `query:"location"`
}

func (BGPRouteStatsParams) URLQuery

func (r BGPRouteStatsParams) URLQuery() (v url.Values)

URLQuery serializes BGPRouteStatsParams's query parameters as `url.Values`.

type BGPRouteStatsParamsFormat

type BGPRouteStatsParamsFormat string

Format results are returned in.

const (
	BGPRouteStatsParamsFormatJson BGPRouteStatsParamsFormat = "JSON"
	BGPRouteStatsParamsFormatCsv  BGPRouteStatsParamsFormat = "CSV"
)

func (BGPRouteStatsParamsFormat) IsKnown

func (r BGPRouteStatsParamsFormat) IsKnown() bool

type BGPRouteStatsResponse

type BGPRouteStatsResponse struct {
	Meta  BGPRouteStatsResponseMeta  `json:"meta,required"`
	Stats BGPRouteStatsResponseStats `json:"stats,required"`
	JSON  bgpRouteStatsResponseJSON  `json:"-"`
}

func (*BGPRouteStatsResponse) UnmarshalJSON

func (r *BGPRouteStatsResponse) UnmarshalJSON(data []byte) (err error)

type BGPRouteStatsResponseEnvelope

type BGPRouteStatsResponseEnvelope struct {
	Result  BGPRouteStatsResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    bgpRouteStatsResponseEnvelopeJSON `json:"-"`
}

func (*BGPRouteStatsResponseEnvelope) UnmarshalJSON

func (r *BGPRouteStatsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPRouteStatsResponseMeta

type BGPRouteStatsResponseMeta struct {
	DataTime   string                        `json:"data_time,required"`
	QueryTime  string                        `json:"query_time,required"`
	TotalPeers int64                         `json:"total_peers,required"`
	JSON       bgpRouteStatsResponseMetaJSON `json:"-"`
}

func (*BGPRouteStatsResponseMeta) UnmarshalJSON

func (r *BGPRouteStatsResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPRouteStatsResponseStats

type BGPRouteStatsResponseStats struct {
	DistinctOrigins      int64                          `json:"distinct_origins,required"`
	DistinctOriginsIPV4  int64                          `json:"distinct_origins_ipv4,required"`
	DistinctOriginsIPV6  int64                          `json:"distinct_origins_ipv6,required"`
	DistinctPrefixes     int64                          `json:"distinct_prefixes,required"`
	DistinctPrefixesIPV4 int64                          `json:"distinct_prefixes_ipv4,required"`
	DistinctPrefixesIPV6 int64                          `json:"distinct_prefixes_ipv6,required"`
	RoutesInvalid        int64                          `json:"routes_invalid,required"`
	RoutesInvalidIPV4    int64                          `json:"routes_invalid_ipv4,required"`
	RoutesInvalidIPV6    int64                          `json:"routes_invalid_ipv6,required"`
	RoutesTotal          int64                          `json:"routes_total,required"`
	RoutesTotalIPV4      int64                          `json:"routes_total_ipv4,required"`
	RoutesTotalIPV6      int64                          `json:"routes_total_ipv6,required"`
	RoutesUnknown        int64                          `json:"routes_unknown,required"`
	RoutesUnknownIPV4    int64                          `json:"routes_unknown_ipv4,required"`
	RoutesUnknownIPV6    int64                          `json:"routes_unknown_ipv6,required"`
	RoutesValid          int64                          `json:"routes_valid,required"`
	RoutesValidIPV4      int64                          `json:"routes_valid_ipv4,required"`
	RoutesValidIPV6      int64                          `json:"routes_valid_ipv6,required"`
	JSON                 bgpRouteStatsResponseStatsJSON `json:"-"`
}

func (*BGPRouteStatsResponseStats) UnmarshalJSON

func (r *BGPRouteStatsResponseStats) UnmarshalJSON(data []byte) (err error)

type BGPService

type BGPService struct {
	Options []option.RequestOption
	Leaks   *BGPLeakService
	Top     *BGPTopService
	Hijacks *BGPHijackService
	Routes  *BGPRouteService
	IPs     *BGPIPService
}

BGPService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPService method instead.

func NewBGPService

func NewBGPService(opts ...option.RequestOption) (r *BGPService)

NewBGPService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BGPService) Timeseries

func (r *BGPService) Timeseries(ctx context.Context, query BGPTimeseriesParams, opts ...option.RequestOption) (res *BGPTimeseriesResponse, err error)

Get BGP updates change over time. Raw values are returned. When requesting updates for an autonomous system (AS), only BGP updates of type announcement are returned.

type BGPTimeseriesParams

type BGPTimeseriesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[BGPTimeseriesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[BGPTimeseriesParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of BGP network prefixes.
	Prefix param.Field[[]string] `query:"prefix"`
	// Array of BGP update types.
	UpdateType param.Field[[]BGPTimeseriesParamsUpdateType] `query:"updateType"`
}

func (BGPTimeseriesParams) URLQuery

func (r BGPTimeseriesParams) URLQuery() (v url.Values)

URLQuery serializes BGPTimeseriesParams's query parameters as `url.Values`.

type BGPTimeseriesParamsAggInterval

type BGPTimeseriesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	BGPTimeseriesParamsAggInterval15m BGPTimeseriesParamsAggInterval = "15m"
	BGPTimeseriesParamsAggInterval1h  BGPTimeseriesParamsAggInterval = "1h"
	BGPTimeseriesParamsAggInterval1d  BGPTimeseriesParamsAggInterval = "1d"
	BGPTimeseriesParamsAggInterval1w  BGPTimeseriesParamsAggInterval = "1w"
)

func (BGPTimeseriesParamsAggInterval) IsKnown

type BGPTimeseriesParamsFormat

type BGPTimeseriesParamsFormat string

Format results are returned in.

const (
	BGPTimeseriesParamsFormatJson BGPTimeseriesParamsFormat = "JSON"
	BGPTimeseriesParamsFormatCsv  BGPTimeseriesParamsFormat = "CSV"
)

func (BGPTimeseriesParamsFormat) IsKnown

func (r BGPTimeseriesParamsFormat) IsKnown() bool

type BGPTimeseriesParamsUpdateType

type BGPTimeseriesParamsUpdateType string
const (
	BGPTimeseriesParamsUpdateTypeAnnouncement BGPTimeseriesParamsUpdateType = "ANNOUNCEMENT"
	BGPTimeseriesParamsUpdateTypeWithdrawal   BGPTimeseriesParamsUpdateType = "WITHDRAWAL"
)

func (BGPTimeseriesParamsUpdateType) IsKnown

func (r BGPTimeseriesParamsUpdateType) IsKnown() bool

type BGPTimeseriesResponse

type BGPTimeseriesResponse struct {
	Meta   BGPTimeseriesResponseMeta   `json:"meta,required"`
	Serie0 BGPTimeseriesResponseSerie0 `json:"serie_0,required"`
	JSON   bgpTimeseriesResponseJSON   `json:"-"`
}

func (*BGPTimeseriesResponse) UnmarshalJSON

func (r *BGPTimeseriesResponse) UnmarshalJSON(data []byte) (err error)

type BGPTimeseriesResponseEnvelope

type BGPTimeseriesResponseEnvelope struct {
	Result  BGPTimeseriesResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    bgpTimeseriesResponseEnvelopeJSON `json:"-"`
}

func (*BGPTimeseriesResponseEnvelope) UnmarshalJSON

func (r *BGPTimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPTimeseriesResponseMeta

type BGPTimeseriesResponseMeta struct {
	AggInterval    string                                  `json:"aggInterval,required"`
	DateRange      []BGPTimeseriesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                               `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo BGPTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           bgpTimeseriesResponseMetaJSON           `json:"-"`
}

func (*BGPTimeseriesResponseMeta) UnmarshalJSON

func (r *BGPTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPTimeseriesResponseMetaConfidenceInfo

type BGPTimeseriesResponseMetaConfidenceInfo struct {
	Annotations []BGPTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                               `json:"level"`
	JSON        bgpTimeseriesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*BGPTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *BGPTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type BGPTimeseriesResponseMetaConfidenceInfoAnnotation

type BGPTimeseriesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                `json:"dataSource,required"`
	Description     string                                                `json:"description,required"`
	EventType       string                                                `json:"eventType,required"`
	IsInstantaneous bool                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                `json:"linkedUrl"`
	StartTime       time.Time                                             `json:"startTime" format:"date-time"`
	JSON            bgpTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*BGPTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *BGPTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type BGPTimeseriesResponseMetaDateRange

type BGPTimeseriesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                              `json:"startTime,required" format:"date-time"`
	JSON      bgpTimeseriesResponseMetaDateRangeJSON `json:"-"`
}

func (*BGPTimeseriesResponseMetaDateRange) UnmarshalJSON

func (r *BGPTimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type BGPTimeseriesResponseSerie0

type BGPTimeseriesResponseSerie0 struct {
	Timestamps []time.Time                     `json:"timestamps,required" format:"date-time"`
	Values     []string                        `json:"values,required"`
	JSON       bgpTimeseriesResponseSerie0JSON `json:"-"`
}

func (*BGPTimeseriesResponseSerie0) UnmarshalJSON

func (r *BGPTimeseriesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type BGPTopAseGetParams

type BGPTopAseGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[BGPTopAseGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of BGP network prefixes.
	Prefix param.Field[[]string] `query:"prefix"`
	// Array of BGP update types.
	UpdateType param.Field[[]BGPTopAseGetParamsUpdateType] `query:"updateType"`
}

func (BGPTopAseGetParams) URLQuery

func (r BGPTopAseGetParams) URLQuery() (v url.Values)

URLQuery serializes BGPTopAseGetParams's query parameters as `url.Values`.

type BGPTopAseGetParamsFormat

type BGPTopAseGetParamsFormat string

Format results are returned in.

const (
	BGPTopAseGetParamsFormatJson BGPTopAseGetParamsFormat = "JSON"
	BGPTopAseGetParamsFormatCsv  BGPTopAseGetParamsFormat = "CSV"
)

func (BGPTopAseGetParamsFormat) IsKnown

func (r BGPTopAseGetParamsFormat) IsKnown() bool

type BGPTopAseGetParamsUpdateType

type BGPTopAseGetParamsUpdateType string
const (
	BGPTopAseGetParamsUpdateTypeAnnouncement BGPTopAseGetParamsUpdateType = "ANNOUNCEMENT"
	BGPTopAseGetParamsUpdateTypeWithdrawal   BGPTopAseGetParamsUpdateType = "WITHDRAWAL"
)

func (BGPTopAseGetParamsUpdateType) IsKnown

func (r BGPTopAseGetParamsUpdateType) IsKnown() bool

type BGPTopAseGetResponse

type BGPTopAseGetResponse struct {
	Meta BGPTopAseGetResponseMeta   `json:"meta,required"`
	Top0 []BGPTopAseGetResponseTop0 `json:"top_0,required"`
	JSON bgpTopAseGetResponseJSON   `json:"-"`
}

func (*BGPTopAseGetResponse) UnmarshalJSON

func (r *BGPTopAseGetResponse) UnmarshalJSON(data []byte) (err error)

type BGPTopAseGetResponseEnvelope

type BGPTopAseGetResponseEnvelope struct {
	Result  BGPTopAseGetResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    bgpTopAseGetResponseEnvelopeJSON `json:"-"`
}

func (*BGPTopAseGetResponseEnvelope) UnmarshalJSON

func (r *BGPTopAseGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPTopAseGetResponseMeta

type BGPTopAseGetResponseMeta struct {
	DateRange []BGPTopAseGetResponseMetaDateRange `json:"dateRange,required"`
	JSON      bgpTopAseGetResponseMetaJSON        `json:"-"`
}

func (*BGPTopAseGetResponseMeta) UnmarshalJSON

func (r *BGPTopAseGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPTopAseGetResponseMetaDateRange

type BGPTopAseGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                             `json:"startTime,required" format:"date-time"`
	JSON      bgpTopAseGetResponseMetaDateRangeJSON `json:"-"`
}

func (*BGPTopAseGetResponseMetaDateRange) UnmarshalJSON

func (r *BGPTopAseGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type BGPTopAseGetResponseTop0

type BGPTopAseGetResponseTop0 struct {
	ASN    int64  `json:"asn,required"`
	AsName string `json:"ASName,required"`
	// Percentage of updates by this AS out of the total updates by all autonomous
	// systems.
	Value string                       `json:"value,required"`
	JSON  bgpTopAseGetResponseTop0JSON `json:"-"`
}

func (*BGPTopAseGetResponseTop0) UnmarshalJSON

func (r *BGPTopAseGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type BGPTopAsePrefixesParams

type BGPTopAsePrefixesParams struct {
	// Alpha-2 country code.
	Country param.Field[string] `query:"country"`
	// Format results are returned in.
	Format param.Field[BGPTopAsePrefixesParamsFormat] `query:"format"`
	// Maximum number of ASes to return
	Limit param.Field[int64] `query:"limit"`
}

func (BGPTopAsePrefixesParams) URLQuery

func (r BGPTopAsePrefixesParams) URLQuery() (v url.Values)

URLQuery serializes BGPTopAsePrefixesParams's query parameters as `url.Values`.

type BGPTopAsePrefixesParamsFormat

type BGPTopAsePrefixesParamsFormat string

Format results are returned in.

const (
	BGPTopAsePrefixesParamsFormatJson BGPTopAsePrefixesParamsFormat = "JSON"
	BGPTopAsePrefixesParamsFormatCsv  BGPTopAsePrefixesParamsFormat = "CSV"
)

func (BGPTopAsePrefixesParamsFormat) IsKnown

func (r BGPTopAsePrefixesParamsFormat) IsKnown() bool

type BGPTopAsePrefixesResponse

type BGPTopAsePrefixesResponse struct {
	ASNs []BGPTopAsePrefixesResponseASN `json:"asns,required"`
	Meta BGPTopAsePrefixesResponseMeta  `json:"meta,required"`
	JSON bgpTopAsePrefixesResponseJSON  `json:"-"`
}

func (*BGPTopAsePrefixesResponse) UnmarshalJSON

func (r *BGPTopAsePrefixesResponse) UnmarshalJSON(data []byte) (err error)

type BGPTopAsePrefixesResponseASN

type BGPTopAsePrefixesResponseASN struct {
	ASN       int64                            `json:"asn,required"`
	Country   string                           `json:"country,required"`
	Name      string                           `json:"name,required"`
	PfxsCount int64                            `json:"pfxs_count,required"`
	JSON      bgpTopAsePrefixesResponseASNJSON `json:"-"`
}

func (*BGPTopAsePrefixesResponseASN) UnmarshalJSON

func (r *BGPTopAsePrefixesResponseASN) UnmarshalJSON(data []byte) (err error)

type BGPTopAsePrefixesResponseEnvelope

type BGPTopAsePrefixesResponseEnvelope struct {
	Result  BGPTopAsePrefixesResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    bgpTopAsePrefixesResponseEnvelopeJSON `json:"-"`
}

func (*BGPTopAsePrefixesResponseEnvelope) UnmarshalJSON

func (r *BGPTopAsePrefixesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPTopAsePrefixesResponseMeta

type BGPTopAsePrefixesResponseMeta struct {
	DataTime   string                            `json:"data_time,required"`
	QueryTime  string                            `json:"query_time,required"`
	TotalPeers int64                             `json:"total_peers,required"`
	JSON       bgpTopAsePrefixesResponseMetaJSON `json:"-"`
}

func (*BGPTopAsePrefixesResponseMeta) UnmarshalJSON

func (r *BGPTopAsePrefixesResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPTopAseService

type BGPTopAseService struct {
	Options []option.RequestOption
}

BGPTopAseService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPTopAseService method instead.

func NewBGPTopAseService

func NewBGPTopAseService(opts ...option.RequestOption) (r *BGPTopAseService)

NewBGPTopAseService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BGPTopAseService) Get

Get the top autonomous systems (ASes) by BGP updates (announcements only). Values are a percentage out of the total updates.

func (*BGPTopAseService) Prefixes

Get the full list of autonomous systems on the global routing table ordered by announced prefixes count. The data comes from public BGP MRT data archives and updates every 2 hours.

type BGPTopPrefixesParams

type BGPTopPrefixesParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[BGPTopPrefixesParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Array of BGP update types.
	UpdateType param.Field[[]BGPTopPrefixesParamsUpdateType] `query:"updateType"`
}

func (BGPTopPrefixesParams) URLQuery

func (r BGPTopPrefixesParams) URLQuery() (v url.Values)

URLQuery serializes BGPTopPrefixesParams's query parameters as `url.Values`.

type BGPTopPrefixesParamsFormat

type BGPTopPrefixesParamsFormat string

Format results are returned in.

const (
	BGPTopPrefixesParamsFormatJson BGPTopPrefixesParamsFormat = "JSON"
	BGPTopPrefixesParamsFormatCsv  BGPTopPrefixesParamsFormat = "CSV"
)

func (BGPTopPrefixesParamsFormat) IsKnown

func (r BGPTopPrefixesParamsFormat) IsKnown() bool

type BGPTopPrefixesParamsUpdateType

type BGPTopPrefixesParamsUpdateType string
const (
	BGPTopPrefixesParamsUpdateTypeAnnouncement BGPTopPrefixesParamsUpdateType = "ANNOUNCEMENT"
	BGPTopPrefixesParamsUpdateTypeWithdrawal   BGPTopPrefixesParamsUpdateType = "WITHDRAWAL"
)

func (BGPTopPrefixesParamsUpdateType) IsKnown

type BGPTopPrefixesResponse

type BGPTopPrefixesResponse struct {
	Meta BGPTopPrefixesResponseMeta   `json:"meta,required"`
	Top0 []BGPTopPrefixesResponseTop0 `json:"top_0,required"`
	JSON bgpTopPrefixesResponseJSON   `json:"-"`
}

func (*BGPTopPrefixesResponse) UnmarshalJSON

func (r *BGPTopPrefixesResponse) UnmarshalJSON(data []byte) (err error)

type BGPTopPrefixesResponseEnvelope

type BGPTopPrefixesResponseEnvelope struct {
	Result  BGPTopPrefixesResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    bgpTopPrefixesResponseEnvelopeJSON `json:"-"`
}

func (*BGPTopPrefixesResponseEnvelope) UnmarshalJSON

func (r *BGPTopPrefixesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BGPTopPrefixesResponseMeta

type BGPTopPrefixesResponseMeta struct {
	DateRange []BGPTopPrefixesResponseMetaDateRange `json:"dateRange,required"`
	JSON      bgpTopPrefixesResponseMetaJSON        `json:"-"`
}

func (*BGPTopPrefixesResponseMeta) UnmarshalJSON

func (r *BGPTopPrefixesResponseMeta) UnmarshalJSON(data []byte) (err error)

type BGPTopPrefixesResponseMetaDateRange

type BGPTopPrefixesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                               `json:"startTime,required" format:"date-time"`
	JSON      bgpTopPrefixesResponseMetaDateRangeJSON `json:"-"`
}

func (*BGPTopPrefixesResponseMetaDateRange) UnmarshalJSON

func (r *BGPTopPrefixesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type BGPTopPrefixesResponseTop0

type BGPTopPrefixesResponseTop0 struct {
	Prefix string                         `json:"prefix,required"`
	Value  string                         `json:"value,required"`
	JSON   bgpTopPrefixesResponseTop0JSON `json:"-"`
}

func (*BGPTopPrefixesResponseTop0) UnmarshalJSON

func (r *BGPTopPrefixesResponseTop0) UnmarshalJSON(data []byte) (err error)

type BGPTopService

type BGPTopService struct {
	Options []option.RequestOption
	Ases    *BGPTopAseService
}

BGPTopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBGPTopService method instead.

func NewBGPTopService

func NewBGPTopService(opts ...option.RequestOption) (r *BGPTopService)

NewBGPTopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BGPTopService) Prefixes

Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates.

type BgpipTimeseriesParamsFormat

type BgpipTimeseriesParamsFormat string

Format results are returned in.

const (
	BgpipTimeseriesParamsFormatJson BgpipTimeseriesParamsFormat = "JSON"
	BgpipTimeseriesParamsFormatCsv  BgpipTimeseriesParamsFormat = "CSV"
)

func (BgpipTimeseriesParamsFormat) IsKnown

func (r BgpipTimeseriesParamsFormat) IsKnown() bool

type BgpipTimeseriesParamsIPVersion

type BgpipTimeseriesParamsIPVersion string
const (
	BgpipTimeseriesParamsIPVersionIPv4 BgpipTimeseriesParamsIPVersion = "IPv4"
	BgpipTimeseriesParamsIPVersionIPv6 BgpipTimeseriesParamsIPVersion = "IPv6"
)

func (BgpipTimeseriesParamsIPVersion) IsKnown

type BgpipTimeseriesResponse

type BgpipTimeseriesResponse struct {
	Meta     BgpipTimeseriesResponseMeta     `json:"meta,required"`
	Serie174 BgpipTimeseriesResponseSerie174 `json:"serie_174,required"`
	JSON     bgpipTimeseriesResponseJSON     `json:"-"`
}

func (*BgpipTimeseriesResponse) UnmarshalJSON

func (r *BgpipTimeseriesResponse) UnmarshalJSON(data []byte) (err error)

type BgpipTimeseriesResponseEnvelope

type BgpipTimeseriesResponseEnvelope struct {
	Result  BgpipTimeseriesResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    bgpipTimeseriesResponseEnvelopeJSON `json:"-"`
}

func (*BgpipTimeseriesResponseEnvelope) UnmarshalJSON

func (r *BgpipTimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type BgpipTimeseriesResponseMeta

type BgpipTimeseriesResponseMeta struct {
	Queries []BgpipTimeseriesResponseMetaQuery `json:"queries,required"`
	JSON    bgpipTimeseriesResponseMetaJSON    `json:"-"`
}

func (*BgpipTimeseriesResponseMeta) UnmarshalJSON

func (r *BgpipTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)

type BgpipTimeseriesResponseMetaQueriesDateRange

type BgpipTimeseriesResponseMetaQueriesDateRange struct {
	EndTime   string                                          `json:"endTime,required"`
	StartTime string                                          `json:"startTime,required"`
	JSON      bgpipTimeseriesResponseMetaQueriesDateRangeJSON `json:"-"`
}

func (*BgpipTimeseriesResponseMetaQueriesDateRange) UnmarshalJSON

func (r *BgpipTimeseriesResponseMetaQueriesDateRange) UnmarshalJSON(data []byte) (err error)

type BgpipTimeseriesResponseMetaQuery

type BgpipTimeseriesResponseMetaQuery struct {
	DateRange BgpipTimeseriesResponseMetaQueriesDateRange `json:"dateRange,required"`
	Entity    string                                      `json:"entity,required"`
	JSON      bgpipTimeseriesResponseMetaQueryJSON        `json:"-"`
}

func (*BgpipTimeseriesResponseMetaQuery) UnmarshalJSON

func (r *BgpipTimeseriesResponseMetaQuery) UnmarshalJSON(data []byte) (err error)

type BgpipTimeseriesResponseSerie174

type BgpipTimeseriesResponseSerie174 struct {
	IPV4       []string                            `json:"ipv4,required"`
	IPV6       []string                            `json:"ipv6,required"`
	Timestamps []time.Time                         `json:"timestamps,required" format:"date-time"`
	JSON       bgpipTimeseriesResponseSerie174JSON `json:"-"`
}

func (*BgpipTimeseriesResponseSerie174) UnmarshalJSON

func (r *BgpipTimeseriesResponseSerie174) UnmarshalJSON(data []byte) (err error)

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type DNSService

type DNSService struct {
	Options []option.RequestOption
	Top     *DNSTopService
}

DNSService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDNSService method instead.

func NewDNSService

func NewDNSService(opts ...option.RequestOption) (r *DNSService)

NewDNSService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type DNSTopAsesParams

type DNSTopAsesParams struct {
	// Array of domain names.
	Domain param.Field[[]string] `query:"domain,required"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[DNSTopAsesParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (DNSTopAsesParams) URLQuery

func (r DNSTopAsesParams) URLQuery() (v url.Values)

URLQuery serializes DNSTopAsesParams's query parameters as `url.Values`.

type DNSTopAsesParamsFormat

type DNSTopAsesParamsFormat string

Format results are returned in.

const (
	DNSTopAsesParamsFormatJson DNSTopAsesParamsFormat = "JSON"
	DNSTopAsesParamsFormatCsv  DNSTopAsesParamsFormat = "CSV"
)

func (DNSTopAsesParamsFormat) IsKnown

func (r DNSTopAsesParamsFormat) IsKnown() bool

type DNSTopAsesResponse

type DNSTopAsesResponse struct {
	Meta DNSTopAsesResponseMeta   `json:"meta,required"`
	Top0 []DNSTopAsesResponseTop0 `json:"top_0,required"`
	JSON dnsTopAsesResponseJSON   `json:"-"`
}

func (*DNSTopAsesResponse) UnmarshalJSON

func (r *DNSTopAsesResponse) UnmarshalJSON(data []byte) (err error)

type DNSTopAsesResponseEnvelope

type DNSTopAsesResponseEnvelope struct {
	Result  DNSTopAsesResponse             `json:"result,required"`
	Success bool                           `json:"success,required"`
	JSON    dnsTopAsesResponseEnvelopeJSON `json:"-"`
}

func (*DNSTopAsesResponseEnvelope) UnmarshalJSON

func (r *DNSTopAsesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DNSTopAsesResponseMeta

type DNSTopAsesResponseMeta struct {
	DateRange      []DNSTopAsesResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo DNSTopAsesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           dnsTopAsesResponseMetaJSON           `json:"-"`
}

func (*DNSTopAsesResponseMeta) UnmarshalJSON

func (r *DNSTopAsesResponseMeta) UnmarshalJSON(data []byte) (err error)

type DNSTopAsesResponseMetaConfidenceInfo

type DNSTopAsesResponseMetaConfidenceInfo struct {
	Annotations []DNSTopAsesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                            `json:"level"`
	JSON        dnsTopAsesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*DNSTopAsesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *DNSTopAsesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type DNSTopAsesResponseMetaConfidenceInfoAnnotation

type DNSTopAsesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                             `json:"dataSource,required"`
	Description     string                                             `json:"description,required"`
	EventType       string                                             `json:"eventType,required"`
	IsInstantaneous bool                                               `json:"isInstantaneous,required"`
	EndTime         time.Time                                          `json:"endTime" format:"date-time"`
	LinkedURL       string                                             `json:"linkedUrl"`
	StartTime       time.Time                                          `json:"startTime" format:"date-time"`
	JSON            dnsTopAsesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*DNSTopAsesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *DNSTopAsesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type DNSTopAsesResponseMetaDateRange

type DNSTopAsesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                           `json:"startTime,required" format:"date-time"`
	JSON      dnsTopAsesResponseMetaDateRangeJSON `json:"-"`
}

func (*DNSTopAsesResponseMetaDateRange) UnmarshalJSON

func (r *DNSTopAsesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type DNSTopAsesResponseTop0

type DNSTopAsesResponseTop0 struct {
	ClientASN    int64                      `json:"clientASN,required"`
	ClientAsName string                     `json:"clientASName,required"`
	Value        string                     `json:"value,required"`
	JSON         dnsTopAsesResponseTop0JSON `json:"-"`
}

func (*DNSTopAsesResponseTop0) UnmarshalJSON

func (r *DNSTopAsesResponseTop0) UnmarshalJSON(data []byte) (err error)

type DNSTopLocationsParams

type DNSTopLocationsParams struct {
	// Array of domain names.
	Domain param.Field[[]string] `query:"domain,required"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[DNSTopLocationsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (DNSTopLocationsParams) URLQuery

func (r DNSTopLocationsParams) URLQuery() (v url.Values)

URLQuery serializes DNSTopLocationsParams's query parameters as `url.Values`.

type DNSTopLocationsParamsFormat

type DNSTopLocationsParamsFormat string

Format results are returned in.

const (
	DNSTopLocationsParamsFormatJson DNSTopLocationsParamsFormat = "JSON"
	DNSTopLocationsParamsFormatCsv  DNSTopLocationsParamsFormat = "CSV"
)

func (DNSTopLocationsParamsFormat) IsKnown

func (r DNSTopLocationsParamsFormat) IsKnown() bool

type DNSTopLocationsResponse

type DNSTopLocationsResponse struct {
	Meta DNSTopLocationsResponseMeta   `json:"meta,required"`
	Top0 []DNSTopLocationsResponseTop0 `json:"top_0,required"`
	JSON dnsTopLocationsResponseJSON   `json:"-"`
}

func (*DNSTopLocationsResponse) UnmarshalJSON

func (r *DNSTopLocationsResponse) UnmarshalJSON(data []byte) (err error)

type DNSTopLocationsResponseEnvelope

type DNSTopLocationsResponseEnvelope struct {
	Result  DNSTopLocationsResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    dnsTopLocationsResponseEnvelopeJSON `json:"-"`
}

func (*DNSTopLocationsResponseEnvelope) UnmarshalJSON

func (r *DNSTopLocationsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DNSTopLocationsResponseMeta

type DNSTopLocationsResponseMeta struct {
	DateRange      []DNSTopLocationsResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo DNSTopLocationsResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           dnsTopLocationsResponseMetaJSON           `json:"-"`
}

func (*DNSTopLocationsResponseMeta) UnmarshalJSON

func (r *DNSTopLocationsResponseMeta) UnmarshalJSON(data []byte) (err error)

type DNSTopLocationsResponseMetaConfidenceInfo

type DNSTopLocationsResponseMetaConfidenceInfo struct {
	Annotations []DNSTopLocationsResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                 `json:"level"`
	JSON        dnsTopLocationsResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*DNSTopLocationsResponseMetaConfidenceInfo) UnmarshalJSON

func (r *DNSTopLocationsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type DNSTopLocationsResponseMetaConfidenceInfoAnnotation

type DNSTopLocationsResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                  `json:"dataSource,required"`
	Description     string                                                  `json:"description,required"`
	EventType       string                                                  `json:"eventType,required"`
	IsInstantaneous bool                                                    `json:"isInstantaneous,required"`
	EndTime         time.Time                                               `json:"endTime" format:"date-time"`
	LinkedURL       string                                                  `json:"linkedUrl"`
	StartTime       time.Time                                               `json:"startTime" format:"date-time"`
	JSON            dnsTopLocationsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*DNSTopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *DNSTopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type DNSTopLocationsResponseMetaDateRange

type DNSTopLocationsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                `json:"startTime,required" format:"date-time"`
	JSON      dnsTopLocationsResponseMetaDateRangeJSON `json:"-"`
}

func (*DNSTopLocationsResponseMetaDateRange) UnmarshalJSON

func (r *DNSTopLocationsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type DNSTopLocationsResponseTop0

type DNSTopLocationsResponseTop0 struct {
	ClientCountryAlpha2 string                          `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                          `json:"clientCountryName,required"`
	Value               string                          `json:"value,required"`
	JSON                dnsTopLocationsResponseTop0JSON `json:"-"`
}

func (*DNSTopLocationsResponseTop0) UnmarshalJSON

func (r *DNSTopLocationsResponseTop0) UnmarshalJSON(data []byte) (err error)

type DNSTopService

type DNSTopService struct {
	Options []option.RequestOption
}

DNSTopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDNSTopService method instead.

func NewDNSTopService

func NewDNSTopService(opts ...option.RequestOption) (r *DNSTopService)

NewDNSTopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*DNSTopService) Ases

func (r *DNSTopService) Ases(ctx context.Context, query DNSTopAsesParams, opts ...option.RequestOption) (res *DNSTopAsesResponse, err error)

Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver.

func (*DNSTopService) Locations

Get top locations by DNS queries made to Cloudflare's public DNS resolver.

type DatasetDownloadParams

type DatasetDownloadParams struct {
	DatasetID param.Field[int64] `json:"datasetId,required"`
	// Format results are returned in.
	Format param.Field[DatasetDownloadParamsFormat] `query:"format"`
}

func (DatasetDownloadParams) MarshalJSON

func (r DatasetDownloadParams) MarshalJSON() (data []byte, err error)

func (DatasetDownloadParams) URLQuery

func (r DatasetDownloadParams) URLQuery() (v url.Values)

URLQuery serializes DatasetDownloadParams's query parameters as `url.Values`.

type DatasetDownloadParamsFormat

type DatasetDownloadParamsFormat string

Format results are returned in.

const (
	DatasetDownloadParamsFormatJson DatasetDownloadParamsFormat = "JSON"
	DatasetDownloadParamsFormatCsv  DatasetDownloadParamsFormat = "CSV"
)

func (DatasetDownloadParamsFormat) IsKnown

func (r DatasetDownloadParamsFormat) IsKnown() bool

type DatasetDownloadResponse

type DatasetDownloadResponse struct {
	Dataset DatasetDownloadResponseDataset `json:"dataset,required"`
	JSON    datasetDownloadResponseJSON    `json:"-"`
}

func (*DatasetDownloadResponse) UnmarshalJSON

func (r *DatasetDownloadResponse) UnmarshalJSON(data []byte) (err error)

type DatasetDownloadResponseDataset

type DatasetDownloadResponseDataset struct {
	URL  string                             `json:"url,required"`
	JSON datasetDownloadResponseDatasetJSON `json:"-"`
}

func (*DatasetDownloadResponseDataset) UnmarshalJSON

func (r *DatasetDownloadResponseDataset) UnmarshalJSON(data []byte) (err error)

type DatasetDownloadResponseEnvelope

type DatasetDownloadResponseEnvelope struct {
	Result DatasetDownloadResponse             `json:"result,required"`
	JSON   datasetDownloadResponseEnvelopeJSON `json:"-"`
}

func (*DatasetDownloadResponseEnvelope) UnmarshalJSON

func (r *DatasetDownloadResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatasetListParams

type DatasetListParams struct {
	// Dataset type.
	DatasetType param.Field[DatasetListParamsDatasetType] `query:"datasetType"`
	// Format results are returned in.
	Format param.Field[DatasetListParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Number of objects to skip before grabbing results.
	Offset param.Field[int64] `query:"offset"`
}

func (DatasetListParams) URLQuery

func (r DatasetListParams) URLQuery() (v url.Values)

URLQuery serializes DatasetListParams's query parameters as `url.Values`.

type DatasetListParamsDatasetType

type DatasetListParamsDatasetType string

Dataset type.

const (
	DatasetListParamsDatasetTypeRankingBucket DatasetListParamsDatasetType = "RANKING_BUCKET"
	DatasetListParamsDatasetTypeReport        DatasetListParamsDatasetType = "REPORT"
)

func (DatasetListParamsDatasetType) IsKnown

func (r DatasetListParamsDatasetType) IsKnown() bool

type DatasetListParamsFormat

type DatasetListParamsFormat string

Format results are returned in.

const (
	DatasetListParamsFormatJson DatasetListParamsFormat = "JSON"
	DatasetListParamsFormatCsv  DatasetListParamsFormat = "CSV"
)

func (DatasetListParamsFormat) IsKnown

func (r DatasetListParamsFormat) IsKnown() bool

type DatasetListResponse

type DatasetListResponse struct {
	Datasets []DatasetListResponseDataset `json:"datasets,required"`
	JSON     datasetListResponseJSON      `json:"-"`
}

func (*DatasetListResponse) UnmarshalJSON

func (r *DatasetListResponse) UnmarshalJSON(data []byte) (err error)

type DatasetListResponseDataset

type DatasetListResponseDataset struct {
	ID          int64                          `json:"id,required"`
	Description string                         `json:"description,required"`
	Meta        interface{}                    `json:"meta,required"`
	Tags        []string                       `json:"tags,required"`
	Title       string                         `json:"title,required"`
	Type        string                         `json:"type,required"`
	JSON        datasetListResponseDatasetJSON `json:"-"`
}

func (*DatasetListResponseDataset) UnmarshalJSON

func (r *DatasetListResponseDataset) UnmarshalJSON(data []byte) (err error)

type DatasetListResponseEnvelope

type DatasetListResponseEnvelope struct {
	Result  DatasetListResponse             `json:"result,required"`
	Success bool                            `json:"success,required"`
	JSON    datasetListResponseEnvelopeJSON `json:"-"`
}

func (*DatasetListResponseEnvelope) UnmarshalJSON

func (r *DatasetListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatasetService

type DatasetService struct {
	Options []option.RequestOption
}

DatasetService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDatasetService method instead.

func NewDatasetService

func NewDatasetService(opts ...option.RequestOption) (r *DatasetService)

NewDatasetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*DatasetService) Download

Get a url to download a single dataset.

func (*DatasetService) Get

func (r *DatasetService) Get(ctx context.Context, alias string, opts ...option.RequestOption) (res *string, err error)

Get the CSV content of a given dataset by alias or ID. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date.

func (*DatasetService) List

Get a list of datasets.

type EmailRoutingService

type EmailRoutingService struct {
	Options          []option.RequestOption
	Summary          *EmailRoutingSummaryService
	TimeseriesGroups *EmailRoutingTimeseriesGroupService
}

EmailRoutingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailRoutingService method instead.

func NewEmailRoutingService

func NewEmailRoutingService(opts ...option.RequestOption) (r *EmailRoutingService)

NewEmailRoutingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type EmailRoutingSummaryARCParams

type EmailRoutingSummaryARCParams struct {
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingSummaryARCParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingSummaryARCParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingSummaryARCParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingSummaryARCParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingSummaryARCParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingSummaryARCParamsSPF] `query:"spf"`
}

func (EmailRoutingSummaryARCParams) URLQuery

func (r EmailRoutingSummaryARCParams) URLQuery() (v url.Values)

URLQuery serializes EmailRoutingSummaryARCParams's query parameters as `url.Values`.

type EmailRoutingSummaryARCParamsDKIM

type EmailRoutingSummaryARCParamsDKIM string
const (
	EmailRoutingSummaryARCParamsDKIMPass EmailRoutingSummaryARCParamsDKIM = "PASS"
	EmailRoutingSummaryARCParamsDKIMNone EmailRoutingSummaryARCParamsDKIM = "NONE"
	EmailRoutingSummaryARCParamsDKIMFail EmailRoutingSummaryARCParamsDKIM = "FAIL"
)

func (EmailRoutingSummaryARCParamsDKIM) IsKnown

type EmailRoutingSummaryARCParamsDMARC

type EmailRoutingSummaryARCParamsDMARC string
const (
	EmailRoutingSummaryARCParamsDMARCPass EmailRoutingSummaryARCParamsDMARC = "PASS"
	EmailRoutingSummaryARCParamsDMARCNone EmailRoutingSummaryARCParamsDMARC = "NONE"
	EmailRoutingSummaryARCParamsDMARCFail EmailRoutingSummaryARCParamsDMARC = "FAIL"
)

func (EmailRoutingSummaryARCParamsDMARC) IsKnown

type EmailRoutingSummaryARCParamsEncrypted

type EmailRoutingSummaryARCParamsEncrypted string
const (
	EmailRoutingSummaryARCParamsEncryptedEncrypted    EmailRoutingSummaryARCParamsEncrypted = "ENCRYPTED"
	EmailRoutingSummaryARCParamsEncryptedNotEncrypted EmailRoutingSummaryARCParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingSummaryARCParamsEncrypted) IsKnown

type EmailRoutingSummaryARCParamsFormat

type EmailRoutingSummaryARCParamsFormat string

Format results are returned in.

const (
	EmailRoutingSummaryARCParamsFormatJson EmailRoutingSummaryARCParamsFormat = "JSON"
	EmailRoutingSummaryARCParamsFormatCsv  EmailRoutingSummaryARCParamsFormat = "CSV"
)

func (EmailRoutingSummaryARCParamsFormat) IsKnown

type EmailRoutingSummaryARCParamsIPVersion

type EmailRoutingSummaryARCParamsIPVersion string
const (
	EmailRoutingSummaryARCParamsIPVersionIPv4 EmailRoutingSummaryARCParamsIPVersion = "IPv4"
	EmailRoutingSummaryARCParamsIPVersionIPv6 EmailRoutingSummaryARCParamsIPVersion = "IPv6"
)

func (EmailRoutingSummaryARCParamsIPVersion) IsKnown

type EmailRoutingSummaryARCParamsSPF

type EmailRoutingSummaryARCParamsSPF string
const (
	EmailRoutingSummaryARCParamsSPFPass EmailRoutingSummaryARCParamsSPF = "PASS"
	EmailRoutingSummaryARCParamsSPFNone EmailRoutingSummaryARCParamsSPF = "NONE"
	EmailRoutingSummaryARCParamsSPFFail EmailRoutingSummaryARCParamsSPF = "FAIL"
)

func (EmailRoutingSummaryARCParamsSPF) IsKnown

type EmailRoutingSummaryARCResponse

type EmailRoutingSummaryARCResponse struct {
	Meta     EmailRoutingSummaryARCResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                  `json:"summary_0,required"`
	JSON     emailRoutingSummaryARCResponseJSON `json:"-"`
}

func (*EmailRoutingSummaryARCResponse) UnmarshalJSON

func (r *EmailRoutingSummaryARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryARCResponseEnvelope

type EmailRoutingSummaryARCResponseEnvelope struct {
	Result  EmailRoutingSummaryARCResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    emailRoutingSummaryARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingSummaryARCResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingSummaryARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryARCResponseMeta

type EmailRoutingSummaryARCResponseMeta struct {
	DateRange      []EmailRoutingSummaryARCResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	Normalization  string                                           `json:"normalization,required"`
	ConfidenceInfo EmailRoutingSummaryARCResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailRoutingSummaryARCResponseMetaJSON           `json:"-"`
}

func (*EmailRoutingSummaryARCResponseMeta) UnmarshalJSON

func (r *EmailRoutingSummaryARCResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryARCResponseMetaConfidenceInfo

type EmailRoutingSummaryARCResponseMetaConfidenceInfo struct {
	Annotations []EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        emailRoutingSummaryARCResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailRoutingSummaryARCResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailRoutingSummaryARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation

type EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            emailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailRoutingSummaryARCResponseMetaDateRange

type EmailRoutingSummaryARCResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      emailRoutingSummaryARCResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailRoutingSummaryARCResponseMetaDateRange) UnmarshalJSON

func (r *EmailRoutingSummaryARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDKIMParams

type EmailRoutingSummaryDKIMParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingSummaryDKIMParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingSummaryDKIMParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingSummaryDKIMParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingSummaryDKIMParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingSummaryDKIMParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingSummaryDKIMParamsSPF] `query:"spf"`
}

func (EmailRoutingSummaryDKIMParams) URLQuery

func (r EmailRoutingSummaryDKIMParams) URLQuery() (v url.Values)

URLQuery serializes EmailRoutingSummaryDKIMParams's query parameters as `url.Values`.

type EmailRoutingSummaryDKIMParamsARC

type EmailRoutingSummaryDKIMParamsARC string
const (
	EmailRoutingSummaryDKIMParamsARCPass EmailRoutingSummaryDKIMParamsARC = "PASS"
	EmailRoutingSummaryDKIMParamsARCNone EmailRoutingSummaryDKIMParamsARC = "NONE"
	EmailRoutingSummaryDKIMParamsARCFail EmailRoutingSummaryDKIMParamsARC = "FAIL"
)

func (EmailRoutingSummaryDKIMParamsARC) IsKnown

type EmailRoutingSummaryDKIMParamsDMARC

type EmailRoutingSummaryDKIMParamsDMARC string
const (
	EmailRoutingSummaryDKIMParamsDMARCPass EmailRoutingSummaryDKIMParamsDMARC = "PASS"
	EmailRoutingSummaryDKIMParamsDMARCNone EmailRoutingSummaryDKIMParamsDMARC = "NONE"
	EmailRoutingSummaryDKIMParamsDMARCFail EmailRoutingSummaryDKIMParamsDMARC = "FAIL"
)

func (EmailRoutingSummaryDKIMParamsDMARC) IsKnown

type EmailRoutingSummaryDKIMParamsEncrypted

type EmailRoutingSummaryDKIMParamsEncrypted string
const (
	EmailRoutingSummaryDKIMParamsEncryptedEncrypted    EmailRoutingSummaryDKIMParamsEncrypted = "ENCRYPTED"
	EmailRoutingSummaryDKIMParamsEncryptedNotEncrypted EmailRoutingSummaryDKIMParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingSummaryDKIMParamsEncrypted) IsKnown

type EmailRoutingSummaryDKIMParamsFormat

type EmailRoutingSummaryDKIMParamsFormat string

Format results are returned in.

const (
	EmailRoutingSummaryDKIMParamsFormatJson EmailRoutingSummaryDKIMParamsFormat = "JSON"
	EmailRoutingSummaryDKIMParamsFormatCsv  EmailRoutingSummaryDKIMParamsFormat = "CSV"
)

func (EmailRoutingSummaryDKIMParamsFormat) IsKnown

type EmailRoutingSummaryDKIMParamsIPVersion

type EmailRoutingSummaryDKIMParamsIPVersion string
const (
	EmailRoutingSummaryDKIMParamsIPVersionIPv4 EmailRoutingSummaryDKIMParamsIPVersion = "IPv4"
	EmailRoutingSummaryDKIMParamsIPVersionIPv6 EmailRoutingSummaryDKIMParamsIPVersion = "IPv6"
)

func (EmailRoutingSummaryDKIMParamsIPVersion) IsKnown

type EmailRoutingSummaryDKIMParamsSPF

type EmailRoutingSummaryDKIMParamsSPF string
const (
	EmailRoutingSummaryDKIMParamsSPFPass EmailRoutingSummaryDKIMParamsSPF = "PASS"
	EmailRoutingSummaryDKIMParamsSPFNone EmailRoutingSummaryDKIMParamsSPF = "NONE"
	EmailRoutingSummaryDKIMParamsSPFFail EmailRoutingSummaryDKIMParamsSPF = "FAIL"
)

func (EmailRoutingSummaryDKIMParamsSPF) IsKnown

type EmailRoutingSummaryDKIMResponse

type EmailRoutingSummaryDKIMResponse struct {
	Meta     EmailRoutingSummaryDKIMResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                   `json:"summary_0,required"`
	JSON     emailRoutingSummaryDKIMResponseJSON `json:"-"`
}

func (*EmailRoutingSummaryDKIMResponse) UnmarshalJSON

func (r *EmailRoutingSummaryDKIMResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDKIMResponseEnvelope

type EmailRoutingSummaryDKIMResponseEnvelope struct {
	Result  EmailRoutingSummaryDKIMResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    emailRoutingSummaryDKIMResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingSummaryDKIMResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingSummaryDKIMResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDKIMResponseMeta

type EmailRoutingSummaryDKIMResponseMeta struct {
	DateRange      []EmailRoutingSummaryDKIMResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	Normalization  string                                            `json:"normalization,required"`
	ConfidenceInfo EmailRoutingSummaryDKIMResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailRoutingSummaryDKIMResponseMetaJSON           `json:"-"`
}

func (*EmailRoutingSummaryDKIMResponseMeta) UnmarshalJSON

func (r *EmailRoutingSummaryDKIMResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDKIMResponseMetaConfidenceInfo

type EmailRoutingSummaryDKIMResponseMetaConfidenceInfo struct {
	Annotations []EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        emailRoutingSummaryDKIMResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailRoutingSummaryDKIMResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailRoutingSummaryDKIMResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation

type EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            emailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailRoutingSummaryDKIMResponseMetaDateRange

type EmailRoutingSummaryDKIMResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      emailRoutingSummaryDKIMResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailRoutingSummaryDKIMResponseMetaDateRange) UnmarshalJSON

func (r *EmailRoutingSummaryDKIMResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDMARCParams

type EmailRoutingSummaryDMARCParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingSummaryDMARCParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingSummaryDMARCParamsDKIM] `query:"dkim"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingSummaryDMARCParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingSummaryDMARCParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingSummaryDMARCParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingSummaryDMARCParamsSPF] `query:"spf"`
}

func (EmailRoutingSummaryDMARCParams) URLQuery

func (r EmailRoutingSummaryDMARCParams) URLQuery() (v url.Values)

URLQuery serializes EmailRoutingSummaryDMARCParams's query parameters as `url.Values`.

type EmailRoutingSummaryDMARCParamsARC

type EmailRoutingSummaryDMARCParamsARC string
const (
	EmailRoutingSummaryDMARCParamsARCPass EmailRoutingSummaryDMARCParamsARC = "PASS"
	EmailRoutingSummaryDMARCParamsARCNone EmailRoutingSummaryDMARCParamsARC = "NONE"
	EmailRoutingSummaryDMARCParamsARCFail EmailRoutingSummaryDMARCParamsARC = "FAIL"
)

func (EmailRoutingSummaryDMARCParamsARC) IsKnown

type EmailRoutingSummaryDMARCParamsDKIM

type EmailRoutingSummaryDMARCParamsDKIM string
const (
	EmailRoutingSummaryDMARCParamsDKIMPass EmailRoutingSummaryDMARCParamsDKIM = "PASS"
	EmailRoutingSummaryDMARCParamsDKIMNone EmailRoutingSummaryDMARCParamsDKIM = "NONE"
	EmailRoutingSummaryDMARCParamsDKIMFail EmailRoutingSummaryDMARCParamsDKIM = "FAIL"
)

func (EmailRoutingSummaryDMARCParamsDKIM) IsKnown

type EmailRoutingSummaryDMARCParamsEncrypted

type EmailRoutingSummaryDMARCParamsEncrypted string
const (
	EmailRoutingSummaryDMARCParamsEncryptedEncrypted    EmailRoutingSummaryDMARCParamsEncrypted = "ENCRYPTED"
	EmailRoutingSummaryDMARCParamsEncryptedNotEncrypted EmailRoutingSummaryDMARCParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingSummaryDMARCParamsEncrypted) IsKnown

type EmailRoutingSummaryDMARCParamsFormat

type EmailRoutingSummaryDMARCParamsFormat string

Format results are returned in.

const (
	EmailRoutingSummaryDMARCParamsFormatJson EmailRoutingSummaryDMARCParamsFormat = "JSON"
	EmailRoutingSummaryDMARCParamsFormatCsv  EmailRoutingSummaryDMARCParamsFormat = "CSV"
)

func (EmailRoutingSummaryDMARCParamsFormat) IsKnown

type EmailRoutingSummaryDMARCParamsIPVersion

type EmailRoutingSummaryDMARCParamsIPVersion string
const (
	EmailRoutingSummaryDMARCParamsIPVersionIPv4 EmailRoutingSummaryDMARCParamsIPVersion = "IPv4"
	EmailRoutingSummaryDMARCParamsIPVersionIPv6 EmailRoutingSummaryDMARCParamsIPVersion = "IPv6"
)

func (EmailRoutingSummaryDMARCParamsIPVersion) IsKnown

type EmailRoutingSummaryDMARCParamsSPF

type EmailRoutingSummaryDMARCParamsSPF string
const (
	EmailRoutingSummaryDMARCParamsSPFPass EmailRoutingSummaryDMARCParamsSPF = "PASS"
	EmailRoutingSummaryDMARCParamsSPFNone EmailRoutingSummaryDMARCParamsSPF = "NONE"
	EmailRoutingSummaryDMARCParamsSPFFail EmailRoutingSummaryDMARCParamsSPF = "FAIL"
)

func (EmailRoutingSummaryDMARCParamsSPF) IsKnown

type EmailRoutingSummaryDMARCResponse

type EmailRoutingSummaryDMARCResponse struct {
	Meta     EmailRoutingSummaryDMARCResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                    `json:"summary_0,required"`
	JSON     emailRoutingSummaryDMARCResponseJSON `json:"-"`
}

func (*EmailRoutingSummaryDMARCResponse) UnmarshalJSON

func (r *EmailRoutingSummaryDMARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDMARCResponseEnvelope

type EmailRoutingSummaryDMARCResponseEnvelope struct {
	Result  EmailRoutingSummaryDMARCResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    emailRoutingSummaryDMARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingSummaryDMARCResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingSummaryDMARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDMARCResponseMeta

type EmailRoutingSummaryDMARCResponseMeta struct {
	DateRange      []EmailRoutingSummaryDMARCResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                             `json:"lastUpdated,required"`
	Normalization  string                                             `json:"normalization,required"`
	ConfidenceInfo EmailRoutingSummaryDMARCResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailRoutingSummaryDMARCResponseMetaJSON           `json:"-"`
}

func (*EmailRoutingSummaryDMARCResponseMeta) UnmarshalJSON

func (r *EmailRoutingSummaryDMARCResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDMARCResponseMetaConfidenceInfo

type EmailRoutingSummaryDMARCResponseMetaConfidenceInfo struct {
	Annotations []EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                          `json:"level"`
	JSON        emailRoutingSummaryDMARCResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailRoutingSummaryDMARCResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailRoutingSummaryDMARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation

type EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                           `json:"dataSource,required"`
	Description     string                                                           `json:"description,required"`
	EventType       string                                                           `json:"eventType,required"`
	IsInstantaneous bool                                                             `json:"isInstantaneous,required"`
	EndTime         time.Time                                                        `json:"endTime" format:"date-time"`
	LinkedURL       string                                                           `json:"linkedUrl"`
	StartTime       time.Time                                                        `json:"startTime" format:"date-time"`
	JSON            emailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailRoutingSummaryDMARCResponseMetaDateRange

type EmailRoutingSummaryDMARCResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                         `json:"startTime,required" format:"date-time"`
	JSON      emailRoutingSummaryDMARCResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailRoutingSummaryDMARCResponseMetaDateRange) UnmarshalJSON

func (r *EmailRoutingSummaryDMARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryEncryptedParams

type EmailRoutingSummaryEncryptedParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingSummaryEncryptedParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingSummaryEncryptedParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingSummaryEncryptedParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailRoutingSummaryEncryptedParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingSummaryEncryptedParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingSummaryEncryptedParamsSPF] `query:"spf"`
}

func (EmailRoutingSummaryEncryptedParams) URLQuery

URLQuery serializes EmailRoutingSummaryEncryptedParams's query parameters as `url.Values`.

type EmailRoutingSummaryEncryptedParamsARC

type EmailRoutingSummaryEncryptedParamsARC string
const (
	EmailRoutingSummaryEncryptedParamsARCPass EmailRoutingSummaryEncryptedParamsARC = "PASS"
	EmailRoutingSummaryEncryptedParamsARCNone EmailRoutingSummaryEncryptedParamsARC = "NONE"
	EmailRoutingSummaryEncryptedParamsARCFail EmailRoutingSummaryEncryptedParamsARC = "FAIL"
)

func (EmailRoutingSummaryEncryptedParamsARC) IsKnown

type EmailRoutingSummaryEncryptedParamsDKIM

type EmailRoutingSummaryEncryptedParamsDKIM string
const (
	EmailRoutingSummaryEncryptedParamsDKIMPass EmailRoutingSummaryEncryptedParamsDKIM = "PASS"
	EmailRoutingSummaryEncryptedParamsDKIMNone EmailRoutingSummaryEncryptedParamsDKIM = "NONE"
	EmailRoutingSummaryEncryptedParamsDKIMFail EmailRoutingSummaryEncryptedParamsDKIM = "FAIL"
)

func (EmailRoutingSummaryEncryptedParamsDKIM) IsKnown

type EmailRoutingSummaryEncryptedParamsDMARC

type EmailRoutingSummaryEncryptedParamsDMARC string
const (
	EmailRoutingSummaryEncryptedParamsDMARCPass EmailRoutingSummaryEncryptedParamsDMARC = "PASS"
	EmailRoutingSummaryEncryptedParamsDMARCNone EmailRoutingSummaryEncryptedParamsDMARC = "NONE"
	EmailRoutingSummaryEncryptedParamsDMARCFail EmailRoutingSummaryEncryptedParamsDMARC = "FAIL"
)

func (EmailRoutingSummaryEncryptedParamsDMARC) IsKnown

type EmailRoutingSummaryEncryptedParamsFormat

type EmailRoutingSummaryEncryptedParamsFormat string

Format results are returned in.

const (
	EmailRoutingSummaryEncryptedParamsFormatJson EmailRoutingSummaryEncryptedParamsFormat = "JSON"
	EmailRoutingSummaryEncryptedParamsFormatCsv  EmailRoutingSummaryEncryptedParamsFormat = "CSV"
)

func (EmailRoutingSummaryEncryptedParamsFormat) IsKnown

type EmailRoutingSummaryEncryptedParamsIPVersion

type EmailRoutingSummaryEncryptedParamsIPVersion string
const (
	EmailRoutingSummaryEncryptedParamsIPVersionIPv4 EmailRoutingSummaryEncryptedParamsIPVersion = "IPv4"
	EmailRoutingSummaryEncryptedParamsIPVersionIPv6 EmailRoutingSummaryEncryptedParamsIPVersion = "IPv6"
)

func (EmailRoutingSummaryEncryptedParamsIPVersion) IsKnown

type EmailRoutingSummaryEncryptedParamsSPF

type EmailRoutingSummaryEncryptedParamsSPF string
const (
	EmailRoutingSummaryEncryptedParamsSPFPass EmailRoutingSummaryEncryptedParamsSPF = "PASS"
	EmailRoutingSummaryEncryptedParamsSPFNone EmailRoutingSummaryEncryptedParamsSPF = "NONE"
	EmailRoutingSummaryEncryptedParamsSPFFail EmailRoutingSummaryEncryptedParamsSPF = "FAIL"
)

func (EmailRoutingSummaryEncryptedParamsSPF) IsKnown

type EmailRoutingSummaryEncryptedResponse

type EmailRoutingSummaryEncryptedResponse struct {
	Meta     EmailRoutingSummaryEncryptedResponseMeta     `json:"meta,required"`
	Summary0 EmailRoutingSummaryEncryptedResponseSummary0 `json:"summary_0,required"`
	JSON     emailRoutingSummaryEncryptedResponseJSON     `json:"-"`
}

func (*EmailRoutingSummaryEncryptedResponse) UnmarshalJSON

func (r *EmailRoutingSummaryEncryptedResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryEncryptedResponseEnvelope

type EmailRoutingSummaryEncryptedResponseEnvelope struct {
	Result  EmailRoutingSummaryEncryptedResponse             `json:"result,required"`
	Success bool                                             `json:"success,required"`
	JSON    emailRoutingSummaryEncryptedResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingSummaryEncryptedResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingSummaryEncryptedResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryEncryptedResponseMeta

type EmailRoutingSummaryEncryptedResponseMeta struct {
	DateRange      []EmailRoutingSummaryEncryptedResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                 `json:"lastUpdated,required"`
	Normalization  string                                                 `json:"normalization,required"`
	ConfidenceInfo EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailRoutingSummaryEncryptedResponseMetaJSON           `json:"-"`
}

func (*EmailRoutingSummaryEncryptedResponseMeta) UnmarshalJSON

func (r *EmailRoutingSummaryEncryptedResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo

type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo struct {
	Annotations []EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                              `json:"level"`
	JSON        emailRoutingSummaryEncryptedResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation

type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                               `json:"dataSource,required"`
	Description     string                                                               `json:"description,required"`
	EventType       string                                                               `json:"eventType,required"`
	IsInstantaneous bool                                                                 `json:"isInstantaneous,required"`
	EndTime         time.Time                                                            `json:"endTime" format:"date-time"`
	LinkedURL       string                                                               `json:"linkedUrl"`
	StartTime       time.Time                                                            `json:"startTime" format:"date-time"`
	JSON            emailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailRoutingSummaryEncryptedResponseMetaDateRange

type EmailRoutingSummaryEncryptedResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                             `json:"startTime,required" format:"date-time"`
	JSON      emailRoutingSummaryEncryptedResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailRoutingSummaryEncryptedResponseMetaDateRange) UnmarshalJSON

func (r *EmailRoutingSummaryEncryptedResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryEncryptedResponseSummary0

type EmailRoutingSummaryEncryptedResponseSummary0 struct {
	Encrypted    string                                           `json:"ENCRYPTED,required"`
	NotEncrypted string                                           `json:"NOT_ENCRYPTED,required"`
	JSON         emailRoutingSummaryEncryptedResponseSummary0JSON `json:"-"`
}

func (*EmailRoutingSummaryEncryptedResponseSummary0) UnmarshalJSON

func (r *EmailRoutingSummaryEncryptedResponseSummary0) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryIPVersionParams

type EmailRoutingSummaryIPVersionParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingSummaryIPVersionParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingSummaryIPVersionParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingSummaryIPVersionParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingSummaryIPVersionParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingSummaryIPVersionParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingSummaryIPVersionParamsSPF] `query:"spf"`
}

func (EmailRoutingSummaryIPVersionParams) URLQuery

URLQuery serializes EmailRoutingSummaryIPVersionParams's query parameters as `url.Values`.

type EmailRoutingSummaryIPVersionParamsARC

type EmailRoutingSummaryIPVersionParamsARC string
const (
	EmailRoutingSummaryIPVersionParamsARCPass EmailRoutingSummaryIPVersionParamsARC = "PASS"
	EmailRoutingSummaryIPVersionParamsARCNone EmailRoutingSummaryIPVersionParamsARC = "NONE"
	EmailRoutingSummaryIPVersionParamsARCFail EmailRoutingSummaryIPVersionParamsARC = "FAIL"
)

func (EmailRoutingSummaryIPVersionParamsARC) IsKnown

type EmailRoutingSummaryIPVersionParamsDKIM

type EmailRoutingSummaryIPVersionParamsDKIM string
const (
	EmailRoutingSummaryIPVersionParamsDKIMPass EmailRoutingSummaryIPVersionParamsDKIM = "PASS"
	EmailRoutingSummaryIPVersionParamsDKIMNone EmailRoutingSummaryIPVersionParamsDKIM = "NONE"
	EmailRoutingSummaryIPVersionParamsDKIMFail EmailRoutingSummaryIPVersionParamsDKIM = "FAIL"
)

func (EmailRoutingSummaryIPVersionParamsDKIM) IsKnown

type EmailRoutingSummaryIPVersionParamsDMARC

type EmailRoutingSummaryIPVersionParamsDMARC string
const (
	EmailRoutingSummaryIPVersionParamsDMARCPass EmailRoutingSummaryIPVersionParamsDMARC = "PASS"
	EmailRoutingSummaryIPVersionParamsDMARCNone EmailRoutingSummaryIPVersionParamsDMARC = "NONE"
	EmailRoutingSummaryIPVersionParamsDMARCFail EmailRoutingSummaryIPVersionParamsDMARC = "FAIL"
)

func (EmailRoutingSummaryIPVersionParamsDMARC) IsKnown

type EmailRoutingSummaryIPVersionParamsEncrypted

type EmailRoutingSummaryIPVersionParamsEncrypted string
const (
	EmailRoutingSummaryIPVersionParamsEncryptedEncrypted    EmailRoutingSummaryIPVersionParamsEncrypted = "ENCRYPTED"
	EmailRoutingSummaryIPVersionParamsEncryptedNotEncrypted EmailRoutingSummaryIPVersionParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingSummaryIPVersionParamsEncrypted) IsKnown

type EmailRoutingSummaryIPVersionParamsFormat

type EmailRoutingSummaryIPVersionParamsFormat string

Format results are returned in.

const (
	EmailRoutingSummaryIPVersionParamsFormatJson EmailRoutingSummaryIPVersionParamsFormat = "JSON"
	EmailRoutingSummaryIPVersionParamsFormatCsv  EmailRoutingSummaryIPVersionParamsFormat = "CSV"
)

func (EmailRoutingSummaryIPVersionParamsFormat) IsKnown

type EmailRoutingSummaryIPVersionParamsSPF

type EmailRoutingSummaryIPVersionParamsSPF string
const (
	EmailRoutingSummaryIPVersionParamsSPFPass EmailRoutingSummaryIPVersionParamsSPF = "PASS"
	EmailRoutingSummaryIPVersionParamsSPFNone EmailRoutingSummaryIPVersionParamsSPF = "NONE"
	EmailRoutingSummaryIPVersionParamsSPFFail EmailRoutingSummaryIPVersionParamsSPF = "FAIL"
)

func (EmailRoutingSummaryIPVersionParamsSPF) IsKnown

type EmailRoutingSummaryIPVersionResponse

type EmailRoutingSummaryIPVersionResponse struct {
	Meta     EmailRoutingSummaryIPVersionResponseMeta     `json:"meta,required"`
	Summary0 EmailRoutingSummaryIPVersionResponseSummary0 `json:"summary_0,required"`
	JSON     emailRoutingSummaryIPVersionResponseJSON     `json:"-"`
}

func (*EmailRoutingSummaryIPVersionResponse) UnmarshalJSON

func (r *EmailRoutingSummaryIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryIPVersionResponseEnvelope

type EmailRoutingSummaryIPVersionResponseEnvelope struct {
	Result  EmailRoutingSummaryIPVersionResponse             `json:"result,required"`
	Success bool                                             `json:"success,required"`
	JSON    emailRoutingSummaryIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingSummaryIPVersionResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingSummaryIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryIPVersionResponseMeta

type EmailRoutingSummaryIPVersionResponseMeta struct {
	DateRange      []EmailRoutingSummaryIPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                 `json:"lastUpdated,required"`
	Normalization  string                                                 `json:"normalization,required"`
	ConfidenceInfo EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailRoutingSummaryIPVersionResponseMetaJSON           `json:"-"`
}

func (*EmailRoutingSummaryIPVersionResponseMeta) UnmarshalJSON

func (r *EmailRoutingSummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo

type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo struct {
	Annotations []EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                              `json:"level"`
	JSON        emailRoutingSummaryIPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation

type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                               `json:"dataSource,required"`
	Description     string                                                               `json:"description,required"`
	EventType       string                                                               `json:"eventType,required"`
	IsInstantaneous bool                                                                 `json:"isInstantaneous,required"`
	EndTime         time.Time                                                            `json:"endTime" format:"date-time"`
	LinkedURL       string                                                               `json:"linkedUrl"`
	StartTime       time.Time                                                            `json:"startTime" format:"date-time"`
	JSON            emailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailRoutingSummaryIPVersionResponseMetaDateRange

type EmailRoutingSummaryIPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                             `json:"startTime,required" format:"date-time"`
	JSON      emailRoutingSummaryIPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailRoutingSummaryIPVersionResponseMetaDateRange) UnmarshalJSON

func (r *EmailRoutingSummaryIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryIPVersionResponseSummary0

type EmailRoutingSummaryIPVersionResponseSummary0 struct {
	IPv4 string                                           `json:"IPv4,required"`
	IPv6 string                                           `json:"IPv6,required"`
	JSON emailRoutingSummaryIPVersionResponseSummary0JSON `json:"-"`
}

func (*EmailRoutingSummaryIPVersionResponseSummary0) UnmarshalJSON

func (r *EmailRoutingSummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummarySPFParams

type EmailRoutingSummarySPFParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingSummarySPFParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingSummarySPFParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingSummarySPFParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingSummarySPFParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingSummarySPFParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingSummarySPFParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (EmailRoutingSummarySPFParams) URLQuery

func (r EmailRoutingSummarySPFParams) URLQuery() (v url.Values)

URLQuery serializes EmailRoutingSummarySPFParams's query parameters as `url.Values`.

type EmailRoutingSummarySPFParamsARC

type EmailRoutingSummarySPFParamsARC string
const (
	EmailRoutingSummarySPFParamsARCPass EmailRoutingSummarySPFParamsARC = "PASS"
	EmailRoutingSummarySPFParamsARCNone EmailRoutingSummarySPFParamsARC = "NONE"
	EmailRoutingSummarySPFParamsARCFail EmailRoutingSummarySPFParamsARC = "FAIL"
)

func (EmailRoutingSummarySPFParamsARC) IsKnown

type EmailRoutingSummarySPFParamsDKIM

type EmailRoutingSummarySPFParamsDKIM string
const (
	EmailRoutingSummarySPFParamsDKIMPass EmailRoutingSummarySPFParamsDKIM = "PASS"
	EmailRoutingSummarySPFParamsDKIMNone EmailRoutingSummarySPFParamsDKIM = "NONE"
	EmailRoutingSummarySPFParamsDKIMFail EmailRoutingSummarySPFParamsDKIM = "FAIL"
)

func (EmailRoutingSummarySPFParamsDKIM) IsKnown

type EmailRoutingSummarySPFParamsDMARC

type EmailRoutingSummarySPFParamsDMARC string
const (
	EmailRoutingSummarySPFParamsDMARCPass EmailRoutingSummarySPFParamsDMARC = "PASS"
	EmailRoutingSummarySPFParamsDMARCNone EmailRoutingSummarySPFParamsDMARC = "NONE"
	EmailRoutingSummarySPFParamsDMARCFail EmailRoutingSummarySPFParamsDMARC = "FAIL"
)

func (EmailRoutingSummarySPFParamsDMARC) IsKnown

type EmailRoutingSummarySPFParamsEncrypted

type EmailRoutingSummarySPFParamsEncrypted string
const (
	EmailRoutingSummarySPFParamsEncryptedEncrypted    EmailRoutingSummarySPFParamsEncrypted = "ENCRYPTED"
	EmailRoutingSummarySPFParamsEncryptedNotEncrypted EmailRoutingSummarySPFParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingSummarySPFParamsEncrypted) IsKnown

type EmailRoutingSummarySPFParamsFormat

type EmailRoutingSummarySPFParamsFormat string

Format results are returned in.

const (
	EmailRoutingSummarySPFParamsFormatJson EmailRoutingSummarySPFParamsFormat = "JSON"
	EmailRoutingSummarySPFParamsFormatCsv  EmailRoutingSummarySPFParamsFormat = "CSV"
)

func (EmailRoutingSummarySPFParamsFormat) IsKnown

type EmailRoutingSummarySPFParamsIPVersion

type EmailRoutingSummarySPFParamsIPVersion string
const (
	EmailRoutingSummarySPFParamsIPVersionIPv4 EmailRoutingSummarySPFParamsIPVersion = "IPv4"
	EmailRoutingSummarySPFParamsIPVersionIPv6 EmailRoutingSummarySPFParamsIPVersion = "IPv6"
)

func (EmailRoutingSummarySPFParamsIPVersion) IsKnown

type EmailRoutingSummarySPFResponse

type EmailRoutingSummarySPFResponse struct {
	Meta     EmailRoutingSummarySPFResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                  `json:"summary_0,required"`
	JSON     emailRoutingSummarySPFResponseJSON `json:"-"`
}

func (*EmailRoutingSummarySPFResponse) UnmarshalJSON

func (r *EmailRoutingSummarySPFResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummarySPFResponseEnvelope

type EmailRoutingSummarySPFResponseEnvelope struct {
	Result  EmailRoutingSummarySPFResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    emailRoutingSummarySPFResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingSummarySPFResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingSummarySPFResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummarySPFResponseMeta

type EmailRoutingSummarySPFResponseMeta struct {
	DateRange      []EmailRoutingSummarySPFResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	Normalization  string                                           `json:"normalization,required"`
	ConfidenceInfo EmailRoutingSummarySPFResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailRoutingSummarySPFResponseMetaJSON           `json:"-"`
}

func (*EmailRoutingSummarySPFResponseMeta) UnmarshalJSON

func (r *EmailRoutingSummarySPFResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummarySPFResponseMetaConfidenceInfo

type EmailRoutingSummarySPFResponseMetaConfidenceInfo struct {
	Annotations []EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        emailRoutingSummarySPFResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailRoutingSummarySPFResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailRoutingSummarySPFResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation

type EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            emailRoutingSummarySPFResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailRoutingSummarySPFResponseMetaDateRange

type EmailRoutingSummarySPFResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      emailRoutingSummarySPFResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailRoutingSummarySPFResponseMetaDateRange) UnmarshalJSON

func (r *EmailRoutingSummarySPFResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailRoutingSummaryService

type EmailRoutingSummaryService struct {
	Options []option.RequestOption
}

EmailRoutingSummaryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailRoutingSummaryService method instead.

func NewEmailRoutingSummaryService

func NewEmailRoutingSummaryService(opts ...option.RequestOption) (r *EmailRoutingSummaryService)

NewEmailRoutingSummaryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailRoutingSummaryService) ARC

Percentage distribution of emails classified by ARC validation.

func (*EmailRoutingSummaryService) DKIM

Percentage distribution of emails classified by DKIM validation.

func (*EmailRoutingSummaryService) DMARC

Percentage distribution of emails classified by DMARC validation.

func (*EmailRoutingSummaryService) Encrypted

Percentage distribution of emails by encryption status.

func (*EmailRoutingSummaryService) IPVersion

Percentage distribution of emails by IP version.

func (*EmailRoutingSummaryService) SPF

Percentage distribution of emails classified by SPF validation.

type EmailRoutingTimeseriesGroupARCParams

type EmailRoutingTimeseriesGroupARCParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailRoutingTimeseriesGroupARCParamsAggInterval] `query:"aggInterval"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingTimeseriesGroupARCParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingTimeseriesGroupARCParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingTimeseriesGroupARCParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingTimeseriesGroupARCParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingTimeseriesGroupARCParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingTimeseriesGroupARCParamsSPF] `query:"spf"`
}

func (EmailRoutingTimeseriesGroupARCParams) URLQuery

URLQuery serializes EmailRoutingTimeseriesGroupARCParams's query parameters as `url.Values`.

type EmailRoutingTimeseriesGroupARCParamsAggInterval

type EmailRoutingTimeseriesGroupARCParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailRoutingTimeseriesGroupARCParamsAggInterval15m EmailRoutingTimeseriesGroupARCParamsAggInterval = "15m"
	EmailRoutingTimeseriesGroupARCParamsAggInterval1h  EmailRoutingTimeseriesGroupARCParamsAggInterval = "1h"
	EmailRoutingTimeseriesGroupARCParamsAggInterval1d  EmailRoutingTimeseriesGroupARCParamsAggInterval = "1d"
	EmailRoutingTimeseriesGroupARCParamsAggInterval1w  EmailRoutingTimeseriesGroupARCParamsAggInterval = "1w"
)

func (EmailRoutingTimeseriesGroupARCParamsAggInterval) IsKnown

type EmailRoutingTimeseriesGroupARCParamsDKIM

type EmailRoutingTimeseriesGroupARCParamsDKIM string
const (
	EmailRoutingTimeseriesGroupARCParamsDKIMPass EmailRoutingTimeseriesGroupARCParamsDKIM = "PASS"
	EmailRoutingTimeseriesGroupARCParamsDKIMNone EmailRoutingTimeseriesGroupARCParamsDKIM = "NONE"
	EmailRoutingTimeseriesGroupARCParamsDKIMFail EmailRoutingTimeseriesGroupARCParamsDKIM = "FAIL"
)

func (EmailRoutingTimeseriesGroupARCParamsDKIM) IsKnown

type EmailRoutingTimeseriesGroupARCParamsDMARC

type EmailRoutingTimeseriesGroupARCParamsDMARC string
const (
	EmailRoutingTimeseriesGroupARCParamsDMARCPass EmailRoutingTimeseriesGroupARCParamsDMARC = "PASS"
	EmailRoutingTimeseriesGroupARCParamsDMARCNone EmailRoutingTimeseriesGroupARCParamsDMARC = "NONE"
	EmailRoutingTimeseriesGroupARCParamsDMARCFail EmailRoutingTimeseriesGroupARCParamsDMARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupARCParamsDMARC) IsKnown

type EmailRoutingTimeseriesGroupARCParamsEncrypted

type EmailRoutingTimeseriesGroupARCParamsEncrypted string
const (
	EmailRoutingTimeseriesGroupARCParamsEncryptedEncrypted    EmailRoutingTimeseriesGroupARCParamsEncrypted = "ENCRYPTED"
	EmailRoutingTimeseriesGroupARCParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupARCParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingTimeseriesGroupARCParamsEncrypted) IsKnown

type EmailRoutingTimeseriesGroupARCParamsFormat

type EmailRoutingTimeseriesGroupARCParamsFormat string

Format results are returned in.

const (
	EmailRoutingTimeseriesGroupARCParamsFormatJson EmailRoutingTimeseriesGroupARCParamsFormat = "JSON"
	EmailRoutingTimeseriesGroupARCParamsFormatCsv  EmailRoutingTimeseriesGroupARCParamsFormat = "CSV"
)

func (EmailRoutingTimeseriesGroupARCParamsFormat) IsKnown

type EmailRoutingTimeseriesGroupARCParamsIPVersion

type EmailRoutingTimeseriesGroupARCParamsIPVersion string
const (
	EmailRoutingTimeseriesGroupARCParamsIPVersionIPv4 EmailRoutingTimeseriesGroupARCParamsIPVersion = "IPv4"
	EmailRoutingTimeseriesGroupARCParamsIPVersionIPv6 EmailRoutingTimeseriesGroupARCParamsIPVersion = "IPv6"
)

func (EmailRoutingTimeseriesGroupARCParamsIPVersion) IsKnown

type EmailRoutingTimeseriesGroupARCParamsSPF

type EmailRoutingTimeseriesGroupARCParamsSPF string
const (
	EmailRoutingTimeseriesGroupARCParamsSPFPass EmailRoutingTimeseriesGroupARCParamsSPF = "PASS"
	EmailRoutingTimeseriesGroupARCParamsSPFNone EmailRoutingTimeseriesGroupARCParamsSPF = "NONE"
	EmailRoutingTimeseriesGroupARCParamsSPFFail EmailRoutingTimeseriesGroupARCParamsSPF = "FAIL"
)

func (EmailRoutingTimeseriesGroupARCParamsSPF) IsKnown

type EmailRoutingTimeseriesGroupARCResponse

type EmailRoutingTimeseriesGroupARCResponse struct {
	Meta   interface{}                                `json:"meta,required"`
	Serie0 RadarEmailSeries                           `json:"serie_0,required"`
	JSON   emailRoutingTimeseriesGroupARCResponseJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupARCResponse) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupARCResponseEnvelope

type EmailRoutingTimeseriesGroupARCResponseEnvelope struct {
	Result  EmailRoutingTimeseriesGroupARCResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    emailRoutingTimeseriesGroupARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupARCResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupDKIMParams

type EmailRoutingTimeseriesGroupDKIMParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailRoutingTimeseriesGroupDKIMParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingTimeseriesGroupDKIMParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsSPF] `query:"spf"`
}

func (EmailRoutingTimeseriesGroupDKIMParams) URLQuery

URLQuery serializes EmailRoutingTimeseriesGroupDKIMParams's query parameters as `url.Values`.

type EmailRoutingTimeseriesGroupDKIMParamsARC

type EmailRoutingTimeseriesGroupDKIMParamsARC string
const (
	EmailRoutingTimeseriesGroupDKIMParamsARCPass EmailRoutingTimeseriesGroupDKIMParamsARC = "PASS"
	EmailRoutingTimeseriesGroupDKIMParamsARCNone EmailRoutingTimeseriesGroupDKIMParamsARC = "NONE"
	EmailRoutingTimeseriesGroupDKIMParamsARCFail EmailRoutingTimeseriesGroupDKIMParamsARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupDKIMParamsARC) IsKnown

type EmailRoutingTimeseriesGroupDKIMParamsAggInterval

type EmailRoutingTimeseriesGroupDKIMParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailRoutingTimeseriesGroupDKIMParamsAggInterval15m EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "15m"
	EmailRoutingTimeseriesGroupDKIMParamsAggInterval1h  EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "1h"
	EmailRoutingTimeseriesGroupDKIMParamsAggInterval1d  EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "1d"
	EmailRoutingTimeseriesGroupDKIMParamsAggInterval1w  EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "1w"
)

func (EmailRoutingTimeseriesGroupDKIMParamsAggInterval) IsKnown

type EmailRoutingTimeseriesGroupDKIMParamsDMARC

type EmailRoutingTimeseriesGroupDKIMParamsDMARC string
const (
	EmailRoutingTimeseriesGroupDKIMParamsDMARCPass EmailRoutingTimeseriesGroupDKIMParamsDMARC = "PASS"
	EmailRoutingTimeseriesGroupDKIMParamsDMARCNone EmailRoutingTimeseriesGroupDKIMParamsDMARC = "NONE"
	EmailRoutingTimeseriesGroupDKIMParamsDMARCFail EmailRoutingTimeseriesGroupDKIMParamsDMARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupDKIMParamsDMARC) IsKnown

type EmailRoutingTimeseriesGroupDKIMParamsEncrypted

type EmailRoutingTimeseriesGroupDKIMParamsEncrypted string
const (
	EmailRoutingTimeseriesGroupDKIMParamsEncryptedEncrypted    EmailRoutingTimeseriesGroupDKIMParamsEncrypted = "ENCRYPTED"
	EmailRoutingTimeseriesGroupDKIMParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupDKIMParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingTimeseriesGroupDKIMParamsEncrypted) IsKnown

type EmailRoutingTimeseriesGroupDKIMParamsFormat

type EmailRoutingTimeseriesGroupDKIMParamsFormat string

Format results are returned in.

const (
	EmailRoutingTimeseriesGroupDKIMParamsFormatJson EmailRoutingTimeseriesGroupDKIMParamsFormat = "JSON"
	EmailRoutingTimeseriesGroupDKIMParamsFormatCsv  EmailRoutingTimeseriesGroupDKIMParamsFormat = "CSV"
)

func (EmailRoutingTimeseriesGroupDKIMParamsFormat) IsKnown

type EmailRoutingTimeseriesGroupDKIMParamsIPVersion

type EmailRoutingTimeseriesGroupDKIMParamsIPVersion string
const (
	EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv4 EmailRoutingTimeseriesGroupDKIMParamsIPVersion = "IPv4"
	EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv6 EmailRoutingTimeseriesGroupDKIMParamsIPVersion = "IPv6"
)

func (EmailRoutingTimeseriesGroupDKIMParamsIPVersion) IsKnown

type EmailRoutingTimeseriesGroupDKIMParamsSPF

type EmailRoutingTimeseriesGroupDKIMParamsSPF string
const (
	EmailRoutingTimeseriesGroupDKIMParamsSPFPass EmailRoutingTimeseriesGroupDKIMParamsSPF = "PASS"
	EmailRoutingTimeseriesGroupDKIMParamsSPFNone EmailRoutingTimeseriesGroupDKIMParamsSPF = "NONE"
	EmailRoutingTimeseriesGroupDKIMParamsSPFFail EmailRoutingTimeseriesGroupDKIMParamsSPF = "FAIL"
)

func (EmailRoutingTimeseriesGroupDKIMParamsSPF) IsKnown

type EmailRoutingTimeseriesGroupDKIMResponse

type EmailRoutingTimeseriesGroupDKIMResponse struct {
	Meta   interface{}                                 `json:"meta,required"`
	Serie0 RadarEmailSeries                            `json:"serie_0,required"`
	JSON   emailRoutingTimeseriesGroupDKIMResponseJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupDKIMResponse) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupDKIMResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupDKIMResponseEnvelope

type EmailRoutingTimeseriesGroupDKIMResponseEnvelope struct {
	Result  EmailRoutingTimeseriesGroupDKIMResponse             `json:"result,required"`
	Success bool                                                `json:"success,required"`
	JSON    emailRoutingTimeseriesGroupDKIMResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupDKIMResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupDKIMResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupDMARCParams

type EmailRoutingTimeseriesGroupDMARCParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailRoutingTimeseriesGroupDMARCParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsDKIM] `query:"dkim"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingTimeseriesGroupDMARCParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsSPF] `query:"spf"`
}

func (EmailRoutingTimeseriesGroupDMARCParams) URLQuery

URLQuery serializes EmailRoutingTimeseriesGroupDMARCParams's query parameters as `url.Values`.

type EmailRoutingTimeseriesGroupDMARCParamsARC

type EmailRoutingTimeseriesGroupDMARCParamsARC string
const (
	EmailRoutingTimeseriesGroupDMARCParamsARCPass EmailRoutingTimeseriesGroupDMARCParamsARC = "PASS"
	EmailRoutingTimeseriesGroupDMARCParamsARCNone EmailRoutingTimeseriesGroupDMARCParamsARC = "NONE"
	EmailRoutingTimeseriesGroupDMARCParamsARCFail EmailRoutingTimeseriesGroupDMARCParamsARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupDMARCParamsARC) IsKnown

type EmailRoutingTimeseriesGroupDMARCParamsAggInterval

type EmailRoutingTimeseriesGroupDMARCParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailRoutingTimeseriesGroupDMARCParamsAggInterval15m EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "15m"
	EmailRoutingTimeseriesGroupDMARCParamsAggInterval1h  EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "1h"
	EmailRoutingTimeseriesGroupDMARCParamsAggInterval1d  EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "1d"
	EmailRoutingTimeseriesGroupDMARCParamsAggInterval1w  EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "1w"
)

func (EmailRoutingTimeseriesGroupDMARCParamsAggInterval) IsKnown

type EmailRoutingTimeseriesGroupDMARCParamsDKIM

type EmailRoutingTimeseriesGroupDMARCParamsDKIM string
const (
	EmailRoutingTimeseriesGroupDMARCParamsDKIMPass EmailRoutingTimeseriesGroupDMARCParamsDKIM = "PASS"
	EmailRoutingTimeseriesGroupDMARCParamsDKIMNone EmailRoutingTimeseriesGroupDMARCParamsDKIM = "NONE"
	EmailRoutingTimeseriesGroupDMARCParamsDKIMFail EmailRoutingTimeseriesGroupDMARCParamsDKIM = "FAIL"
)

func (EmailRoutingTimeseriesGroupDMARCParamsDKIM) IsKnown

type EmailRoutingTimeseriesGroupDMARCParamsEncrypted

type EmailRoutingTimeseriesGroupDMARCParamsEncrypted string
const (
	EmailRoutingTimeseriesGroupDMARCParamsEncryptedEncrypted    EmailRoutingTimeseriesGroupDMARCParamsEncrypted = "ENCRYPTED"
	EmailRoutingTimeseriesGroupDMARCParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupDMARCParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingTimeseriesGroupDMARCParamsEncrypted) IsKnown

type EmailRoutingTimeseriesGroupDMARCParamsFormat

type EmailRoutingTimeseriesGroupDMARCParamsFormat string

Format results are returned in.

const (
	EmailRoutingTimeseriesGroupDMARCParamsFormatJson EmailRoutingTimeseriesGroupDMARCParamsFormat = "JSON"
	EmailRoutingTimeseriesGroupDMARCParamsFormatCsv  EmailRoutingTimeseriesGroupDMARCParamsFormat = "CSV"
)

func (EmailRoutingTimeseriesGroupDMARCParamsFormat) IsKnown

type EmailRoutingTimeseriesGroupDMARCParamsIPVersion

type EmailRoutingTimeseriesGroupDMARCParamsIPVersion string
const (
	EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv4 EmailRoutingTimeseriesGroupDMARCParamsIPVersion = "IPv4"
	EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv6 EmailRoutingTimeseriesGroupDMARCParamsIPVersion = "IPv6"
)

func (EmailRoutingTimeseriesGroupDMARCParamsIPVersion) IsKnown

type EmailRoutingTimeseriesGroupDMARCParamsSPF

type EmailRoutingTimeseriesGroupDMARCParamsSPF string
const (
	EmailRoutingTimeseriesGroupDMARCParamsSPFPass EmailRoutingTimeseriesGroupDMARCParamsSPF = "PASS"
	EmailRoutingTimeseriesGroupDMARCParamsSPFNone EmailRoutingTimeseriesGroupDMARCParamsSPF = "NONE"
	EmailRoutingTimeseriesGroupDMARCParamsSPFFail EmailRoutingTimeseriesGroupDMARCParamsSPF = "FAIL"
)

func (EmailRoutingTimeseriesGroupDMARCParamsSPF) IsKnown

type EmailRoutingTimeseriesGroupDMARCResponse

type EmailRoutingTimeseriesGroupDMARCResponse struct {
	Meta   interface{}                                  `json:"meta,required"`
	Serie0 RadarEmailSeries                             `json:"serie_0,required"`
	JSON   emailRoutingTimeseriesGroupDMARCResponseJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupDMARCResponse) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupDMARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupDMARCResponseEnvelope

type EmailRoutingTimeseriesGroupDMARCResponseEnvelope struct {
	Result  EmailRoutingTimeseriesGroupDMARCResponse             `json:"result,required"`
	Success bool                                                 `json:"success,required"`
	JSON    emailRoutingTimeseriesGroupDMARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupDMARCResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupDMARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupEncryptedParams

type EmailRoutingTimeseriesGroupEncryptedParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailRoutingTimeseriesGroupEncryptedParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailRoutingTimeseriesGroupEncryptedParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsSPF] `query:"spf"`
}

func (EmailRoutingTimeseriesGroupEncryptedParams) URLQuery

URLQuery serializes EmailRoutingTimeseriesGroupEncryptedParams's query parameters as `url.Values`.

type EmailRoutingTimeseriesGroupEncryptedParamsARC

type EmailRoutingTimeseriesGroupEncryptedParamsARC string
const (
	EmailRoutingTimeseriesGroupEncryptedParamsARCPass EmailRoutingTimeseriesGroupEncryptedParamsARC = "PASS"
	EmailRoutingTimeseriesGroupEncryptedParamsARCNone EmailRoutingTimeseriesGroupEncryptedParamsARC = "NONE"
	EmailRoutingTimeseriesGroupEncryptedParamsARCFail EmailRoutingTimeseriesGroupEncryptedParamsARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupEncryptedParamsARC) IsKnown

type EmailRoutingTimeseriesGroupEncryptedParamsAggInterval

type EmailRoutingTimeseriesGroupEncryptedParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailRoutingTimeseriesGroupEncryptedParamsAggInterval15m EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "15m"
	EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1h  EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "1h"
	EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1d  EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "1d"
	EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1w  EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "1w"
)

func (EmailRoutingTimeseriesGroupEncryptedParamsAggInterval) IsKnown

type EmailRoutingTimeseriesGroupEncryptedParamsDKIM

type EmailRoutingTimeseriesGroupEncryptedParamsDKIM string
const (
	EmailRoutingTimeseriesGroupEncryptedParamsDKIMPass EmailRoutingTimeseriesGroupEncryptedParamsDKIM = "PASS"
	EmailRoutingTimeseriesGroupEncryptedParamsDKIMNone EmailRoutingTimeseriesGroupEncryptedParamsDKIM = "NONE"
	EmailRoutingTimeseriesGroupEncryptedParamsDKIMFail EmailRoutingTimeseriesGroupEncryptedParamsDKIM = "FAIL"
)

func (EmailRoutingTimeseriesGroupEncryptedParamsDKIM) IsKnown

type EmailRoutingTimeseriesGroupEncryptedParamsDMARC

type EmailRoutingTimeseriesGroupEncryptedParamsDMARC string
const (
	EmailRoutingTimeseriesGroupEncryptedParamsDMARCPass EmailRoutingTimeseriesGroupEncryptedParamsDMARC = "PASS"
	EmailRoutingTimeseriesGroupEncryptedParamsDMARCNone EmailRoutingTimeseriesGroupEncryptedParamsDMARC = "NONE"
	EmailRoutingTimeseriesGroupEncryptedParamsDMARCFail EmailRoutingTimeseriesGroupEncryptedParamsDMARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupEncryptedParamsDMARC) IsKnown

type EmailRoutingTimeseriesGroupEncryptedParamsFormat

type EmailRoutingTimeseriesGroupEncryptedParamsFormat string

Format results are returned in.

const (
	EmailRoutingTimeseriesGroupEncryptedParamsFormatJson EmailRoutingTimeseriesGroupEncryptedParamsFormat = "JSON"
	EmailRoutingTimeseriesGroupEncryptedParamsFormatCsv  EmailRoutingTimeseriesGroupEncryptedParamsFormat = "CSV"
)

func (EmailRoutingTimeseriesGroupEncryptedParamsFormat) IsKnown

type EmailRoutingTimeseriesGroupEncryptedParamsIPVersion

type EmailRoutingTimeseriesGroupEncryptedParamsIPVersion string
const (
	EmailRoutingTimeseriesGroupEncryptedParamsIPVersionIPv4 EmailRoutingTimeseriesGroupEncryptedParamsIPVersion = "IPv4"
	EmailRoutingTimeseriesGroupEncryptedParamsIPVersionIPv6 EmailRoutingTimeseriesGroupEncryptedParamsIPVersion = "IPv6"
)

func (EmailRoutingTimeseriesGroupEncryptedParamsIPVersion) IsKnown

type EmailRoutingTimeseriesGroupEncryptedParamsSPF

type EmailRoutingTimeseriesGroupEncryptedParamsSPF string
const (
	EmailRoutingTimeseriesGroupEncryptedParamsSPFPass EmailRoutingTimeseriesGroupEncryptedParamsSPF = "PASS"
	EmailRoutingTimeseriesGroupEncryptedParamsSPFNone EmailRoutingTimeseriesGroupEncryptedParamsSPF = "NONE"
	EmailRoutingTimeseriesGroupEncryptedParamsSPFFail EmailRoutingTimeseriesGroupEncryptedParamsSPF = "FAIL"
)

func (EmailRoutingTimeseriesGroupEncryptedParamsSPF) IsKnown

type EmailRoutingTimeseriesGroupEncryptedResponse

type EmailRoutingTimeseriesGroupEncryptedResponse struct {
	Meta   interface{}                                        `json:"meta,required"`
	Serie0 EmailRoutingTimeseriesGroupEncryptedResponseSerie0 `json:"serie_0,required"`
	JSON   emailRoutingTimeseriesGroupEncryptedResponseJSON   `json:"-"`
}

func (*EmailRoutingTimeseriesGroupEncryptedResponse) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupEncryptedResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupEncryptedResponseEnvelope

type EmailRoutingTimeseriesGroupEncryptedResponseEnvelope struct {
	Result  EmailRoutingTimeseriesGroupEncryptedResponse             `json:"result,required"`
	Success bool                                                     `json:"success,required"`
	JSON    emailRoutingTimeseriesGroupEncryptedResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupEncryptedResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupEncryptedResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupEncryptedResponseSerie0

type EmailRoutingTimeseriesGroupEncryptedResponseSerie0 struct {
	Encrypted    []string                                               `json:"ENCRYPTED,required"`
	NotEncrypted []string                                               `json:"NOT_ENCRYPTED,required"`
	JSON         emailRoutingTimeseriesGroupEncryptedResponseSerie0JSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupEncryptedResponseSerie0) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupEncryptedResponseSerie0) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupIPVersionParams

type EmailRoutingTimeseriesGroupIPVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailRoutingTimeseriesGroupIPVersionParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingTimeseriesGroupIPVersionParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsSPF] `query:"spf"`
}

func (EmailRoutingTimeseriesGroupIPVersionParams) URLQuery

URLQuery serializes EmailRoutingTimeseriesGroupIPVersionParams's query parameters as `url.Values`.

type EmailRoutingTimeseriesGroupIPVersionParamsARC

type EmailRoutingTimeseriesGroupIPVersionParamsARC string
const (
	EmailRoutingTimeseriesGroupIPVersionParamsARCPass EmailRoutingTimeseriesGroupIPVersionParamsARC = "PASS"
	EmailRoutingTimeseriesGroupIPVersionParamsARCNone EmailRoutingTimeseriesGroupIPVersionParamsARC = "NONE"
	EmailRoutingTimeseriesGroupIPVersionParamsARCFail EmailRoutingTimeseriesGroupIPVersionParamsARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupIPVersionParamsARC) IsKnown

type EmailRoutingTimeseriesGroupIPVersionParamsAggInterval

type EmailRoutingTimeseriesGroupIPVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailRoutingTimeseriesGroupIPVersionParamsAggInterval15m EmailRoutingTimeseriesGroupIPVersionParamsAggInterval = "15m"
	EmailRoutingTimeseriesGroupIPVersionParamsAggInterval1h  EmailRoutingTimeseriesGroupIPVersionParamsAggInterval = "1h"
	EmailRoutingTimeseriesGroupIPVersionParamsAggInterval1d  EmailRoutingTimeseriesGroupIPVersionParamsAggInterval = "1d"
	EmailRoutingTimeseriesGroupIPVersionParamsAggInterval1w  EmailRoutingTimeseriesGroupIPVersionParamsAggInterval = "1w"
)

func (EmailRoutingTimeseriesGroupIPVersionParamsAggInterval) IsKnown

type EmailRoutingTimeseriesGroupIPVersionParamsDKIM

type EmailRoutingTimeseriesGroupIPVersionParamsDKIM string
const (
	EmailRoutingTimeseriesGroupIPVersionParamsDKIMPass EmailRoutingTimeseriesGroupIPVersionParamsDKIM = "PASS"
	EmailRoutingTimeseriesGroupIPVersionParamsDKIMNone EmailRoutingTimeseriesGroupIPVersionParamsDKIM = "NONE"
	EmailRoutingTimeseriesGroupIPVersionParamsDKIMFail EmailRoutingTimeseriesGroupIPVersionParamsDKIM = "FAIL"
)

func (EmailRoutingTimeseriesGroupIPVersionParamsDKIM) IsKnown

type EmailRoutingTimeseriesGroupIPVersionParamsDMARC

type EmailRoutingTimeseriesGroupIPVersionParamsDMARC string
const (
	EmailRoutingTimeseriesGroupIPVersionParamsDMARCPass EmailRoutingTimeseriesGroupIPVersionParamsDMARC = "PASS"
	EmailRoutingTimeseriesGroupIPVersionParamsDMARCNone EmailRoutingTimeseriesGroupIPVersionParamsDMARC = "NONE"
	EmailRoutingTimeseriesGroupIPVersionParamsDMARCFail EmailRoutingTimeseriesGroupIPVersionParamsDMARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupIPVersionParamsDMARC) IsKnown

type EmailRoutingTimeseriesGroupIPVersionParamsEncrypted

type EmailRoutingTimeseriesGroupIPVersionParamsEncrypted string
const (
	EmailRoutingTimeseriesGroupIPVersionParamsEncryptedEncrypted    EmailRoutingTimeseriesGroupIPVersionParamsEncrypted = "ENCRYPTED"
	EmailRoutingTimeseriesGroupIPVersionParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupIPVersionParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingTimeseriesGroupIPVersionParamsEncrypted) IsKnown

type EmailRoutingTimeseriesGroupIPVersionParamsFormat

type EmailRoutingTimeseriesGroupIPVersionParamsFormat string

Format results are returned in.

const (
	EmailRoutingTimeseriesGroupIPVersionParamsFormatJson EmailRoutingTimeseriesGroupIPVersionParamsFormat = "JSON"
	EmailRoutingTimeseriesGroupIPVersionParamsFormatCsv  EmailRoutingTimeseriesGroupIPVersionParamsFormat = "CSV"
)

func (EmailRoutingTimeseriesGroupIPVersionParamsFormat) IsKnown

type EmailRoutingTimeseriesGroupIPVersionParamsSPF

type EmailRoutingTimeseriesGroupIPVersionParamsSPF string
const (
	EmailRoutingTimeseriesGroupIPVersionParamsSPFPass EmailRoutingTimeseriesGroupIPVersionParamsSPF = "PASS"
	EmailRoutingTimeseriesGroupIPVersionParamsSPFNone EmailRoutingTimeseriesGroupIPVersionParamsSPF = "NONE"
	EmailRoutingTimeseriesGroupIPVersionParamsSPFFail EmailRoutingTimeseriesGroupIPVersionParamsSPF = "FAIL"
)

func (EmailRoutingTimeseriesGroupIPVersionParamsSPF) IsKnown

type EmailRoutingTimeseriesGroupIPVersionResponse

type EmailRoutingTimeseriesGroupIPVersionResponse struct {
	Meta   interface{}                                        `json:"meta,required"`
	Serie0 EmailRoutingTimeseriesGroupIPVersionResponseSerie0 `json:"serie_0,required"`
	JSON   emailRoutingTimeseriesGroupIPVersionResponseJSON   `json:"-"`
}

func (*EmailRoutingTimeseriesGroupIPVersionResponse) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupIPVersionResponseEnvelope

type EmailRoutingTimeseriesGroupIPVersionResponseEnvelope struct {
	Result  EmailRoutingTimeseriesGroupIPVersionResponse             `json:"result,required"`
	Success bool                                                     `json:"success,required"`
	JSON    emailRoutingTimeseriesGroupIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupIPVersionResponseSerie0

type EmailRoutingTimeseriesGroupIPVersionResponseSerie0 struct {
	IPv4 []string                                               `json:"IPv4,required"`
	IPv6 []string                                               `json:"IPv6,required"`
	JSON emailRoutingTimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupSPFParams

type EmailRoutingTimeseriesGroupSPFParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailRoutingTimeseriesGroupSPFParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailRoutingTimeseriesGroupSPFParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailRoutingTimeseriesGroupSPFParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailRoutingTimeseriesGroupSPFParamsDMARC] `query:"dmarc"`
	// Filter for encrypted emails.
	Encrypted param.Field[[]EmailRoutingTimeseriesGroupSPFParamsEncrypted] `query:"encrypted"`
	// Format results are returned in.
	Format param.Field[EmailRoutingTimeseriesGroupSPFParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]EmailRoutingTimeseriesGroupSPFParamsIPVersion] `query:"ipVersion"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (EmailRoutingTimeseriesGroupSPFParams) URLQuery

URLQuery serializes EmailRoutingTimeseriesGroupSPFParams's query parameters as `url.Values`.

type EmailRoutingTimeseriesGroupSPFParamsARC

type EmailRoutingTimeseriesGroupSPFParamsARC string
const (
	EmailRoutingTimeseriesGroupSPFParamsARCPass EmailRoutingTimeseriesGroupSPFParamsARC = "PASS"
	EmailRoutingTimeseriesGroupSPFParamsARCNone EmailRoutingTimeseriesGroupSPFParamsARC = "NONE"
	EmailRoutingTimeseriesGroupSPFParamsARCFail EmailRoutingTimeseriesGroupSPFParamsARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupSPFParamsARC) IsKnown

type EmailRoutingTimeseriesGroupSPFParamsAggInterval

type EmailRoutingTimeseriesGroupSPFParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailRoutingTimeseriesGroupSPFParamsAggInterval15m EmailRoutingTimeseriesGroupSPFParamsAggInterval = "15m"
	EmailRoutingTimeseriesGroupSPFParamsAggInterval1h  EmailRoutingTimeseriesGroupSPFParamsAggInterval = "1h"
	EmailRoutingTimeseriesGroupSPFParamsAggInterval1d  EmailRoutingTimeseriesGroupSPFParamsAggInterval = "1d"
	EmailRoutingTimeseriesGroupSPFParamsAggInterval1w  EmailRoutingTimeseriesGroupSPFParamsAggInterval = "1w"
)

func (EmailRoutingTimeseriesGroupSPFParamsAggInterval) IsKnown

type EmailRoutingTimeseriesGroupSPFParamsDKIM

type EmailRoutingTimeseriesGroupSPFParamsDKIM string
const (
	EmailRoutingTimeseriesGroupSPFParamsDKIMPass EmailRoutingTimeseriesGroupSPFParamsDKIM = "PASS"
	EmailRoutingTimeseriesGroupSPFParamsDKIMNone EmailRoutingTimeseriesGroupSPFParamsDKIM = "NONE"
	EmailRoutingTimeseriesGroupSPFParamsDKIMFail EmailRoutingTimeseriesGroupSPFParamsDKIM = "FAIL"
)

func (EmailRoutingTimeseriesGroupSPFParamsDKIM) IsKnown

type EmailRoutingTimeseriesGroupSPFParamsDMARC

type EmailRoutingTimeseriesGroupSPFParamsDMARC string
const (
	EmailRoutingTimeseriesGroupSPFParamsDMARCPass EmailRoutingTimeseriesGroupSPFParamsDMARC = "PASS"
	EmailRoutingTimeseriesGroupSPFParamsDMARCNone EmailRoutingTimeseriesGroupSPFParamsDMARC = "NONE"
	EmailRoutingTimeseriesGroupSPFParamsDMARCFail EmailRoutingTimeseriesGroupSPFParamsDMARC = "FAIL"
)

func (EmailRoutingTimeseriesGroupSPFParamsDMARC) IsKnown

type EmailRoutingTimeseriesGroupSPFParamsEncrypted

type EmailRoutingTimeseriesGroupSPFParamsEncrypted string
const (
	EmailRoutingTimeseriesGroupSPFParamsEncryptedEncrypted    EmailRoutingTimeseriesGroupSPFParamsEncrypted = "ENCRYPTED"
	EmailRoutingTimeseriesGroupSPFParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupSPFParamsEncrypted = "NOT_ENCRYPTED"
)

func (EmailRoutingTimeseriesGroupSPFParamsEncrypted) IsKnown

type EmailRoutingTimeseriesGroupSPFParamsFormat

type EmailRoutingTimeseriesGroupSPFParamsFormat string

Format results are returned in.

const (
	EmailRoutingTimeseriesGroupSPFParamsFormatJson EmailRoutingTimeseriesGroupSPFParamsFormat = "JSON"
	EmailRoutingTimeseriesGroupSPFParamsFormatCsv  EmailRoutingTimeseriesGroupSPFParamsFormat = "CSV"
)

func (EmailRoutingTimeseriesGroupSPFParamsFormat) IsKnown

type EmailRoutingTimeseriesGroupSPFParamsIPVersion

type EmailRoutingTimeseriesGroupSPFParamsIPVersion string
const (
	EmailRoutingTimeseriesGroupSPFParamsIPVersionIPv4 EmailRoutingTimeseriesGroupSPFParamsIPVersion = "IPv4"
	EmailRoutingTimeseriesGroupSPFParamsIPVersionIPv6 EmailRoutingTimeseriesGroupSPFParamsIPVersion = "IPv6"
)

func (EmailRoutingTimeseriesGroupSPFParamsIPVersion) IsKnown

type EmailRoutingTimeseriesGroupSPFResponse

type EmailRoutingTimeseriesGroupSPFResponse struct {
	Meta   interface{}                                `json:"meta,required"`
	Serie0 RadarEmailSeries                           `json:"serie_0,required"`
	JSON   emailRoutingTimeseriesGroupSPFResponseJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupSPFResponse) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupSPFResponse) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupSPFResponseEnvelope

type EmailRoutingTimeseriesGroupSPFResponseEnvelope struct {
	Result  EmailRoutingTimeseriesGroupSPFResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    emailRoutingTimeseriesGroupSPFResponseEnvelopeJSON `json:"-"`
}

func (*EmailRoutingTimeseriesGroupSPFResponseEnvelope) UnmarshalJSON

func (r *EmailRoutingTimeseriesGroupSPFResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailRoutingTimeseriesGroupService

type EmailRoutingTimeseriesGroupService struct {
	Options []option.RequestOption
}

EmailRoutingTimeseriesGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailRoutingTimeseriesGroupService method instead.

func NewEmailRoutingTimeseriesGroupService

func NewEmailRoutingTimeseriesGroupService(opts ...option.RequestOption) (r *EmailRoutingTimeseriesGroupService)

NewEmailRoutingTimeseriesGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailRoutingTimeseriesGroupService) ARC

Percentage distribution of emails classified by ARC validation over time.

func (*EmailRoutingTimeseriesGroupService) DKIM

Percentage distribution of emails classified by DKIM validation over time.

func (*EmailRoutingTimeseriesGroupService) DMARC

Percentage distribution of emails classified by DMARC validation over time.

func (*EmailRoutingTimeseriesGroupService) Encrypted

Percentage distribution of emails by encryption status over time.

func (*EmailRoutingTimeseriesGroupService) IPVersion

Percentage distribution of emails by IP version over time.

func (*EmailRoutingTimeseriesGroupService) SPF

Percentage distribution of emails classified by SPF validation over time.

type EmailSecurityService

type EmailSecurityService struct {
	Options          []option.RequestOption
	Top              *EmailSecurityTopService
	Summary          *EmailSecuritySummaryService
	TimeseriesGroups *EmailSecurityTimeseriesGroupService
}

EmailSecurityService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityService method instead.

func NewEmailSecurityService

func NewEmailSecurityService(opts ...option.RequestOption) (r *EmailSecurityService)

NewEmailSecurityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type EmailSecuritySummaryARCParams

type EmailSecuritySummaryARCParams struct {
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummaryARCParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummaryARCParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummaryARCParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummaryARCParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummaryARCParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummaryARCParams) URLQuery

func (r EmailSecuritySummaryARCParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecuritySummaryARCParams's query parameters as `url.Values`.

type EmailSecuritySummaryARCParamsDKIM

type EmailSecuritySummaryARCParamsDKIM string
const (
	EmailSecuritySummaryARCParamsDKIMPass EmailSecuritySummaryARCParamsDKIM = "PASS"
	EmailSecuritySummaryARCParamsDKIMNone EmailSecuritySummaryARCParamsDKIM = "NONE"
	EmailSecuritySummaryARCParamsDKIMFail EmailSecuritySummaryARCParamsDKIM = "FAIL"
)

func (EmailSecuritySummaryARCParamsDKIM) IsKnown

type EmailSecuritySummaryARCParamsDMARC

type EmailSecuritySummaryARCParamsDMARC string
const (
	EmailSecuritySummaryARCParamsDMARCPass EmailSecuritySummaryARCParamsDMARC = "PASS"
	EmailSecuritySummaryARCParamsDMARCNone EmailSecuritySummaryARCParamsDMARC = "NONE"
	EmailSecuritySummaryARCParamsDMARCFail EmailSecuritySummaryARCParamsDMARC = "FAIL"
)

func (EmailSecuritySummaryARCParamsDMARC) IsKnown

type EmailSecuritySummaryARCParamsFormat

type EmailSecuritySummaryARCParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummaryARCParamsFormatJson EmailSecuritySummaryARCParamsFormat = "JSON"
	EmailSecuritySummaryARCParamsFormatCsv  EmailSecuritySummaryARCParamsFormat = "CSV"
)

func (EmailSecuritySummaryARCParamsFormat) IsKnown

type EmailSecuritySummaryARCParamsSPF

type EmailSecuritySummaryARCParamsSPF string
const (
	EmailSecuritySummaryARCParamsSPFPass EmailSecuritySummaryARCParamsSPF = "PASS"
	EmailSecuritySummaryARCParamsSPFNone EmailSecuritySummaryARCParamsSPF = "NONE"
	EmailSecuritySummaryARCParamsSPFFail EmailSecuritySummaryARCParamsSPF = "FAIL"
)

func (EmailSecuritySummaryARCParamsSPF) IsKnown

type EmailSecuritySummaryARCParamsTLSVersion

type EmailSecuritySummaryARCParamsTLSVersion string
const (
	EmailSecuritySummaryARCParamsTLSVersionTlSv1_0 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummaryARCParamsTLSVersionTlSv1_1 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummaryARCParamsTLSVersionTlSv1_2 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummaryARCParamsTLSVersionTlSv1_3 EmailSecuritySummaryARCParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummaryARCParamsTLSVersion) IsKnown

type EmailSecuritySummaryARCResponse

type EmailSecuritySummaryARCResponse struct {
	Meta     EmailSecuritySummaryARCResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                   `json:"summary_0,required"`
	JSON     emailSecuritySummaryARCResponseJSON `json:"-"`
}

func (*EmailSecuritySummaryARCResponse) UnmarshalJSON

func (r *EmailSecuritySummaryARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryARCResponseEnvelope

type EmailSecuritySummaryARCResponseEnvelope struct {
	Result  EmailSecuritySummaryARCResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    emailSecuritySummaryARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummaryARCResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummaryARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryARCResponseMeta

type EmailSecuritySummaryARCResponseMeta struct {
	DateRange      []EmailSecuritySummaryARCResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	Normalization  string                                            `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummaryARCResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummaryARCResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummaryARCResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummaryARCResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryARCResponseMetaConfidenceInfo

type EmailSecuritySummaryARCResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        emailSecuritySummaryARCResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummaryARCResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecuritySummaryARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummaryARCResponseMetaDateRange

type EmailSecuritySummaryARCResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummaryARCResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummaryARCResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummaryARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDKIMParams

type EmailSecuritySummaryDKIMParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummaryDKIMParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummaryDKIMParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummaryDKIMParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummaryDKIMParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummaryDKIMParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummaryDKIMParams) URLQuery

func (r EmailSecuritySummaryDKIMParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecuritySummaryDKIMParams's query parameters as `url.Values`.

type EmailSecuritySummaryDKIMParamsARC

type EmailSecuritySummaryDKIMParamsARC string
const (
	EmailSecuritySummaryDKIMParamsARCPass EmailSecuritySummaryDKIMParamsARC = "PASS"
	EmailSecuritySummaryDKIMParamsARCNone EmailSecuritySummaryDKIMParamsARC = "NONE"
	EmailSecuritySummaryDKIMParamsARCFail EmailSecuritySummaryDKIMParamsARC = "FAIL"
)

func (EmailSecuritySummaryDKIMParamsARC) IsKnown

type EmailSecuritySummaryDKIMParamsDMARC

type EmailSecuritySummaryDKIMParamsDMARC string
const (
	EmailSecuritySummaryDKIMParamsDMARCPass EmailSecuritySummaryDKIMParamsDMARC = "PASS"
	EmailSecuritySummaryDKIMParamsDMARCNone EmailSecuritySummaryDKIMParamsDMARC = "NONE"
	EmailSecuritySummaryDKIMParamsDMARCFail EmailSecuritySummaryDKIMParamsDMARC = "FAIL"
)

func (EmailSecuritySummaryDKIMParamsDMARC) IsKnown

type EmailSecuritySummaryDKIMParamsFormat

type EmailSecuritySummaryDKIMParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummaryDKIMParamsFormatJson EmailSecuritySummaryDKIMParamsFormat = "JSON"
	EmailSecuritySummaryDKIMParamsFormatCsv  EmailSecuritySummaryDKIMParamsFormat = "CSV"
)

func (EmailSecuritySummaryDKIMParamsFormat) IsKnown

type EmailSecuritySummaryDKIMParamsSPF

type EmailSecuritySummaryDKIMParamsSPF string
const (
	EmailSecuritySummaryDKIMParamsSPFPass EmailSecuritySummaryDKIMParamsSPF = "PASS"
	EmailSecuritySummaryDKIMParamsSPFNone EmailSecuritySummaryDKIMParamsSPF = "NONE"
	EmailSecuritySummaryDKIMParamsSPFFail EmailSecuritySummaryDKIMParamsSPF = "FAIL"
)

func (EmailSecuritySummaryDKIMParamsSPF) IsKnown

type EmailSecuritySummaryDKIMParamsTLSVersion

type EmailSecuritySummaryDKIMParamsTLSVersion string
const (
	EmailSecuritySummaryDKIMParamsTLSVersionTlSv1_0 EmailSecuritySummaryDKIMParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummaryDKIMParamsTLSVersionTlSv1_1 EmailSecuritySummaryDKIMParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummaryDKIMParamsTLSVersionTlSv1_2 EmailSecuritySummaryDKIMParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummaryDKIMParamsTLSVersionTlSv1_3 EmailSecuritySummaryDKIMParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummaryDKIMParamsTLSVersion) IsKnown

type EmailSecuritySummaryDKIMResponse

type EmailSecuritySummaryDKIMResponse struct {
	Meta     EmailSecuritySummaryDKIMResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                    `json:"summary_0,required"`
	JSON     emailSecuritySummaryDKIMResponseJSON `json:"-"`
}

func (*EmailSecuritySummaryDKIMResponse) UnmarshalJSON

func (r *EmailSecuritySummaryDKIMResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDKIMResponseEnvelope

type EmailSecuritySummaryDKIMResponseEnvelope struct {
	Result  EmailSecuritySummaryDKIMResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    emailSecuritySummaryDKIMResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummaryDKIMResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummaryDKIMResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDKIMResponseMeta

type EmailSecuritySummaryDKIMResponseMeta struct {
	DateRange      []EmailSecuritySummaryDKIMResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                             `json:"lastUpdated,required"`
	Normalization  string                                             `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummaryDKIMResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummaryDKIMResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummaryDKIMResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummaryDKIMResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDKIMResponseMetaConfidenceInfo

type EmailSecuritySummaryDKIMResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                          `json:"level"`
	JSON        emailSecuritySummaryDKIMResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummaryDKIMResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecuritySummaryDKIMResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                           `json:"dataSource,required"`
	Description     string                                                           `json:"description,required"`
	EventType       string                                                           `json:"eventType,required"`
	IsInstantaneous bool                                                             `json:"isInstantaneous,required"`
	EndTime         time.Time                                                        `json:"endTime" format:"date-time"`
	LinkedURL       string                                                           `json:"linkedUrl"`
	StartTime       time.Time                                                        `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummaryDKIMResponseMetaDateRange

type EmailSecuritySummaryDKIMResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                         `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummaryDKIMResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummaryDKIMResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummaryDKIMResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDMARCParams

type EmailSecuritySummaryDMARCParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummaryDMARCParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummaryDMARCParamsDKIM] `query:"dkim"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummaryDMARCParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummaryDMARCParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummaryDMARCParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummaryDMARCParams) URLQuery

func (r EmailSecuritySummaryDMARCParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecuritySummaryDMARCParams's query parameters as `url.Values`.

type EmailSecuritySummaryDMARCParamsARC

type EmailSecuritySummaryDMARCParamsARC string
const (
	EmailSecuritySummaryDMARCParamsARCPass EmailSecuritySummaryDMARCParamsARC = "PASS"
	EmailSecuritySummaryDMARCParamsARCNone EmailSecuritySummaryDMARCParamsARC = "NONE"
	EmailSecuritySummaryDMARCParamsARCFail EmailSecuritySummaryDMARCParamsARC = "FAIL"
)

func (EmailSecuritySummaryDMARCParamsARC) IsKnown

type EmailSecuritySummaryDMARCParamsDKIM

type EmailSecuritySummaryDMARCParamsDKIM string
const (
	EmailSecuritySummaryDMARCParamsDKIMPass EmailSecuritySummaryDMARCParamsDKIM = "PASS"
	EmailSecuritySummaryDMARCParamsDKIMNone EmailSecuritySummaryDMARCParamsDKIM = "NONE"
	EmailSecuritySummaryDMARCParamsDKIMFail EmailSecuritySummaryDMARCParamsDKIM = "FAIL"
)

func (EmailSecuritySummaryDMARCParamsDKIM) IsKnown

type EmailSecuritySummaryDMARCParamsFormat

type EmailSecuritySummaryDMARCParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummaryDMARCParamsFormatJson EmailSecuritySummaryDMARCParamsFormat = "JSON"
	EmailSecuritySummaryDMARCParamsFormatCsv  EmailSecuritySummaryDMARCParamsFormat = "CSV"
)

func (EmailSecuritySummaryDMARCParamsFormat) IsKnown

type EmailSecuritySummaryDMARCParamsSPF

type EmailSecuritySummaryDMARCParamsSPF string
const (
	EmailSecuritySummaryDMARCParamsSPFPass EmailSecuritySummaryDMARCParamsSPF = "PASS"
	EmailSecuritySummaryDMARCParamsSPFNone EmailSecuritySummaryDMARCParamsSPF = "NONE"
	EmailSecuritySummaryDMARCParamsSPFFail EmailSecuritySummaryDMARCParamsSPF = "FAIL"
)

func (EmailSecuritySummaryDMARCParamsSPF) IsKnown

type EmailSecuritySummaryDMARCParamsTLSVersion

type EmailSecuritySummaryDMARCParamsTLSVersion string
const (
	EmailSecuritySummaryDMARCParamsTLSVersionTlSv1_0 EmailSecuritySummaryDMARCParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummaryDMARCParamsTLSVersionTlSv1_1 EmailSecuritySummaryDMARCParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummaryDMARCParamsTLSVersionTlSv1_2 EmailSecuritySummaryDMARCParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummaryDMARCParamsTLSVersionTlSv1_3 EmailSecuritySummaryDMARCParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummaryDMARCParamsTLSVersion) IsKnown

type EmailSecuritySummaryDMARCResponse

type EmailSecuritySummaryDMARCResponse struct {
	Meta     EmailSecuritySummaryDMARCResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                     `json:"summary_0,required"`
	JSON     emailSecuritySummaryDMARCResponseJSON `json:"-"`
}

func (*EmailSecuritySummaryDMARCResponse) UnmarshalJSON

func (r *EmailSecuritySummaryDMARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDMARCResponseEnvelope

type EmailSecuritySummaryDMARCResponseEnvelope struct {
	Result  EmailSecuritySummaryDMARCResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    emailSecuritySummaryDMARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummaryDMARCResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummaryDMARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDMARCResponseMeta

type EmailSecuritySummaryDMARCResponseMeta struct {
	DateRange      []EmailSecuritySummaryDMARCResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                              `json:"lastUpdated,required"`
	Normalization  string                                              `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummaryDMARCResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummaryDMARCResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummaryDMARCResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummaryDMARCResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDMARCResponseMetaConfidenceInfo

type EmailSecuritySummaryDMARCResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                           `json:"level"`
	JSON        emailSecuritySummaryDMARCResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummaryDMARCResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecuritySummaryDMARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                            `json:"dataSource,required"`
	Description     string                                                            `json:"description,required"`
	EventType       string                                                            `json:"eventType,required"`
	IsInstantaneous bool                                                              `json:"isInstantaneous,required"`
	EndTime         time.Time                                                         `json:"endTime" format:"date-time"`
	LinkedURL       string                                                            `json:"linkedUrl"`
	StartTime       time.Time                                                         `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummaryDMARCResponseMetaDateRange

type EmailSecuritySummaryDMARCResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                          `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummaryDMARCResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummaryDMARCResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummaryDMARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryMaliciousParams

type EmailSecuritySummaryMaliciousParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummaryMaliciousParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummaryMaliciousParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummaryMaliciousParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummaryMaliciousParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummaryMaliciousParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummaryMaliciousParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummaryMaliciousParams) URLQuery

URLQuery serializes EmailSecuritySummaryMaliciousParams's query parameters as `url.Values`.

type EmailSecuritySummaryMaliciousParamsARC

type EmailSecuritySummaryMaliciousParamsARC string
const (
	EmailSecuritySummaryMaliciousParamsARCPass EmailSecuritySummaryMaliciousParamsARC = "PASS"
	EmailSecuritySummaryMaliciousParamsARCNone EmailSecuritySummaryMaliciousParamsARC = "NONE"
	EmailSecuritySummaryMaliciousParamsARCFail EmailSecuritySummaryMaliciousParamsARC = "FAIL"
)

func (EmailSecuritySummaryMaliciousParamsARC) IsKnown

type EmailSecuritySummaryMaliciousParamsDKIM

type EmailSecuritySummaryMaliciousParamsDKIM string
const (
	EmailSecuritySummaryMaliciousParamsDKIMPass EmailSecuritySummaryMaliciousParamsDKIM = "PASS"
	EmailSecuritySummaryMaliciousParamsDKIMNone EmailSecuritySummaryMaliciousParamsDKIM = "NONE"
	EmailSecuritySummaryMaliciousParamsDKIMFail EmailSecuritySummaryMaliciousParamsDKIM = "FAIL"
)

func (EmailSecuritySummaryMaliciousParamsDKIM) IsKnown

type EmailSecuritySummaryMaliciousParamsDMARC

type EmailSecuritySummaryMaliciousParamsDMARC string
const (
	EmailSecuritySummaryMaliciousParamsDMARCPass EmailSecuritySummaryMaliciousParamsDMARC = "PASS"
	EmailSecuritySummaryMaliciousParamsDMARCNone EmailSecuritySummaryMaliciousParamsDMARC = "NONE"
	EmailSecuritySummaryMaliciousParamsDMARCFail EmailSecuritySummaryMaliciousParamsDMARC = "FAIL"
)

func (EmailSecuritySummaryMaliciousParamsDMARC) IsKnown

type EmailSecuritySummaryMaliciousParamsFormat

type EmailSecuritySummaryMaliciousParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummaryMaliciousParamsFormatJson EmailSecuritySummaryMaliciousParamsFormat = "JSON"
	EmailSecuritySummaryMaliciousParamsFormatCsv  EmailSecuritySummaryMaliciousParamsFormat = "CSV"
)

func (EmailSecuritySummaryMaliciousParamsFormat) IsKnown

type EmailSecuritySummaryMaliciousParamsSPF

type EmailSecuritySummaryMaliciousParamsSPF string
const (
	EmailSecuritySummaryMaliciousParamsSPFPass EmailSecuritySummaryMaliciousParamsSPF = "PASS"
	EmailSecuritySummaryMaliciousParamsSPFNone EmailSecuritySummaryMaliciousParamsSPF = "NONE"
	EmailSecuritySummaryMaliciousParamsSPFFail EmailSecuritySummaryMaliciousParamsSPF = "FAIL"
)

func (EmailSecuritySummaryMaliciousParamsSPF) IsKnown

type EmailSecuritySummaryMaliciousParamsTLSVersion

type EmailSecuritySummaryMaliciousParamsTLSVersion string
const (
	EmailSecuritySummaryMaliciousParamsTLSVersionTlSv1_0 EmailSecuritySummaryMaliciousParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummaryMaliciousParamsTLSVersionTlSv1_1 EmailSecuritySummaryMaliciousParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummaryMaliciousParamsTLSVersionTlSv1_2 EmailSecuritySummaryMaliciousParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummaryMaliciousParamsTLSVersionTlSv1_3 EmailSecuritySummaryMaliciousParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummaryMaliciousParamsTLSVersion) IsKnown

type EmailSecuritySummaryMaliciousResponse

type EmailSecuritySummaryMaliciousResponse struct {
	Meta     EmailSecuritySummaryMaliciousResponseMeta     `json:"meta,required"`
	Summary0 EmailSecuritySummaryMaliciousResponseSummary0 `json:"summary_0,required"`
	JSON     emailSecuritySummaryMaliciousResponseJSON     `json:"-"`
}

func (*EmailSecuritySummaryMaliciousResponse) UnmarshalJSON

func (r *EmailSecuritySummaryMaliciousResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryMaliciousResponseEnvelope

type EmailSecuritySummaryMaliciousResponseEnvelope struct {
	Result  EmailSecuritySummaryMaliciousResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    emailSecuritySummaryMaliciousResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummaryMaliciousResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummaryMaliciousResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryMaliciousResponseMeta

type EmailSecuritySummaryMaliciousResponseMeta struct {
	DateRange      []EmailSecuritySummaryMaliciousResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                  `json:"lastUpdated,required"`
	Normalization  string                                                  `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummaryMaliciousResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummaryMaliciousResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummaryMaliciousResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo

type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                               `json:"level"`
	JSON        emailSecuritySummaryMaliciousResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo) UnmarshalJSON

type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                `json:"dataSource,required"`
	Description     string                                                                `json:"description,required"`
	EventType       string                                                                `json:"eventType,required"`
	IsInstantaneous bool                                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                `json:"linkedUrl"`
	StartTime       time.Time                                                             `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummaryMaliciousResponseMetaDateRange

type EmailSecuritySummaryMaliciousResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                              `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummaryMaliciousResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummaryMaliciousResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummaryMaliciousResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryMaliciousResponseSummary0

type EmailSecuritySummaryMaliciousResponseSummary0 struct {
	Malicious    string                                            `json:"MALICIOUS,required"`
	NotMalicious string                                            `json:"NOT_MALICIOUS,required"`
	JSON         emailSecuritySummaryMaliciousResponseSummary0JSON `json:"-"`
}

func (*EmailSecuritySummaryMaliciousResponseSummary0) UnmarshalJSON

func (r *EmailSecuritySummaryMaliciousResponseSummary0) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySPFParams

type EmailSecuritySummarySPFParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummarySPFParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummarySPFParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummarySPFParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummarySPFParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummarySPFParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummarySPFParams) URLQuery

func (r EmailSecuritySummarySPFParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecuritySummarySPFParams's query parameters as `url.Values`.

type EmailSecuritySummarySPFParamsARC

type EmailSecuritySummarySPFParamsARC string
const (
	EmailSecuritySummarySPFParamsARCPass EmailSecuritySummarySPFParamsARC = "PASS"
	EmailSecuritySummarySPFParamsARCNone EmailSecuritySummarySPFParamsARC = "NONE"
	EmailSecuritySummarySPFParamsARCFail EmailSecuritySummarySPFParamsARC = "FAIL"
)

func (EmailSecuritySummarySPFParamsARC) IsKnown

type EmailSecuritySummarySPFParamsDKIM

type EmailSecuritySummarySPFParamsDKIM string
const (
	EmailSecuritySummarySPFParamsDKIMPass EmailSecuritySummarySPFParamsDKIM = "PASS"
	EmailSecuritySummarySPFParamsDKIMNone EmailSecuritySummarySPFParamsDKIM = "NONE"
	EmailSecuritySummarySPFParamsDKIMFail EmailSecuritySummarySPFParamsDKIM = "FAIL"
)

func (EmailSecuritySummarySPFParamsDKIM) IsKnown

type EmailSecuritySummarySPFParamsDMARC

type EmailSecuritySummarySPFParamsDMARC string
const (
	EmailSecuritySummarySPFParamsDMARCPass EmailSecuritySummarySPFParamsDMARC = "PASS"
	EmailSecuritySummarySPFParamsDMARCNone EmailSecuritySummarySPFParamsDMARC = "NONE"
	EmailSecuritySummarySPFParamsDMARCFail EmailSecuritySummarySPFParamsDMARC = "FAIL"
)

func (EmailSecuritySummarySPFParamsDMARC) IsKnown

type EmailSecuritySummarySPFParamsFormat

type EmailSecuritySummarySPFParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummarySPFParamsFormatJson EmailSecuritySummarySPFParamsFormat = "JSON"
	EmailSecuritySummarySPFParamsFormatCsv  EmailSecuritySummarySPFParamsFormat = "CSV"
)

func (EmailSecuritySummarySPFParamsFormat) IsKnown

type EmailSecuritySummarySPFParamsTLSVersion

type EmailSecuritySummarySPFParamsTLSVersion string
const (
	EmailSecuritySummarySPFParamsTLSVersionTlSv1_0 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummarySPFParamsTLSVersionTlSv1_1 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummarySPFParamsTLSVersionTlSv1_2 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummarySPFParamsTLSVersionTlSv1_3 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummarySPFParamsTLSVersion) IsKnown

type EmailSecuritySummarySPFResponse

type EmailSecuritySummarySPFResponse struct {
	Meta     EmailSecuritySummarySPFResponseMeta `json:"meta,required"`
	Summary0 RadarEmailSummary                   `json:"summary_0,required"`
	JSON     emailSecuritySummarySPFResponseJSON `json:"-"`
}

func (*EmailSecuritySummarySPFResponse) UnmarshalJSON

func (r *EmailSecuritySummarySPFResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySPFResponseEnvelope

type EmailSecuritySummarySPFResponseEnvelope struct {
	Result  EmailSecuritySummarySPFResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    emailSecuritySummarySPFResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummarySPFResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummarySPFResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySPFResponseMeta

type EmailSecuritySummarySPFResponseMeta struct {
	DateRange      []EmailSecuritySummarySPFResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	Normalization  string                                            `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummarySPFResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummarySPFResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummarySPFResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummarySPFResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySPFResponseMetaConfidenceInfo

type EmailSecuritySummarySPFResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        emailSecuritySummarySPFResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummarySPFResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecuritySummarySPFResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummarySPFResponseMetaDateRange

type EmailSecuritySummarySPFResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummarySPFResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummarySPFResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummarySPFResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryService

type EmailSecuritySummaryService struct {
	Options []option.RequestOption
}

EmailSecuritySummaryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecuritySummaryService method instead.

func NewEmailSecuritySummaryService

func NewEmailSecuritySummaryService(opts ...option.RequestOption) (r *EmailSecuritySummaryService)

NewEmailSecuritySummaryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailSecuritySummaryService) ARC

Percentage distribution of emails classified by ARC validation.

func (*EmailSecuritySummaryService) DKIM

Percentage distribution of emails classified by DKIM validation.

func (*EmailSecuritySummaryService) DMARC

Percentage distribution of emails classified by DMARC validation.

func (*EmailSecuritySummaryService) Malicious

Percentage distribution of emails classified as MALICIOUS.

func (*EmailSecuritySummaryService) SPF

Percentage distribution of emails classified by SPF validation.

func (*EmailSecuritySummaryService) Spam

Proportion of emails categorized as either spam or legitimate (non-spam).

func (*EmailSecuritySummaryService) Spoof

Proportion of emails categorized as either spoof or legitimate (non-spoof).

func (*EmailSecuritySummaryService) TLSVersion

Percentage distribution of emails classified by TLS version.

func (*EmailSecuritySummaryService) ThreatCategory

Percentage distribution of emails classified in Threat Categories.

type EmailSecuritySummarySpamParams

type EmailSecuritySummarySpamParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummarySpamParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummarySpamParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummarySpamParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummarySpamParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummarySpamParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummarySpamParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummarySpamParams) URLQuery

func (r EmailSecuritySummarySpamParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecuritySummarySpamParams's query parameters as `url.Values`.

type EmailSecuritySummarySpamParamsARC

type EmailSecuritySummarySpamParamsARC string
const (
	EmailSecuritySummarySpamParamsARCPass EmailSecuritySummarySpamParamsARC = "PASS"
	EmailSecuritySummarySpamParamsARCNone EmailSecuritySummarySpamParamsARC = "NONE"
	EmailSecuritySummarySpamParamsARCFail EmailSecuritySummarySpamParamsARC = "FAIL"
)

func (EmailSecuritySummarySpamParamsARC) IsKnown

type EmailSecuritySummarySpamParamsDKIM

type EmailSecuritySummarySpamParamsDKIM string
const (
	EmailSecuritySummarySpamParamsDKIMPass EmailSecuritySummarySpamParamsDKIM = "PASS"
	EmailSecuritySummarySpamParamsDKIMNone EmailSecuritySummarySpamParamsDKIM = "NONE"
	EmailSecuritySummarySpamParamsDKIMFail EmailSecuritySummarySpamParamsDKIM = "FAIL"
)

func (EmailSecuritySummarySpamParamsDKIM) IsKnown

type EmailSecuritySummarySpamParamsDMARC

type EmailSecuritySummarySpamParamsDMARC string
const (
	EmailSecuritySummarySpamParamsDMARCPass EmailSecuritySummarySpamParamsDMARC = "PASS"
	EmailSecuritySummarySpamParamsDMARCNone EmailSecuritySummarySpamParamsDMARC = "NONE"
	EmailSecuritySummarySpamParamsDMARCFail EmailSecuritySummarySpamParamsDMARC = "FAIL"
)

func (EmailSecuritySummarySpamParamsDMARC) IsKnown

type EmailSecuritySummarySpamParamsFormat

type EmailSecuritySummarySpamParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummarySpamParamsFormatJson EmailSecuritySummarySpamParamsFormat = "JSON"
	EmailSecuritySummarySpamParamsFormatCsv  EmailSecuritySummarySpamParamsFormat = "CSV"
)

func (EmailSecuritySummarySpamParamsFormat) IsKnown

type EmailSecuritySummarySpamParamsSPF

type EmailSecuritySummarySpamParamsSPF string
const (
	EmailSecuritySummarySpamParamsSPFPass EmailSecuritySummarySpamParamsSPF = "PASS"
	EmailSecuritySummarySpamParamsSPFNone EmailSecuritySummarySpamParamsSPF = "NONE"
	EmailSecuritySummarySpamParamsSPFFail EmailSecuritySummarySpamParamsSPF = "FAIL"
)

func (EmailSecuritySummarySpamParamsSPF) IsKnown

type EmailSecuritySummarySpamParamsTLSVersion

type EmailSecuritySummarySpamParamsTLSVersion string
const (
	EmailSecuritySummarySpamParamsTLSVersionTlSv1_0 EmailSecuritySummarySpamParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummarySpamParamsTLSVersionTlSv1_1 EmailSecuritySummarySpamParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummarySpamParamsTLSVersionTlSv1_2 EmailSecuritySummarySpamParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummarySpamParamsTLSVersionTlSv1_3 EmailSecuritySummarySpamParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummarySpamParamsTLSVersion) IsKnown

type EmailSecuritySummarySpamResponse

type EmailSecuritySummarySpamResponse struct {
	Meta     EmailSecuritySummarySpamResponseMeta     `json:"meta,required"`
	Summary0 EmailSecuritySummarySpamResponseSummary0 `json:"summary_0,required"`
	JSON     emailSecuritySummarySpamResponseJSON     `json:"-"`
}

func (*EmailSecuritySummarySpamResponse) UnmarshalJSON

func (r *EmailSecuritySummarySpamResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpamResponseEnvelope

type EmailSecuritySummarySpamResponseEnvelope struct {
	Result  EmailSecuritySummarySpamResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    emailSecuritySummarySpamResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummarySpamResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummarySpamResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpamResponseMeta

type EmailSecuritySummarySpamResponseMeta struct {
	DateRange      []EmailSecuritySummarySpamResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                             `json:"lastUpdated,required"`
	Normalization  string                                             `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummarySpamResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummarySpamResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummarySpamResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummarySpamResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpamResponseMetaConfidenceInfo

type EmailSecuritySummarySpamResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                          `json:"level"`
	JSON        emailSecuritySummarySpamResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummarySpamResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecuritySummarySpamResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                           `json:"dataSource,required"`
	Description     string                                                           `json:"description,required"`
	EventType       string                                                           `json:"eventType,required"`
	IsInstantaneous bool                                                             `json:"isInstantaneous,required"`
	EndTime         time.Time                                                        `json:"endTime" format:"date-time"`
	LinkedURL       string                                                           `json:"linkedUrl"`
	StartTime       time.Time                                                        `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummarySpamResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummarySpamResponseMetaDateRange

type EmailSecuritySummarySpamResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                         `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummarySpamResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummarySpamResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummarySpamResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpamResponseSummary0

type EmailSecuritySummarySpamResponseSummary0 struct {
	NotSpam string                                       `json:"NOT_SPAM,required"`
	Spam    string                                       `json:"SPAM,required"`
	JSON    emailSecuritySummarySpamResponseSummary0JSON `json:"-"`
}

func (*EmailSecuritySummarySpamResponseSummary0) UnmarshalJSON

func (r *EmailSecuritySummarySpamResponseSummary0) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpoofParams

type EmailSecuritySummarySpoofParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummarySpoofParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummarySpoofParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummarySpoofParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummarySpoofParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummarySpoofParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummarySpoofParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummarySpoofParams) URLQuery

func (r EmailSecuritySummarySpoofParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecuritySummarySpoofParams's query parameters as `url.Values`.

type EmailSecuritySummarySpoofParamsARC

type EmailSecuritySummarySpoofParamsARC string
const (
	EmailSecuritySummarySpoofParamsARCPass EmailSecuritySummarySpoofParamsARC = "PASS"
	EmailSecuritySummarySpoofParamsARCNone EmailSecuritySummarySpoofParamsARC = "NONE"
	EmailSecuritySummarySpoofParamsARCFail EmailSecuritySummarySpoofParamsARC = "FAIL"
)

func (EmailSecuritySummarySpoofParamsARC) IsKnown

type EmailSecuritySummarySpoofParamsDKIM

type EmailSecuritySummarySpoofParamsDKIM string
const (
	EmailSecuritySummarySpoofParamsDKIMPass EmailSecuritySummarySpoofParamsDKIM = "PASS"
	EmailSecuritySummarySpoofParamsDKIMNone EmailSecuritySummarySpoofParamsDKIM = "NONE"
	EmailSecuritySummarySpoofParamsDKIMFail EmailSecuritySummarySpoofParamsDKIM = "FAIL"
)

func (EmailSecuritySummarySpoofParamsDKIM) IsKnown

type EmailSecuritySummarySpoofParamsDMARC

type EmailSecuritySummarySpoofParamsDMARC string
const (
	EmailSecuritySummarySpoofParamsDMARCPass EmailSecuritySummarySpoofParamsDMARC = "PASS"
	EmailSecuritySummarySpoofParamsDMARCNone EmailSecuritySummarySpoofParamsDMARC = "NONE"
	EmailSecuritySummarySpoofParamsDMARCFail EmailSecuritySummarySpoofParamsDMARC = "FAIL"
)

func (EmailSecuritySummarySpoofParamsDMARC) IsKnown

type EmailSecuritySummarySpoofParamsFormat

type EmailSecuritySummarySpoofParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummarySpoofParamsFormatJson EmailSecuritySummarySpoofParamsFormat = "JSON"
	EmailSecuritySummarySpoofParamsFormatCsv  EmailSecuritySummarySpoofParamsFormat = "CSV"
)

func (EmailSecuritySummarySpoofParamsFormat) IsKnown

type EmailSecuritySummarySpoofParamsSPF

type EmailSecuritySummarySpoofParamsSPF string
const (
	EmailSecuritySummarySpoofParamsSPFPass EmailSecuritySummarySpoofParamsSPF = "PASS"
	EmailSecuritySummarySpoofParamsSPFNone EmailSecuritySummarySpoofParamsSPF = "NONE"
	EmailSecuritySummarySpoofParamsSPFFail EmailSecuritySummarySpoofParamsSPF = "FAIL"
)

func (EmailSecuritySummarySpoofParamsSPF) IsKnown

type EmailSecuritySummarySpoofParamsTLSVersion

type EmailSecuritySummarySpoofParamsTLSVersion string
const (
	EmailSecuritySummarySpoofParamsTLSVersionTlSv1_0 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummarySpoofParamsTLSVersionTlSv1_1 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummarySpoofParamsTLSVersionTlSv1_2 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummarySpoofParamsTLSVersionTlSv1_3 EmailSecuritySummarySpoofParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummarySpoofParamsTLSVersion) IsKnown

type EmailSecuritySummarySpoofResponse

type EmailSecuritySummarySpoofResponse struct {
	Meta     EmailSecuritySummarySpoofResponseMeta     `json:"meta,required"`
	Summary0 EmailSecuritySummarySpoofResponseSummary0 `json:"summary_0,required"`
	JSON     emailSecuritySummarySpoofResponseJSON     `json:"-"`
}

func (*EmailSecuritySummarySpoofResponse) UnmarshalJSON

func (r *EmailSecuritySummarySpoofResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpoofResponseEnvelope

type EmailSecuritySummarySpoofResponseEnvelope struct {
	Result  EmailSecuritySummarySpoofResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    emailSecuritySummarySpoofResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummarySpoofResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummarySpoofResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpoofResponseMeta

type EmailSecuritySummarySpoofResponseMeta struct {
	DateRange      []EmailSecuritySummarySpoofResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                              `json:"lastUpdated,required"`
	Normalization  string                                              `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummarySpoofResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummarySpoofResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummarySpoofResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummarySpoofResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpoofResponseMetaConfidenceInfo

type EmailSecuritySummarySpoofResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                           `json:"level"`
	JSON        emailSecuritySummarySpoofResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummarySpoofResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecuritySummarySpoofResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                            `json:"dataSource,required"`
	Description     string                                                            `json:"description,required"`
	EventType       string                                                            `json:"eventType,required"`
	IsInstantaneous bool                                                              `json:"isInstantaneous,required"`
	EndTime         time.Time                                                         `json:"endTime" format:"date-time"`
	LinkedURL       string                                                            `json:"linkedUrl"`
	StartTime       time.Time                                                         `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummarySpoofResponseMetaDateRange

type EmailSecuritySummarySpoofResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                          `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummarySpoofResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummarySpoofResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummarySpoofResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummarySpoofResponseSummary0

type EmailSecuritySummarySpoofResponseSummary0 struct {
	NotSpoof string                                        `json:"NOT_SPOOF,required"`
	Spoof    string                                        `json:"SPOOF,required"`
	JSON     emailSecuritySummarySpoofResponseSummary0JSON `json:"-"`
}

func (*EmailSecuritySummarySpoofResponseSummary0) UnmarshalJSON

func (r *EmailSecuritySummarySpoofResponseSummary0) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryTLSVersionParams

type EmailSecuritySummaryTLSVersionParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummaryTLSVersionParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummaryTLSVersionParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummaryTLSVersionParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummaryTLSVersionParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummaryTLSVersionParamsSPF] `query:"spf"`
}

func (EmailSecuritySummaryTLSVersionParams) URLQuery

URLQuery serializes EmailSecuritySummaryTLSVersionParams's query parameters as `url.Values`.

type EmailSecuritySummaryTLSVersionParamsARC

type EmailSecuritySummaryTLSVersionParamsARC string
const (
	EmailSecuritySummaryTLSVersionParamsARCPass EmailSecuritySummaryTLSVersionParamsARC = "PASS"
	EmailSecuritySummaryTLSVersionParamsARCNone EmailSecuritySummaryTLSVersionParamsARC = "NONE"
	EmailSecuritySummaryTLSVersionParamsARCFail EmailSecuritySummaryTLSVersionParamsARC = "FAIL"
)

func (EmailSecuritySummaryTLSVersionParamsARC) IsKnown

type EmailSecuritySummaryTLSVersionParamsDKIM

type EmailSecuritySummaryTLSVersionParamsDKIM string
const (
	EmailSecuritySummaryTLSVersionParamsDKIMPass EmailSecuritySummaryTLSVersionParamsDKIM = "PASS"
	EmailSecuritySummaryTLSVersionParamsDKIMNone EmailSecuritySummaryTLSVersionParamsDKIM = "NONE"
	EmailSecuritySummaryTLSVersionParamsDKIMFail EmailSecuritySummaryTLSVersionParamsDKIM = "FAIL"
)

func (EmailSecuritySummaryTLSVersionParamsDKIM) IsKnown

type EmailSecuritySummaryTLSVersionParamsDMARC

type EmailSecuritySummaryTLSVersionParamsDMARC string
const (
	EmailSecuritySummaryTLSVersionParamsDMARCPass EmailSecuritySummaryTLSVersionParamsDMARC = "PASS"
	EmailSecuritySummaryTLSVersionParamsDMARCNone EmailSecuritySummaryTLSVersionParamsDMARC = "NONE"
	EmailSecuritySummaryTLSVersionParamsDMARCFail EmailSecuritySummaryTLSVersionParamsDMARC = "FAIL"
)

func (EmailSecuritySummaryTLSVersionParamsDMARC) IsKnown

type EmailSecuritySummaryTLSVersionParamsFormat

type EmailSecuritySummaryTLSVersionParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummaryTLSVersionParamsFormatJson EmailSecuritySummaryTLSVersionParamsFormat = "JSON"
	EmailSecuritySummaryTLSVersionParamsFormatCsv  EmailSecuritySummaryTLSVersionParamsFormat = "CSV"
)

func (EmailSecuritySummaryTLSVersionParamsFormat) IsKnown

type EmailSecuritySummaryTLSVersionParamsSPF

type EmailSecuritySummaryTLSVersionParamsSPF string
const (
	EmailSecuritySummaryTLSVersionParamsSPFPass EmailSecuritySummaryTLSVersionParamsSPF = "PASS"
	EmailSecuritySummaryTLSVersionParamsSPFNone EmailSecuritySummaryTLSVersionParamsSPF = "NONE"
	EmailSecuritySummaryTLSVersionParamsSPFFail EmailSecuritySummaryTLSVersionParamsSPF = "FAIL"
)

func (EmailSecuritySummaryTLSVersionParamsSPF) IsKnown

type EmailSecuritySummaryTLSVersionResponse

type EmailSecuritySummaryTLSVersionResponse struct {
	Meta     EmailSecuritySummaryTLSVersionResponseMeta     `json:"meta,required"`
	Summary0 EmailSecuritySummaryTLSVersionResponseSummary0 `json:"summary_0,required"`
	JSON     emailSecuritySummaryTLSVersionResponseJSON     `json:"-"`
}

func (*EmailSecuritySummaryTLSVersionResponse) UnmarshalJSON

func (r *EmailSecuritySummaryTLSVersionResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryTLSVersionResponseEnvelope

type EmailSecuritySummaryTLSVersionResponseEnvelope struct {
	Result  EmailSecuritySummaryTLSVersionResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    emailSecuritySummaryTLSVersionResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummaryTLSVersionResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummaryTLSVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryTLSVersionResponseMeta

type EmailSecuritySummaryTLSVersionResponseMeta struct {
	DateRange      []EmailSecuritySummaryTLSVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                   `json:"lastUpdated,required"`
	Normalization  string                                                   `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummaryTLSVersionResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummaryTLSVersionResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummaryTLSVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo

type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                `json:"level"`
	JSON        emailSecuritySummaryTLSVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON

type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                 `json:"dataSource,required"`
	Description     string                                                                 `json:"description,required"`
	EventType       string                                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                 `json:"linkedUrl"`
	StartTime       time.Time                                                              `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummaryTLSVersionResponseMetaDateRange

type EmailSecuritySummaryTLSVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                               `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummaryTLSVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummaryTLSVersionResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecuritySummaryTLSVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryTLSVersionResponseSummary0

type EmailSecuritySummaryTLSVersionResponseSummary0 struct {
	TLS1_0 string                                             `json:"TLS 1.0,required"`
	TLS1_1 string                                             `json:"TLS 1.1,required"`
	TLS1_2 string                                             `json:"TLS 1.2,required"`
	TLS1_3 string                                             `json:"TLS 1.3,required"`
	JSON   emailSecuritySummaryTLSVersionResponseSummary0JSON `json:"-"`
}

func (*EmailSecuritySummaryTLSVersionResponseSummary0) UnmarshalJSON

func (r *EmailSecuritySummaryTLSVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryThreatCategoryParams

type EmailSecuritySummaryThreatCategoryParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecuritySummaryThreatCategoryParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecuritySummaryThreatCategoryParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecuritySummaryThreatCategoryParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecuritySummaryThreatCategoryParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecuritySummaryThreatCategoryParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecuritySummaryThreatCategoryParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecuritySummaryThreatCategoryParams) URLQuery

URLQuery serializes EmailSecuritySummaryThreatCategoryParams's query parameters as `url.Values`.

type EmailSecuritySummaryThreatCategoryParamsARC

type EmailSecuritySummaryThreatCategoryParamsARC string
const (
	EmailSecuritySummaryThreatCategoryParamsARCPass EmailSecuritySummaryThreatCategoryParamsARC = "PASS"
	EmailSecuritySummaryThreatCategoryParamsARCNone EmailSecuritySummaryThreatCategoryParamsARC = "NONE"
	EmailSecuritySummaryThreatCategoryParamsARCFail EmailSecuritySummaryThreatCategoryParamsARC = "FAIL"
)

func (EmailSecuritySummaryThreatCategoryParamsARC) IsKnown

type EmailSecuritySummaryThreatCategoryParamsDKIM

type EmailSecuritySummaryThreatCategoryParamsDKIM string
const (
	EmailSecuritySummaryThreatCategoryParamsDKIMPass EmailSecuritySummaryThreatCategoryParamsDKIM = "PASS"
	EmailSecuritySummaryThreatCategoryParamsDKIMNone EmailSecuritySummaryThreatCategoryParamsDKIM = "NONE"
	EmailSecuritySummaryThreatCategoryParamsDKIMFail EmailSecuritySummaryThreatCategoryParamsDKIM = "FAIL"
)

func (EmailSecuritySummaryThreatCategoryParamsDKIM) IsKnown

type EmailSecuritySummaryThreatCategoryParamsDMARC

type EmailSecuritySummaryThreatCategoryParamsDMARC string
const (
	EmailSecuritySummaryThreatCategoryParamsDMARCPass EmailSecuritySummaryThreatCategoryParamsDMARC = "PASS"
	EmailSecuritySummaryThreatCategoryParamsDMARCNone EmailSecuritySummaryThreatCategoryParamsDMARC = "NONE"
	EmailSecuritySummaryThreatCategoryParamsDMARCFail EmailSecuritySummaryThreatCategoryParamsDMARC = "FAIL"
)

func (EmailSecuritySummaryThreatCategoryParamsDMARC) IsKnown

type EmailSecuritySummaryThreatCategoryParamsFormat

type EmailSecuritySummaryThreatCategoryParamsFormat string

Format results are returned in.

const (
	EmailSecuritySummaryThreatCategoryParamsFormatJson EmailSecuritySummaryThreatCategoryParamsFormat = "JSON"
	EmailSecuritySummaryThreatCategoryParamsFormatCsv  EmailSecuritySummaryThreatCategoryParamsFormat = "CSV"
)

func (EmailSecuritySummaryThreatCategoryParamsFormat) IsKnown

type EmailSecuritySummaryThreatCategoryParamsSPF

type EmailSecuritySummaryThreatCategoryParamsSPF string
const (
	EmailSecuritySummaryThreatCategoryParamsSPFPass EmailSecuritySummaryThreatCategoryParamsSPF = "PASS"
	EmailSecuritySummaryThreatCategoryParamsSPFNone EmailSecuritySummaryThreatCategoryParamsSPF = "NONE"
	EmailSecuritySummaryThreatCategoryParamsSPFFail EmailSecuritySummaryThreatCategoryParamsSPF = "FAIL"
)

func (EmailSecuritySummaryThreatCategoryParamsSPF) IsKnown

type EmailSecuritySummaryThreatCategoryParamsTLSVersion

type EmailSecuritySummaryThreatCategoryParamsTLSVersion string
const (
	EmailSecuritySummaryThreatCategoryParamsTLSVersionTlSv1_0 EmailSecuritySummaryThreatCategoryParamsTLSVersion = "TLSv1_0"
	EmailSecuritySummaryThreatCategoryParamsTLSVersionTlSv1_1 EmailSecuritySummaryThreatCategoryParamsTLSVersion = "TLSv1_1"
	EmailSecuritySummaryThreatCategoryParamsTLSVersionTlSv1_2 EmailSecuritySummaryThreatCategoryParamsTLSVersion = "TLSv1_2"
	EmailSecuritySummaryThreatCategoryParamsTLSVersionTlSv1_3 EmailSecuritySummaryThreatCategoryParamsTLSVersion = "TLSv1_3"
)

func (EmailSecuritySummaryThreatCategoryParamsTLSVersion) IsKnown

type EmailSecuritySummaryThreatCategoryResponse

type EmailSecuritySummaryThreatCategoryResponse struct {
	Meta     EmailSecuritySummaryThreatCategoryResponseMeta     `json:"meta,required"`
	Summary0 EmailSecuritySummaryThreatCategoryResponseSummary0 `json:"summary_0,required"`
	JSON     emailSecuritySummaryThreatCategoryResponseJSON     `json:"-"`
}

func (*EmailSecuritySummaryThreatCategoryResponse) UnmarshalJSON

func (r *EmailSecuritySummaryThreatCategoryResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryThreatCategoryResponseEnvelope

type EmailSecuritySummaryThreatCategoryResponseEnvelope struct {
	Result  EmailSecuritySummaryThreatCategoryResponse             `json:"result,required"`
	Success bool                                                   `json:"success,required"`
	JSON    emailSecuritySummaryThreatCategoryResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecuritySummaryThreatCategoryResponseEnvelope) UnmarshalJSON

func (r *EmailSecuritySummaryThreatCategoryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryThreatCategoryResponseMeta

type EmailSecuritySummaryThreatCategoryResponseMeta struct {
	DateRange      []EmailSecuritySummaryThreatCategoryResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                       `json:"lastUpdated,required"`
	Normalization  string                                                       `json:"normalization,required"`
	ConfidenceInfo EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecuritySummaryThreatCategoryResponseMetaJSON           `json:"-"`
}

func (*EmailSecuritySummaryThreatCategoryResponseMeta) UnmarshalJSON

func (r *EmailSecuritySummaryThreatCategoryResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo

type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo struct {
	Annotations []EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                    `json:"level"`
	JSON        emailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo) UnmarshalJSON

type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation

type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                     `json:"dataSource,required"`
	Description     string                                                                     `json:"description,required"`
	EventType       string                                                                     `json:"eventType,required"`
	IsInstantaneous bool                                                                       `json:"isInstantaneous,required"`
	EndTime         time.Time                                                                  `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                     `json:"linkedUrl"`
	StartTime       time.Time                                                                  `json:"startTime" format:"date-time"`
	JSON            emailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecuritySummaryThreatCategoryResponseMetaDateRange

type EmailSecuritySummaryThreatCategoryResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                                   `json:"startTime,required" format:"date-time"`
	JSON      emailSecuritySummaryThreatCategoryResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecuritySummaryThreatCategoryResponseMetaDateRange) UnmarshalJSON

type EmailSecuritySummaryThreatCategoryResponseSummary0

type EmailSecuritySummaryThreatCategoryResponseSummary0 struct {
	BrandImpersonation  string                                                 `json:"BrandImpersonation,required"`
	CredentialHarvester string                                                 `json:"CredentialHarvester,required"`
	IdentityDeception   string                                                 `json:"IdentityDeception,required"`
	Link                string                                                 `json:"Link,required"`
	JSON                emailSecuritySummaryThreatCategoryResponseSummary0JSON `json:"-"`
}

func (*EmailSecuritySummaryThreatCategoryResponseSummary0) UnmarshalJSON

func (r *EmailSecuritySummaryThreatCategoryResponseSummary0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupARCParams

type EmailSecurityTimeseriesGroupARCParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupARCParamsAggInterval] `query:"aggInterval"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupARCParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupARCParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupARCParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupARCParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupARCParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupARCParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupARCParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupARCParamsAggInterval

type EmailSecurityTimeseriesGroupARCParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupARCParamsAggInterval15m EmailSecurityTimeseriesGroupARCParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupARCParamsAggInterval1h  EmailSecurityTimeseriesGroupARCParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupARCParamsAggInterval1d  EmailSecurityTimeseriesGroupARCParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupARCParamsAggInterval1w  EmailSecurityTimeseriesGroupARCParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupARCParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupARCParamsDKIM

type EmailSecurityTimeseriesGroupARCParamsDKIM string
const (
	EmailSecurityTimeseriesGroupARCParamsDKIMPass EmailSecurityTimeseriesGroupARCParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupARCParamsDKIMNone EmailSecurityTimeseriesGroupARCParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupARCParamsDKIMFail EmailSecurityTimeseriesGroupARCParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupARCParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupARCParamsDMARC

type EmailSecurityTimeseriesGroupARCParamsDMARC string
const (
	EmailSecurityTimeseriesGroupARCParamsDMARCPass EmailSecurityTimeseriesGroupARCParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupARCParamsDMARCNone EmailSecurityTimeseriesGroupARCParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupARCParamsDMARCFail EmailSecurityTimeseriesGroupARCParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupARCParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupARCParamsFormat

type EmailSecurityTimeseriesGroupARCParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupARCParamsFormatJson EmailSecurityTimeseriesGroupARCParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupARCParamsFormatCsv  EmailSecurityTimeseriesGroupARCParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupARCParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupARCParamsSPF

type EmailSecurityTimeseriesGroupARCParamsSPF string
const (
	EmailSecurityTimeseriesGroupARCParamsSPFPass EmailSecurityTimeseriesGroupARCParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupARCParamsSPFNone EmailSecurityTimeseriesGroupARCParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupARCParamsSPFFail EmailSecurityTimeseriesGroupARCParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupARCParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupARCParamsTLSVersion

type EmailSecurityTimeseriesGroupARCParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupARCParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupARCResponse

type EmailSecurityTimeseriesGroupARCResponse struct {
	Meta   interface{}                                 `json:"meta,required"`
	Serie0 RadarEmailSeries                            `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupARCResponseJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupARCResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupARCResponseEnvelope

type EmailSecurityTimeseriesGroupARCResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupARCResponse             `json:"result,required"`
	Success bool                                                `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupARCResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupDKIMParams

type EmailSecurityTimeseriesGroupDKIMParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupDKIMParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupDKIMParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupDKIMParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupDKIMParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupDKIMParamsARC

type EmailSecurityTimeseriesGroupDKIMParamsARC string
const (
	EmailSecurityTimeseriesGroupDKIMParamsARCPass EmailSecurityTimeseriesGroupDKIMParamsARC = "PASS"
	EmailSecurityTimeseriesGroupDKIMParamsARCNone EmailSecurityTimeseriesGroupDKIMParamsARC = "NONE"
	EmailSecurityTimeseriesGroupDKIMParamsARCFail EmailSecurityTimeseriesGroupDKIMParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupDKIMParamsARC) IsKnown

type EmailSecurityTimeseriesGroupDKIMParamsAggInterval

type EmailSecurityTimeseriesGroupDKIMParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupDKIMParamsAggInterval15m EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupDKIMParamsAggInterval1h  EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupDKIMParamsAggInterval1d  EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupDKIMParamsAggInterval1w  EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupDKIMParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupDKIMParamsDMARC

type EmailSecurityTimeseriesGroupDKIMParamsDMARC string
const (
	EmailSecurityTimeseriesGroupDKIMParamsDMARCPass EmailSecurityTimeseriesGroupDKIMParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupDKIMParamsDMARCNone EmailSecurityTimeseriesGroupDKIMParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupDKIMParamsDMARCFail EmailSecurityTimeseriesGroupDKIMParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupDKIMParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupDKIMParamsFormat

type EmailSecurityTimeseriesGroupDKIMParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupDKIMParamsFormatJson EmailSecurityTimeseriesGroupDKIMParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupDKIMParamsFormatCsv  EmailSecurityTimeseriesGroupDKIMParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupDKIMParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupDKIMParamsSPF

type EmailSecurityTimeseriesGroupDKIMParamsSPF string
const (
	EmailSecurityTimeseriesGroupDKIMParamsSPFPass EmailSecurityTimeseriesGroupDKIMParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupDKIMParamsSPFNone EmailSecurityTimeseriesGroupDKIMParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupDKIMParamsSPFFail EmailSecurityTimeseriesGroupDKIMParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupDKIMParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupDKIMParamsTLSVersion

type EmailSecurityTimeseriesGroupDKIMParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupDKIMParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupDKIMResponse

type EmailSecurityTimeseriesGroupDKIMResponse struct {
	Meta   interface{}                                  `json:"meta,required"`
	Serie0 RadarEmailSeries                             `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupDKIMResponseJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupDKIMResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupDKIMResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupDKIMResponseEnvelope

type EmailSecurityTimeseriesGroupDKIMResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupDKIMResponse             `json:"result,required"`
	Success bool                                                 `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupDKIMResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupDKIMResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupDKIMResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupDMARCParams

type EmailSecurityTimeseriesGroupDMARCParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupDMARCParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsDKIM] `query:"dkim"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupDMARCParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupDMARCParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupDMARCParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupDMARCParamsARC

type EmailSecurityTimeseriesGroupDMARCParamsARC string
const (
	EmailSecurityTimeseriesGroupDMARCParamsARCPass EmailSecurityTimeseriesGroupDMARCParamsARC = "PASS"
	EmailSecurityTimeseriesGroupDMARCParamsARCNone EmailSecurityTimeseriesGroupDMARCParamsARC = "NONE"
	EmailSecurityTimeseriesGroupDMARCParamsARCFail EmailSecurityTimeseriesGroupDMARCParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupDMARCParamsARC) IsKnown

type EmailSecurityTimeseriesGroupDMARCParamsAggInterval

type EmailSecurityTimeseriesGroupDMARCParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupDMARCParamsAggInterval15m EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupDMARCParamsAggInterval1h  EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupDMARCParamsAggInterval1d  EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupDMARCParamsAggInterval1w  EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupDMARCParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupDMARCParamsDKIM

type EmailSecurityTimeseriesGroupDMARCParamsDKIM string
const (
	EmailSecurityTimeseriesGroupDMARCParamsDKIMPass EmailSecurityTimeseriesGroupDMARCParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupDMARCParamsDKIMNone EmailSecurityTimeseriesGroupDMARCParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupDMARCParamsDKIMFail EmailSecurityTimeseriesGroupDMARCParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupDMARCParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupDMARCParamsFormat

type EmailSecurityTimeseriesGroupDMARCParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupDMARCParamsFormatJson EmailSecurityTimeseriesGroupDMARCParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupDMARCParamsFormatCsv  EmailSecurityTimeseriesGroupDMARCParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupDMARCParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupDMARCParamsSPF

type EmailSecurityTimeseriesGroupDMARCParamsSPF string
const (
	EmailSecurityTimeseriesGroupDMARCParamsSPFPass EmailSecurityTimeseriesGroupDMARCParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupDMARCParamsSPFNone EmailSecurityTimeseriesGroupDMARCParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupDMARCParamsSPFFail EmailSecurityTimeseriesGroupDMARCParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupDMARCParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupDMARCParamsTLSVersion

type EmailSecurityTimeseriesGroupDMARCParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupDMARCParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupDMARCParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupDMARCParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupDMARCParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupDMARCParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupDMARCParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupDMARCParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupDMARCParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupDMARCParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupDMARCResponse

type EmailSecurityTimeseriesGroupDMARCResponse struct {
	Meta   interface{}                                   `json:"meta,required"`
	Serie0 RadarEmailSeries                              `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupDMARCResponseJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupDMARCResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupDMARCResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupDMARCResponseEnvelope

type EmailSecurityTimeseriesGroupDMARCResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupDMARCResponse             `json:"result,required"`
	Success bool                                                  `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupDMARCResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupDMARCResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupDMARCResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupMaliciousParams

type EmailSecurityTimeseriesGroupMaliciousParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupMaliciousParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupMaliciousParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupMaliciousParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupMaliciousParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupMaliciousParamsARC

type EmailSecurityTimeseriesGroupMaliciousParamsARC string
const (
	EmailSecurityTimeseriesGroupMaliciousParamsARCPass EmailSecurityTimeseriesGroupMaliciousParamsARC = "PASS"
	EmailSecurityTimeseriesGroupMaliciousParamsARCNone EmailSecurityTimeseriesGroupMaliciousParamsARC = "NONE"
	EmailSecurityTimeseriesGroupMaliciousParamsARCFail EmailSecurityTimeseriesGroupMaliciousParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupMaliciousParamsARC) IsKnown

type EmailSecurityTimeseriesGroupMaliciousParamsAggInterval

type EmailSecurityTimeseriesGroupMaliciousParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupMaliciousParamsAggInterval15m EmailSecurityTimeseriesGroupMaliciousParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupMaliciousParamsAggInterval1h  EmailSecurityTimeseriesGroupMaliciousParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupMaliciousParamsAggInterval1d  EmailSecurityTimeseriesGroupMaliciousParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupMaliciousParamsAggInterval1w  EmailSecurityTimeseriesGroupMaliciousParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupMaliciousParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupMaliciousParamsDKIM

type EmailSecurityTimeseriesGroupMaliciousParamsDKIM string
const (
	EmailSecurityTimeseriesGroupMaliciousParamsDKIMPass EmailSecurityTimeseriesGroupMaliciousParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupMaliciousParamsDKIMNone EmailSecurityTimeseriesGroupMaliciousParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupMaliciousParamsDKIMFail EmailSecurityTimeseriesGroupMaliciousParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupMaliciousParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupMaliciousParamsDMARC

type EmailSecurityTimeseriesGroupMaliciousParamsDMARC string
const (
	EmailSecurityTimeseriesGroupMaliciousParamsDMARCPass EmailSecurityTimeseriesGroupMaliciousParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupMaliciousParamsDMARCNone EmailSecurityTimeseriesGroupMaliciousParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupMaliciousParamsDMARCFail EmailSecurityTimeseriesGroupMaliciousParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupMaliciousParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupMaliciousParamsFormat

type EmailSecurityTimeseriesGroupMaliciousParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupMaliciousParamsFormatJson EmailSecurityTimeseriesGroupMaliciousParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupMaliciousParamsFormatCsv  EmailSecurityTimeseriesGroupMaliciousParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupMaliciousParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupMaliciousParamsSPF

type EmailSecurityTimeseriesGroupMaliciousParamsSPF string
const (
	EmailSecurityTimeseriesGroupMaliciousParamsSPFPass EmailSecurityTimeseriesGroupMaliciousParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupMaliciousParamsSPFNone EmailSecurityTimeseriesGroupMaliciousParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupMaliciousParamsSPFFail EmailSecurityTimeseriesGroupMaliciousParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupMaliciousParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion

type EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupMaliciousParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupMaliciousParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupMaliciousParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupMaliciousParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupMaliciousResponse

type EmailSecurityTimeseriesGroupMaliciousResponse struct {
	Meta   interface{}                                         `json:"meta,required"`
	Serie0 EmailSecurityTimeseriesGroupMaliciousResponseSerie0 `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupMaliciousResponseJSON   `json:"-"`
}

func (*EmailSecurityTimeseriesGroupMaliciousResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupMaliciousResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupMaliciousResponseEnvelope

type EmailSecurityTimeseriesGroupMaliciousResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupMaliciousResponse             `json:"result,required"`
	Success bool                                                      `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupMaliciousResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupMaliciousResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupMaliciousResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupMaliciousResponseSerie0

type EmailSecurityTimeseriesGroupMaliciousResponseSerie0 struct {
	Malicious    []string                                                `json:"MALICIOUS,required"`
	NotMalicious []string                                                `json:"NOT_MALICIOUS,required"`
	JSON         emailSecurityTimeseriesGroupMaliciousResponseSerie0JSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupMaliciousResponseSerie0) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupMaliciousResponseSerie0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupSPFParams

type EmailSecurityTimeseriesGroupSPFParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupSPFParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupSPFParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupSPFParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupSPFParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupSPFParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupSPFParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupSPFParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupSPFParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupSPFParamsARC

type EmailSecurityTimeseriesGroupSPFParamsARC string
const (
	EmailSecurityTimeseriesGroupSPFParamsARCPass EmailSecurityTimeseriesGroupSPFParamsARC = "PASS"
	EmailSecurityTimeseriesGroupSPFParamsARCNone EmailSecurityTimeseriesGroupSPFParamsARC = "NONE"
	EmailSecurityTimeseriesGroupSPFParamsARCFail EmailSecurityTimeseriesGroupSPFParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupSPFParamsARC) IsKnown

type EmailSecurityTimeseriesGroupSPFParamsAggInterval

type EmailSecurityTimeseriesGroupSPFParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupSPFParamsAggInterval15m EmailSecurityTimeseriesGroupSPFParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupSPFParamsAggInterval1h  EmailSecurityTimeseriesGroupSPFParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupSPFParamsAggInterval1d  EmailSecurityTimeseriesGroupSPFParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupSPFParamsAggInterval1w  EmailSecurityTimeseriesGroupSPFParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupSPFParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupSPFParamsDKIM

type EmailSecurityTimeseriesGroupSPFParamsDKIM string
const (
	EmailSecurityTimeseriesGroupSPFParamsDKIMPass EmailSecurityTimeseriesGroupSPFParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupSPFParamsDKIMNone EmailSecurityTimeseriesGroupSPFParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupSPFParamsDKIMFail EmailSecurityTimeseriesGroupSPFParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupSPFParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupSPFParamsDMARC

type EmailSecurityTimeseriesGroupSPFParamsDMARC string
const (
	EmailSecurityTimeseriesGroupSPFParamsDMARCPass EmailSecurityTimeseriesGroupSPFParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupSPFParamsDMARCNone EmailSecurityTimeseriesGroupSPFParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupSPFParamsDMARCFail EmailSecurityTimeseriesGroupSPFParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupSPFParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupSPFParamsFormat

type EmailSecurityTimeseriesGroupSPFParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupSPFParamsFormatJson EmailSecurityTimeseriesGroupSPFParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupSPFParamsFormatCsv  EmailSecurityTimeseriesGroupSPFParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupSPFParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupSPFParamsTLSVersion

type EmailSecurityTimeseriesGroupSPFParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupSPFParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupSPFParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupSPFParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupSPFParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupSPFParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupSPFParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupSPFParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupSPFParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupSPFParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupSPFResponse

type EmailSecurityTimeseriesGroupSPFResponse struct {
	Meta   interface{}                                 `json:"meta,required"`
	Serie0 RadarEmailSeries                            `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupSPFResponseJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSPFResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSPFResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupSPFResponseEnvelope

type EmailSecurityTimeseriesGroupSPFResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupSPFResponse             `json:"result,required"`
	Success bool                                                `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupSPFResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSPFResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSPFResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupService

type EmailSecurityTimeseriesGroupService struct {
	Options []option.RequestOption
}

EmailSecurityTimeseriesGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityTimeseriesGroupService method instead.

func NewEmailSecurityTimeseriesGroupService

func NewEmailSecurityTimeseriesGroupService(opts ...option.RequestOption) (r *EmailSecurityTimeseriesGroupService)

NewEmailSecurityTimeseriesGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailSecurityTimeseriesGroupService) ARC

Percentage distribution of emails classified by ARC validation over time.

func (*EmailSecurityTimeseriesGroupService) DKIM

Percentage distribution of emails classified by DKIM validation over time.

func (*EmailSecurityTimeseriesGroupService) DMARC

Percentage distribution of emails classified by DMARC validation over time.

func (*EmailSecurityTimeseriesGroupService) Malicious

Percentage distribution of emails classified as MALICIOUS over time.

func (*EmailSecurityTimeseriesGroupService) SPF

Percentage distribution of emails classified by SPF validation over time.

func (*EmailSecurityTimeseriesGroupService) Spam

Percentage distribution of emails classified as SPAM over time.

func (*EmailSecurityTimeseriesGroupService) Spoof

Percentage distribution of emails classified as SPOOF over time.

func (*EmailSecurityTimeseriesGroupService) TLSVersion

Percentage distribution of emails classified by TLS version over time.

func (*EmailSecurityTimeseriesGroupService) ThreatCategory

Percentage distribution of emails classified by threat category over time.

type EmailSecurityTimeseriesGroupSpamParams

type EmailSecurityTimeseriesGroupSpamParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupSpamParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupSpamParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupSpamParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupSpamParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupSpamParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupSpamParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupSpamParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupSpamParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupSpamParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupSpamParamsARC

type EmailSecurityTimeseriesGroupSpamParamsARC string
const (
	EmailSecurityTimeseriesGroupSpamParamsARCPass EmailSecurityTimeseriesGroupSpamParamsARC = "PASS"
	EmailSecurityTimeseriesGroupSpamParamsARCNone EmailSecurityTimeseriesGroupSpamParamsARC = "NONE"
	EmailSecurityTimeseriesGroupSpamParamsARCFail EmailSecurityTimeseriesGroupSpamParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpamParamsARC) IsKnown

type EmailSecurityTimeseriesGroupSpamParamsAggInterval

type EmailSecurityTimeseriesGroupSpamParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupSpamParamsAggInterval15m EmailSecurityTimeseriesGroupSpamParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupSpamParamsAggInterval1h  EmailSecurityTimeseriesGroupSpamParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupSpamParamsAggInterval1d  EmailSecurityTimeseriesGroupSpamParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupSpamParamsAggInterval1w  EmailSecurityTimeseriesGroupSpamParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupSpamParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupSpamParamsDKIM

type EmailSecurityTimeseriesGroupSpamParamsDKIM string
const (
	EmailSecurityTimeseriesGroupSpamParamsDKIMPass EmailSecurityTimeseriesGroupSpamParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupSpamParamsDKIMNone EmailSecurityTimeseriesGroupSpamParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupSpamParamsDKIMFail EmailSecurityTimeseriesGroupSpamParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpamParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupSpamParamsDMARC

type EmailSecurityTimeseriesGroupSpamParamsDMARC string
const (
	EmailSecurityTimeseriesGroupSpamParamsDMARCPass EmailSecurityTimeseriesGroupSpamParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupSpamParamsDMARCNone EmailSecurityTimeseriesGroupSpamParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupSpamParamsDMARCFail EmailSecurityTimeseriesGroupSpamParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpamParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupSpamParamsFormat

type EmailSecurityTimeseriesGroupSpamParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupSpamParamsFormatJson EmailSecurityTimeseriesGroupSpamParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupSpamParamsFormatCsv  EmailSecurityTimeseriesGroupSpamParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupSpamParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupSpamParamsSPF

type EmailSecurityTimeseriesGroupSpamParamsSPF string
const (
	EmailSecurityTimeseriesGroupSpamParamsSPFPass EmailSecurityTimeseriesGroupSpamParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupSpamParamsSPFNone EmailSecurityTimeseriesGroupSpamParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupSpamParamsSPFFail EmailSecurityTimeseriesGroupSpamParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpamParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupSpamParamsTLSVersion

type EmailSecurityTimeseriesGroupSpamParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupSpamParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupSpamParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupSpamParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupSpamParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupSpamParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupSpamParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupSpamParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupSpamParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupSpamParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupSpamResponse

type EmailSecurityTimeseriesGroupSpamResponse struct {
	Meta   interface{}                                    `json:"meta,required"`
	Serie0 EmailSecurityTimeseriesGroupSpamResponseSerie0 `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupSpamResponseJSON   `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSpamResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSpamResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupSpamResponseEnvelope

type EmailSecurityTimeseriesGroupSpamResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupSpamResponse             `json:"result,required"`
	Success bool                                                 `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupSpamResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSpamResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSpamResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupSpamResponseSerie0

type EmailSecurityTimeseriesGroupSpamResponseSerie0 struct {
	NotSpam []string                                           `json:"NOT_SPAM,required"`
	Spam    []string                                           `json:"SPAM,required"`
	JSON    emailSecurityTimeseriesGroupSpamResponseSerie0JSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSpamResponseSerie0) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSpamResponseSerie0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupSpoofParams

type EmailSecurityTimeseriesGroupSpoofParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupSpoofParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupSpoofParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupSpoofParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupSpoofParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupSpoofParamsARC

type EmailSecurityTimeseriesGroupSpoofParamsARC string
const (
	EmailSecurityTimeseriesGroupSpoofParamsARCPass EmailSecurityTimeseriesGroupSpoofParamsARC = "PASS"
	EmailSecurityTimeseriesGroupSpoofParamsARCNone EmailSecurityTimeseriesGroupSpoofParamsARC = "NONE"
	EmailSecurityTimeseriesGroupSpoofParamsARCFail EmailSecurityTimeseriesGroupSpoofParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpoofParamsARC) IsKnown

type EmailSecurityTimeseriesGroupSpoofParamsAggInterval

type EmailSecurityTimeseriesGroupSpoofParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupSpoofParamsAggInterval15m EmailSecurityTimeseriesGroupSpoofParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupSpoofParamsAggInterval1h  EmailSecurityTimeseriesGroupSpoofParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupSpoofParamsAggInterval1d  EmailSecurityTimeseriesGroupSpoofParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupSpoofParamsAggInterval1w  EmailSecurityTimeseriesGroupSpoofParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupSpoofParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupSpoofParamsDKIM

type EmailSecurityTimeseriesGroupSpoofParamsDKIM string
const (
	EmailSecurityTimeseriesGroupSpoofParamsDKIMPass EmailSecurityTimeseriesGroupSpoofParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupSpoofParamsDKIMNone EmailSecurityTimeseriesGroupSpoofParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupSpoofParamsDKIMFail EmailSecurityTimeseriesGroupSpoofParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpoofParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupSpoofParamsDMARC

type EmailSecurityTimeseriesGroupSpoofParamsDMARC string
const (
	EmailSecurityTimeseriesGroupSpoofParamsDMARCPass EmailSecurityTimeseriesGroupSpoofParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupSpoofParamsDMARCNone EmailSecurityTimeseriesGroupSpoofParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupSpoofParamsDMARCFail EmailSecurityTimeseriesGroupSpoofParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpoofParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupSpoofParamsFormat

type EmailSecurityTimeseriesGroupSpoofParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupSpoofParamsFormatJson EmailSecurityTimeseriesGroupSpoofParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupSpoofParamsFormatCsv  EmailSecurityTimeseriesGroupSpoofParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupSpoofParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupSpoofParamsSPF

type EmailSecurityTimeseriesGroupSpoofParamsSPF string
const (
	EmailSecurityTimeseriesGroupSpoofParamsSPFPass EmailSecurityTimeseriesGroupSpoofParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupSpoofParamsSPFNone EmailSecurityTimeseriesGroupSpoofParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupSpoofParamsSPFFail EmailSecurityTimeseriesGroupSpoofParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupSpoofParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupSpoofParamsTLSVersion

type EmailSecurityTimeseriesGroupSpoofParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupSpoofParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupSpoofParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupSpoofParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupSpoofParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupSpoofParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupSpoofParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupSpoofParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupSpoofParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupSpoofParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupSpoofResponse

type EmailSecurityTimeseriesGroupSpoofResponse struct {
	Meta   interface{}                                     `json:"meta,required"`
	Serie0 EmailSecurityTimeseriesGroupSpoofResponseSerie0 `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupSpoofResponseJSON   `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSpoofResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSpoofResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupSpoofResponseEnvelope

type EmailSecurityTimeseriesGroupSpoofResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupSpoofResponse             `json:"result,required"`
	Success bool                                                  `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupSpoofResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSpoofResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSpoofResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupSpoofResponseSerie0

type EmailSecurityTimeseriesGroupSpoofResponseSerie0 struct {
	NotSpoof []string                                            `json:"NOT_SPOOF,required"`
	Spoof    []string                                            `json:"SPOOF,required"`
	JSON     emailSecurityTimeseriesGroupSpoofResponseSerie0JSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupSpoofResponseSerie0) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupSpoofResponseSerie0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupTLSVersionParams

type EmailSecurityTimeseriesGroupTLSVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupTLSVersionParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsSPF] `query:"spf"`
}

func (EmailSecurityTimeseriesGroupTLSVersionParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupTLSVersionParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupTLSVersionParamsARC

type EmailSecurityTimeseriesGroupTLSVersionParamsARC string
const (
	EmailSecurityTimeseriesGroupTLSVersionParamsARCPass EmailSecurityTimeseriesGroupTLSVersionParamsARC = "PASS"
	EmailSecurityTimeseriesGroupTLSVersionParamsARCNone EmailSecurityTimeseriesGroupTLSVersionParamsARC = "NONE"
	EmailSecurityTimeseriesGroupTLSVersionParamsARCFail EmailSecurityTimeseriesGroupTLSVersionParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupTLSVersionParamsARC) IsKnown

type EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval

type EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval15m EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval1h  EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval1d  EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval1w  EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupTLSVersionParamsDKIM

type EmailSecurityTimeseriesGroupTLSVersionParamsDKIM string
const (
	EmailSecurityTimeseriesGroupTLSVersionParamsDKIMPass EmailSecurityTimeseriesGroupTLSVersionParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupTLSVersionParamsDKIMNone EmailSecurityTimeseriesGroupTLSVersionParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupTLSVersionParamsDKIMFail EmailSecurityTimeseriesGroupTLSVersionParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupTLSVersionParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupTLSVersionParamsDMARC

type EmailSecurityTimeseriesGroupTLSVersionParamsDMARC string
const (
	EmailSecurityTimeseriesGroupTLSVersionParamsDMARCPass EmailSecurityTimeseriesGroupTLSVersionParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupTLSVersionParamsDMARCNone EmailSecurityTimeseriesGroupTLSVersionParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupTLSVersionParamsDMARCFail EmailSecurityTimeseriesGroupTLSVersionParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupTLSVersionParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupTLSVersionParamsFormat

type EmailSecurityTimeseriesGroupTLSVersionParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupTLSVersionParamsFormatJson EmailSecurityTimeseriesGroupTLSVersionParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupTLSVersionParamsFormatCsv  EmailSecurityTimeseriesGroupTLSVersionParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupTLSVersionParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupTLSVersionParamsSPF

type EmailSecurityTimeseriesGroupTLSVersionParamsSPF string
const (
	EmailSecurityTimeseriesGroupTLSVersionParamsSPFPass EmailSecurityTimeseriesGroupTLSVersionParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupTLSVersionParamsSPFNone EmailSecurityTimeseriesGroupTLSVersionParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupTLSVersionParamsSPFFail EmailSecurityTimeseriesGroupTLSVersionParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupTLSVersionParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupTLSVersionResponse

type EmailSecurityTimeseriesGroupTLSVersionResponse struct {
	Meta   interface{}                                          `json:"meta,required"`
	Serie0 EmailSecurityTimeseriesGroupTLSVersionResponseSerie0 `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupTLSVersionResponseJSON   `json:"-"`
}

func (*EmailSecurityTimeseriesGroupTLSVersionResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupTLSVersionResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupTLSVersionResponseEnvelope

type EmailSecurityTimeseriesGroupTLSVersionResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupTLSVersionResponse             `json:"result,required"`
	Success bool                                                       `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupTLSVersionResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupTLSVersionResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupTLSVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupTLSVersionResponseSerie0

type EmailSecurityTimeseriesGroupTLSVersionResponseSerie0 struct {
	TLS1_0 []string                                                 `json:"TLS 1.0,required"`
	TLS1_1 []string                                                 `json:"TLS 1.1,required"`
	TLS1_2 []string                                                 `json:"TLS 1.2,required"`
	TLS1_3 []string                                                 `json:"TLS 1.3,required"`
	JSON   emailSecurityTimeseriesGroupTLSVersionResponseSerie0JSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupTLSVersionResponseSerie0) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupTLSVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupThreatCategoryParams

type EmailSecurityTimeseriesGroupThreatCategoryParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval] `query:"aggInterval"`
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTimeseriesGroupThreatCategoryParamsFormat] `query:"format"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsSPF] `query:"spf"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTimeseriesGroupThreatCategoryParams) URLQuery

URLQuery serializes EmailSecurityTimeseriesGroupThreatCategoryParams's query parameters as `url.Values`.

type EmailSecurityTimeseriesGroupThreatCategoryParamsARC

type EmailSecurityTimeseriesGroupThreatCategoryParamsARC string
const (
	EmailSecurityTimeseriesGroupThreatCategoryParamsARCPass EmailSecurityTimeseriesGroupThreatCategoryParamsARC = "PASS"
	EmailSecurityTimeseriesGroupThreatCategoryParamsARCNone EmailSecurityTimeseriesGroupThreatCategoryParamsARC = "NONE"
	EmailSecurityTimeseriesGroupThreatCategoryParamsARCFail EmailSecurityTimeseriesGroupThreatCategoryParamsARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupThreatCategoryParamsARC) IsKnown

type EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval

type EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval15m EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval = "15m"
	EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval1h  EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval = "1h"
	EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval1d  EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval = "1d"
	EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval1w  EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval = "1w"
)

func (EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval) IsKnown

type EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM

type EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM string
const (
	EmailSecurityTimeseriesGroupThreatCategoryParamsDKIMPass EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM = "PASS"
	EmailSecurityTimeseriesGroupThreatCategoryParamsDKIMNone EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM = "NONE"
	EmailSecurityTimeseriesGroupThreatCategoryParamsDKIMFail EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM = "FAIL"
)

func (EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM) IsKnown

type EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC

type EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC string
const (
	EmailSecurityTimeseriesGroupThreatCategoryParamsDMARCPass EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC = "PASS"
	EmailSecurityTimeseriesGroupThreatCategoryParamsDMARCNone EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC = "NONE"
	EmailSecurityTimeseriesGroupThreatCategoryParamsDMARCFail EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC = "FAIL"
)

func (EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC) IsKnown

type EmailSecurityTimeseriesGroupThreatCategoryParamsFormat

type EmailSecurityTimeseriesGroupThreatCategoryParamsFormat string

Format results are returned in.

const (
	EmailSecurityTimeseriesGroupThreatCategoryParamsFormatJson EmailSecurityTimeseriesGroupThreatCategoryParamsFormat = "JSON"
	EmailSecurityTimeseriesGroupThreatCategoryParamsFormatCsv  EmailSecurityTimeseriesGroupThreatCategoryParamsFormat = "CSV"
)

func (EmailSecurityTimeseriesGroupThreatCategoryParamsFormat) IsKnown

type EmailSecurityTimeseriesGroupThreatCategoryParamsSPF

type EmailSecurityTimeseriesGroupThreatCategoryParamsSPF string
const (
	EmailSecurityTimeseriesGroupThreatCategoryParamsSPFPass EmailSecurityTimeseriesGroupThreatCategoryParamsSPF = "PASS"
	EmailSecurityTimeseriesGroupThreatCategoryParamsSPFNone EmailSecurityTimeseriesGroupThreatCategoryParamsSPF = "NONE"
	EmailSecurityTimeseriesGroupThreatCategoryParamsSPFFail EmailSecurityTimeseriesGroupThreatCategoryParamsSPF = "FAIL"
)

func (EmailSecurityTimeseriesGroupThreatCategoryParamsSPF) IsKnown

type EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion

type EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion string
const (
	EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion = "TLSv1_0"
	EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion = "TLSv1_1"
	EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion = "TLSv1_2"
	EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion) IsKnown

type EmailSecurityTimeseriesGroupThreatCategoryResponse

type EmailSecurityTimeseriesGroupThreatCategoryResponse struct {
	Meta   interface{}                                              `json:"meta,required"`
	Serie0 EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0 `json:"serie_0,required"`
	JSON   emailSecurityTimeseriesGroupThreatCategoryResponseJSON   `json:"-"`
}

func (*EmailSecurityTimeseriesGroupThreatCategoryResponse) UnmarshalJSON

func (r *EmailSecurityTimeseriesGroupThreatCategoryResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTimeseriesGroupThreatCategoryResponseEnvelope

type EmailSecurityTimeseriesGroupThreatCategoryResponseEnvelope struct {
	Result  EmailSecurityTimeseriesGroupThreatCategoryResponse             `json:"result,required"`
	Success bool                                                           `json:"success,required"`
	JSON    emailSecurityTimeseriesGroupThreatCategoryResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupThreatCategoryResponseEnvelope) UnmarshalJSON

type EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0

type EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0 struct {
	BrandImpersonation  []string                                                     `json:"BrandImpersonation,required"`
	CredentialHarvester []string                                                     `json:"CredentialHarvester,required"`
	IdentityDeception   []string                                                     `json:"IdentityDeception,required"`
	Link                []string                                                     `json:"Link,required"`
	JSON                emailSecurityTimeseriesGroupThreatCategoryResponseSerie0JSON `json:"-"`
}

func (*EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0) UnmarshalJSON

type EmailSecurityTopService

type EmailSecurityTopService struct {
	Options []option.RequestOption
	Tlds    *EmailSecurityTopTldService
}

EmailSecurityTopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityTopService method instead.

func NewEmailSecurityTopService

func NewEmailSecurityTopService(opts ...option.RequestOption) (r *EmailSecurityTopService)

NewEmailSecurityTopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type EmailSecurityTopTldGetParams

type EmailSecurityTopTldGetParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTopTldGetParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTopTldGetParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTopTldGetParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTopTldGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTopTldGetParamsSPF] `query:"spf"`
	// Filter for TLDs by category.
	TldCategory param.Field[EmailSecurityTopTldGetParamsTldCategory] `query:"tldCategory"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTopTldGetParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTopTldGetParams) URLQuery

func (r EmailSecurityTopTldGetParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecurityTopTldGetParams's query parameters as `url.Values`.

type EmailSecurityTopTldGetParamsARC

type EmailSecurityTopTldGetParamsARC string
const (
	EmailSecurityTopTldGetParamsARCPass EmailSecurityTopTldGetParamsARC = "PASS"
	EmailSecurityTopTldGetParamsARCNone EmailSecurityTopTldGetParamsARC = "NONE"
	EmailSecurityTopTldGetParamsARCFail EmailSecurityTopTldGetParamsARC = "FAIL"
)

func (EmailSecurityTopTldGetParamsARC) IsKnown

type EmailSecurityTopTldGetParamsDKIM

type EmailSecurityTopTldGetParamsDKIM string
const (
	EmailSecurityTopTldGetParamsDKIMPass EmailSecurityTopTldGetParamsDKIM = "PASS"
	EmailSecurityTopTldGetParamsDKIMNone EmailSecurityTopTldGetParamsDKIM = "NONE"
	EmailSecurityTopTldGetParamsDKIMFail EmailSecurityTopTldGetParamsDKIM = "FAIL"
)

func (EmailSecurityTopTldGetParamsDKIM) IsKnown

type EmailSecurityTopTldGetParamsDMARC

type EmailSecurityTopTldGetParamsDMARC string
const (
	EmailSecurityTopTldGetParamsDMARCPass EmailSecurityTopTldGetParamsDMARC = "PASS"
	EmailSecurityTopTldGetParamsDMARCNone EmailSecurityTopTldGetParamsDMARC = "NONE"
	EmailSecurityTopTldGetParamsDMARCFail EmailSecurityTopTldGetParamsDMARC = "FAIL"
)

func (EmailSecurityTopTldGetParamsDMARC) IsKnown

type EmailSecurityTopTldGetParamsFormat

type EmailSecurityTopTldGetParamsFormat string

Format results are returned in.

const (
	EmailSecurityTopTldGetParamsFormatJson EmailSecurityTopTldGetParamsFormat = "JSON"
	EmailSecurityTopTldGetParamsFormatCsv  EmailSecurityTopTldGetParamsFormat = "CSV"
)

func (EmailSecurityTopTldGetParamsFormat) IsKnown

type EmailSecurityTopTldGetParamsSPF

type EmailSecurityTopTldGetParamsSPF string
const (
	EmailSecurityTopTldGetParamsSPFPass EmailSecurityTopTldGetParamsSPF = "PASS"
	EmailSecurityTopTldGetParamsSPFNone EmailSecurityTopTldGetParamsSPF = "NONE"
	EmailSecurityTopTldGetParamsSPFFail EmailSecurityTopTldGetParamsSPF = "FAIL"
)

func (EmailSecurityTopTldGetParamsSPF) IsKnown

type EmailSecurityTopTldGetParamsTLSVersion

type EmailSecurityTopTldGetParamsTLSVersion string
const (
	EmailSecurityTopTldGetParamsTLSVersionTlSv1_0 EmailSecurityTopTldGetParamsTLSVersion = "TLSv1_0"
	EmailSecurityTopTldGetParamsTLSVersionTlSv1_1 EmailSecurityTopTldGetParamsTLSVersion = "TLSv1_1"
	EmailSecurityTopTldGetParamsTLSVersionTlSv1_2 EmailSecurityTopTldGetParamsTLSVersion = "TLSv1_2"
	EmailSecurityTopTldGetParamsTLSVersionTlSv1_3 EmailSecurityTopTldGetParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTopTldGetParamsTLSVersion) IsKnown

type EmailSecurityTopTldGetParamsTldCategory

type EmailSecurityTopTldGetParamsTldCategory string

Filter for TLDs by category.

const (
	EmailSecurityTopTldGetParamsTldCategoryClassic EmailSecurityTopTldGetParamsTldCategory = "CLASSIC"
	EmailSecurityTopTldGetParamsTldCategoryCountry EmailSecurityTopTldGetParamsTldCategory = "COUNTRY"
)

func (EmailSecurityTopTldGetParamsTldCategory) IsKnown

type EmailSecurityTopTldGetResponse

type EmailSecurityTopTldGetResponse struct {
	Meta EmailSecurityTopTldGetResponseMeta   `json:"meta,required"`
	Top0 []EmailSecurityTopTldGetResponseTop0 `json:"top_0,required"`
	JSON emailSecurityTopTldGetResponseJSON   `json:"-"`
}

func (*EmailSecurityTopTldGetResponse) UnmarshalJSON

func (r *EmailSecurityTopTldGetResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldGetResponseEnvelope

type EmailSecurityTopTldGetResponseEnvelope struct {
	Result  EmailSecurityTopTldGetResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    emailSecurityTopTldGetResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTopTldGetResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTopTldGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldGetResponseMeta

type EmailSecurityTopTldGetResponseMeta struct {
	DateRange      []EmailSecurityTopTldGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	ConfidenceInfo EmailSecurityTopTldGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecurityTopTldGetResponseMetaJSON           `json:"-"`
}

func (*EmailSecurityTopTldGetResponseMeta) UnmarshalJSON

func (r *EmailSecurityTopTldGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldGetResponseMetaConfidenceInfo

type EmailSecurityTopTldGetResponseMetaConfidenceInfo struct {
	Annotations []EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        emailSecurityTopTldGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecurityTopTldGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecurityTopTldGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation

type EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            emailSecurityTopTldGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecurityTopTldGetResponseMetaDateRange

type EmailSecurityTopTldGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      emailSecurityTopTldGetResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecurityTopTldGetResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecurityTopTldGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldGetResponseTop0

type EmailSecurityTopTldGetResponseTop0 struct {
	Name  string                                 `json:"name,required"`
	Value string                                 `json:"value,required"`
	JSON  emailSecurityTopTldGetResponseTop0JSON `json:"-"`
}

func (*EmailSecurityTopTldGetResponseTop0) UnmarshalJSON

func (r *EmailSecurityTopTldGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldMaliciousGetParams

type EmailSecurityTopTldMaliciousGetParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTopTldMaliciousGetParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTopTldMaliciousGetParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTopTldMaliciousGetParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTopTldMaliciousGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTopTldMaliciousGetParamsSPF] `query:"spf"`
	// Filter for TLDs by category.
	TldCategory param.Field[EmailSecurityTopTldMaliciousGetParamsTldCategory] `query:"tldCategory"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTopTldMaliciousGetParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTopTldMaliciousGetParams) URLQuery

URLQuery serializes EmailSecurityTopTldMaliciousGetParams's query parameters as `url.Values`.

type EmailSecurityTopTldMaliciousGetParamsARC

type EmailSecurityTopTldMaliciousGetParamsARC string
const (
	EmailSecurityTopTldMaliciousGetParamsARCPass EmailSecurityTopTldMaliciousGetParamsARC = "PASS"
	EmailSecurityTopTldMaliciousGetParamsARCNone EmailSecurityTopTldMaliciousGetParamsARC = "NONE"
	EmailSecurityTopTldMaliciousGetParamsARCFail EmailSecurityTopTldMaliciousGetParamsARC = "FAIL"
)

func (EmailSecurityTopTldMaliciousGetParamsARC) IsKnown

type EmailSecurityTopTldMaliciousGetParamsDKIM

type EmailSecurityTopTldMaliciousGetParamsDKIM string
const (
	EmailSecurityTopTldMaliciousGetParamsDKIMPass EmailSecurityTopTldMaliciousGetParamsDKIM = "PASS"
	EmailSecurityTopTldMaliciousGetParamsDKIMNone EmailSecurityTopTldMaliciousGetParamsDKIM = "NONE"
	EmailSecurityTopTldMaliciousGetParamsDKIMFail EmailSecurityTopTldMaliciousGetParamsDKIM = "FAIL"
)

func (EmailSecurityTopTldMaliciousGetParamsDKIM) IsKnown

type EmailSecurityTopTldMaliciousGetParamsDMARC

type EmailSecurityTopTldMaliciousGetParamsDMARC string
const (
	EmailSecurityTopTldMaliciousGetParamsDMARCPass EmailSecurityTopTldMaliciousGetParamsDMARC = "PASS"
	EmailSecurityTopTldMaliciousGetParamsDMARCNone EmailSecurityTopTldMaliciousGetParamsDMARC = "NONE"
	EmailSecurityTopTldMaliciousGetParamsDMARCFail EmailSecurityTopTldMaliciousGetParamsDMARC = "FAIL"
)

func (EmailSecurityTopTldMaliciousGetParamsDMARC) IsKnown

type EmailSecurityTopTldMaliciousGetParamsFormat

type EmailSecurityTopTldMaliciousGetParamsFormat string

Format results are returned in.

const (
	EmailSecurityTopTldMaliciousGetParamsFormatJson EmailSecurityTopTldMaliciousGetParamsFormat = "JSON"
	EmailSecurityTopTldMaliciousGetParamsFormatCsv  EmailSecurityTopTldMaliciousGetParamsFormat = "CSV"
)

func (EmailSecurityTopTldMaliciousGetParamsFormat) IsKnown

type EmailSecurityTopTldMaliciousGetParamsMalicious

type EmailSecurityTopTldMaliciousGetParamsMalicious string

Malicious.

const (
	EmailSecurityTopTldMaliciousGetParamsMaliciousMalicious    EmailSecurityTopTldMaliciousGetParamsMalicious = "MALICIOUS"
	EmailSecurityTopTldMaliciousGetParamsMaliciousNotMalicious EmailSecurityTopTldMaliciousGetParamsMalicious = "NOT_MALICIOUS"
)

func (EmailSecurityTopTldMaliciousGetParamsMalicious) IsKnown

type EmailSecurityTopTldMaliciousGetParamsSPF

type EmailSecurityTopTldMaliciousGetParamsSPF string
const (
	EmailSecurityTopTldMaliciousGetParamsSPFPass EmailSecurityTopTldMaliciousGetParamsSPF = "PASS"
	EmailSecurityTopTldMaliciousGetParamsSPFNone EmailSecurityTopTldMaliciousGetParamsSPF = "NONE"
	EmailSecurityTopTldMaliciousGetParamsSPFFail EmailSecurityTopTldMaliciousGetParamsSPF = "FAIL"
)

func (EmailSecurityTopTldMaliciousGetParamsSPF) IsKnown

type EmailSecurityTopTldMaliciousGetParamsTLSVersion

type EmailSecurityTopTldMaliciousGetParamsTLSVersion string
const (
	EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_0 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_0"
	EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_1 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_1"
	EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_2 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_2"
	EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_3 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTopTldMaliciousGetParamsTLSVersion) IsKnown

type EmailSecurityTopTldMaliciousGetParamsTldCategory

type EmailSecurityTopTldMaliciousGetParamsTldCategory string

Filter for TLDs by category.

const (
	EmailSecurityTopTldMaliciousGetParamsTldCategoryClassic EmailSecurityTopTldMaliciousGetParamsTldCategory = "CLASSIC"
	EmailSecurityTopTldMaliciousGetParamsTldCategoryCountry EmailSecurityTopTldMaliciousGetParamsTldCategory = "COUNTRY"
)

func (EmailSecurityTopTldMaliciousGetParamsTldCategory) IsKnown

type EmailSecurityTopTldMaliciousGetResponse

type EmailSecurityTopTldMaliciousGetResponse struct {
	Meta EmailSecurityTopTldMaliciousGetResponseMeta   `json:"meta,required"`
	Top0 []EmailSecurityTopTldMaliciousGetResponseTop0 `json:"top_0,required"`
	JSON emailSecurityTopTldMaliciousGetResponseJSON   `json:"-"`
}

func (*EmailSecurityTopTldMaliciousGetResponse) UnmarshalJSON

func (r *EmailSecurityTopTldMaliciousGetResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldMaliciousGetResponseEnvelope

type EmailSecurityTopTldMaliciousGetResponseEnvelope struct {
	Result  EmailSecurityTopTldMaliciousGetResponse             `json:"result,required"`
	Success bool                                                `json:"success,required"`
	JSON    emailSecurityTopTldMaliciousGetResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTopTldMaliciousGetResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTopTldMaliciousGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldMaliciousGetResponseMeta

type EmailSecurityTopTldMaliciousGetResponseMeta struct {
	DateRange      []EmailSecurityTopTldMaliciousGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                    `json:"lastUpdated,required"`
	ConfidenceInfo EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecurityTopTldMaliciousGetResponseMetaJSON           `json:"-"`
}

func (*EmailSecurityTopTldMaliciousGetResponseMeta) UnmarshalJSON

func (r *EmailSecurityTopTldMaliciousGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo

type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo struct {
	Annotations []EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                 `json:"level"`
	JSON        emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo) UnmarshalJSON

type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation

type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                  `json:"dataSource,required"`
	Description     string                                                                  `json:"description,required"`
	EventType       string                                                                  `json:"eventType,required"`
	IsInstantaneous bool                                                                    `json:"isInstantaneous,required"`
	EndTime         time.Time                                                               `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                  `json:"linkedUrl"`
	StartTime       time.Time                                                               `json:"startTime" format:"date-time"`
	JSON            emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecurityTopTldMaliciousGetResponseMetaDateRange

type EmailSecurityTopTldMaliciousGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                                `json:"startTime,required" format:"date-time"`
	JSON      emailSecurityTopTldMaliciousGetResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecurityTopTldMaliciousGetResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecurityTopTldMaliciousGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldMaliciousGetResponseTop0

type EmailSecurityTopTldMaliciousGetResponseTop0 struct {
	Name  string                                          `json:"name,required"`
	Value string                                          `json:"value,required"`
	JSON  emailSecurityTopTldMaliciousGetResponseTop0JSON `json:"-"`
}

func (*EmailSecurityTopTldMaliciousGetResponseTop0) UnmarshalJSON

func (r *EmailSecurityTopTldMaliciousGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldMaliciousService

type EmailSecurityTopTldMaliciousService struct {
	Options []option.RequestOption
}

EmailSecurityTopTldMaliciousService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityTopTldMaliciousService method instead.

func NewEmailSecurityTopTldMaliciousService

func NewEmailSecurityTopTldMaliciousService(opts ...option.RequestOption) (r *EmailSecurityTopTldMaliciousService)

NewEmailSecurityTopTldMaliciousService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailSecurityTopTldMaliciousService) Get

Get the TLDs by emails classified as malicious or not.

type EmailSecurityTopTldService

type EmailSecurityTopTldService struct {
	Options   []option.RequestOption
	Malicious *EmailSecurityTopTldMaliciousService
	Spam      *EmailSecurityTopTldSpamService
	Spoof     *EmailSecurityTopTldSpoofService
}

EmailSecurityTopTldService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityTopTldService method instead.

func NewEmailSecurityTopTldService

func NewEmailSecurityTopTldService(opts ...option.RequestOption) (r *EmailSecurityTopTldService)

NewEmailSecurityTopTldService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailSecurityTopTldService) Get

Get the top TLDs by email messages. Values are a percentage out of total email volume.

type EmailSecurityTopTldSpamGetParams

type EmailSecurityTopTldSpamGetParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTopTldSpamGetParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTopTldSpamGetParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTopTldSpamGetParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTopTldSpamGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTopTldSpamGetParamsSPF] `query:"spf"`
	// Filter for TLDs by category.
	TldCategory param.Field[EmailSecurityTopTldSpamGetParamsTldCategory] `query:"tldCategory"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTopTldSpamGetParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTopTldSpamGetParams) URLQuery

func (r EmailSecurityTopTldSpamGetParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecurityTopTldSpamGetParams's query parameters as `url.Values`.

type EmailSecurityTopTldSpamGetParamsARC

type EmailSecurityTopTldSpamGetParamsARC string
const (
	EmailSecurityTopTldSpamGetParamsARCPass EmailSecurityTopTldSpamGetParamsARC = "PASS"
	EmailSecurityTopTldSpamGetParamsARCNone EmailSecurityTopTldSpamGetParamsARC = "NONE"
	EmailSecurityTopTldSpamGetParamsARCFail EmailSecurityTopTldSpamGetParamsARC = "FAIL"
)

func (EmailSecurityTopTldSpamGetParamsARC) IsKnown

type EmailSecurityTopTldSpamGetParamsDKIM

type EmailSecurityTopTldSpamGetParamsDKIM string
const (
	EmailSecurityTopTldSpamGetParamsDKIMPass EmailSecurityTopTldSpamGetParamsDKIM = "PASS"
	EmailSecurityTopTldSpamGetParamsDKIMNone EmailSecurityTopTldSpamGetParamsDKIM = "NONE"
	EmailSecurityTopTldSpamGetParamsDKIMFail EmailSecurityTopTldSpamGetParamsDKIM = "FAIL"
)

func (EmailSecurityTopTldSpamGetParamsDKIM) IsKnown

type EmailSecurityTopTldSpamGetParamsDMARC

type EmailSecurityTopTldSpamGetParamsDMARC string
const (
	EmailSecurityTopTldSpamGetParamsDMARCPass EmailSecurityTopTldSpamGetParamsDMARC = "PASS"
	EmailSecurityTopTldSpamGetParamsDMARCNone EmailSecurityTopTldSpamGetParamsDMARC = "NONE"
	EmailSecurityTopTldSpamGetParamsDMARCFail EmailSecurityTopTldSpamGetParamsDMARC = "FAIL"
)

func (EmailSecurityTopTldSpamGetParamsDMARC) IsKnown

type EmailSecurityTopTldSpamGetParamsFormat

type EmailSecurityTopTldSpamGetParamsFormat string

Format results are returned in.

const (
	EmailSecurityTopTldSpamGetParamsFormatJson EmailSecurityTopTldSpamGetParamsFormat = "JSON"
	EmailSecurityTopTldSpamGetParamsFormatCsv  EmailSecurityTopTldSpamGetParamsFormat = "CSV"
)

func (EmailSecurityTopTldSpamGetParamsFormat) IsKnown

type EmailSecurityTopTldSpamGetParamsSPF

type EmailSecurityTopTldSpamGetParamsSPF string
const (
	EmailSecurityTopTldSpamGetParamsSPFPass EmailSecurityTopTldSpamGetParamsSPF = "PASS"
	EmailSecurityTopTldSpamGetParamsSPFNone EmailSecurityTopTldSpamGetParamsSPF = "NONE"
	EmailSecurityTopTldSpamGetParamsSPFFail EmailSecurityTopTldSpamGetParamsSPF = "FAIL"
)

func (EmailSecurityTopTldSpamGetParamsSPF) IsKnown

type EmailSecurityTopTldSpamGetParamsSpam

type EmailSecurityTopTldSpamGetParamsSpam string

Spam.

const (
	EmailSecurityTopTldSpamGetParamsSpamSpam    EmailSecurityTopTldSpamGetParamsSpam = "SPAM"
	EmailSecurityTopTldSpamGetParamsSpamNotSpam EmailSecurityTopTldSpamGetParamsSpam = "NOT_SPAM"
)

func (EmailSecurityTopTldSpamGetParamsSpam) IsKnown

type EmailSecurityTopTldSpamGetParamsTLSVersion

type EmailSecurityTopTldSpamGetParamsTLSVersion string
const (
	EmailSecurityTopTldSpamGetParamsTLSVersionTlSv1_0 EmailSecurityTopTldSpamGetParamsTLSVersion = "TLSv1_0"
	EmailSecurityTopTldSpamGetParamsTLSVersionTlSv1_1 EmailSecurityTopTldSpamGetParamsTLSVersion = "TLSv1_1"
	EmailSecurityTopTldSpamGetParamsTLSVersionTlSv1_2 EmailSecurityTopTldSpamGetParamsTLSVersion = "TLSv1_2"
	EmailSecurityTopTldSpamGetParamsTLSVersionTlSv1_3 EmailSecurityTopTldSpamGetParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTopTldSpamGetParamsTLSVersion) IsKnown

type EmailSecurityTopTldSpamGetParamsTldCategory

type EmailSecurityTopTldSpamGetParamsTldCategory string

Filter for TLDs by category.

const (
	EmailSecurityTopTldSpamGetParamsTldCategoryClassic EmailSecurityTopTldSpamGetParamsTldCategory = "CLASSIC"
	EmailSecurityTopTldSpamGetParamsTldCategoryCountry EmailSecurityTopTldSpamGetParamsTldCategory = "COUNTRY"
)

func (EmailSecurityTopTldSpamGetParamsTldCategory) IsKnown

type EmailSecurityTopTldSpamGetResponse

type EmailSecurityTopTldSpamGetResponse struct {
	Meta EmailSecurityTopTldSpamGetResponseMeta   `json:"meta,required"`
	Top0 []EmailSecurityTopTldSpamGetResponseTop0 `json:"top_0,required"`
	JSON emailSecurityTopTldSpamGetResponseJSON   `json:"-"`
}

func (*EmailSecurityTopTldSpamGetResponse) UnmarshalJSON

func (r *EmailSecurityTopTldSpamGetResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpamGetResponseEnvelope

type EmailSecurityTopTldSpamGetResponseEnvelope struct {
	Result  EmailSecurityTopTldSpamGetResponse             `json:"result,required"`
	Success bool                                           `json:"success,required"`
	JSON    emailSecurityTopTldSpamGetResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTopTldSpamGetResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTopTldSpamGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpamGetResponseMeta

type EmailSecurityTopTldSpamGetResponseMeta struct {
	DateRange      []EmailSecurityTopTldSpamGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                               `json:"lastUpdated,required"`
	ConfidenceInfo EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecurityTopTldSpamGetResponseMetaJSON           `json:"-"`
}

func (*EmailSecurityTopTldSpamGetResponseMeta) UnmarshalJSON

func (r *EmailSecurityTopTldSpamGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo

type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo struct {
	Annotations []EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                            `json:"level"`
	JSON        emailSecurityTopTldSpamGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation

type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                             `json:"dataSource,required"`
	Description     string                                                             `json:"description,required"`
	EventType       string                                                             `json:"eventType,required"`
	IsInstantaneous bool                                                               `json:"isInstantaneous,required"`
	EndTime         time.Time                                                          `json:"endTime" format:"date-time"`
	LinkedURL       string                                                             `json:"linkedUrl"`
	StartTime       time.Time                                                          `json:"startTime" format:"date-time"`
	JSON            emailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecurityTopTldSpamGetResponseMetaDateRange

type EmailSecurityTopTldSpamGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                           `json:"startTime,required" format:"date-time"`
	JSON      emailSecurityTopTldSpamGetResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecurityTopTldSpamGetResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecurityTopTldSpamGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpamGetResponseTop0

type EmailSecurityTopTldSpamGetResponseTop0 struct {
	Name  string                                     `json:"name,required"`
	Value string                                     `json:"value,required"`
	JSON  emailSecurityTopTldSpamGetResponseTop0JSON `json:"-"`
}

func (*EmailSecurityTopTldSpamGetResponseTop0) UnmarshalJSON

func (r *EmailSecurityTopTldSpamGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpamService

type EmailSecurityTopTldSpamService struct {
	Options []option.RequestOption
}

EmailSecurityTopTldSpamService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityTopTldSpamService method instead.

func NewEmailSecurityTopTldSpamService

func NewEmailSecurityTopTldSpamService(opts ...option.RequestOption) (r *EmailSecurityTopTldSpamService)

NewEmailSecurityTopTldSpamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailSecurityTopTldSpamService) Get

Get the top TLDs by emails classified as spam or not.

type EmailSecurityTopTldSpoofGetParams

type EmailSecurityTopTldSpoofGetParams struct {
	// Filter for arc (Authenticated Received Chain).
	ARC param.Field[[]EmailSecurityTopTldSpoofGetParamsARC] `query:"arc"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for dkim.
	DKIM param.Field[[]EmailSecurityTopTldSpoofGetParamsDKIM] `query:"dkim"`
	// Filter for dmarc.
	DMARC param.Field[[]EmailSecurityTopTldSpoofGetParamsDMARC] `query:"dmarc"`
	// Format results are returned in.
	Format param.Field[EmailSecurityTopTldSpoofGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for spf.
	SPF param.Field[[]EmailSecurityTopTldSpoofGetParamsSPF] `query:"spf"`
	// Filter for TLDs by category.
	TldCategory param.Field[EmailSecurityTopTldSpoofGetParamsTldCategory] `query:"tldCategory"`
	// Filter for tls version.
	TLSVersion param.Field[[]EmailSecurityTopTldSpoofGetParamsTLSVersion] `query:"tlsVersion"`
}

func (EmailSecurityTopTldSpoofGetParams) URLQuery

func (r EmailSecurityTopTldSpoofGetParams) URLQuery() (v url.Values)

URLQuery serializes EmailSecurityTopTldSpoofGetParams's query parameters as `url.Values`.

type EmailSecurityTopTldSpoofGetParamsARC

type EmailSecurityTopTldSpoofGetParamsARC string
const (
	EmailSecurityTopTldSpoofGetParamsARCPass EmailSecurityTopTldSpoofGetParamsARC = "PASS"
	EmailSecurityTopTldSpoofGetParamsARCNone EmailSecurityTopTldSpoofGetParamsARC = "NONE"
	EmailSecurityTopTldSpoofGetParamsARCFail EmailSecurityTopTldSpoofGetParamsARC = "FAIL"
)

func (EmailSecurityTopTldSpoofGetParamsARC) IsKnown

type EmailSecurityTopTldSpoofGetParamsDKIM

type EmailSecurityTopTldSpoofGetParamsDKIM string
const (
	EmailSecurityTopTldSpoofGetParamsDKIMPass EmailSecurityTopTldSpoofGetParamsDKIM = "PASS"
	EmailSecurityTopTldSpoofGetParamsDKIMNone EmailSecurityTopTldSpoofGetParamsDKIM = "NONE"
	EmailSecurityTopTldSpoofGetParamsDKIMFail EmailSecurityTopTldSpoofGetParamsDKIM = "FAIL"
)

func (EmailSecurityTopTldSpoofGetParamsDKIM) IsKnown

type EmailSecurityTopTldSpoofGetParamsDMARC

type EmailSecurityTopTldSpoofGetParamsDMARC string
const (
	EmailSecurityTopTldSpoofGetParamsDMARCPass EmailSecurityTopTldSpoofGetParamsDMARC = "PASS"
	EmailSecurityTopTldSpoofGetParamsDMARCNone EmailSecurityTopTldSpoofGetParamsDMARC = "NONE"
	EmailSecurityTopTldSpoofGetParamsDMARCFail EmailSecurityTopTldSpoofGetParamsDMARC = "FAIL"
)

func (EmailSecurityTopTldSpoofGetParamsDMARC) IsKnown

type EmailSecurityTopTldSpoofGetParamsFormat

type EmailSecurityTopTldSpoofGetParamsFormat string

Format results are returned in.

const (
	EmailSecurityTopTldSpoofGetParamsFormatJson EmailSecurityTopTldSpoofGetParamsFormat = "JSON"
	EmailSecurityTopTldSpoofGetParamsFormatCsv  EmailSecurityTopTldSpoofGetParamsFormat = "CSV"
)

func (EmailSecurityTopTldSpoofGetParamsFormat) IsKnown

type EmailSecurityTopTldSpoofGetParamsSPF

type EmailSecurityTopTldSpoofGetParamsSPF string
const (
	EmailSecurityTopTldSpoofGetParamsSPFPass EmailSecurityTopTldSpoofGetParamsSPF = "PASS"
	EmailSecurityTopTldSpoofGetParamsSPFNone EmailSecurityTopTldSpoofGetParamsSPF = "NONE"
	EmailSecurityTopTldSpoofGetParamsSPFFail EmailSecurityTopTldSpoofGetParamsSPF = "FAIL"
)

func (EmailSecurityTopTldSpoofGetParamsSPF) IsKnown

type EmailSecurityTopTldSpoofGetParamsSpoof

type EmailSecurityTopTldSpoofGetParamsSpoof string

Spoof.

const (
	EmailSecurityTopTldSpoofGetParamsSpoofSpoof    EmailSecurityTopTldSpoofGetParamsSpoof = "SPOOF"
	EmailSecurityTopTldSpoofGetParamsSpoofNotSpoof EmailSecurityTopTldSpoofGetParamsSpoof = "NOT_SPOOF"
)

func (EmailSecurityTopTldSpoofGetParamsSpoof) IsKnown

type EmailSecurityTopTldSpoofGetParamsTLSVersion

type EmailSecurityTopTldSpoofGetParamsTLSVersion string
const (
	EmailSecurityTopTldSpoofGetParamsTLSVersionTlSv1_0 EmailSecurityTopTldSpoofGetParamsTLSVersion = "TLSv1_0"
	EmailSecurityTopTldSpoofGetParamsTLSVersionTlSv1_1 EmailSecurityTopTldSpoofGetParamsTLSVersion = "TLSv1_1"
	EmailSecurityTopTldSpoofGetParamsTLSVersionTlSv1_2 EmailSecurityTopTldSpoofGetParamsTLSVersion = "TLSv1_2"
	EmailSecurityTopTldSpoofGetParamsTLSVersionTlSv1_3 EmailSecurityTopTldSpoofGetParamsTLSVersion = "TLSv1_3"
)

func (EmailSecurityTopTldSpoofGetParamsTLSVersion) IsKnown

type EmailSecurityTopTldSpoofGetParamsTldCategory

type EmailSecurityTopTldSpoofGetParamsTldCategory string

Filter for TLDs by category.

const (
	EmailSecurityTopTldSpoofGetParamsTldCategoryClassic EmailSecurityTopTldSpoofGetParamsTldCategory = "CLASSIC"
	EmailSecurityTopTldSpoofGetParamsTldCategoryCountry EmailSecurityTopTldSpoofGetParamsTldCategory = "COUNTRY"
)

func (EmailSecurityTopTldSpoofGetParamsTldCategory) IsKnown

type EmailSecurityTopTldSpoofGetResponse

type EmailSecurityTopTldSpoofGetResponse struct {
	Meta EmailSecurityTopTldSpoofGetResponseMeta   `json:"meta,required"`
	Top0 []EmailSecurityTopTldSpoofGetResponseTop0 `json:"top_0,required"`
	JSON emailSecurityTopTldSpoofGetResponseJSON   `json:"-"`
}

func (*EmailSecurityTopTldSpoofGetResponse) UnmarshalJSON

func (r *EmailSecurityTopTldSpoofGetResponse) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpoofGetResponseEnvelope

type EmailSecurityTopTldSpoofGetResponseEnvelope struct {
	Result  EmailSecurityTopTldSpoofGetResponse             `json:"result,required"`
	Success bool                                            `json:"success,required"`
	JSON    emailSecurityTopTldSpoofGetResponseEnvelopeJSON `json:"-"`
}

func (*EmailSecurityTopTldSpoofGetResponseEnvelope) UnmarshalJSON

func (r *EmailSecurityTopTldSpoofGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpoofGetResponseMeta

type EmailSecurityTopTldSpoofGetResponseMeta struct {
	DateRange      []EmailSecurityTopTldSpoofGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                `json:"lastUpdated,required"`
	ConfidenceInfo EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           emailSecurityTopTldSpoofGetResponseMetaJSON           `json:"-"`
}

func (*EmailSecurityTopTldSpoofGetResponseMeta) UnmarshalJSON

func (r *EmailSecurityTopTldSpoofGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo

type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo struct {
	Annotations []EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                             `json:"level"`
	JSON        emailSecurityTopTldSpoofGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation

type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                              `json:"dataSource,required"`
	Description     string                                                              `json:"description,required"`
	EventType       string                                                              `json:"eventType,required"`
	IsInstantaneous bool                                                                `json:"isInstantaneous,required"`
	EndTime         time.Time                                                           `json:"endTime" format:"date-time"`
	LinkedURL       string                                                              `json:"linkedUrl"`
	StartTime       time.Time                                                           `json:"startTime" format:"date-time"`
	JSON            emailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type EmailSecurityTopTldSpoofGetResponseMetaDateRange

type EmailSecurityTopTldSpoofGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                            `json:"startTime,required" format:"date-time"`
	JSON      emailSecurityTopTldSpoofGetResponseMetaDateRangeJSON `json:"-"`
}

func (*EmailSecurityTopTldSpoofGetResponseMetaDateRange) UnmarshalJSON

func (r *EmailSecurityTopTldSpoofGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpoofGetResponseTop0

type EmailSecurityTopTldSpoofGetResponseTop0 struct {
	Name  string                                      `json:"name,required"`
	Value string                                      `json:"value,required"`
	JSON  emailSecurityTopTldSpoofGetResponseTop0JSON `json:"-"`
}

func (*EmailSecurityTopTldSpoofGetResponseTop0) UnmarshalJSON

func (r *EmailSecurityTopTldSpoofGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type EmailSecurityTopTldSpoofService

type EmailSecurityTopTldSpoofService struct {
	Options []option.RequestOption
}

EmailSecurityTopTldSpoofService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityTopTldSpoofService method instead.

func NewEmailSecurityTopTldSpoofService

func NewEmailSecurityTopTldSpoofService(opts ...option.RequestOption) (r *EmailSecurityTopTldSpoofService)

NewEmailSecurityTopTldSpoofService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EmailSecurityTopTldSpoofService) Get

Get the TLDs by emails classified as spoof or not.

type EmailService

type EmailService struct {
	Options  []option.RequestOption
	Routing  *EmailRoutingService
	Security *EmailSecurityService
}

EmailService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailService method instead.

func NewEmailService

func NewEmailService(opts ...option.RequestOption) (r *EmailService)

NewEmailService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type EntityASNGetParams

type EntityASNGetParams struct {
	// Format results are returned in.
	Format param.Field[EntityASNGetParamsFormat] `query:"format"`
}

func (EntityASNGetParams) URLQuery

func (r EntityASNGetParams) URLQuery() (v url.Values)

URLQuery serializes EntityASNGetParams's query parameters as `url.Values`.

type EntityASNGetParamsFormat

type EntityASNGetParamsFormat string

Format results are returned in.

const (
	EntityASNGetParamsFormatJson EntityASNGetParamsFormat = "JSON"
	EntityASNGetParamsFormatCsv  EntityASNGetParamsFormat = "CSV"
)

func (EntityASNGetParamsFormat) IsKnown

func (r EntityASNGetParamsFormat) IsKnown() bool

type EntityASNGetResponse

type EntityASNGetResponse struct {
	ASN  EntityASNGetResponseASN  `json:"asn,required"`
	JSON entityASNGetResponseJSON `json:"-"`
}

func (*EntityASNGetResponse) UnmarshalJSON

func (r *EntityASNGetResponse) UnmarshalJSON(data []byte) (err error)

type EntityASNGetResponseASN

type EntityASNGetResponseASN struct {
	ASN             int64                                 `json:"asn,required"`
	ConfidenceLevel int64                                 `json:"confidenceLevel,required"`
	Country         string                                `json:"country,required"`
	CountryName     string                                `json:"countryName,required"`
	EstimatedUsers  EntityASNGetResponseASNEstimatedUsers `json:"estimatedUsers,required"`
	Name            string                                `json:"name,required"`
	OrgName         string                                `json:"orgName,required"`
	Related         []EntityASNGetResponseASNRelated      `json:"related,required"`
	// Regional Internet Registry
	Source  string `json:"source,required"`
	Website string `json:"website,required"`
	Aka     string `json:"aka"`
	// Deprecated field. Please use 'aka'.
	NameLong string                      `json:"nameLong"`
	JSON     entityASNGetResponseASNJSON `json:"-"`
}

func (*EntityASNGetResponseASN) UnmarshalJSON

func (r *EntityASNGetResponseASN) UnmarshalJSON(data []byte) (err error)

type EntityASNGetResponseASNEstimatedUsers

type EntityASNGetResponseASNEstimatedUsers struct {
	Locations []EntityASNGetResponseASNEstimatedUsersLocation `json:"locations,required"`
	// Total estimated users
	EstimatedUsers int64                                     `json:"estimatedUsers"`
	JSON           entityASNGetResponseASNEstimatedUsersJSON `json:"-"`
}

func (*EntityASNGetResponseASNEstimatedUsers) UnmarshalJSON

func (r *EntityASNGetResponseASNEstimatedUsers) UnmarshalJSON(data []byte) (err error)

type EntityASNGetResponseASNEstimatedUsersLocation

type EntityASNGetResponseASNEstimatedUsersLocation struct {
	LocationAlpha2 string `json:"locationAlpha2,required"`
	LocationName   string `json:"locationName,required"`
	// Estimated users per location
	EstimatedUsers int64                                             `json:"estimatedUsers"`
	JSON           entityASNGetResponseASNEstimatedUsersLocationJSON `json:"-"`
}

func (*EntityASNGetResponseASNEstimatedUsersLocation) UnmarshalJSON

func (r *EntityASNGetResponseASNEstimatedUsersLocation) UnmarshalJSON(data []byte) (err error)

type EntityASNGetResponseASNRelated

type EntityASNGetResponseASNRelated struct {
	ASN  int64  `json:"asn,required"`
	Name string `json:"name,required"`
	Aka  string `json:"aka"`
	// Total estimated users
	EstimatedUsers int64                              `json:"estimatedUsers"`
	JSON           entityASNGetResponseASNRelatedJSON `json:"-"`
}

func (*EntityASNGetResponseASNRelated) UnmarshalJSON

func (r *EntityASNGetResponseASNRelated) UnmarshalJSON(data []byte) (err error)

type EntityASNGetResponseEnvelope

type EntityASNGetResponseEnvelope struct {
	Result  EntityASNGetResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    entityASNGetResponseEnvelopeJSON `json:"-"`
}

func (*EntityASNGetResponseEnvelope) UnmarshalJSON

func (r *EntityASNGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntityASNIPParams

type EntityASNIPParams struct {
	// IP address.
	IP param.Field[string] `query:"ip,required"`
	// Format results are returned in.
	Format param.Field[EntityAsnipParamsFormat] `query:"format"`
}

func (EntityASNIPParams) URLQuery

func (r EntityASNIPParams) URLQuery() (v url.Values)

URLQuery serializes EntityASNIPParams's query parameters as `url.Values`.

type EntityASNListParams

type EntityASNListParams struct {
	// Comma separated list of ASNs.
	ASN param.Field[string] `query:"asn"`
	// Format results are returned in.
	Format param.Field[EntityASNListParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Location Alpha2 to filter results.
	Location param.Field[string] `query:"location"`
	// Number of objects to skip before grabbing results.
	Offset param.Field[int64] `query:"offset"`
	// Order asn list.
	OrderBy param.Field[EntityASNListParamsOrderBy] `query:"orderBy"`
}

func (EntityASNListParams) URLQuery

func (r EntityASNListParams) URLQuery() (v url.Values)

URLQuery serializes EntityASNListParams's query parameters as `url.Values`.

type EntityASNListParamsFormat

type EntityASNListParamsFormat string

Format results are returned in.

const (
	EntityASNListParamsFormatJson EntityASNListParamsFormat = "JSON"
	EntityASNListParamsFormatCsv  EntityASNListParamsFormat = "CSV"
)

func (EntityASNListParamsFormat) IsKnown

func (r EntityASNListParamsFormat) IsKnown() bool

type EntityASNListParamsOrderBy

type EntityASNListParamsOrderBy string

Order asn list.

const (
	EntityASNListParamsOrderByASN        EntityASNListParamsOrderBy = "ASN"
	EntityASNListParamsOrderByPopulation EntityASNListParamsOrderBy = "POPULATION"
)

func (EntityASNListParamsOrderBy) IsKnown

func (r EntityASNListParamsOrderBy) IsKnown() bool

type EntityASNListResponse

type EntityASNListResponse struct {
	ASNs []EntityASNListResponseASN `json:"asns,required"`
	JSON entityASNListResponseJSON  `json:"-"`
}

func (*EntityASNListResponse) UnmarshalJSON

func (r *EntityASNListResponse) UnmarshalJSON(data []byte) (err error)

type EntityASNListResponseASN

type EntityASNListResponseASN struct {
	ASN         int64  `json:"asn,required"`
	Country     string `json:"country,required"`
	CountryName string `json:"countryName,required"`
	Name        string `json:"name,required"`
	Aka         string `json:"aka"`
	// Deprecated field. Please use 'aka'.
	NameLong string                       `json:"nameLong"`
	OrgName  string                       `json:"orgName"`
	Website  string                       `json:"website"`
	JSON     entityASNListResponseASNJSON `json:"-"`
}

func (*EntityASNListResponseASN) UnmarshalJSON

func (r *EntityASNListResponseASN) UnmarshalJSON(data []byte) (err error)

type EntityASNListResponseEnvelope

type EntityASNListResponseEnvelope struct {
	Result  EntityASNListResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    entityASNListResponseEnvelopeJSON `json:"-"`
}

func (*EntityASNListResponseEnvelope) UnmarshalJSON

func (r *EntityASNListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntityASNRelParams

type EntityASNRelParams struct {
	// Get the AS relationship of ASN2 with respect to the given ASN
	Asn2 param.Field[int64] `query:"asn2"`
	// Format results are returned in.
	Format param.Field[EntityASNRelParamsFormat] `query:"format"`
}

func (EntityASNRelParams) URLQuery

func (r EntityASNRelParams) URLQuery() (v url.Values)

URLQuery serializes EntityASNRelParams's query parameters as `url.Values`.

type EntityASNRelParamsFormat

type EntityASNRelParamsFormat string

Format results are returned in.

const (
	EntityASNRelParamsFormatJson EntityASNRelParamsFormat = "JSON"
	EntityASNRelParamsFormatCsv  EntityASNRelParamsFormat = "CSV"
)

func (EntityASNRelParamsFormat) IsKnown

func (r EntityASNRelParamsFormat) IsKnown() bool

type EntityASNRelResponse

type EntityASNRelResponse struct {
	Meta EntityASNRelResponseMeta  `json:"meta,required"`
	Rels []EntityASNRelResponseRel `json:"rels,required"`
	JSON entityASNRelResponseJSON  `json:"-"`
}

func (*EntityASNRelResponse) UnmarshalJSON

func (r *EntityASNRelResponse) UnmarshalJSON(data []byte) (err error)

type EntityASNRelResponseEnvelope

type EntityASNRelResponseEnvelope struct {
	Result  EntityASNRelResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    entityASNRelResponseEnvelopeJSON `json:"-"`
}

func (*EntityASNRelResponseEnvelope) UnmarshalJSON

func (r *EntityASNRelResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntityASNRelResponseMeta

type EntityASNRelResponseMeta struct {
	DataTime   string                       `json:"data_time,required"`
	QueryTime  string                       `json:"query_time,required"`
	TotalPeers int64                        `json:"total_peers,required"`
	JSON       entityASNRelResponseMetaJSON `json:"-"`
}

func (*EntityASNRelResponseMeta) UnmarshalJSON

func (r *EntityASNRelResponseMeta) UnmarshalJSON(data []byte) (err error)

type EntityASNRelResponseRel

type EntityASNRelResponseRel struct {
	Asn1        int64                       `json:"asn1,required"`
	Asn1Country string                      `json:"asn1_country,required"`
	Asn1Name    string                      `json:"asn1_name,required"`
	Asn2        int64                       `json:"asn2,required"`
	Asn2Country string                      `json:"asn2_country,required"`
	Asn2Name    string                      `json:"asn2_name,required"`
	Rel         string                      `json:"rel,required"`
	JSON        entityASNRelResponseRelJSON `json:"-"`
}

func (*EntityASNRelResponseRel) UnmarshalJSON

func (r *EntityASNRelResponseRel) UnmarshalJSON(data []byte) (err error)

type EntityASNService

type EntityASNService struct {
	Options []option.RequestOption
}

EntityASNService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEntityASNService method instead.

func NewEntityASNService

func NewEntityASNService(opts ...option.RequestOption) (r *EntityASNService)

NewEntityASNService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EntityASNService) Get

Get the requested autonomous system information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).

func (*EntityASNService) IP

Get the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).

func (*EntityASNService) List

Get a list of autonomous systems (ASes).

func (*EntityASNService) Rel

Get AS-level relationship for given networks.

type EntityAsnipParamsFormat

type EntityAsnipParamsFormat string

Format results are returned in.

const (
	EntityAsnipParamsFormatJson EntityAsnipParamsFormat = "JSON"
	EntityAsnipParamsFormatCsv  EntityAsnipParamsFormat = "CSV"
)

func (EntityAsnipParamsFormat) IsKnown

func (r EntityAsnipParamsFormat) IsKnown() bool

type EntityAsnipResponse

type EntityAsnipResponse struct {
	ASN  EntityAsnipResponseASN  `json:"asn,required"`
	JSON entityAsnipResponseJSON `json:"-"`
}

func (*EntityAsnipResponse) UnmarshalJSON

func (r *EntityAsnipResponse) UnmarshalJSON(data []byte) (err error)

type EntityAsnipResponseASN

type EntityAsnipResponseASN struct {
	ASN            int64                                `json:"asn,required"`
	Country        string                               `json:"country,required"`
	CountryName    string                               `json:"countryName,required"`
	EstimatedUsers EntityAsnipResponseASNEstimatedUsers `json:"estimatedUsers,required"`
	Name           string                               `json:"name,required"`
	OrgName        string                               `json:"orgName,required"`
	Related        []EntityAsnipResponseASNRelated      `json:"related,required"`
	// Regional Internet Registry
	Source  string `json:"source,required"`
	Website string `json:"website,required"`
	Aka     string `json:"aka"`
	// Deprecated field. Please use 'aka'.
	NameLong string                     `json:"nameLong"`
	JSON     entityAsnipResponseASNJSON `json:"-"`
}

func (*EntityAsnipResponseASN) UnmarshalJSON

func (r *EntityAsnipResponseASN) UnmarshalJSON(data []byte) (err error)

type EntityAsnipResponseASNEstimatedUsers

type EntityAsnipResponseASNEstimatedUsers struct {
	Locations []EntityAsnipResponseASNEstimatedUsersLocation `json:"locations,required"`
	// Total estimated users
	EstimatedUsers int64                                    `json:"estimatedUsers"`
	JSON           entityAsnipResponseASNEstimatedUsersJSON `json:"-"`
}

func (*EntityAsnipResponseASNEstimatedUsers) UnmarshalJSON

func (r *EntityAsnipResponseASNEstimatedUsers) UnmarshalJSON(data []byte) (err error)

type EntityAsnipResponseASNEstimatedUsersLocation

type EntityAsnipResponseASNEstimatedUsersLocation struct {
	LocationAlpha2 string `json:"locationAlpha2,required"`
	LocationName   string `json:"locationName,required"`
	// Estimated users per location
	EstimatedUsers int64                                            `json:"estimatedUsers"`
	JSON           entityAsnipResponseASNEstimatedUsersLocationJSON `json:"-"`
}

func (*EntityAsnipResponseASNEstimatedUsersLocation) UnmarshalJSON

func (r *EntityAsnipResponseASNEstimatedUsersLocation) UnmarshalJSON(data []byte) (err error)

type EntityAsnipResponseASNRelated

type EntityAsnipResponseASNRelated struct {
	ASN  int64  `json:"asn,required"`
	Name string `json:"name,required"`
	Aka  string `json:"aka"`
	// Total estimated users
	EstimatedUsers int64                             `json:"estimatedUsers"`
	JSON           entityAsnipResponseASNRelatedJSON `json:"-"`
}

func (*EntityAsnipResponseASNRelated) UnmarshalJSON

func (r *EntityAsnipResponseASNRelated) UnmarshalJSON(data []byte) (err error)

type EntityAsnipResponseEnvelope

type EntityAsnipResponseEnvelope struct {
	Result  EntityAsnipResponse             `json:"result,required"`
	Success bool                            `json:"success,required"`
	JSON    entityAsnipResponseEnvelopeJSON `json:"-"`
}

func (*EntityAsnipResponseEnvelope) UnmarshalJSON

func (r *EntityAsnipResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntityGetParams

type EntityGetParams struct {
	// IP address.
	IP param.Field[string] `query:"ip,required"`
	// Format results are returned in.
	Format param.Field[EntityGetParamsFormat] `query:"format"`
}

func (EntityGetParams) URLQuery

func (r EntityGetParams) URLQuery() (v url.Values)

URLQuery serializes EntityGetParams's query parameters as `url.Values`.

type EntityGetParamsFormat

type EntityGetParamsFormat string

Format results are returned in.

const (
	EntityGetParamsFormatJson EntityGetParamsFormat = "JSON"
	EntityGetParamsFormatCsv  EntityGetParamsFormat = "CSV"
)

func (EntityGetParamsFormat) IsKnown

func (r EntityGetParamsFormat) IsKnown() bool

type EntityGetResponse

type EntityGetResponse struct {
	IP   EntityGetResponseIP   `json:"ip,required"`
	JSON entityGetResponseJSON `json:"-"`
}

func (*EntityGetResponse) UnmarshalJSON

func (r *EntityGetResponse) UnmarshalJSON(data []byte) (err error)

type EntityGetResponseEnvelope

type EntityGetResponseEnvelope struct {
	Result  EntityGetResponse             `json:"result,required"`
	Success bool                          `json:"success,required"`
	JSON    entityGetResponseEnvelopeJSON `json:"-"`
}

func (*EntityGetResponseEnvelope) UnmarshalJSON

func (r *EntityGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntityGetResponseIP

type EntityGetResponseIP struct {
	ASN          string                  `json:"asn,required"`
	ASNLocation  string                  `json:"asnLocation,required"`
	ASNName      string                  `json:"asnName,required"`
	ASNOrgName   string                  `json:"asnOrgName,required"`
	IP           string                  `json:"ip,required"`
	IPVersion    string                  `json:"ipVersion,required"`
	Location     string                  `json:"location,required"`
	LocationName string                  `json:"locationName,required"`
	JSON         entityGetResponseIPJSON `json:"-"`
}

func (*EntityGetResponseIP) UnmarshalJSON

func (r *EntityGetResponseIP) UnmarshalJSON(data []byte) (err error)

type EntityLocationGetParams

type EntityLocationGetParams struct {
	// Format results are returned in.
	Format param.Field[EntityLocationGetParamsFormat] `query:"format"`
}

func (EntityLocationGetParams) URLQuery

func (r EntityLocationGetParams) URLQuery() (v url.Values)

URLQuery serializes EntityLocationGetParams's query parameters as `url.Values`.

type EntityLocationGetParamsFormat

type EntityLocationGetParamsFormat string

Format results are returned in.

const (
	EntityLocationGetParamsFormatJson EntityLocationGetParamsFormat = "JSON"
	EntityLocationGetParamsFormatCsv  EntityLocationGetParamsFormat = "CSV"
)

func (EntityLocationGetParamsFormat) IsKnown

func (r EntityLocationGetParamsFormat) IsKnown() bool

type EntityLocationGetResponse

type EntityLocationGetResponse struct {
	Location EntityLocationGetResponseLocation `json:"location,required"`
	JSON     entityLocationGetResponseJSON     `json:"-"`
}

func (*EntityLocationGetResponse) UnmarshalJSON

func (r *EntityLocationGetResponse) UnmarshalJSON(data []byte) (err error)

type EntityLocationGetResponseEnvelope

type EntityLocationGetResponseEnvelope struct {
	Result  EntityLocationGetResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    entityLocationGetResponseEnvelopeJSON `json:"-"`
}

func (*EntityLocationGetResponseEnvelope) UnmarshalJSON

func (r *EntityLocationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntityLocationGetResponseLocation

type EntityLocationGetResponseLocation struct {
	Alpha2          string                                `json:"alpha2,required"`
	ConfidenceLevel int64                                 `json:"confidenceLevel,required"`
	Latitude        string                                `json:"latitude,required"`
	Longitude       string                                `json:"longitude,required"`
	Name            string                                `json:"name,required"`
	Region          string                                `json:"region,required"`
	Subregion       string                                `json:"subregion,required"`
	JSON            entityLocationGetResponseLocationJSON `json:"-"`
}

func (*EntityLocationGetResponseLocation) UnmarshalJSON

func (r *EntityLocationGetResponseLocation) UnmarshalJSON(data []byte) (err error)

type EntityLocationListParams

type EntityLocationListParams struct {
	// Format results are returned in.
	Format param.Field[EntityLocationListParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Comma separated list of locations.
	Location param.Field[string] `query:"location"`
	// Number of objects to skip before grabbing results.
	Offset param.Field[int64] `query:"offset"`
}

func (EntityLocationListParams) URLQuery

func (r EntityLocationListParams) URLQuery() (v url.Values)

URLQuery serializes EntityLocationListParams's query parameters as `url.Values`.

type EntityLocationListParamsFormat

type EntityLocationListParamsFormat string

Format results are returned in.

const (
	EntityLocationListParamsFormatJson EntityLocationListParamsFormat = "JSON"
	EntityLocationListParamsFormatCsv  EntityLocationListParamsFormat = "CSV"
)

func (EntityLocationListParamsFormat) IsKnown

type EntityLocationListResponse

type EntityLocationListResponse struct {
	Locations []EntityLocationListResponseLocation `json:"locations,required"`
	JSON      entityLocationListResponseJSON       `json:"-"`
}

func (*EntityLocationListResponse) UnmarshalJSON

func (r *EntityLocationListResponse) UnmarshalJSON(data []byte) (err error)

type EntityLocationListResponseEnvelope

type EntityLocationListResponseEnvelope struct {
	Result  EntityLocationListResponse             `json:"result,required"`
	Success bool                                   `json:"success,required"`
	JSON    entityLocationListResponseEnvelopeJSON `json:"-"`
}

func (*EntityLocationListResponseEnvelope) UnmarshalJSON

func (r *EntityLocationListResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type EntityLocationListResponseLocation

type EntityLocationListResponseLocation struct {
	Alpha2    string                                 `json:"alpha2,required"`
	Latitude  string                                 `json:"latitude,required"`
	Longitude string                                 `json:"longitude,required"`
	Name      string                                 `json:"name,required"`
	JSON      entityLocationListResponseLocationJSON `json:"-"`
}

func (*EntityLocationListResponseLocation) UnmarshalJSON

func (r *EntityLocationListResponseLocation) UnmarshalJSON(data []byte) (err error)

type EntityLocationService

type EntityLocationService struct {
	Options []option.RequestOption
}

EntityLocationService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEntityLocationService method instead.

func NewEntityLocationService

func NewEntityLocationService(opts ...option.RequestOption) (r *EntityLocationService)

NewEntityLocationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EntityLocationService) Get

Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).

func (*EntityLocationService) List

Get a list of locations.

type EntityService

type EntityService struct {
	Options   []option.RequestOption
	ASNs      *EntityASNService
	Locations *EntityLocationService
}

EntityService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEntityService method instead.

func NewEntityService

func NewEntityService(opts ...option.RequestOption) (r *EntityService)

NewEntityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EntityService) Get

func (r *EntityService) Get(ctx context.Context, query EntityGetParams, opts ...option.RequestOption) (res *EntityGetResponse, err error)

Get IP address information.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type HTTPAseBotClassGetParams

type HTTPAseBotClassGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseBotClassGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseBotClassGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseBotClassGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseBotClassGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPAseBotClassGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseBotClassGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseBotClassGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseBotClassGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseBotClassGetParams) URLQuery

func (r HTTPAseBotClassGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseBotClassGetParams's query parameters as `url.Values`.

type HTTPAseBotClassGetParamsBotClass

type HTTPAseBotClassGetParamsBotClass string

Bot class.

const (
	HTTPAseBotClassGetParamsBotClassLikelyAutomated HTTPAseBotClassGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseBotClassGetParamsBotClassLikelyHuman     HTTPAseBotClassGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseBotClassGetParamsBotClass) IsKnown

type HTTPAseBotClassGetParamsBrowserFamily

type HTTPAseBotClassGetParamsBrowserFamily string
const (
	HTTPAseBotClassGetParamsBrowserFamilyChrome  HTTPAseBotClassGetParamsBrowserFamily = "CHROME"
	HTTPAseBotClassGetParamsBrowserFamilyEdge    HTTPAseBotClassGetParamsBrowserFamily = "EDGE"
	HTTPAseBotClassGetParamsBrowserFamilyFirefox HTTPAseBotClassGetParamsBrowserFamily = "FIREFOX"
	HTTPAseBotClassGetParamsBrowserFamilySafari  HTTPAseBotClassGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseBotClassGetParamsBrowserFamily) IsKnown

type HTTPAseBotClassGetParamsDeviceType

type HTTPAseBotClassGetParamsDeviceType string
const (
	HTTPAseBotClassGetParamsDeviceTypeDesktop HTTPAseBotClassGetParamsDeviceType = "DESKTOP"
	HTTPAseBotClassGetParamsDeviceTypeMobile  HTTPAseBotClassGetParamsDeviceType = "MOBILE"
	HTTPAseBotClassGetParamsDeviceTypeOther   HTTPAseBotClassGetParamsDeviceType = "OTHER"
)

func (HTTPAseBotClassGetParamsDeviceType) IsKnown

type HTTPAseBotClassGetParamsFormat

type HTTPAseBotClassGetParamsFormat string

Format results are returned in.

const (
	HTTPAseBotClassGetParamsFormatJson HTTPAseBotClassGetParamsFormat = "JSON"
	HTTPAseBotClassGetParamsFormatCsv  HTTPAseBotClassGetParamsFormat = "CSV"
)

func (HTTPAseBotClassGetParamsFormat) IsKnown

type HTTPAseBotClassGetParamsHTTPProtocol

type HTTPAseBotClassGetParamsHTTPProtocol string
const (
	HTTPAseBotClassGetParamsHTTPProtocolHTTP  HTTPAseBotClassGetParamsHTTPProtocol = "HTTP"
	HTTPAseBotClassGetParamsHTTPProtocolHTTPS HTTPAseBotClassGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseBotClassGetParamsHTTPProtocol) IsKnown

type HTTPAseBotClassGetParamsHTTPVersion

type HTTPAseBotClassGetParamsHTTPVersion string
const (
	HTTPAseBotClassGetParamsHTTPVersionHttPv1 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv1"
	HTTPAseBotClassGetParamsHTTPVersionHttPv2 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv2"
	HTTPAseBotClassGetParamsHTTPVersionHttPv3 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseBotClassGetParamsHTTPVersion) IsKnown

type HTTPAseBotClassGetParamsIPVersion

type HTTPAseBotClassGetParamsIPVersion string
const (
	HTTPAseBotClassGetParamsIPVersionIPv4 HTTPAseBotClassGetParamsIPVersion = "IPv4"
	HTTPAseBotClassGetParamsIPVersionIPv6 HTTPAseBotClassGetParamsIPVersion = "IPv6"
)

func (HTTPAseBotClassGetParamsIPVersion) IsKnown

type HTTPAseBotClassGetParamsOS

type HTTPAseBotClassGetParamsOS string
const (
	HTTPAseBotClassGetParamsOSWindows  HTTPAseBotClassGetParamsOS = "WINDOWS"
	HTTPAseBotClassGetParamsOSMacosx   HTTPAseBotClassGetParamsOS = "MACOSX"
	HTTPAseBotClassGetParamsOSIos      HTTPAseBotClassGetParamsOS = "IOS"
	HTTPAseBotClassGetParamsOSAndroid  HTTPAseBotClassGetParamsOS = "ANDROID"
	HTTPAseBotClassGetParamsOSChromeos HTTPAseBotClassGetParamsOS = "CHROMEOS"
	HTTPAseBotClassGetParamsOSLinux    HTTPAseBotClassGetParamsOS = "LINUX"
	HTTPAseBotClassGetParamsOSSmartTv  HTTPAseBotClassGetParamsOS = "SMART_TV"
)

func (HTTPAseBotClassGetParamsOS) IsKnown

func (r HTTPAseBotClassGetParamsOS) IsKnown() bool

type HTTPAseBotClassGetParamsTLSVersion

type HTTPAseBotClassGetParamsTLSVersion string
const (
	HTTPAseBotClassGetParamsTLSVersionTlSv1_0  HTTPAseBotClassGetParamsTLSVersion = "TLSv1_0"
	HTTPAseBotClassGetParamsTLSVersionTlSv1_1  HTTPAseBotClassGetParamsTLSVersion = "TLSv1_1"
	HTTPAseBotClassGetParamsTLSVersionTlSv1_2  HTTPAseBotClassGetParamsTLSVersion = "TLSv1_2"
	HTTPAseBotClassGetParamsTLSVersionTlSv1_3  HTTPAseBotClassGetParamsTLSVersion = "TLSv1_3"
	HTTPAseBotClassGetParamsTLSVersionTlSvQuic HTTPAseBotClassGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseBotClassGetParamsTLSVersion) IsKnown

type HTTPAseBotClassGetResponse

type HTTPAseBotClassGetResponse struct {
	Meta HTTPAseBotClassGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseBotClassGetResponseTop0 `json:"top_0,required"`
	JSON httpAseBotClassGetResponseJSON   `json:"-"`
}

func (*HTTPAseBotClassGetResponse) UnmarshalJSON

func (r *HTTPAseBotClassGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseBotClassGetResponseEnvelope

type HTTPAseBotClassGetResponseEnvelope struct {
	Result  HTTPAseBotClassGetResponse             `json:"result,required"`
	Success bool                                   `json:"success,required"`
	JSON    httpAseBotClassGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseBotClassGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseBotClassGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseBotClassGetResponseMeta

type HTTPAseBotClassGetResponseMeta struct {
	DateRange      []HTTPAseBotClassGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                       `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseBotClassGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseBotClassGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseBotClassGetResponseMeta) UnmarshalJSON

func (r *HTTPAseBotClassGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseBotClassGetResponseMetaConfidenceInfo

type HTTPAseBotClassGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                    `json:"level"`
	JSON        httpAseBotClassGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseBotClassGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseBotClassGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation

type HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                     `json:"dataSource,required"`
	Description     string                                                     `json:"description,required"`
	EventType       string                                                     `json:"eventType,required"`
	IsInstantaneous bool                                                       `json:"isInstantaneous,required"`
	EndTime         time.Time                                                  `json:"endTime" format:"date-time"`
	LinkedURL       string                                                     `json:"linkedUrl"`
	StartTime       time.Time                                                  `json:"startTime" format:"date-time"`
	JSON            httpAseBotClassGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPAseBotClassGetResponseMetaDateRange

type HTTPAseBotClassGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                   `json:"startTime,required" format:"date-time"`
	JSON      httpAseBotClassGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseBotClassGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseBotClassGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseBotClassGetResponseTop0

type HTTPAseBotClassGetResponseTop0 struct {
	ClientASN    int64                              `json:"clientASN,required"`
	ClientAsName string                             `json:"clientASName,required"`
	Value        string                             `json:"value,required"`
	JSON         httpAseBotClassGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseBotClassGetResponseTop0) UnmarshalJSON

func (r *HTTPAseBotClassGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseBotClassService

type HTTPAseBotClassService struct {
	Options []option.RequestOption
}

HTTPAseBotClassService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseBotClassService method instead.

func NewHTTPAseBotClassService

func NewHTTPAseBotClassService(opts ...option.RequestOption) (r *HTTPAseBotClassService)

NewHTTPAseBotClassService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseBotClassService) Get

Get the top autonomous systems (AS), by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more information. Values are a percentage out of the total traffic.

type HTTPAseBrowserFamilyGetParams

type HTTPAseBrowserFamilyGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseBrowserFamilyGetParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseBrowserFamilyGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseBrowserFamilyGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseBrowserFamilyGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPAseBrowserFamilyGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseBrowserFamilyGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseBrowserFamilyGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseBrowserFamilyGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseBrowserFamilyGetParams) URLQuery

func (r HTTPAseBrowserFamilyGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseBrowserFamilyGetParams's query parameters as `url.Values`.

type HTTPAseBrowserFamilyGetParamsBotClass

type HTTPAseBrowserFamilyGetParamsBotClass string
const (
	HTTPAseBrowserFamilyGetParamsBotClassLikelyAutomated HTTPAseBrowserFamilyGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseBrowserFamilyGetParamsBotClassLikelyHuman     HTTPAseBrowserFamilyGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseBrowserFamilyGetParamsBotClass) IsKnown

type HTTPAseBrowserFamilyGetParamsBrowserFamily

type HTTPAseBrowserFamilyGetParamsBrowserFamily string

Browser family.

const (
	HTTPAseBrowserFamilyGetParamsBrowserFamilyChrome  HTTPAseBrowserFamilyGetParamsBrowserFamily = "CHROME"
	HTTPAseBrowserFamilyGetParamsBrowserFamilyEdge    HTTPAseBrowserFamilyGetParamsBrowserFamily = "EDGE"
	HTTPAseBrowserFamilyGetParamsBrowserFamilyFirefox HTTPAseBrowserFamilyGetParamsBrowserFamily = "FIREFOX"
	HTTPAseBrowserFamilyGetParamsBrowserFamilySafari  HTTPAseBrowserFamilyGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseBrowserFamilyGetParamsBrowserFamily) IsKnown

type HTTPAseBrowserFamilyGetParamsDeviceType

type HTTPAseBrowserFamilyGetParamsDeviceType string
const (
	HTTPAseBrowserFamilyGetParamsDeviceTypeDesktop HTTPAseBrowserFamilyGetParamsDeviceType = "DESKTOP"
	HTTPAseBrowserFamilyGetParamsDeviceTypeMobile  HTTPAseBrowserFamilyGetParamsDeviceType = "MOBILE"
	HTTPAseBrowserFamilyGetParamsDeviceTypeOther   HTTPAseBrowserFamilyGetParamsDeviceType = "OTHER"
)

func (HTTPAseBrowserFamilyGetParamsDeviceType) IsKnown

type HTTPAseBrowserFamilyGetParamsFormat

type HTTPAseBrowserFamilyGetParamsFormat string

Format results are returned in.

const (
	HTTPAseBrowserFamilyGetParamsFormatJson HTTPAseBrowserFamilyGetParamsFormat = "JSON"
	HTTPAseBrowserFamilyGetParamsFormatCsv  HTTPAseBrowserFamilyGetParamsFormat = "CSV"
)

func (HTTPAseBrowserFamilyGetParamsFormat) IsKnown

type HTTPAseBrowserFamilyGetParamsHTTPProtocol

type HTTPAseBrowserFamilyGetParamsHTTPProtocol string
const (
	HTTPAseBrowserFamilyGetParamsHTTPProtocolHTTP  HTTPAseBrowserFamilyGetParamsHTTPProtocol = "HTTP"
	HTTPAseBrowserFamilyGetParamsHTTPProtocolHTTPS HTTPAseBrowserFamilyGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseBrowserFamilyGetParamsHTTPProtocol) IsKnown

type HTTPAseBrowserFamilyGetParamsHTTPVersion

type HTTPAseBrowserFamilyGetParamsHTTPVersion string
const (
	HTTPAseBrowserFamilyGetParamsHTTPVersionHttPv1 HTTPAseBrowserFamilyGetParamsHTTPVersion = "HTTPv1"
	HTTPAseBrowserFamilyGetParamsHTTPVersionHttPv2 HTTPAseBrowserFamilyGetParamsHTTPVersion = "HTTPv2"
	HTTPAseBrowserFamilyGetParamsHTTPVersionHttPv3 HTTPAseBrowserFamilyGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseBrowserFamilyGetParamsHTTPVersion) IsKnown

type HTTPAseBrowserFamilyGetParamsIPVersion

type HTTPAseBrowserFamilyGetParamsIPVersion string
const (
	HTTPAseBrowserFamilyGetParamsIPVersionIPv4 HTTPAseBrowserFamilyGetParamsIPVersion = "IPv4"
	HTTPAseBrowserFamilyGetParamsIPVersionIPv6 HTTPAseBrowserFamilyGetParamsIPVersion = "IPv6"
)

func (HTTPAseBrowserFamilyGetParamsIPVersion) IsKnown

type HTTPAseBrowserFamilyGetParamsOS

type HTTPAseBrowserFamilyGetParamsOS string
const (
	HTTPAseBrowserFamilyGetParamsOSWindows  HTTPAseBrowserFamilyGetParamsOS = "WINDOWS"
	HTTPAseBrowserFamilyGetParamsOSMacosx   HTTPAseBrowserFamilyGetParamsOS = "MACOSX"
	HTTPAseBrowserFamilyGetParamsOSIos      HTTPAseBrowserFamilyGetParamsOS = "IOS"
	HTTPAseBrowserFamilyGetParamsOSAndroid  HTTPAseBrowserFamilyGetParamsOS = "ANDROID"
	HTTPAseBrowserFamilyGetParamsOSChromeos HTTPAseBrowserFamilyGetParamsOS = "CHROMEOS"
	HTTPAseBrowserFamilyGetParamsOSLinux    HTTPAseBrowserFamilyGetParamsOS = "LINUX"
	HTTPAseBrowserFamilyGetParamsOSSmartTv  HTTPAseBrowserFamilyGetParamsOS = "SMART_TV"
)

func (HTTPAseBrowserFamilyGetParamsOS) IsKnown

type HTTPAseBrowserFamilyGetParamsTLSVersion

type HTTPAseBrowserFamilyGetParamsTLSVersion string
const (
	HTTPAseBrowserFamilyGetParamsTLSVersionTlSv1_0  HTTPAseBrowserFamilyGetParamsTLSVersion = "TLSv1_0"
	HTTPAseBrowserFamilyGetParamsTLSVersionTlSv1_1  HTTPAseBrowserFamilyGetParamsTLSVersion = "TLSv1_1"
	HTTPAseBrowserFamilyGetParamsTLSVersionTlSv1_2  HTTPAseBrowserFamilyGetParamsTLSVersion = "TLSv1_2"
	HTTPAseBrowserFamilyGetParamsTLSVersionTlSv1_3  HTTPAseBrowserFamilyGetParamsTLSVersion = "TLSv1_3"
	HTTPAseBrowserFamilyGetParamsTLSVersionTlSvQuic HTTPAseBrowserFamilyGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseBrowserFamilyGetParamsTLSVersion) IsKnown

type HTTPAseBrowserFamilyGetResponse

type HTTPAseBrowserFamilyGetResponse struct {
	Meta HTTPAseBrowserFamilyGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseBrowserFamilyGetResponseTop0 `json:"top_0,required"`
	JSON httpAseBrowserFamilyGetResponseJSON   `json:"-"`
}

func (*HTTPAseBrowserFamilyGetResponse) UnmarshalJSON

func (r *HTTPAseBrowserFamilyGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseBrowserFamilyGetResponseEnvelope

type HTTPAseBrowserFamilyGetResponseEnvelope struct {
	Result  HTTPAseBrowserFamilyGetResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    httpAseBrowserFamilyGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseBrowserFamilyGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseBrowserFamilyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseBrowserFamilyGetResponseMeta

type HTTPAseBrowserFamilyGetResponseMeta struct {
	DateRange      []HTTPAseBrowserFamilyGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseBrowserFamilyGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseBrowserFamilyGetResponseMeta) UnmarshalJSON

func (r *HTTPAseBrowserFamilyGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo

type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        httpAseBrowserFamilyGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation

type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            httpAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPAseBrowserFamilyGetResponseMetaDateRange

type HTTPAseBrowserFamilyGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      httpAseBrowserFamilyGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseBrowserFamilyGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseBrowserFamilyGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseBrowserFamilyGetResponseTop0

type HTTPAseBrowserFamilyGetResponseTop0 struct {
	ClientASN    int64                                   `json:"clientASN,required"`
	ClientAsName string                                  `json:"clientASName,required"`
	Value        string                                  `json:"value,required"`
	JSON         httpAseBrowserFamilyGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseBrowserFamilyGetResponseTop0) UnmarshalJSON

func (r *HTTPAseBrowserFamilyGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseBrowserFamilyService

type HTTPAseBrowserFamilyService struct {
	Options []option.RequestOption
}

HTTPAseBrowserFamilyService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseBrowserFamilyService method instead.

func NewHTTPAseBrowserFamilyService

func NewHTTPAseBrowserFamilyService(opts ...option.RequestOption) (r *HTTPAseBrowserFamilyService)

NewHTTPAseBrowserFamilyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseBrowserFamilyService) Get

Get the top autonomous systems (AS), by HTTP traffic, of the requested browser family. Values are a percentage out of the total traffic.

type HTTPAseDeviceTypeGetParams

type HTTPAseDeviceTypeGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseDeviceTypeGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseDeviceTypeGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[HTTPAseDeviceTypeGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseDeviceTypeGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPAseDeviceTypeGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseDeviceTypeGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseDeviceTypeGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseDeviceTypeGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseDeviceTypeGetParams) URLQuery

func (r HTTPAseDeviceTypeGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseDeviceTypeGetParams's query parameters as `url.Values`.

type HTTPAseDeviceTypeGetParamsBotClass

type HTTPAseDeviceTypeGetParamsBotClass string
const (
	HTTPAseDeviceTypeGetParamsBotClassLikelyAutomated HTTPAseDeviceTypeGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseDeviceTypeGetParamsBotClassLikelyHuman     HTTPAseDeviceTypeGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseDeviceTypeGetParamsBotClass) IsKnown

type HTTPAseDeviceTypeGetParamsBrowserFamily

type HTTPAseDeviceTypeGetParamsBrowserFamily string
const (
	HTTPAseDeviceTypeGetParamsBrowserFamilyChrome  HTTPAseDeviceTypeGetParamsBrowserFamily = "CHROME"
	HTTPAseDeviceTypeGetParamsBrowserFamilyEdge    HTTPAseDeviceTypeGetParamsBrowserFamily = "EDGE"
	HTTPAseDeviceTypeGetParamsBrowserFamilyFirefox HTTPAseDeviceTypeGetParamsBrowserFamily = "FIREFOX"
	HTTPAseDeviceTypeGetParamsBrowserFamilySafari  HTTPAseDeviceTypeGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseDeviceTypeGetParamsBrowserFamily) IsKnown

type HTTPAseDeviceTypeGetParamsDeviceType

type HTTPAseDeviceTypeGetParamsDeviceType string

Device type.

const (
	HTTPAseDeviceTypeGetParamsDeviceTypeDesktop HTTPAseDeviceTypeGetParamsDeviceType = "DESKTOP"
	HTTPAseDeviceTypeGetParamsDeviceTypeMobile  HTTPAseDeviceTypeGetParamsDeviceType = "MOBILE"
	HTTPAseDeviceTypeGetParamsDeviceTypeOther   HTTPAseDeviceTypeGetParamsDeviceType = "OTHER"
)

func (HTTPAseDeviceTypeGetParamsDeviceType) IsKnown

type HTTPAseDeviceTypeGetParamsFormat

type HTTPAseDeviceTypeGetParamsFormat string

Format results are returned in.

const (
	HTTPAseDeviceTypeGetParamsFormatJson HTTPAseDeviceTypeGetParamsFormat = "JSON"
	HTTPAseDeviceTypeGetParamsFormatCsv  HTTPAseDeviceTypeGetParamsFormat = "CSV"
)

func (HTTPAseDeviceTypeGetParamsFormat) IsKnown

type HTTPAseDeviceTypeGetParamsHTTPProtocol

type HTTPAseDeviceTypeGetParamsHTTPProtocol string
const (
	HTTPAseDeviceTypeGetParamsHTTPProtocolHTTP  HTTPAseDeviceTypeGetParamsHTTPProtocol = "HTTP"
	HTTPAseDeviceTypeGetParamsHTTPProtocolHTTPS HTTPAseDeviceTypeGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseDeviceTypeGetParamsHTTPProtocol) IsKnown

type HTTPAseDeviceTypeGetParamsHTTPVersion

type HTTPAseDeviceTypeGetParamsHTTPVersion string
const (
	HTTPAseDeviceTypeGetParamsHTTPVersionHttPv1 HTTPAseDeviceTypeGetParamsHTTPVersion = "HTTPv1"
	HTTPAseDeviceTypeGetParamsHTTPVersionHttPv2 HTTPAseDeviceTypeGetParamsHTTPVersion = "HTTPv2"
	HTTPAseDeviceTypeGetParamsHTTPVersionHttPv3 HTTPAseDeviceTypeGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseDeviceTypeGetParamsHTTPVersion) IsKnown

type HTTPAseDeviceTypeGetParamsIPVersion

type HTTPAseDeviceTypeGetParamsIPVersion string
const (
	HTTPAseDeviceTypeGetParamsIPVersionIPv4 HTTPAseDeviceTypeGetParamsIPVersion = "IPv4"
	HTTPAseDeviceTypeGetParamsIPVersionIPv6 HTTPAseDeviceTypeGetParamsIPVersion = "IPv6"
)

func (HTTPAseDeviceTypeGetParamsIPVersion) IsKnown

type HTTPAseDeviceTypeGetParamsOS

type HTTPAseDeviceTypeGetParamsOS string
const (
	HTTPAseDeviceTypeGetParamsOSWindows  HTTPAseDeviceTypeGetParamsOS = "WINDOWS"
	HTTPAseDeviceTypeGetParamsOSMacosx   HTTPAseDeviceTypeGetParamsOS = "MACOSX"
	HTTPAseDeviceTypeGetParamsOSIos      HTTPAseDeviceTypeGetParamsOS = "IOS"
	HTTPAseDeviceTypeGetParamsOSAndroid  HTTPAseDeviceTypeGetParamsOS = "ANDROID"
	HTTPAseDeviceTypeGetParamsOSChromeos HTTPAseDeviceTypeGetParamsOS = "CHROMEOS"
	HTTPAseDeviceTypeGetParamsOSLinux    HTTPAseDeviceTypeGetParamsOS = "LINUX"
	HTTPAseDeviceTypeGetParamsOSSmartTv  HTTPAseDeviceTypeGetParamsOS = "SMART_TV"
)

func (HTTPAseDeviceTypeGetParamsOS) IsKnown

func (r HTTPAseDeviceTypeGetParamsOS) IsKnown() bool

type HTTPAseDeviceTypeGetParamsTLSVersion

type HTTPAseDeviceTypeGetParamsTLSVersion string
const (
	HTTPAseDeviceTypeGetParamsTLSVersionTlSv1_0  HTTPAseDeviceTypeGetParamsTLSVersion = "TLSv1_0"
	HTTPAseDeviceTypeGetParamsTLSVersionTlSv1_1  HTTPAseDeviceTypeGetParamsTLSVersion = "TLSv1_1"
	HTTPAseDeviceTypeGetParamsTLSVersionTlSv1_2  HTTPAseDeviceTypeGetParamsTLSVersion = "TLSv1_2"
	HTTPAseDeviceTypeGetParamsTLSVersionTlSv1_3  HTTPAseDeviceTypeGetParamsTLSVersion = "TLSv1_3"
	HTTPAseDeviceTypeGetParamsTLSVersionTlSvQuic HTTPAseDeviceTypeGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseDeviceTypeGetParamsTLSVersion) IsKnown

type HTTPAseDeviceTypeGetResponse

type HTTPAseDeviceTypeGetResponse struct {
	Meta HTTPAseDeviceTypeGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseDeviceTypeGetResponseTop0 `json:"top_0,required"`
	JSON httpAseDeviceTypeGetResponseJSON   `json:"-"`
}

func (*HTTPAseDeviceTypeGetResponse) UnmarshalJSON

func (r *HTTPAseDeviceTypeGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseDeviceTypeGetResponseEnvelope

type HTTPAseDeviceTypeGetResponseEnvelope struct {
	Result  HTTPAseDeviceTypeGetResponse             `json:"result,required"`
	Success bool                                     `json:"success,required"`
	JSON    httpAseDeviceTypeGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseDeviceTypeGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseDeviceTypeGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseDeviceTypeGetResponseMeta

type HTTPAseDeviceTypeGetResponseMeta struct {
	DateRange      []HTTPAseDeviceTypeGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                         `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseDeviceTypeGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseDeviceTypeGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseDeviceTypeGetResponseMeta) UnmarshalJSON

func (r *HTTPAseDeviceTypeGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseDeviceTypeGetResponseMetaConfidenceInfo

type HTTPAseDeviceTypeGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                      `json:"level"`
	JSON        httpAseDeviceTypeGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseDeviceTypeGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseDeviceTypeGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation

type HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                       `json:"dataSource,required"`
	Description     string                                                       `json:"description,required"`
	EventType       string                                                       `json:"eventType,required"`
	IsInstantaneous bool                                                         `json:"isInstantaneous,required"`
	EndTime         time.Time                                                    `json:"endTime" format:"date-time"`
	LinkedURL       string                                                       `json:"linkedUrl"`
	StartTime       time.Time                                                    `json:"startTime" format:"date-time"`
	JSON            httpAseDeviceTypeGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPAseDeviceTypeGetResponseMetaDateRange

type HTTPAseDeviceTypeGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                     `json:"startTime,required" format:"date-time"`
	JSON      httpAseDeviceTypeGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseDeviceTypeGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseDeviceTypeGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseDeviceTypeGetResponseTop0

type HTTPAseDeviceTypeGetResponseTop0 struct {
	ClientASN    int64                                `json:"clientASN,required"`
	ClientAsName string                               `json:"clientASName,required"`
	Value        string                               `json:"value,required"`
	JSON         httpAseDeviceTypeGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseDeviceTypeGetResponseTop0) UnmarshalJSON

func (r *HTTPAseDeviceTypeGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseDeviceTypeService

type HTTPAseDeviceTypeService struct {
	Options []option.RequestOption
}

HTTPAseDeviceTypeService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseDeviceTypeService method instead.

func NewHTTPAseDeviceTypeService

func NewHTTPAseDeviceTypeService(opts ...option.RequestOption) (r *HTTPAseDeviceTypeService)

NewHTTPAseDeviceTypeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseDeviceTypeService) Get

Get the top autonomous systems (AS), by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.

type HTTPAseGetParams

type HTTPAseGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPAseGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseGetParams) URLQuery

func (r HTTPAseGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseGetParams's query parameters as `url.Values`.

type HTTPAseGetParamsBotClass

type HTTPAseGetParamsBotClass string
const (
	HTTPAseGetParamsBotClassLikelyAutomated HTTPAseGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseGetParamsBotClassLikelyHuman     HTTPAseGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseGetParamsBotClass) IsKnown

func (r HTTPAseGetParamsBotClass) IsKnown() bool

type HTTPAseGetParamsBrowserFamily

type HTTPAseGetParamsBrowserFamily string
const (
	HTTPAseGetParamsBrowserFamilyChrome  HTTPAseGetParamsBrowserFamily = "CHROME"
	HTTPAseGetParamsBrowserFamilyEdge    HTTPAseGetParamsBrowserFamily = "EDGE"
	HTTPAseGetParamsBrowserFamilyFirefox HTTPAseGetParamsBrowserFamily = "FIREFOX"
	HTTPAseGetParamsBrowserFamilySafari  HTTPAseGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseGetParamsBrowserFamily) IsKnown

func (r HTTPAseGetParamsBrowserFamily) IsKnown() bool

type HTTPAseGetParamsDeviceType

type HTTPAseGetParamsDeviceType string
const (
	HTTPAseGetParamsDeviceTypeDesktop HTTPAseGetParamsDeviceType = "DESKTOP"
	HTTPAseGetParamsDeviceTypeMobile  HTTPAseGetParamsDeviceType = "MOBILE"
	HTTPAseGetParamsDeviceTypeOther   HTTPAseGetParamsDeviceType = "OTHER"
)

func (HTTPAseGetParamsDeviceType) IsKnown

func (r HTTPAseGetParamsDeviceType) IsKnown() bool

type HTTPAseGetParamsFormat

type HTTPAseGetParamsFormat string

Format results are returned in.

const (
	HTTPAseGetParamsFormatJson HTTPAseGetParamsFormat = "JSON"
	HTTPAseGetParamsFormatCsv  HTTPAseGetParamsFormat = "CSV"
)

func (HTTPAseGetParamsFormat) IsKnown

func (r HTTPAseGetParamsFormat) IsKnown() bool

type HTTPAseGetParamsHTTPProtocol

type HTTPAseGetParamsHTTPProtocol string
const (
	HTTPAseGetParamsHTTPProtocolHTTP  HTTPAseGetParamsHTTPProtocol = "HTTP"
	HTTPAseGetParamsHTTPProtocolHTTPS HTTPAseGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseGetParamsHTTPProtocol) IsKnown

func (r HTTPAseGetParamsHTTPProtocol) IsKnown() bool

type HTTPAseGetParamsHTTPVersion

type HTTPAseGetParamsHTTPVersion string
const (
	HTTPAseGetParamsHTTPVersionHttPv1 HTTPAseGetParamsHTTPVersion = "HTTPv1"
	HTTPAseGetParamsHTTPVersionHttPv2 HTTPAseGetParamsHTTPVersion = "HTTPv2"
	HTTPAseGetParamsHTTPVersionHttPv3 HTTPAseGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseGetParamsHTTPVersion) IsKnown

func (r HTTPAseGetParamsHTTPVersion) IsKnown() bool

type HTTPAseGetParamsIPVersion

type HTTPAseGetParamsIPVersion string
const (
	HTTPAseGetParamsIPVersionIPv4 HTTPAseGetParamsIPVersion = "IPv4"
	HTTPAseGetParamsIPVersionIPv6 HTTPAseGetParamsIPVersion = "IPv6"
)

func (HTTPAseGetParamsIPVersion) IsKnown

func (r HTTPAseGetParamsIPVersion) IsKnown() bool

type HTTPAseGetParamsOS

type HTTPAseGetParamsOS string
const (
	HTTPAseGetParamsOSWindows  HTTPAseGetParamsOS = "WINDOWS"
	HTTPAseGetParamsOSMacosx   HTTPAseGetParamsOS = "MACOSX"
	HTTPAseGetParamsOSIos      HTTPAseGetParamsOS = "IOS"
	HTTPAseGetParamsOSAndroid  HTTPAseGetParamsOS = "ANDROID"
	HTTPAseGetParamsOSChromeos HTTPAseGetParamsOS = "CHROMEOS"
	HTTPAseGetParamsOSLinux    HTTPAseGetParamsOS = "LINUX"
	HTTPAseGetParamsOSSmartTv  HTTPAseGetParamsOS = "SMART_TV"
)

func (HTTPAseGetParamsOS) IsKnown

func (r HTTPAseGetParamsOS) IsKnown() bool

type HTTPAseGetParamsTLSVersion

type HTTPAseGetParamsTLSVersion string
const (
	HTTPAseGetParamsTLSVersionTlSv1_0  HTTPAseGetParamsTLSVersion = "TLSv1_0"
	HTTPAseGetParamsTLSVersionTlSv1_1  HTTPAseGetParamsTLSVersion = "TLSv1_1"
	HTTPAseGetParamsTLSVersionTlSv1_2  HTTPAseGetParamsTLSVersion = "TLSv1_2"
	HTTPAseGetParamsTLSVersionTlSv1_3  HTTPAseGetParamsTLSVersion = "TLSv1_3"
	HTTPAseGetParamsTLSVersionTlSvQuic HTTPAseGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseGetParamsTLSVersion) IsKnown

func (r HTTPAseGetParamsTLSVersion) IsKnown() bool

type HTTPAseGetResponse

type HTTPAseGetResponse struct {
	Meta HTTPAseGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseGetResponseTop0 `json:"top_0,required"`
	JSON httpAseGetResponseJSON   `json:"-"`
}

func (*HTTPAseGetResponse) UnmarshalJSON

func (r *HTTPAseGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseGetResponseEnvelope

type HTTPAseGetResponseEnvelope struct {
	Result  HTTPAseGetResponse             `json:"result,required"`
	Success bool                           `json:"success,required"`
	JSON    httpAseGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseGetResponseMeta

type HTTPAseGetResponseMeta struct {
	DateRange      []HTTPAseGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                               `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseGetResponseMeta) UnmarshalJSON

func (r *HTTPAseGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseGetResponseMetaConfidenceInfo

type HTTPAseGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                            `json:"level"`
	JSON        httpAseGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseGetResponseMetaConfidenceInfoAnnotation

type HTTPAseGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                             `json:"dataSource,required"`
	Description     string                                             `json:"description,required"`
	EventType       string                                             `json:"eventType,required"`
	IsInstantaneous bool                                               `json:"isInstantaneous,required"`
	EndTime         time.Time                                          `json:"endTime" format:"date-time"`
	LinkedURL       string                                             `json:"linkedUrl"`
	StartTime       time.Time                                          `json:"startTime" format:"date-time"`
	JSON            httpAseGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPAseGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPAseGetResponseMetaDateRange

type HTTPAseGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                           `json:"startTime,required" format:"date-time"`
	JSON      httpAseGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseGetResponseTop0

type HTTPAseGetResponseTop0 struct {
	ClientASN    int64                      `json:"clientASN,required"`
	ClientAsName string                     `json:"clientASName,required"`
	Value        string                     `json:"value,required"`
	JSON         httpAseGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseGetResponseTop0) UnmarshalJSON

func (r *HTTPAseGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPMethodGetParams

type HTTPAseHTTPMethodGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseHTTPMethodGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseHTTPMethodGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseHTTPMethodGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseHTTPMethodGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseHTTPMethodGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseHTTPMethodGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseHTTPMethodGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseHTTPMethodGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseHTTPMethodGetParams) URLQuery

func (r HTTPAseHTTPMethodGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseHTTPMethodGetParams's query parameters as `url.Values`.

type HTTPAseHTTPMethodGetParamsBotClass

type HTTPAseHTTPMethodGetParamsBotClass string
const (
	HTTPAseHTTPMethodGetParamsBotClassLikelyAutomated HTTPAseHTTPMethodGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseHTTPMethodGetParamsBotClassLikelyHuman     HTTPAseHTTPMethodGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseHTTPMethodGetParamsBotClass) IsKnown

type HTTPAseHTTPMethodGetParamsBrowserFamily

type HTTPAseHTTPMethodGetParamsBrowserFamily string
const (
	HTTPAseHTTPMethodGetParamsBrowserFamilyChrome  HTTPAseHTTPMethodGetParamsBrowserFamily = "CHROME"
	HTTPAseHTTPMethodGetParamsBrowserFamilyEdge    HTTPAseHTTPMethodGetParamsBrowserFamily = "EDGE"
	HTTPAseHTTPMethodGetParamsBrowserFamilyFirefox HTTPAseHTTPMethodGetParamsBrowserFamily = "FIREFOX"
	HTTPAseHTTPMethodGetParamsBrowserFamilySafari  HTTPAseHTTPMethodGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseHTTPMethodGetParamsBrowserFamily) IsKnown

type HTTPAseHTTPMethodGetParamsDeviceType

type HTTPAseHTTPMethodGetParamsDeviceType string
const (
	HTTPAseHTTPMethodGetParamsDeviceTypeDesktop HTTPAseHTTPMethodGetParamsDeviceType = "DESKTOP"
	HTTPAseHTTPMethodGetParamsDeviceTypeMobile  HTTPAseHTTPMethodGetParamsDeviceType = "MOBILE"
	HTTPAseHTTPMethodGetParamsDeviceTypeOther   HTTPAseHTTPMethodGetParamsDeviceType = "OTHER"
)

func (HTTPAseHTTPMethodGetParamsDeviceType) IsKnown

type HTTPAseHTTPMethodGetParamsFormat

type HTTPAseHTTPMethodGetParamsFormat string

Format results are returned in.

const (
	HTTPAseHTTPMethodGetParamsFormatJson HTTPAseHTTPMethodGetParamsFormat = "JSON"
	HTTPAseHTTPMethodGetParamsFormatCsv  HTTPAseHTTPMethodGetParamsFormat = "CSV"
)

func (HTTPAseHTTPMethodGetParamsFormat) IsKnown

type HTTPAseHTTPMethodGetParamsHTTPProtocol

type HTTPAseHTTPMethodGetParamsHTTPProtocol string
const (
	HTTPAseHTTPMethodGetParamsHTTPProtocolHTTP  HTTPAseHTTPMethodGetParamsHTTPProtocol = "HTTP"
	HTTPAseHTTPMethodGetParamsHTTPProtocolHTTPS HTTPAseHTTPMethodGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseHTTPMethodGetParamsHTTPProtocol) IsKnown

type HTTPAseHTTPMethodGetParamsHTTPVersion

type HTTPAseHTTPMethodGetParamsHTTPVersion string

HTTP version.

const (
	HTTPAseHTTPMethodGetParamsHTTPVersionHttPv1 HTTPAseHTTPMethodGetParamsHTTPVersion = "HTTPv1"
	HTTPAseHTTPMethodGetParamsHTTPVersionHttPv2 HTTPAseHTTPMethodGetParamsHTTPVersion = "HTTPv2"
	HTTPAseHTTPMethodGetParamsHTTPVersionHttPv3 HTTPAseHTTPMethodGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseHTTPMethodGetParamsHTTPVersion) IsKnown

type HTTPAseHTTPMethodGetParamsIPVersion

type HTTPAseHTTPMethodGetParamsIPVersion string
const (
	HTTPAseHTTPMethodGetParamsIPVersionIPv4 HTTPAseHTTPMethodGetParamsIPVersion = "IPv4"
	HTTPAseHTTPMethodGetParamsIPVersionIPv6 HTTPAseHTTPMethodGetParamsIPVersion = "IPv6"
)

func (HTTPAseHTTPMethodGetParamsIPVersion) IsKnown

type HTTPAseHTTPMethodGetParamsOS

type HTTPAseHTTPMethodGetParamsOS string
const (
	HTTPAseHTTPMethodGetParamsOSWindows  HTTPAseHTTPMethodGetParamsOS = "WINDOWS"
	HTTPAseHTTPMethodGetParamsOSMacosx   HTTPAseHTTPMethodGetParamsOS = "MACOSX"
	HTTPAseHTTPMethodGetParamsOSIos      HTTPAseHTTPMethodGetParamsOS = "IOS"
	HTTPAseHTTPMethodGetParamsOSAndroid  HTTPAseHTTPMethodGetParamsOS = "ANDROID"
	HTTPAseHTTPMethodGetParamsOSChromeos HTTPAseHTTPMethodGetParamsOS = "CHROMEOS"
	HTTPAseHTTPMethodGetParamsOSLinux    HTTPAseHTTPMethodGetParamsOS = "LINUX"
	HTTPAseHTTPMethodGetParamsOSSmartTv  HTTPAseHTTPMethodGetParamsOS = "SMART_TV"
)

func (HTTPAseHTTPMethodGetParamsOS) IsKnown

func (r HTTPAseHTTPMethodGetParamsOS) IsKnown() bool

type HTTPAseHTTPMethodGetParamsTLSVersion

type HTTPAseHTTPMethodGetParamsTLSVersion string
const (
	HTTPAseHTTPMethodGetParamsTLSVersionTlSv1_0  HTTPAseHTTPMethodGetParamsTLSVersion = "TLSv1_0"
	HTTPAseHTTPMethodGetParamsTLSVersionTlSv1_1  HTTPAseHTTPMethodGetParamsTLSVersion = "TLSv1_1"
	HTTPAseHTTPMethodGetParamsTLSVersionTlSv1_2  HTTPAseHTTPMethodGetParamsTLSVersion = "TLSv1_2"
	HTTPAseHTTPMethodGetParamsTLSVersionTlSv1_3  HTTPAseHTTPMethodGetParamsTLSVersion = "TLSv1_3"
	HTTPAseHTTPMethodGetParamsTLSVersionTlSvQuic HTTPAseHTTPMethodGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseHTTPMethodGetParamsTLSVersion) IsKnown

type HTTPAseHTTPMethodGetResponse

type HTTPAseHTTPMethodGetResponse struct {
	Meta HTTPAseHTTPMethodGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseHTTPMethodGetResponseTop0 `json:"top_0,required"`
	JSON httpAseHTTPMethodGetResponseJSON   `json:"-"`
}

func (*HTTPAseHTTPMethodGetResponse) UnmarshalJSON

func (r *HTTPAseHTTPMethodGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPMethodGetResponseEnvelope

type HTTPAseHTTPMethodGetResponseEnvelope struct {
	Result  HTTPAseHTTPMethodGetResponse             `json:"result,required"`
	Success bool                                     `json:"success,required"`
	JSON    httpAseHTTPMethodGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseHTTPMethodGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseHTTPMethodGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPMethodGetResponseMeta

type HTTPAseHTTPMethodGetResponseMeta struct {
	DateRange      []HTTPAseHTTPMethodGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                         `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseHTTPMethodGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseHTTPMethodGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseHTTPMethodGetResponseMeta) UnmarshalJSON

func (r *HTTPAseHTTPMethodGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPMethodGetResponseMetaConfidenceInfo

type HTTPAseHTTPMethodGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                      `json:"level"`
	JSON        httpAseHTTPMethodGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseHTTPMethodGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseHTTPMethodGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation

type HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                       `json:"dataSource,required"`
	Description     string                                                       `json:"description,required"`
	EventType       string                                                       `json:"eventType,required"`
	IsInstantaneous bool                                                         `json:"isInstantaneous,required"`
	EndTime         time.Time                                                    `json:"endTime" format:"date-time"`
	LinkedURL       string                                                       `json:"linkedUrl"`
	StartTime       time.Time                                                    `json:"startTime" format:"date-time"`
	JSON            httpAseHTTPMethodGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPAseHTTPMethodGetResponseMetaDateRange

type HTTPAseHTTPMethodGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                     `json:"startTime,required" format:"date-time"`
	JSON      httpAseHTTPMethodGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseHTTPMethodGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseHTTPMethodGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPMethodGetResponseTop0

type HTTPAseHTTPMethodGetResponseTop0 struct {
	ClientASN    int64                                `json:"clientASN,required"`
	ClientAsName string                               `json:"clientASName,required"`
	Value        string                               `json:"value,required"`
	JSON         httpAseHTTPMethodGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseHTTPMethodGetResponseTop0) UnmarshalJSON

func (r *HTTPAseHTTPMethodGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPMethodService

type HTTPAseHTTPMethodService struct {
	Options []option.RequestOption
}

HTTPAseHTTPMethodService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseHTTPMethodService method instead.

func NewHTTPAseHTTPMethodService

func NewHTTPAseHTTPMethodService(opts ...option.RequestOption) (r *HTTPAseHTTPMethodService)

NewHTTPAseHTTPMethodService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseHTTPMethodService) Get

Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP version. Values are a percentage out of the total traffic.

type HTTPAseHTTPProtocolGetParams

type HTTPAseHTTPProtocolGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseHTTPProtocolGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseHTTPProtocolGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseHTTPProtocolGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseHTTPProtocolGetParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseHTTPProtocolGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseHTTPProtocolGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseHTTPProtocolGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseHTTPProtocolGetParams) URLQuery

func (r HTTPAseHTTPProtocolGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseHTTPProtocolGetParams's query parameters as `url.Values`.

type HTTPAseHTTPProtocolGetParamsBotClass

type HTTPAseHTTPProtocolGetParamsBotClass string
const (
	HTTPAseHTTPProtocolGetParamsBotClassLikelyAutomated HTTPAseHTTPProtocolGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseHTTPProtocolGetParamsBotClassLikelyHuman     HTTPAseHTTPProtocolGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseHTTPProtocolGetParamsBotClass) IsKnown

type HTTPAseHTTPProtocolGetParamsBrowserFamily

type HTTPAseHTTPProtocolGetParamsBrowserFamily string
const (
	HTTPAseHTTPProtocolGetParamsBrowserFamilyChrome  HTTPAseHTTPProtocolGetParamsBrowserFamily = "CHROME"
	HTTPAseHTTPProtocolGetParamsBrowserFamilyEdge    HTTPAseHTTPProtocolGetParamsBrowserFamily = "EDGE"
	HTTPAseHTTPProtocolGetParamsBrowserFamilyFirefox HTTPAseHTTPProtocolGetParamsBrowserFamily = "FIREFOX"
	HTTPAseHTTPProtocolGetParamsBrowserFamilySafari  HTTPAseHTTPProtocolGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseHTTPProtocolGetParamsBrowserFamily) IsKnown

type HTTPAseHTTPProtocolGetParamsDeviceType

type HTTPAseHTTPProtocolGetParamsDeviceType string
const (
	HTTPAseHTTPProtocolGetParamsDeviceTypeDesktop HTTPAseHTTPProtocolGetParamsDeviceType = "DESKTOP"
	HTTPAseHTTPProtocolGetParamsDeviceTypeMobile  HTTPAseHTTPProtocolGetParamsDeviceType = "MOBILE"
	HTTPAseHTTPProtocolGetParamsDeviceTypeOther   HTTPAseHTTPProtocolGetParamsDeviceType = "OTHER"
)

func (HTTPAseHTTPProtocolGetParamsDeviceType) IsKnown

type HTTPAseHTTPProtocolGetParamsFormat

type HTTPAseHTTPProtocolGetParamsFormat string

Format results are returned in.

const (
	HTTPAseHTTPProtocolGetParamsFormatJson HTTPAseHTTPProtocolGetParamsFormat = "JSON"
	HTTPAseHTTPProtocolGetParamsFormatCsv  HTTPAseHTTPProtocolGetParamsFormat = "CSV"
)

func (HTTPAseHTTPProtocolGetParamsFormat) IsKnown

type HTTPAseHTTPProtocolGetParamsHTTPProtocol

type HTTPAseHTTPProtocolGetParamsHTTPProtocol string

HTTP Protocol.

const (
	HTTPAseHTTPProtocolGetParamsHTTPProtocolHTTP  HTTPAseHTTPProtocolGetParamsHTTPProtocol = "HTTP"
	HTTPAseHTTPProtocolGetParamsHTTPProtocolHTTPS HTTPAseHTTPProtocolGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseHTTPProtocolGetParamsHTTPProtocol) IsKnown

type HTTPAseHTTPProtocolGetParamsIPVersion

type HTTPAseHTTPProtocolGetParamsIPVersion string
const (
	HTTPAseHTTPProtocolGetParamsIPVersionIPv4 HTTPAseHTTPProtocolGetParamsIPVersion = "IPv4"
	HTTPAseHTTPProtocolGetParamsIPVersionIPv6 HTTPAseHTTPProtocolGetParamsIPVersion = "IPv6"
)

func (HTTPAseHTTPProtocolGetParamsIPVersion) IsKnown

type HTTPAseHTTPProtocolGetParamsOS

type HTTPAseHTTPProtocolGetParamsOS string
const (
	HTTPAseHTTPProtocolGetParamsOSWindows  HTTPAseHTTPProtocolGetParamsOS = "WINDOWS"
	HTTPAseHTTPProtocolGetParamsOSMacosx   HTTPAseHTTPProtocolGetParamsOS = "MACOSX"
	HTTPAseHTTPProtocolGetParamsOSIos      HTTPAseHTTPProtocolGetParamsOS = "IOS"
	HTTPAseHTTPProtocolGetParamsOSAndroid  HTTPAseHTTPProtocolGetParamsOS = "ANDROID"
	HTTPAseHTTPProtocolGetParamsOSChromeos HTTPAseHTTPProtocolGetParamsOS = "CHROMEOS"
	HTTPAseHTTPProtocolGetParamsOSLinux    HTTPAseHTTPProtocolGetParamsOS = "LINUX"
	HTTPAseHTTPProtocolGetParamsOSSmartTv  HTTPAseHTTPProtocolGetParamsOS = "SMART_TV"
)

func (HTTPAseHTTPProtocolGetParamsOS) IsKnown

type HTTPAseHTTPProtocolGetParamsTLSVersion

type HTTPAseHTTPProtocolGetParamsTLSVersion string
const (
	HTTPAseHTTPProtocolGetParamsTLSVersionTlSv1_0  HTTPAseHTTPProtocolGetParamsTLSVersion = "TLSv1_0"
	HTTPAseHTTPProtocolGetParamsTLSVersionTlSv1_1  HTTPAseHTTPProtocolGetParamsTLSVersion = "TLSv1_1"
	HTTPAseHTTPProtocolGetParamsTLSVersionTlSv1_2  HTTPAseHTTPProtocolGetParamsTLSVersion = "TLSv1_2"
	HTTPAseHTTPProtocolGetParamsTLSVersionTlSv1_3  HTTPAseHTTPProtocolGetParamsTLSVersion = "TLSv1_3"
	HTTPAseHTTPProtocolGetParamsTLSVersionTlSvQuic HTTPAseHTTPProtocolGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseHTTPProtocolGetParamsTLSVersion) IsKnown

type HTTPAseHTTPProtocolGetResponse

type HTTPAseHTTPProtocolGetResponse struct {
	Meta HTTPAseHTTPProtocolGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseHTTPProtocolGetResponseTop0 `json:"top_0,required"`
	JSON httpAseHTTPProtocolGetResponseJSON   `json:"-"`
}

func (*HTTPAseHTTPProtocolGetResponse) UnmarshalJSON

func (r *HTTPAseHTTPProtocolGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPProtocolGetResponseEnvelope

type HTTPAseHTTPProtocolGetResponseEnvelope struct {
	Result  HTTPAseHTTPProtocolGetResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    httpAseHTTPProtocolGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseHTTPProtocolGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseHTTPProtocolGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPProtocolGetResponseMeta

type HTTPAseHTTPProtocolGetResponseMeta struct {
	DateRange      []HTTPAseHTTPProtocolGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseHTTPProtocolGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseHTTPProtocolGetResponseMeta) UnmarshalJSON

func (r *HTTPAseHTTPProtocolGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo

type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        httpAseHTTPProtocolGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation

type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            httpAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPAseHTTPProtocolGetResponseMetaDateRange

type HTTPAseHTTPProtocolGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      httpAseHTTPProtocolGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseHTTPProtocolGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseHTTPProtocolGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPProtocolGetResponseTop0

type HTTPAseHTTPProtocolGetResponseTop0 struct {
	ClientASN    int64                                  `json:"clientASN,required"`
	ClientAsName string                                 `json:"clientASName,required"`
	Value        string                                 `json:"value,required"`
	JSON         httpAseHTTPProtocolGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseHTTPProtocolGetResponseTop0) UnmarshalJSON

func (r *HTTPAseHTTPProtocolGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseHTTPProtocolService

type HTTPAseHTTPProtocolService struct {
	Options []option.RequestOption
}

HTTPAseHTTPProtocolService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseHTTPProtocolService method instead.

func NewHTTPAseHTTPProtocolService

func NewHTTPAseHTTPProtocolService(opts ...option.RequestOption) (r *HTTPAseHTTPProtocolService)

NewHTTPAseHTTPProtocolService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseHTTPProtocolService) Get

Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.

type HTTPAseIPVersionGetParams

type HTTPAseIPVersionGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseIPVersionGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseIPVersionGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseIPVersionGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseIPVersionGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseIPVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPAseIPVersionGetParamsHTTPVersion] `query:"httpVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseIPVersionGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseIPVersionGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseIPVersionGetParams) URLQuery

func (r HTTPAseIPVersionGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseIPVersionGetParams's query parameters as `url.Values`.

type HTTPAseIPVersionGetParamsBotClass

type HTTPAseIPVersionGetParamsBotClass string
const (
	HTTPAseIPVersionGetParamsBotClassLikelyAutomated HTTPAseIPVersionGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseIPVersionGetParamsBotClassLikelyHuman     HTTPAseIPVersionGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseIPVersionGetParamsBotClass) IsKnown

type HTTPAseIPVersionGetParamsBrowserFamily

type HTTPAseIPVersionGetParamsBrowserFamily string
const (
	HTTPAseIPVersionGetParamsBrowserFamilyChrome  HTTPAseIPVersionGetParamsBrowserFamily = "CHROME"
	HTTPAseIPVersionGetParamsBrowserFamilyEdge    HTTPAseIPVersionGetParamsBrowserFamily = "EDGE"
	HTTPAseIPVersionGetParamsBrowserFamilyFirefox HTTPAseIPVersionGetParamsBrowserFamily = "FIREFOX"
	HTTPAseIPVersionGetParamsBrowserFamilySafari  HTTPAseIPVersionGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseIPVersionGetParamsBrowserFamily) IsKnown

type HTTPAseIPVersionGetParamsDeviceType

type HTTPAseIPVersionGetParamsDeviceType string
const (
	HTTPAseIPVersionGetParamsDeviceTypeDesktop HTTPAseIPVersionGetParamsDeviceType = "DESKTOP"
	HTTPAseIPVersionGetParamsDeviceTypeMobile  HTTPAseIPVersionGetParamsDeviceType = "MOBILE"
	HTTPAseIPVersionGetParamsDeviceTypeOther   HTTPAseIPVersionGetParamsDeviceType = "OTHER"
)

func (HTTPAseIPVersionGetParamsDeviceType) IsKnown

type HTTPAseIPVersionGetParamsFormat

type HTTPAseIPVersionGetParamsFormat string

Format results are returned in.

const (
	HTTPAseIPVersionGetParamsFormatJson HTTPAseIPVersionGetParamsFormat = "JSON"
	HTTPAseIPVersionGetParamsFormatCsv  HTTPAseIPVersionGetParamsFormat = "CSV"
)

func (HTTPAseIPVersionGetParamsFormat) IsKnown

type HTTPAseIPVersionGetParamsHTTPProtocol

type HTTPAseIPVersionGetParamsHTTPProtocol string
const (
	HTTPAseIPVersionGetParamsHTTPProtocolHTTP  HTTPAseIPVersionGetParamsHTTPProtocol = "HTTP"
	HTTPAseIPVersionGetParamsHTTPProtocolHTTPS HTTPAseIPVersionGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseIPVersionGetParamsHTTPProtocol) IsKnown

type HTTPAseIPVersionGetParamsHTTPVersion

type HTTPAseIPVersionGetParamsHTTPVersion string
const (
	HTTPAseIPVersionGetParamsHTTPVersionHttPv1 HTTPAseIPVersionGetParamsHTTPVersion = "HTTPv1"
	HTTPAseIPVersionGetParamsHTTPVersionHttPv2 HTTPAseIPVersionGetParamsHTTPVersion = "HTTPv2"
	HTTPAseIPVersionGetParamsHTTPVersionHttPv3 HTTPAseIPVersionGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseIPVersionGetParamsHTTPVersion) IsKnown

type HTTPAseIPVersionGetParamsIPVersion

type HTTPAseIPVersionGetParamsIPVersion string

IP version.

const (
	HTTPAseIPVersionGetParamsIPVersionIPv4 HTTPAseIPVersionGetParamsIPVersion = "IPv4"
	HTTPAseIPVersionGetParamsIPVersionIPv6 HTTPAseIPVersionGetParamsIPVersion = "IPv6"
)

func (HTTPAseIPVersionGetParamsIPVersion) IsKnown

type HTTPAseIPVersionGetParamsOS

type HTTPAseIPVersionGetParamsOS string
const (
	HTTPAseIPVersionGetParamsOSWindows  HTTPAseIPVersionGetParamsOS = "WINDOWS"
	HTTPAseIPVersionGetParamsOSMacosx   HTTPAseIPVersionGetParamsOS = "MACOSX"
	HTTPAseIPVersionGetParamsOSIos      HTTPAseIPVersionGetParamsOS = "IOS"
	HTTPAseIPVersionGetParamsOSAndroid  HTTPAseIPVersionGetParamsOS = "ANDROID"
	HTTPAseIPVersionGetParamsOSChromeos HTTPAseIPVersionGetParamsOS = "CHROMEOS"
	HTTPAseIPVersionGetParamsOSLinux    HTTPAseIPVersionGetParamsOS = "LINUX"
	HTTPAseIPVersionGetParamsOSSmartTv  HTTPAseIPVersionGetParamsOS = "SMART_TV"
)

func (HTTPAseIPVersionGetParamsOS) IsKnown

func (r HTTPAseIPVersionGetParamsOS) IsKnown() bool

type HTTPAseIPVersionGetParamsTLSVersion

type HTTPAseIPVersionGetParamsTLSVersion string
const (
	HTTPAseIPVersionGetParamsTLSVersionTlSv1_0  HTTPAseIPVersionGetParamsTLSVersion = "TLSv1_0"
	HTTPAseIPVersionGetParamsTLSVersionTlSv1_1  HTTPAseIPVersionGetParamsTLSVersion = "TLSv1_1"
	HTTPAseIPVersionGetParamsTLSVersionTlSv1_2  HTTPAseIPVersionGetParamsTLSVersion = "TLSv1_2"
	HTTPAseIPVersionGetParamsTLSVersionTlSv1_3  HTTPAseIPVersionGetParamsTLSVersion = "TLSv1_3"
	HTTPAseIPVersionGetParamsTLSVersionTlSvQuic HTTPAseIPVersionGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseIPVersionGetParamsTLSVersion) IsKnown

type HTTPAseIPVersionGetResponse

type HTTPAseIPVersionGetResponse struct {
	Meta HTTPAseIPVersionGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseIPVersionGetResponseTop0 `json:"top_0,required"`
	JSON httpAseIPVersionGetResponseJSON   `json:"-"`
}

func (*HTTPAseIPVersionGetResponse) UnmarshalJSON

func (r *HTTPAseIPVersionGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseIPVersionGetResponseEnvelope

type HTTPAseIPVersionGetResponseEnvelope struct {
	Result  HTTPAseIPVersionGetResponse             `json:"result,required"`
	Success bool                                    `json:"success,required"`
	JSON    httpAseIPVersionGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseIPVersionGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseIPVersionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseIPVersionGetResponseMeta

type HTTPAseIPVersionGetResponseMeta struct {
	DateRange      []HTTPAseIPVersionGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                        `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseIPVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseIPVersionGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseIPVersionGetResponseMeta) UnmarshalJSON

func (r *HTTPAseIPVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseIPVersionGetResponseMetaConfidenceInfo

type HTTPAseIPVersionGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                     `json:"level"`
	JSON        httpAseIPVersionGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseIPVersionGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseIPVersionGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation

type HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                      `json:"dataSource,required"`
	Description     string                                                      `json:"description,required"`
	EventType       string                                                      `json:"eventType,required"`
	IsInstantaneous bool                                                        `json:"isInstantaneous,required"`
	EndTime         time.Time                                                   `json:"endTime" format:"date-time"`
	LinkedURL       string                                                      `json:"linkedUrl"`
	StartTime       time.Time                                                   `json:"startTime" format:"date-time"`
	JSON            httpAseIPVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPAseIPVersionGetResponseMetaDateRange

type HTTPAseIPVersionGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                    `json:"startTime,required" format:"date-time"`
	JSON      httpAseIPVersionGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseIPVersionGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseIPVersionGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseIPVersionGetResponseTop0

type HTTPAseIPVersionGetResponseTop0 struct {
	ClientASN    int64                               `json:"clientASN,required"`
	ClientAsName string                              `json:"clientASName,required"`
	Value        string                              `json:"value,required"`
	JSON         httpAseIPVersionGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseIPVersionGetResponseTop0) UnmarshalJSON

func (r *HTTPAseIPVersionGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseIPVersionService

type HTTPAseIPVersionService struct {
	Options []option.RequestOption
}

HTTPAseIPVersionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseIPVersionService method instead.

func NewHTTPAseIPVersionService

func NewHTTPAseIPVersionService(opts ...option.RequestOption) (r *HTTPAseIPVersionService)

NewHTTPAseIPVersionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseIPVersionService) Get

Get the top autonomous systems, by HTTP traffic, of the requested IP version. Values are a percentage out of the total traffic.

type HTTPAseOSGetParams

type HTTPAseOSGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseOSGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseOSGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseOSGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseOSGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseOSGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPAseOSGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseOSGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPAseOSGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPAseOSGetParams) URLQuery

func (r HTTPAseOSGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseOSGetParams's query parameters as `url.Values`.

type HTTPAseOSGetParamsBotClass

type HTTPAseOSGetParamsBotClass string
const (
	HTTPAseOSGetParamsBotClassLikelyAutomated HTTPAseOSGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseOSGetParamsBotClassLikelyHuman     HTTPAseOSGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseOSGetParamsBotClass) IsKnown

func (r HTTPAseOSGetParamsBotClass) IsKnown() bool

type HTTPAseOSGetParamsBrowserFamily

type HTTPAseOSGetParamsBrowserFamily string
const (
	HTTPAseOSGetParamsBrowserFamilyChrome  HTTPAseOSGetParamsBrowserFamily = "CHROME"
	HTTPAseOSGetParamsBrowserFamilyEdge    HTTPAseOSGetParamsBrowserFamily = "EDGE"
	HTTPAseOSGetParamsBrowserFamilyFirefox HTTPAseOSGetParamsBrowserFamily = "FIREFOX"
	HTTPAseOSGetParamsBrowserFamilySafari  HTTPAseOSGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseOSGetParamsBrowserFamily) IsKnown

type HTTPAseOSGetParamsDeviceType

type HTTPAseOSGetParamsDeviceType string
const (
	HTTPAseOSGetParamsDeviceTypeDesktop HTTPAseOSGetParamsDeviceType = "DESKTOP"
	HTTPAseOSGetParamsDeviceTypeMobile  HTTPAseOSGetParamsDeviceType = "MOBILE"
	HTTPAseOSGetParamsDeviceTypeOther   HTTPAseOSGetParamsDeviceType = "OTHER"
)

func (HTTPAseOSGetParamsDeviceType) IsKnown

func (r HTTPAseOSGetParamsDeviceType) IsKnown() bool

type HTTPAseOSGetParamsFormat

type HTTPAseOSGetParamsFormat string

Format results are returned in.

const (
	HTTPAseOSGetParamsFormatJson HTTPAseOSGetParamsFormat = "JSON"
	HTTPAseOSGetParamsFormatCsv  HTTPAseOSGetParamsFormat = "CSV"
)

func (HTTPAseOSGetParamsFormat) IsKnown

func (r HTTPAseOSGetParamsFormat) IsKnown() bool

type HTTPAseOSGetParamsHTTPProtocol

type HTTPAseOSGetParamsHTTPProtocol string
const (
	HTTPAseOSGetParamsHTTPProtocolHTTP  HTTPAseOSGetParamsHTTPProtocol = "HTTP"
	HTTPAseOSGetParamsHTTPProtocolHTTPS HTTPAseOSGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseOSGetParamsHTTPProtocol) IsKnown

type HTTPAseOSGetParamsHTTPVersion

type HTTPAseOSGetParamsHTTPVersion string
const (
	HTTPAseOSGetParamsHTTPVersionHttPv1 HTTPAseOSGetParamsHTTPVersion = "HTTPv1"
	HTTPAseOSGetParamsHTTPVersionHttPv2 HTTPAseOSGetParamsHTTPVersion = "HTTPv2"
	HTTPAseOSGetParamsHTTPVersionHttPv3 HTTPAseOSGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseOSGetParamsHTTPVersion) IsKnown

func (r HTTPAseOSGetParamsHTTPVersion) IsKnown() bool

type HTTPAseOSGetParamsIPVersion

type HTTPAseOSGetParamsIPVersion string
const (
	HTTPAseOSGetParamsIPVersionIPv4 HTTPAseOSGetParamsIPVersion = "IPv4"
	HTTPAseOSGetParamsIPVersionIPv6 HTTPAseOSGetParamsIPVersion = "IPv6"
)

func (HTTPAseOSGetParamsIPVersion) IsKnown

func (r HTTPAseOSGetParamsIPVersion) IsKnown() bool

type HTTPAseOSGetParamsOS

type HTTPAseOSGetParamsOS string

Operating system.

const (
	HTTPAseOSGetParamsOSWindows  HTTPAseOSGetParamsOS = "WINDOWS"
	HTTPAseOSGetParamsOSMacosx   HTTPAseOSGetParamsOS = "MACOSX"
	HTTPAseOSGetParamsOSIos      HTTPAseOSGetParamsOS = "IOS"
	HTTPAseOSGetParamsOSAndroid  HTTPAseOSGetParamsOS = "ANDROID"
	HTTPAseOSGetParamsOSChromeos HTTPAseOSGetParamsOS = "CHROMEOS"
	HTTPAseOSGetParamsOSLinux    HTTPAseOSGetParamsOS = "LINUX"
	HTTPAseOSGetParamsOSSmartTv  HTTPAseOSGetParamsOS = "SMART_TV"
)

func (HTTPAseOSGetParamsOS) IsKnown

func (r HTTPAseOSGetParamsOS) IsKnown() bool

type HTTPAseOSGetParamsTLSVersion

type HTTPAseOSGetParamsTLSVersion string
const (
	HTTPAseOSGetParamsTLSVersionTlSv1_0  HTTPAseOSGetParamsTLSVersion = "TLSv1_0"
	HTTPAseOSGetParamsTLSVersionTlSv1_1  HTTPAseOSGetParamsTLSVersion = "TLSv1_1"
	HTTPAseOSGetParamsTLSVersionTlSv1_2  HTTPAseOSGetParamsTLSVersion = "TLSv1_2"
	HTTPAseOSGetParamsTLSVersionTlSv1_3  HTTPAseOSGetParamsTLSVersion = "TLSv1_3"
	HTTPAseOSGetParamsTLSVersionTlSvQuic HTTPAseOSGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseOSGetParamsTLSVersion) IsKnown

func (r HTTPAseOSGetParamsTLSVersion) IsKnown() bool

type HTTPAseOSGetResponse

type HTTPAseOSGetResponse struct {
	Meta HTTPAseOSGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseOSGetResponseTop0 `json:"top_0,required"`
	JSON httpAseOSGetResponseJSON   `json:"-"`
}

func (*HTTPAseOSGetResponse) UnmarshalJSON

func (r *HTTPAseOSGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseOSGetResponseEnvelope

type HTTPAseOSGetResponseEnvelope struct {
	Result  HTTPAseOSGetResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    httpAseOSGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseOSGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseOSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseOSGetResponseMeta

type HTTPAseOSGetResponseMeta struct {
	DateRange      []HTTPAseOSGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                 `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseOSGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseOSGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseOSGetResponseMeta) UnmarshalJSON

func (r *HTTPAseOSGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseOSGetResponseMetaConfidenceInfo

type HTTPAseOSGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseOSGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                              `json:"level"`
	JSON        httpAseOSGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseOSGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseOSGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseOSGetResponseMetaConfidenceInfoAnnotation

type HTTPAseOSGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                               `json:"dataSource,required"`
	Description     string                                               `json:"description,required"`
	EventType       string                                               `json:"eventType,required"`
	IsInstantaneous bool                                                 `json:"isInstantaneous,required"`
	EndTime         time.Time                                            `json:"endTime" format:"date-time"`
	LinkedURL       string                                               `json:"linkedUrl"`
	StartTime       time.Time                                            `json:"startTime" format:"date-time"`
	JSON            httpAseOSGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseOSGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPAseOSGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPAseOSGetResponseMetaDateRange

type HTTPAseOSGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                             `json:"startTime,required" format:"date-time"`
	JSON      httpAseOSGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseOSGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseOSGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseOSGetResponseTop0

type HTTPAseOSGetResponseTop0 struct {
	ClientASN    int64                        `json:"clientASN,required"`
	ClientAsName string                       `json:"clientASName,required"`
	Value        string                       `json:"value,required"`
	JSON         httpAseOSGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseOSGetResponseTop0) UnmarshalJSON

func (r *HTTPAseOSGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseOSService

type HTTPAseOSService struct {
	Options []option.RequestOption
}

HTTPAseOSService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseOSService method instead.

func NewHTTPAseOSService

func NewHTTPAseOSService(opts ...option.RequestOption) (r *HTTPAseOSService)

NewHTTPAseOSService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseOSService) Get

Get the top autonomous systems, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.

type HTTPAseService

type HTTPAseService struct {
	Options       []option.RequestOption
	BotClass      *HTTPAseBotClassService
	DeviceType    *HTTPAseDeviceTypeService
	HTTPProtocol  *HTTPAseHTTPProtocolService
	HTTPMethod    *HTTPAseHTTPMethodService
	IPVersion     *HTTPAseIPVersionService
	OS            *HTTPAseOSService
	TLSVersion    *HTTPAseTLSVersionService
	BrowserFamily *HTTPAseBrowserFamilyService
}

HTTPAseService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseService method instead.

func NewHTTPAseService

func NewHTTPAseService(opts ...option.RequestOption) (r *HTTPAseService)

NewHTTPAseService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseService) Get

Get the top autonomous systems by HTTP traffic. Values are a percentage out of the total traffic.

type HTTPAseTLSVersionGetParams

type HTTPAseTLSVersionGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPAseTLSVersionGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPAseTLSVersionGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPAseTLSVersionGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPAseTLSVersionGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPAseTLSVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPAseTLSVersionGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPAseTLSVersionGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPAseTLSVersionGetParamsOS] `query:"os"`
}

func (HTTPAseTLSVersionGetParams) URLQuery

func (r HTTPAseTLSVersionGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPAseTLSVersionGetParams's query parameters as `url.Values`.

type HTTPAseTLSVersionGetParamsBotClass

type HTTPAseTLSVersionGetParamsBotClass string
const (
	HTTPAseTLSVersionGetParamsBotClassLikelyAutomated HTTPAseTLSVersionGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPAseTLSVersionGetParamsBotClassLikelyHuman     HTTPAseTLSVersionGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPAseTLSVersionGetParamsBotClass) IsKnown

type HTTPAseTLSVersionGetParamsBrowserFamily

type HTTPAseTLSVersionGetParamsBrowserFamily string
const (
	HTTPAseTLSVersionGetParamsBrowserFamilyChrome  HTTPAseTLSVersionGetParamsBrowserFamily = "CHROME"
	HTTPAseTLSVersionGetParamsBrowserFamilyEdge    HTTPAseTLSVersionGetParamsBrowserFamily = "EDGE"
	HTTPAseTLSVersionGetParamsBrowserFamilyFirefox HTTPAseTLSVersionGetParamsBrowserFamily = "FIREFOX"
	HTTPAseTLSVersionGetParamsBrowserFamilySafari  HTTPAseTLSVersionGetParamsBrowserFamily = "SAFARI"
)

func (HTTPAseTLSVersionGetParamsBrowserFamily) IsKnown

type HTTPAseTLSVersionGetParamsDeviceType

type HTTPAseTLSVersionGetParamsDeviceType string
const (
	HTTPAseTLSVersionGetParamsDeviceTypeDesktop HTTPAseTLSVersionGetParamsDeviceType = "DESKTOP"
	HTTPAseTLSVersionGetParamsDeviceTypeMobile  HTTPAseTLSVersionGetParamsDeviceType = "MOBILE"
	HTTPAseTLSVersionGetParamsDeviceTypeOther   HTTPAseTLSVersionGetParamsDeviceType = "OTHER"
)

func (HTTPAseTLSVersionGetParamsDeviceType) IsKnown

type HTTPAseTLSVersionGetParamsFormat

type HTTPAseTLSVersionGetParamsFormat string

Format results are returned in.

const (
	HTTPAseTLSVersionGetParamsFormatJson HTTPAseTLSVersionGetParamsFormat = "JSON"
	HTTPAseTLSVersionGetParamsFormatCsv  HTTPAseTLSVersionGetParamsFormat = "CSV"
)

func (HTTPAseTLSVersionGetParamsFormat) IsKnown

type HTTPAseTLSVersionGetParamsHTTPProtocol

type HTTPAseTLSVersionGetParamsHTTPProtocol string
const (
	HTTPAseTLSVersionGetParamsHTTPProtocolHTTP  HTTPAseTLSVersionGetParamsHTTPProtocol = "HTTP"
	HTTPAseTLSVersionGetParamsHTTPProtocolHTTPS HTTPAseTLSVersionGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPAseTLSVersionGetParamsHTTPProtocol) IsKnown

type HTTPAseTLSVersionGetParamsHTTPVersion

type HTTPAseTLSVersionGetParamsHTTPVersion string
const (
	HTTPAseTLSVersionGetParamsHTTPVersionHttPv1 HTTPAseTLSVersionGetParamsHTTPVersion = "HTTPv1"
	HTTPAseTLSVersionGetParamsHTTPVersionHttPv2 HTTPAseTLSVersionGetParamsHTTPVersion = "HTTPv2"
	HTTPAseTLSVersionGetParamsHTTPVersionHttPv3 HTTPAseTLSVersionGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPAseTLSVersionGetParamsHTTPVersion) IsKnown

type HTTPAseTLSVersionGetParamsIPVersion

type HTTPAseTLSVersionGetParamsIPVersion string
const (
	HTTPAseTLSVersionGetParamsIPVersionIPv4 HTTPAseTLSVersionGetParamsIPVersion = "IPv4"
	HTTPAseTLSVersionGetParamsIPVersionIPv6 HTTPAseTLSVersionGetParamsIPVersion = "IPv6"
)

func (HTTPAseTLSVersionGetParamsIPVersion) IsKnown

type HTTPAseTLSVersionGetParamsOS

type HTTPAseTLSVersionGetParamsOS string
const (
	HTTPAseTLSVersionGetParamsOSWindows  HTTPAseTLSVersionGetParamsOS = "WINDOWS"
	HTTPAseTLSVersionGetParamsOSMacosx   HTTPAseTLSVersionGetParamsOS = "MACOSX"
	HTTPAseTLSVersionGetParamsOSIos      HTTPAseTLSVersionGetParamsOS = "IOS"
	HTTPAseTLSVersionGetParamsOSAndroid  HTTPAseTLSVersionGetParamsOS = "ANDROID"
	HTTPAseTLSVersionGetParamsOSChromeos HTTPAseTLSVersionGetParamsOS = "CHROMEOS"
	HTTPAseTLSVersionGetParamsOSLinux    HTTPAseTLSVersionGetParamsOS = "LINUX"
	HTTPAseTLSVersionGetParamsOSSmartTv  HTTPAseTLSVersionGetParamsOS = "SMART_TV"
)

func (HTTPAseTLSVersionGetParamsOS) IsKnown

func (r HTTPAseTLSVersionGetParamsOS) IsKnown() bool

type HTTPAseTLSVersionGetParamsTLSVersion

type HTTPAseTLSVersionGetParamsTLSVersion string

TLS version.

const (
	HTTPAseTLSVersionGetParamsTLSVersionTlSv1_0  HTTPAseTLSVersionGetParamsTLSVersion = "TLSv1_0"
	HTTPAseTLSVersionGetParamsTLSVersionTlSv1_1  HTTPAseTLSVersionGetParamsTLSVersion = "TLSv1_1"
	HTTPAseTLSVersionGetParamsTLSVersionTlSv1_2  HTTPAseTLSVersionGetParamsTLSVersion = "TLSv1_2"
	HTTPAseTLSVersionGetParamsTLSVersionTlSv1_3  HTTPAseTLSVersionGetParamsTLSVersion = "TLSv1_3"
	HTTPAseTLSVersionGetParamsTLSVersionTlSvQuic HTTPAseTLSVersionGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPAseTLSVersionGetParamsTLSVersion) IsKnown

type HTTPAseTLSVersionGetResponse

type HTTPAseTLSVersionGetResponse struct {
	Meta HTTPAseTLSVersionGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPAseTLSVersionGetResponseTop0 `json:"top_0,required"`
	JSON httpAseTLSVersionGetResponseJSON   `json:"-"`
}

func (*HTTPAseTLSVersionGetResponse) UnmarshalJSON

func (r *HTTPAseTLSVersionGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPAseTLSVersionGetResponseEnvelope

type HTTPAseTLSVersionGetResponseEnvelope struct {
	Result  HTTPAseTLSVersionGetResponse             `json:"result,required"`
	Success bool                                     `json:"success,required"`
	JSON    httpAseTLSVersionGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPAseTLSVersionGetResponseEnvelope) UnmarshalJSON

func (r *HTTPAseTLSVersionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPAseTLSVersionGetResponseMeta

type HTTPAseTLSVersionGetResponseMeta struct {
	DateRange      []HTTPAseTLSVersionGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                         `json:"lastUpdated,required"`
	ConfidenceInfo HTTPAseTLSVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpAseTLSVersionGetResponseMetaJSON           `json:"-"`
}

func (*HTTPAseTLSVersionGetResponseMeta) UnmarshalJSON

func (r *HTTPAseTLSVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPAseTLSVersionGetResponseMetaConfidenceInfo

type HTTPAseTLSVersionGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                      `json:"level"`
	JSON        httpAseTLSVersionGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPAseTLSVersionGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPAseTLSVersionGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation

type HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                       `json:"dataSource,required"`
	Description     string                                                       `json:"description,required"`
	EventType       string                                                       `json:"eventType,required"`
	IsInstantaneous bool                                                         `json:"isInstantaneous,required"`
	EndTime         time.Time                                                    `json:"endTime" format:"date-time"`
	LinkedURL       string                                                       `json:"linkedUrl"`
	StartTime       time.Time                                                    `json:"startTime" format:"date-time"`
	JSON            httpAseTLSVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPAseTLSVersionGetResponseMetaDateRange

type HTTPAseTLSVersionGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                     `json:"startTime,required" format:"date-time"`
	JSON      httpAseTLSVersionGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPAseTLSVersionGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPAseTLSVersionGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPAseTLSVersionGetResponseTop0

type HTTPAseTLSVersionGetResponseTop0 struct {
	ClientASN    int64                                `json:"clientASN,required"`
	ClientAsName string                               `json:"clientASName,required"`
	Value        string                               `json:"value,required"`
	JSON         httpAseTLSVersionGetResponseTop0JSON `json:"-"`
}

func (*HTTPAseTLSVersionGetResponseTop0) UnmarshalJSON

func (r *HTTPAseTLSVersionGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPAseTLSVersionService

type HTTPAseTLSVersionService struct {
	Options []option.RequestOption
}

HTTPAseTLSVersionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPAseTLSVersionService method instead.

func NewHTTPAseTLSVersionService

func NewHTTPAseTLSVersionService(opts ...option.RequestOption) (r *HTTPAseTLSVersionService)

NewHTTPAseTLSVersionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPAseTLSVersionService) Get

Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.

type HTTPLocationBotClassGetParams

type HTTPLocationBotClassGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationBotClassGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationBotClassGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationBotClassGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationBotClassGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationBotClassGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationBotClassGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationBotClassGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationBotClassGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationBotClassGetParams) URLQuery

func (r HTTPLocationBotClassGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationBotClassGetParams's query parameters as `url.Values`.

type HTTPLocationBotClassGetParamsBotClass

type HTTPLocationBotClassGetParamsBotClass string

Bot class.

const (
	HTTPLocationBotClassGetParamsBotClassLikelyAutomated HTTPLocationBotClassGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationBotClassGetParamsBotClassLikelyHuman     HTTPLocationBotClassGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationBotClassGetParamsBotClass) IsKnown

type HTTPLocationBotClassGetParamsBrowserFamily

type HTTPLocationBotClassGetParamsBrowserFamily string
const (
	HTTPLocationBotClassGetParamsBrowserFamilyChrome  HTTPLocationBotClassGetParamsBrowserFamily = "CHROME"
	HTTPLocationBotClassGetParamsBrowserFamilyEdge    HTTPLocationBotClassGetParamsBrowserFamily = "EDGE"
	HTTPLocationBotClassGetParamsBrowserFamilyFirefox HTTPLocationBotClassGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationBotClassGetParamsBrowserFamilySafari  HTTPLocationBotClassGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationBotClassGetParamsBrowserFamily) IsKnown

type HTTPLocationBotClassGetParamsDeviceType

type HTTPLocationBotClassGetParamsDeviceType string
const (
	HTTPLocationBotClassGetParamsDeviceTypeDesktop HTTPLocationBotClassGetParamsDeviceType = "DESKTOP"
	HTTPLocationBotClassGetParamsDeviceTypeMobile  HTTPLocationBotClassGetParamsDeviceType = "MOBILE"
	HTTPLocationBotClassGetParamsDeviceTypeOther   HTTPLocationBotClassGetParamsDeviceType = "OTHER"
)

func (HTTPLocationBotClassGetParamsDeviceType) IsKnown

type HTTPLocationBotClassGetParamsFormat

type HTTPLocationBotClassGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationBotClassGetParamsFormatJson HTTPLocationBotClassGetParamsFormat = "JSON"
	HTTPLocationBotClassGetParamsFormatCsv  HTTPLocationBotClassGetParamsFormat = "CSV"
)

func (HTTPLocationBotClassGetParamsFormat) IsKnown

type HTTPLocationBotClassGetParamsHTTPProtocol

type HTTPLocationBotClassGetParamsHTTPProtocol string
const (
	HTTPLocationBotClassGetParamsHTTPProtocolHTTP  HTTPLocationBotClassGetParamsHTTPProtocol = "HTTP"
	HTTPLocationBotClassGetParamsHTTPProtocolHTTPS HTTPLocationBotClassGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationBotClassGetParamsHTTPProtocol) IsKnown

type HTTPLocationBotClassGetParamsHTTPVersion

type HTTPLocationBotClassGetParamsHTTPVersion string
const (
	HTTPLocationBotClassGetParamsHTTPVersionHttPv1 HTTPLocationBotClassGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationBotClassGetParamsHTTPVersionHttPv2 HTTPLocationBotClassGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationBotClassGetParamsHTTPVersionHttPv3 HTTPLocationBotClassGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationBotClassGetParamsHTTPVersion) IsKnown

type HTTPLocationBotClassGetParamsIPVersion

type HTTPLocationBotClassGetParamsIPVersion string
const (
	HTTPLocationBotClassGetParamsIPVersionIPv4 HTTPLocationBotClassGetParamsIPVersion = "IPv4"
	HTTPLocationBotClassGetParamsIPVersionIPv6 HTTPLocationBotClassGetParamsIPVersion = "IPv6"
)

func (HTTPLocationBotClassGetParamsIPVersion) IsKnown

type HTTPLocationBotClassGetParamsOS

type HTTPLocationBotClassGetParamsOS string
const (
	HTTPLocationBotClassGetParamsOSWindows  HTTPLocationBotClassGetParamsOS = "WINDOWS"
	HTTPLocationBotClassGetParamsOSMacosx   HTTPLocationBotClassGetParamsOS = "MACOSX"
	HTTPLocationBotClassGetParamsOSIos      HTTPLocationBotClassGetParamsOS = "IOS"
	HTTPLocationBotClassGetParamsOSAndroid  HTTPLocationBotClassGetParamsOS = "ANDROID"
	HTTPLocationBotClassGetParamsOSChromeos HTTPLocationBotClassGetParamsOS = "CHROMEOS"
	HTTPLocationBotClassGetParamsOSLinux    HTTPLocationBotClassGetParamsOS = "LINUX"
	HTTPLocationBotClassGetParamsOSSmartTv  HTTPLocationBotClassGetParamsOS = "SMART_TV"
)

func (HTTPLocationBotClassGetParamsOS) IsKnown

type HTTPLocationBotClassGetParamsTLSVersion

type HTTPLocationBotClassGetParamsTLSVersion string
const (
	HTTPLocationBotClassGetParamsTLSVersionTlSv1_0  HTTPLocationBotClassGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationBotClassGetParamsTLSVersionTlSv1_1  HTTPLocationBotClassGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationBotClassGetParamsTLSVersionTlSv1_2  HTTPLocationBotClassGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationBotClassGetParamsTLSVersionTlSv1_3  HTTPLocationBotClassGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationBotClassGetParamsTLSVersionTlSvQuic HTTPLocationBotClassGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationBotClassGetParamsTLSVersion) IsKnown

type HTTPLocationBotClassGetResponse

type HTTPLocationBotClassGetResponse struct {
	Meta HTTPLocationBotClassGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationBotClassGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationBotClassGetResponseJSON   `json:"-"`
}

func (*HTTPLocationBotClassGetResponse) UnmarshalJSON

func (r *HTTPLocationBotClassGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBotClassGetResponseEnvelope

type HTTPLocationBotClassGetResponseEnvelope struct {
	Result  HTTPLocationBotClassGetResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    httpLocationBotClassGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationBotClassGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationBotClassGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBotClassGetResponseMeta

type HTTPLocationBotClassGetResponseMeta struct {
	DateRange      []HTTPLocationBotClassGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationBotClassGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationBotClassGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationBotClassGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationBotClassGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBotClassGetResponseMetaConfidenceInfo

type HTTPLocationBotClassGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        httpLocationBotClassGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationBotClassGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationBotClassGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            httpLocationBotClassGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPLocationBotClassGetResponseMetaDateRange

type HTTPLocationBotClassGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      httpLocationBotClassGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationBotClassGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationBotClassGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBotClassGetResponseTop0

type HTTPLocationBotClassGetResponseTop0 struct {
	ClientCountryAlpha2 string                                  `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                  `json:"clientCountryName,required"`
	Value               string                                  `json:"value,required"`
	JSON                httpLocationBotClassGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationBotClassGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationBotClassGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBotClassService

type HTTPLocationBotClassService struct {
	Options []option.RequestOption
}

HTTPLocationBotClassService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationBotClassService method instead.

func NewHTTPLocationBotClassService

func NewHTTPLocationBotClassService(opts ...option.RequestOption) (r *HTTPLocationBotClassService)

NewHTTPLocationBotClassService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationBotClassService) Get

Get the top locations, by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a percentage out of the total traffic.

type HTTPLocationBrowserFamilyGetParams

type HTTPLocationBrowserFamilyGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationBrowserFamilyGetParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationBrowserFamilyGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationBrowserFamilyGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationBrowserFamilyGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationBrowserFamilyGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationBrowserFamilyGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationBrowserFamilyGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationBrowserFamilyGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationBrowserFamilyGetParams) URLQuery

URLQuery serializes HTTPLocationBrowserFamilyGetParams's query parameters as `url.Values`.

type HTTPLocationBrowserFamilyGetParamsBotClass

type HTTPLocationBrowserFamilyGetParamsBotClass string
const (
	HTTPLocationBrowserFamilyGetParamsBotClassLikelyAutomated HTTPLocationBrowserFamilyGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationBrowserFamilyGetParamsBotClassLikelyHuman     HTTPLocationBrowserFamilyGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationBrowserFamilyGetParamsBotClass) IsKnown

type HTTPLocationBrowserFamilyGetParamsBrowserFamily

type HTTPLocationBrowserFamilyGetParamsBrowserFamily string

Browser family.

const (
	HTTPLocationBrowserFamilyGetParamsBrowserFamilyChrome  HTTPLocationBrowserFamilyGetParamsBrowserFamily = "CHROME"
	HTTPLocationBrowserFamilyGetParamsBrowserFamilyEdge    HTTPLocationBrowserFamilyGetParamsBrowserFamily = "EDGE"
	HTTPLocationBrowserFamilyGetParamsBrowserFamilyFirefox HTTPLocationBrowserFamilyGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationBrowserFamilyGetParamsBrowserFamilySafari  HTTPLocationBrowserFamilyGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationBrowserFamilyGetParamsBrowserFamily) IsKnown

type HTTPLocationBrowserFamilyGetParamsDeviceType

type HTTPLocationBrowserFamilyGetParamsDeviceType string
const (
	HTTPLocationBrowserFamilyGetParamsDeviceTypeDesktop HTTPLocationBrowserFamilyGetParamsDeviceType = "DESKTOP"
	HTTPLocationBrowserFamilyGetParamsDeviceTypeMobile  HTTPLocationBrowserFamilyGetParamsDeviceType = "MOBILE"
	HTTPLocationBrowserFamilyGetParamsDeviceTypeOther   HTTPLocationBrowserFamilyGetParamsDeviceType = "OTHER"
)

func (HTTPLocationBrowserFamilyGetParamsDeviceType) IsKnown

type HTTPLocationBrowserFamilyGetParamsFormat

type HTTPLocationBrowserFamilyGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationBrowserFamilyGetParamsFormatJson HTTPLocationBrowserFamilyGetParamsFormat = "JSON"
	HTTPLocationBrowserFamilyGetParamsFormatCsv  HTTPLocationBrowserFamilyGetParamsFormat = "CSV"
)

func (HTTPLocationBrowserFamilyGetParamsFormat) IsKnown

type HTTPLocationBrowserFamilyGetParamsHTTPProtocol

type HTTPLocationBrowserFamilyGetParamsHTTPProtocol string
const (
	HTTPLocationBrowserFamilyGetParamsHTTPProtocolHTTP  HTTPLocationBrowserFamilyGetParamsHTTPProtocol = "HTTP"
	HTTPLocationBrowserFamilyGetParamsHTTPProtocolHTTPS HTTPLocationBrowserFamilyGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationBrowserFamilyGetParamsHTTPProtocol) IsKnown

type HTTPLocationBrowserFamilyGetParamsHTTPVersion

type HTTPLocationBrowserFamilyGetParamsHTTPVersion string
const (
	HTTPLocationBrowserFamilyGetParamsHTTPVersionHttPv1 HTTPLocationBrowserFamilyGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationBrowserFamilyGetParamsHTTPVersionHttPv2 HTTPLocationBrowserFamilyGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationBrowserFamilyGetParamsHTTPVersionHttPv3 HTTPLocationBrowserFamilyGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationBrowserFamilyGetParamsHTTPVersion) IsKnown

type HTTPLocationBrowserFamilyGetParamsIPVersion

type HTTPLocationBrowserFamilyGetParamsIPVersion string
const (
	HTTPLocationBrowserFamilyGetParamsIPVersionIPv4 HTTPLocationBrowserFamilyGetParamsIPVersion = "IPv4"
	HTTPLocationBrowserFamilyGetParamsIPVersionIPv6 HTTPLocationBrowserFamilyGetParamsIPVersion = "IPv6"
)

func (HTTPLocationBrowserFamilyGetParamsIPVersion) IsKnown

type HTTPLocationBrowserFamilyGetParamsOS

type HTTPLocationBrowserFamilyGetParamsOS string
const (
	HTTPLocationBrowserFamilyGetParamsOSWindows  HTTPLocationBrowserFamilyGetParamsOS = "WINDOWS"
	HTTPLocationBrowserFamilyGetParamsOSMacosx   HTTPLocationBrowserFamilyGetParamsOS = "MACOSX"
	HTTPLocationBrowserFamilyGetParamsOSIos      HTTPLocationBrowserFamilyGetParamsOS = "IOS"
	HTTPLocationBrowserFamilyGetParamsOSAndroid  HTTPLocationBrowserFamilyGetParamsOS = "ANDROID"
	HTTPLocationBrowserFamilyGetParamsOSChromeos HTTPLocationBrowserFamilyGetParamsOS = "CHROMEOS"
	HTTPLocationBrowserFamilyGetParamsOSLinux    HTTPLocationBrowserFamilyGetParamsOS = "LINUX"
	HTTPLocationBrowserFamilyGetParamsOSSmartTv  HTTPLocationBrowserFamilyGetParamsOS = "SMART_TV"
)

func (HTTPLocationBrowserFamilyGetParamsOS) IsKnown

type HTTPLocationBrowserFamilyGetParamsTLSVersion

type HTTPLocationBrowserFamilyGetParamsTLSVersion string
const (
	HTTPLocationBrowserFamilyGetParamsTLSVersionTlSv1_0  HTTPLocationBrowserFamilyGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationBrowserFamilyGetParamsTLSVersionTlSv1_1  HTTPLocationBrowserFamilyGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationBrowserFamilyGetParamsTLSVersionTlSv1_2  HTTPLocationBrowserFamilyGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationBrowserFamilyGetParamsTLSVersionTlSv1_3  HTTPLocationBrowserFamilyGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationBrowserFamilyGetParamsTLSVersionTlSvQuic HTTPLocationBrowserFamilyGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationBrowserFamilyGetParamsTLSVersion) IsKnown

type HTTPLocationBrowserFamilyGetResponse

type HTTPLocationBrowserFamilyGetResponse struct {
	Meta HTTPLocationBrowserFamilyGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationBrowserFamilyGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationBrowserFamilyGetResponseJSON   `json:"-"`
}

func (*HTTPLocationBrowserFamilyGetResponse) UnmarshalJSON

func (r *HTTPLocationBrowserFamilyGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBrowserFamilyGetResponseEnvelope

type HTTPLocationBrowserFamilyGetResponseEnvelope struct {
	Result  HTTPLocationBrowserFamilyGetResponse             `json:"result,required"`
	Success bool                                             `json:"success,required"`
	JSON    httpLocationBrowserFamilyGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationBrowserFamilyGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationBrowserFamilyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBrowserFamilyGetResponseMeta

type HTTPLocationBrowserFamilyGetResponseMeta struct {
	DateRange      []HTTPLocationBrowserFamilyGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                 `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationBrowserFamilyGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationBrowserFamilyGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationBrowserFamilyGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo

type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                              `json:"level"`
	JSON        httpLocationBrowserFamilyGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                               `json:"dataSource,required"`
	Description     string                                                               `json:"description,required"`
	EventType       string                                                               `json:"eventType,required"`
	IsInstantaneous bool                                                                 `json:"isInstantaneous,required"`
	EndTime         time.Time                                                            `json:"endTime" format:"date-time"`
	LinkedURL       string                                                               `json:"linkedUrl"`
	StartTime       time.Time                                                            `json:"startTime" format:"date-time"`
	JSON            httpLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPLocationBrowserFamilyGetResponseMetaDateRange

type HTTPLocationBrowserFamilyGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                             `json:"startTime,required" format:"date-time"`
	JSON      httpLocationBrowserFamilyGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationBrowserFamilyGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationBrowserFamilyGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBrowserFamilyGetResponseTop0

type HTTPLocationBrowserFamilyGetResponseTop0 struct {
	ClientCountryAlpha2 string                                       `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                       `json:"clientCountryName,required"`
	Value               string                                       `json:"value,required"`
	JSON                httpLocationBrowserFamilyGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationBrowserFamilyGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationBrowserFamilyGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationBrowserFamilyService

type HTTPLocationBrowserFamilyService struct {
	Options []option.RequestOption
}

HTTPLocationBrowserFamilyService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationBrowserFamilyService method instead.

func NewHTTPLocationBrowserFamilyService

func NewHTTPLocationBrowserFamilyService(opts ...option.RequestOption) (r *HTTPLocationBrowserFamilyService)

NewHTTPLocationBrowserFamilyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationBrowserFamilyService) Get

Get the top locations, by HTTP traffic, of the requested browser family. Values are a percentage out of the total traffic.

type HTTPLocationDeviceTypeGetParams

type HTTPLocationDeviceTypeGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationDeviceTypeGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationDeviceTypeGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[HTTPLocationDeviceTypeGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationDeviceTypeGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationDeviceTypeGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationDeviceTypeGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationDeviceTypeGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationDeviceTypeGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationDeviceTypeGetParams) URLQuery

func (r HTTPLocationDeviceTypeGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationDeviceTypeGetParams's query parameters as `url.Values`.

type HTTPLocationDeviceTypeGetParamsBotClass

type HTTPLocationDeviceTypeGetParamsBotClass string
const (
	HTTPLocationDeviceTypeGetParamsBotClassLikelyAutomated HTTPLocationDeviceTypeGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationDeviceTypeGetParamsBotClassLikelyHuman     HTTPLocationDeviceTypeGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationDeviceTypeGetParamsBotClass) IsKnown

type HTTPLocationDeviceTypeGetParamsBrowserFamily

type HTTPLocationDeviceTypeGetParamsBrowserFamily string
const (
	HTTPLocationDeviceTypeGetParamsBrowserFamilyChrome  HTTPLocationDeviceTypeGetParamsBrowserFamily = "CHROME"
	HTTPLocationDeviceTypeGetParamsBrowserFamilyEdge    HTTPLocationDeviceTypeGetParamsBrowserFamily = "EDGE"
	HTTPLocationDeviceTypeGetParamsBrowserFamilyFirefox HTTPLocationDeviceTypeGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationDeviceTypeGetParamsBrowserFamilySafari  HTTPLocationDeviceTypeGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationDeviceTypeGetParamsBrowserFamily) IsKnown

type HTTPLocationDeviceTypeGetParamsDeviceType

type HTTPLocationDeviceTypeGetParamsDeviceType string

Device type.

const (
	HTTPLocationDeviceTypeGetParamsDeviceTypeDesktop HTTPLocationDeviceTypeGetParamsDeviceType = "DESKTOP"
	HTTPLocationDeviceTypeGetParamsDeviceTypeMobile  HTTPLocationDeviceTypeGetParamsDeviceType = "MOBILE"
	HTTPLocationDeviceTypeGetParamsDeviceTypeOther   HTTPLocationDeviceTypeGetParamsDeviceType = "OTHER"
)

func (HTTPLocationDeviceTypeGetParamsDeviceType) IsKnown

type HTTPLocationDeviceTypeGetParamsFormat

type HTTPLocationDeviceTypeGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationDeviceTypeGetParamsFormatJson HTTPLocationDeviceTypeGetParamsFormat = "JSON"
	HTTPLocationDeviceTypeGetParamsFormatCsv  HTTPLocationDeviceTypeGetParamsFormat = "CSV"
)

func (HTTPLocationDeviceTypeGetParamsFormat) IsKnown

type HTTPLocationDeviceTypeGetParamsHTTPProtocol

type HTTPLocationDeviceTypeGetParamsHTTPProtocol string
const (
	HTTPLocationDeviceTypeGetParamsHTTPProtocolHTTP  HTTPLocationDeviceTypeGetParamsHTTPProtocol = "HTTP"
	HTTPLocationDeviceTypeGetParamsHTTPProtocolHTTPS HTTPLocationDeviceTypeGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationDeviceTypeGetParamsHTTPProtocol) IsKnown

type HTTPLocationDeviceTypeGetParamsHTTPVersion

type HTTPLocationDeviceTypeGetParamsHTTPVersion string
const (
	HTTPLocationDeviceTypeGetParamsHTTPVersionHttPv1 HTTPLocationDeviceTypeGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationDeviceTypeGetParamsHTTPVersionHttPv2 HTTPLocationDeviceTypeGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationDeviceTypeGetParamsHTTPVersionHttPv3 HTTPLocationDeviceTypeGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationDeviceTypeGetParamsHTTPVersion) IsKnown

type HTTPLocationDeviceTypeGetParamsIPVersion

type HTTPLocationDeviceTypeGetParamsIPVersion string
const (
	HTTPLocationDeviceTypeGetParamsIPVersionIPv4 HTTPLocationDeviceTypeGetParamsIPVersion = "IPv4"
	HTTPLocationDeviceTypeGetParamsIPVersionIPv6 HTTPLocationDeviceTypeGetParamsIPVersion = "IPv6"
)

func (HTTPLocationDeviceTypeGetParamsIPVersion) IsKnown

type HTTPLocationDeviceTypeGetParamsOS

type HTTPLocationDeviceTypeGetParamsOS string
const (
	HTTPLocationDeviceTypeGetParamsOSWindows  HTTPLocationDeviceTypeGetParamsOS = "WINDOWS"
	HTTPLocationDeviceTypeGetParamsOSMacosx   HTTPLocationDeviceTypeGetParamsOS = "MACOSX"
	HTTPLocationDeviceTypeGetParamsOSIos      HTTPLocationDeviceTypeGetParamsOS = "IOS"
	HTTPLocationDeviceTypeGetParamsOSAndroid  HTTPLocationDeviceTypeGetParamsOS = "ANDROID"
	HTTPLocationDeviceTypeGetParamsOSChromeos HTTPLocationDeviceTypeGetParamsOS = "CHROMEOS"
	HTTPLocationDeviceTypeGetParamsOSLinux    HTTPLocationDeviceTypeGetParamsOS = "LINUX"
	HTTPLocationDeviceTypeGetParamsOSSmartTv  HTTPLocationDeviceTypeGetParamsOS = "SMART_TV"
)

func (HTTPLocationDeviceTypeGetParamsOS) IsKnown

type HTTPLocationDeviceTypeGetParamsTLSVersion

type HTTPLocationDeviceTypeGetParamsTLSVersion string
const (
	HTTPLocationDeviceTypeGetParamsTLSVersionTlSv1_0  HTTPLocationDeviceTypeGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationDeviceTypeGetParamsTLSVersionTlSv1_1  HTTPLocationDeviceTypeGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationDeviceTypeGetParamsTLSVersionTlSv1_2  HTTPLocationDeviceTypeGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationDeviceTypeGetParamsTLSVersionTlSv1_3  HTTPLocationDeviceTypeGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationDeviceTypeGetParamsTLSVersionTlSvQuic HTTPLocationDeviceTypeGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationDeviceTypeGetParamsTLSVersion) IsKnown

type HTTPLocationDeviceTypeGetResponse

type HTTPLocationDeviceTypeGetResponse struct {
	Meta HTTPLocationDeviceTypeGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationDeviceTypeGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationDeviceTypeGetResponseJSON   `json:"-"`
}

func (*HTTPLocationDeviceTypeGetResponse) UnmarshalJSON

func (r *HTTPLocationDeviceTypeGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationDeviceTypeGetResponseEnvelope

type HTTPLocationDeviceTypeGetResponseEnvelope struct {
	Result  HTTPLocationDeviceTypeGetResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    httpLocationDeviceTypeGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationDeviceTypeGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationDeviceTypeGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationDeviceTypeGetResponseMeta

type HTTPLocationDeviceTypeGetResponseMeta struct {
	DateRange      []HTTPLocationDeviceTypeGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                              `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationDeviceTypeGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationDeviceTypeGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationDeviceTypeGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo

type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                           `json:"level"`
	JSON        httpLocationDeviceTypeGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                            `json:"dataSource,required"`
	Description     string                                                            `json:"description,required"`
	EventType       string                                                            `json:"eventType,required"`
	IsInstantaneous bool                                                              `json:"isInstantaneous,required"`
	EndTime         time.Time                                                         `json:"endTime" format:"date-time"`
	LinkedURL       string                                                            `json:"linkedUrl"`
	StartTime       time.Time                                                         `json:"startTime" format:"date-time"`
	JSON            httpLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPLocationDeviceTypeGetResponseMetaDateRange

type HTTPLocationDeviceTypeGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                          `json:"startTime,required" format:"date-time"`
	JSON      httpLocationDeviceTypeGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationDeviceTypeGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationDeviceTypeGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationDeviceTypeGetResponseTop0

type HTTPLocationDeviceTypeGetResponseTop0 struct {
	ClientCountryAlpha2 string                                    `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                    `json:"clientCountryName,required"`
	Value               string                                    `json:"value,required"`
	JSON                httpLocationDeviceTypeGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationDeviceTypeGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationDeviceTypeGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationDeviceTypeService

type HTTPLocationDeviceTypeService struct {
	Options []option.RequestOption
}

HTTPLocationDeviceTypeService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationDeviceTypeService method instead.

func NewHTTPLocationDeviceTypeService

func NewHTTPLocationDeviceTypeService(opts ...option.RequestOption) (r *HTTPLocationDeviceTypeService)

NewHTTPLocationDeviceTypeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationDeviceTypeService) Get

Get the top locations, by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.

type HTTPLocationGetParams

type HTTPLocationGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationGetParams) URLQuery

func (r HTTPLocationGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationGetParams's query parameters as `url.Values`.

type HTTPLocationGetParamsBotClass

type HTTPLocationGetParamsBotClass string
const (
	HTTPLocationGetParamsBotClassLikelyAutomated HTTPLocationGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationGetParamsBotClassLikelyHuman     HTTPLocationGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationGetParamsBotClass) IsKnown

func (r HTTPLocationGetParamsBotClass) IsKnown() bool

type HTTPLocationGetParamsBrowserFamily

type HTTPLocationGetParamsBrowserFamily string
const (
	HTTPLocationGetParamsBrowserFamilyChrome  HTTPLocationGetParamsBrowserFamily = "CHROME"
	HTTPLocationGetParamsBrowserFamilyEdge    HTTPLocationGetParamsBrowserFamily = "EDGE"
	HTTPLocationGetParamsBrowserFamilyFirefox HTTPLocationGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationGetParamsBrowserFamilySafari  HTTPLocationGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationGetParamsBrowserFamily) IsKnown

type HTTPLocationGetParamsDeviceType

type HTTPLocationGetParamsDeviceType string
const (
	HTTPLocationGetParamsDeviceTypeDesktop HTTPLocationGetParamsDeviceType = "DESKTOP"
	HTTPLocationGetParamsDeviceTypeMobile  HTTPLocationGetParamsDeviceType = "MOBILE"
	HTTPLocationGetParamsDeviceTypeOther   HTTPLocationGetParamsDeviceType = "OTHER"
)

func (HTTPLocationGetParamsDeviceType) IsKnown

type HTTPLocationGetParamsFormat

type HTTPLocationGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationGetParamsFormatJson HTTPLocationGetParamsFormat = "JSON"
	HTTPLocationGetParamsFormatCsv  HTTPLocationGetParamsFormat = "CSV"
)

func (HTTPLocationGetParamsFormat) IsKnown

func (r HTTPLocationGetParamsFormat) IsKnown() bool

type HTTPLocationGetParamsHTTPProtocol

type HTTPLocationGetParamsHTTPProtocol string
const (
	HTTPLocationGetParamsHTTPProtocolHTTP  HTTPLocationGetParamsHTTPProtocol = "HTTP"
	HTTPLocationGetParamsHTTPProtocolHTTPS HTTPLocationGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationGetParamsHTTPProtocol) IsKnown

type HTTPLocationGetParamsHTTPVersion

type HTTPLocationGetParamsHTTPVersion string
const (
	HTTPLocationGetParamsHTTPVersionHttPv1 HTTPLocationGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationGetParamsHTTPVersionHttPv2 HTTPLocationGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationGetParamsHTTPVersionHttPv3 HTTPLocationGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationGetParamsHTTPVersion) IsKnown

type HTTPLocationGetParamsIPVersion

type HTTPLocationGetParamsIPVersion string
const (
	HTTPLocationGetParamsIPVersionIPv4 HTTPLocationGetParamsIPVersion = "IPv4"
	HTTPLocationGetParamsIPVersionIPv6 HTTPLocationGetParamsIPVersion = "IPv6"
)

func (HTTPLocationGetParamsIPVersion) IsKnown

type HTTPLocationGetParamsOS

type HTTPLocationGetParamsOS string
const (
	HTTPLocationGetParamsOSWindows  HTTPLocationGetParamsOS = "WINDOWS"
	HTTPLocationGetParamsOSMacosx   HTTPLocationGetParamsOS = "MACOSX"
	HTTPLocationGetParamsOSIos      HTTPLocationGetParamsOS = "IOS"
	HTTPLocationGetParamsOSAndroid  HTTPLocationGetParamsOS = "ANDROID"
	HTTPLocationGetParamsOSChromeos HTTPLocationGetParamsOS = "CHROMEOS"
	HTTPLocationGetParamsOSLinux    HTTPLocationGetParamsOS = "LINUX"
	HTTPLocationGetParamsOSSmartTv  HTTPLocationGetParamsOS = "SMART_TV"
)

func (HTTPLocationGetParamsOS) IsKnown

func (r HTTPLocationGetParamsOS) IsKnown() bool

type HTTPLocationGetParamsTLSVersion

type HTTPLocationGetParamsTLSVersion string
const (
	HTTPLocationGetParamsTLSVersionTlSv1_0  HTTPLocationGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationGetParamsTLSVersionTlSv1_1  HTTPLocationGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationGetParamsTLSVersionTlSv1_2  HTTPLocationGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationGetParamsTLSVersionTlSv1_3  HTTPLocationGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationGetParamsTLSVersionTlSvQuic HTTPLocationGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationGetParamsTLSVersion) IsKnown

type HTTPLocationGetResponse

type HTTPLocationGetResponse struct {
	Meta HTTPLocationGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationGetResponseJSON   `json:"-"`
}

func (*HTTPLocationGetResponse) UnmarshalJSON

func (r *HTTPLocationGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationGetResponseEnvelope

type HTTPLocationGetResponseEnvelope struct {
	Result  HTTPLocationGetResponse             `json:"result,required"`
	Success bool                                `json:"success,required"`
	JSON    httpLocationGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationGetResponseMeta

type HTTPLocationGetResponseMeta struct {
	DateRange      []HTTPLocationGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                    `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationGetResponseMetaConfidenceInfo

type HTTPLocationGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                 `json:"level"`
	JSON        httpLocationGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                  `json:"dataSource,required"`
	Description     string                                                  `json:"description,required"`
	EventType       string                                                  `json:"eventType,required"`
	IsInstantaneous bool                                                    `json:"isInstantaneous,required"`
	EndTime         time.Time                                               `json:"endTime" format:"date-time"`
	LinkedURL       string                                                  `json:"linkedUrl"`
	StartTime       time.Time                                               `json:"startTime" format:"date-time"`
	JSON            httpLocationGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPLocationGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPLocationGetResponseMetaDateRange

type HTTPLocationGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                `json:"startTime,required" format:"date-time"`
	JSON      httpLocationGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationGetResponseTop0

type HTTPLocationGetResponseTop0 struct {
	ClientCountryAlpha2 string                          `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                          `json:"clientCountryName,required"`
	Value               string                          `json:"value,required"`
	JSON                httpLocationGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPMethodGetParams

type HTTPLocationHTTPMethodGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationHTTPMethodGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationHTTPMethodGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationHTTPMethodGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationHTTPMethodGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationHTTPMethodGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationHTTPMethodGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationHTTPMethodGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationHTTPMethodGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationHTTPMethodGetParams) URLQuery

func (r HTTPLocationHTTPMethodGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationHTTPMethodGetParams's query parameters as `url.Values`.

type HTTPLocationHTTPMethodGetParamsBotClass

type HTTPLocationHTTPMethodGetParamsBotClass string
const (
	HTTPLocationHTTPMethodGetParamsBotClassLikelyAutomated HTTPLocationHTTPMethodGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationHTTPMethodGetParamsBotClassLikelyHuman     HTTPLocationHTTPMethodGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationHTTPMethodGetParamsBotClass) IsKnown

type HTTPLocationHTTPMethodGetParamsBrowserFamily

type HTTPLocationHTTPMethodGetParamsBrowserFamily string
const (
	HTTPLocationHTTPMethodGetParamsBrowserFamilyChrome  HTTPLocationHTTPMethodGetParamsBrowserFamily = "CHROME"
	HTTPLocationHTTPMethodGetParamsBrowserFamilyEdge    HTTPLocationHTTPMethodGetParamsBrowserFamily = "EDGE"
	HTTPLocationHTTPMethodGetParamsBrowserFamilyFirefox HTTPLocationHTTPMethodGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationHTTPMethodGetParamsBrowserFamilySafari  HTTPLocationHTTPMethodGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationHTTPMethodGetParamsBrowserFamily) IsKnown

type HTTPLocationHTTPMethodGetParamsDeviceType

type HTTPLocationHTTPMethodGetParamsDeviceType string
const (
	HTTPLocationHTTPMethodGetParamsDeviceTypeDesktop HTTPLocationHTTPMethodGetParamsDeviceType = "DESKTOP"
	HTTPLocationHTTPMethodGetParamsDeviceTypeMobile  HTTPLocationHTTPMethodGetParamsDeviceType = "MOBILE"
	HTTPLocationHTTPMethodGetParamsDeviceTypeOther   HTTPLocationHTTPMethodGetParamsDeviceType = "OTHER"
)

func (HTTPLocationHTTPMethodGetParamsDeviceType) IsKnown

type HTTPLocationHTTPMethodGetParamsFormat

type HTTPLocationHTTPMethodGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationHTTPMethodGetParamsFormatJson HTTPLocationHTTPMethodGetParamsFormat = "JSON"
	HTTPLocationHTTPMethodGetParamsFormatCsv  HTTPLocationHTTPMethodGetParamsFormat = "CSV"
)

func (HTTPLocationHTTPMethodGetParamsFormat) IsKnown

type HTTPLocationHTTPMethodGetParamsHTTPProtocol

type HTTPLocationHTTPMethodGetParamsHTTPProtocol string
const (
	HTTPLocationHTTPMethodGetParamsHTTPProtocolHTTP  HTTPLocationHTTPMethodGetParamsHTTPProtocol = "HTTP"
	HTTPLocationHTTPMethodGetParamsHTTPProtocolHTTPS HTTPLocationHTTPMethodGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationHTTPMethodGetParamsHTTPProtocol) IsKnown

type HTTPLocationHTTPMethodGetParamsHTTPVersion

type HTTPLocationHTTPMethodGetParamsHTTPVersion string

HTTP version.

const (
	HTTPLocationHTTPMethodGetParamsHTTPVersionHttPv1 HTTPLocationHTTPMethodGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationHTTPMethodGetParamsHTTPVersionHttPv2 HTTPLocationHTTPMethodGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationHTTPMethodGetParamsHTTPVersionHttPv3 HTTPLocationHTTPMethodGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationHTTPMethodGetParamsHTTPVersion) IsKnown

type HTTPLocationHTTPMethodGetParamsIPVersion

type HTTPLocationHTTPMethodGetParamsIPVersion string
const (
	HTTPLocationHTTPMethodGetParamsIPVersionIPv4 HTTPLocationHTTPMethodGetParamsIPVersion = "IPv4"
	HTTPLocationHTTPMethodGetParamsIPVersionIPv6 HTTPLocationHTTPMethodGetParamsIPVersion = "IPv6"
)

func (HTTPLocationHTTPMethodGetParamsIPVersion) IsKnown

type HTTPLocationHTTPMethodGetParamsOS

type HTTPLocationHTTPMethodGetParamsOS string
const (
	HTTPLocationHTTPMethodGetParamsOSWindows  HTTPLocationHTTPMethodGetParamsOS = "WINDOWS"
	HTTPLocationHTTPMethodGetParamsOSMacosx   HTTPLocationHTTPMethodGetParamsOS = "MACOSX"
	HTTPLocationHTTPMethodGetParamsOSIos      HTTPLocationHTTPMethodGetParamsOS = "IOS"
	HTTPLocationHTTPMethodGetParamsOSAndroid  HTTPLocationHTTPMethodGetParamsOS = "ANDROID"
	HTTPLocationHTTPMethodGetParamsOSChromeos HTTPLocationHTTPMethodGetParamsOS = "CHROMEOS"
	HTTPLocationHTTPMethodGetParamsOSLinux    HTTPLocationHTTPMethodGetParamsOS = "LINUX"
	HTTPLocationHTTPMethodGetParamsOSSmartTv  HTTPLocationHTTPMethodGetParamsOS = "SMART_TV"
)

func (HTTPLocationHTTPMethodGetParamsOS) IsKnown

type HTTPLocationHTTPMethodGetParamsTLSVersion

type HTTPLocationHTTPMethodGetParamsTLSVersion string
const (
	HTTPLocationHTTPMethodGetParamsTLSVersionTlSv1_0  HTTPLocationHTTPMethodGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationHTTPMethodGetParamsTLSVersionTlSv1_1  HTTPLocationHTTPMethodGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationHTTPMethodGetParamsTLSVersionTlSv1_2  HTTPLocationHTTPMethodGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationHTTPMethodGetParamsTLSVersionTlSv1_3  HTTPLocationHTTPMethodGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationHTTPMethodGetParamsTLSVersionTlSvQuic HTTPLocationHTTPMethodGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationHTTPMethodGetParamsTLSVersion) IsKnown

type HTTPLocationHTTPMethodGetResponse

type HTTPLocationHTTPMethodGetResponse struct {
	Meta HTTPLocationHTTPMethodGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationHTTPMethodGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationHTTPMethodGetResponseJSON   `json:"-"`
}

func (*HTTPLocationHTTPMethodGetResponse) UnmarshalJSON

func (r *HTTPLocationHTTPMethodGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPMethodGetResponseEnvelope

type HTTPLocationHTTPMethodGetResponseEnvelope struct {
	Result  HTTPLocationHTTPMethodGetResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    httpLocationHTTPMethodGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationHTTPMethodGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationHTTPMethodGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPMethodGetResponseMeta

type HTTPLocationHTTPMethodGetResponseMeta struct {
	DateRange      []HTTPLocationHTTPMethodGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                              `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationHTTPMethodGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationHTTPMethodGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationHTTPMethodGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo

type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                           `json:"level"`
	JSON        httpLocationHTTPMethodGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                            `json:"dataSource,required"`
	Description     string                                                            `json:"description,required"`
	EventType       string                                                            `json:"eventType,required"`
	IsInstantaneous bool                                                              `json:"isInstantaneous,required"`
	EndTime         time.Time                                                         `json:"endTime" format:"date-time"`
	LinkedURL       string                                                            `json:"linkedUrl"`
	StartTime       time.Time                                                         `json:"startTime" format:"date-time"`
	JSON            httpLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPLocationHTTPMethodGetResponseMetaDateRange

type HTTPLocationHTTPMethodGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                          `json:"startTime,required" format:"date-time"`
	JSON      httpLocationHTTPMethodGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationHTTPMethodGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationHTTPMethodGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPMethodGetResponseTop0

type HTTPLocationHTTPMethodGetResponseTop0 struct {
	ClientCountryAlpha2 string                                    `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                    `json:"clientCountryName,required"`
	Value               string                                    `json:"value,required"`
	JSON                httpLocationHTTPMethodGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationHTTPMethodGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationHTTPMethodGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPMethodService

type HTTPLocationHTTPMethodService struct {
	Options []option.RequestOption
}

HTTPLocationHTTPMethodService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationHTTPMethodService method instead.

func NewHTTPLocationHTTPMethodService

func NewHTTPLocationHTTPMethodService(opts ...option.RequestOption) (r *HTTPLocationHTTPMethodService)

NewHTTPLocationHTTPMethodService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationHTTPMethodService) Get

Get the top locations, by HTTP traffic, of the requested HTTP version. Values are a percentage out of the total traffic.

type HTTPLocationHTTPProtocolGetParams

type HTTPLocationHTTPProtocolGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationHTTPProtocolGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationHTTPProtocolGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationHTTPProtocolGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationHTTPProtocolGetParamsFormat] `query:"format"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationHTTPProtocolGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationHTTPProtocolGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationHTTPProtocolGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationHTTPProtocolGetParams) URLQuery

func (r HTTPLocationHTTPProtocolGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationHTTPProtocolGetParams's query parameters as `url.Values`.

type HTTPLocationHTTPProtocolGetParamsBotClass

type HTTPLocationHTTPProtocolGetParamsBotClass string
const (
	HTTPLocationHTTPProtocolGetParamsBotClassLikelyAutomated HTTPLocationHTTPProtocolGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationHTTPProtocolGetParamsBotClassLikelyHuman     HTTPLocationHTTPProtocolGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationHTTPProtocolGetParamsBotClass) IsKnown

type HTTPLocationHTTPProtocolGetParamsBrowserFamily

type HTTPLocationHTTPProtocolGetParamsBrowserFamily string
const (
	HTTPLocationHTTPProtocolGetParamsBrowserFamilyChrome  HTTPLocationHTTPProtocolGetParamsBrowserFamily = "CHROME"
	HTTPLocationHTTPProtocolGetParamsBrowserFamilyEdge    HTTPLocationHTTPProtocolGetParamsBrowserFamily = "EDGE"
	HTTPLocationHTTPProtocolGetParamsBrowserFamilyFirefox HTTPLocationHTTPProtocolGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationHTTPProtocolGetParamsBrowserFamilySafari  HTTPLocationHTTPProtocolGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationHTTPProtocolGetParamsBrowserFamily) IsKnown

type HTTPLocationHTTPProtocolGetParamsDeviceType

type HTTPLocationHTTPProtocolGetParamsDeviceType string
const (
	HTTPLocationHTTPProtocolGetParamsDeviceTypeDesktop HTTPLocationHTTPProtocolGetParamsDeviceType = "DESKTOP"
	HTTPLocationHTTPProtocolGetParamsDeviceTypeMobile  HTTPLocationHTTPProtocolGetParamsDeviceType = "MOBILE"
	HTTPLocationHTTPProtocolGetParamsDeviceTypeOther   HTTPLocationHTTPProtocolGetParamsDeviceType = "OTHER"
)

func (HTTPLocationHTTPProtocolGetParamsDeviceType) IsKnown

type HTTPLocationHTTPProtocolGetParamsFormat

type HTTPLocationHTTPProtocolGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationHTTPProtocolGetParamsFormatJson HTTPLocationHTTPProtocolGetParamsFormat = "JSON"
	HTTPLocationHTTPProtocolGetParamsFormatCsv  HTTPLocationHTTPProtocolGetParamsFormat = "CSV"
)

func (HTTPLocationHTTPProtocolGetParamsFormat) IsKnown

type HTTPLocationHTTPProtocolGetParamsHTTPProtocol

type HTTPLocationHTTPProtocolGetParamsHTTPProtocol string

HTTP Protocol.

const (
	HTTPLocationHTTPProtocolGetParamsHTTPProtocolHTTP  HTTPLocationHTTPProtocolGetParamsHTTPProtocol = "HTTP"
	HTTPLocationHTTPProtocolGetParamsHTTPProtocolHTTPS HTTPLocationHTTPProtocolGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationHTTPProtocolGetParamsHTTPProtocol) IsKnown

type HTTPLocationHTTPProtocolGetParamsIPVersion

type HTTPLocationHTTPProtocolGetParamsIPVersion string
const (
	HTTPLocationHTTPProtocolGetParamsIPVersionIPv4 HTTPLocationHTTPProtocolGetParamsIPVersion = "IPv4"
	HTTPLocationHTTPProtocolGetParamsIPVersionIPv6 HTTPLocationHTTPProtocolGetParamsIPVersion = "IPv6"
)

func (HTTPLocationHTTPProtocolGetParamsIPVersion) IsKnown

type HTTPLocationHTTPProtocolGetParamsOS

type HTTPLocationHTTPProtocolGetParamsOS string
const (
	HTTPLocationHTTPProtocolGetParamsOSWindows  HTTPLocationHTTPProtocolGetParamsOS = "WINDOWS"
	HTTPLocationHTTPProtocolGetParamsOSMacosx   HTTPLocationHTTPProtocolGetParamsOS = "MACOSX"
	HTTPLocationHTTPProtocolGetParamsOSIos      HTTPLocationHTTPProtocolGetParamsOS = "IOS"
	HTTPLocationHTTPProtocolGetParamsOSAndroid  HTTPLocationHTTPProtocolGetParamsOS = "ANDROID"
	HTTPLocationHTTPProtocolGetParamsOSChromeos HTTPLocationHTTPProtocolGetParamsOS = "CHROMEOS"
	HTTPLocationHTTPProtocolGetParamsOSLinux    HTTPLocationHTTPProtocolGetParamsOS = "LINUX"
	HTTPLocationHTTPProtocolGetParamsOSSmartTv  HTTPLocationHTTPProtocolGetParamsOS = "SMART_TV"
)

func (HTTPLocationHTTPProtocolGetParamsOS) IsKnown

type HTTPLocationHTTPProtocolGetParamsTLSVersion

type HTTPLocationHTTPProtocolGetParamsTLSVersion string
const (
	HTTPLocationHTTPProtocolGetParamsTLSVersionTlSv1_0  HTTPLocationHTTPProtocolGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationHTTPProtocolGetParamsTLSVersionTlSv1_1  HTTPLocationHTTPProtocolGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationHTTPProtocolGetParamsTLSVersionTlSv1_2  HTTPLocationHTTPProtocolGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationHTTPProtocolGetParamsTLSVersionTlSv1_3  HTTPLocationHTTPProtocolGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationHTTPProtocolGetParamsTLSVersionTlSvQuic HTTPLocationHTTPProtocolGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationHTTPProtocolGetParamsTLSVersion) IsKnown

type HTTPLocationHTTPProtocolGetResponse

type HTTPLocationHTTPProtocolGetResponse struct {
	Meta HTTPLocationHTTPProtocolGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationHTTPProtocolGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationHTTPProtocolGetResponseJSON   `json:"-"`
}

func (*HTTPLocationHTTPProtocolGetResponse) UnmarshalJSON

func (r *HTTPLocationHTTPProtocolGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPProtocolGetResponseEnvelope

type HTTPLocationHTTPProtocolGetResponseEnvelope struct {
	Result  HTTPLocationHTTPProtocolGetResponse             `json:"result,required"`
	Success bool                                            `json:"success,required"`
	JSON    httpLocationHTTPProtocolGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationHTTPProtocolGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationHTTPProtocolGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPProtocolGetResponseMeta

type HTTPLocationHTTPProtocolGetResponseMeta struct {
	DateRange      []HTTPLocationHTTPProtocolGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                                `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationHTTPProtocolGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationHTTPProtocolGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationHTTPProtocolGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo

type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                             `json:"level"`
	JSON        httpLocationHTTPProtocolGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                              `json:"dataSource,required"`
	Description     string                                                              `json:"description,required"`
	EventType       string                                                              `json:"eventType,required"`
	IsInstantaneous bool                                                                `json:"isInstantaneous,required"`
	EndTime         time.Time                                                           `json:"endTime" format:"date-time"`
	LinkedURL       string                                                              `json:"linkedUrl"`
	StartTime       time.Time                                                           `json:"startTime" format:"date-time"`
	JSON            httpLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPLocationHTTPProtocolGetResponseMetaDateRange

type HTTPLocationHTTPProtocolGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                            `json:"startTime,required" format:"date-time"`
	JSON      httpLocationHTTPProtocolGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationHTTPProtocolGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationHTTPProtocolGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPProtocolGetResponseTop0

type HTTPLocationHTTPProtocolGetResponseTop0 struct {
	ClientCountryAlpha2 string                                      `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                      `json:"clientCountryName,required"`
	Value               string                                      `json:"value,required"`
	JSON                httpLocationHTTPProtocolGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationHTTPProtocolGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationHTTPProtocolGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationHTTPProtocolService

type HTTPLocationHTTPProtocolService struct {
	Options []option.RequestOption
}

HTTPLocationHTTPProtocolService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationHTTPProtocolService method instead.

func NewHTTPLocationHTTPProtocolService

func NewHTTPLocationHTTPProtocolService(opts ...option.RequestOption) (r *HTTPLocationHTTPProtocolService)

NewHTTPLocationHTTPProtocolService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationHTTPProtocolService) Get

Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.

type HTTPLocationIPVersionGetParams

type HTTPLocationIPVersionGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationIPVersionGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationIPVersionGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationIPVersionGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationIPVersionGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationIPVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationIPVersionGetParamsHTTPVersion] `query:"httpVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationIPVersionGetParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationIPVersionGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationIPVersionGetParams) URLQuery

func (r HTTPLocationIPVersionGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationIPVersionGetParams's query parameters as `url.Values`.

type HTTPLocationIPVersionGetParamsBotClass

type HTTPLocationIPVersionGetParamsBotClass string
const (
	HTTPLocationIPVersionGetParamsBotClassLikelyAutomated HTTPLocationIPVersionGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationIPVersionGetParamsBotClassLikelyHuman     HTTPLocationIPVersionGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationIPVersionGetParamsBotClass) IsKnown

type HTTPLocationIPVersionGetParamsBrowserFamily

type HTTPLocationIPVersionGetParamsBrowserFamily string
const (
	HTTPLocationIPVersionGetParamsBrowserFamilyChrome  HTTPLocationIPVersionGetParamsBrowserFamily = "CHROME"
	HTTPLocationIPVersionGetParamsBrowserFamilyEdge    HTTPLocationIPVersionGetParamsBrowserFamily = "EDGE"
	HTTPLocationIPVersionGetParamsBrowserFamilyFirefox HTTPLocationIPVersionGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationIPVersionGetParamsBrowserFamilySafari  HTTPLocationIPVersionGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationIPVersionGetParamsBrowserFamily) IsKnown

type HTTPLocationIPVersionGetParamsDeviceType

type HTTPLocationIPVersionGetParamsDeviceType string
const (
	HTTPLocationIPVersionGetParamsDeviceTypeDesktop HTTPLocationIPVersionGetParamsDeviceType = "DESKTOP"
	HTTPLocationIPVersionGetParamsDeviceTypeMobile  HTTPLocationIPVersionGetParamsDeviceType = "MOBILE"
	HTTPLocationIPVersionGetParamsDeviceTypeOther   HTTPLocationIPVersionGetParamsDeviceType = "OTHER"
)

func (HTTPLocationIPVersionGetParamsDeviceType) IsKnown

type HTTPLocationIPVersionGetParamsFormat

type HTTPLocationIPVersionGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationIPVersionGetParamsFormatJson HTTPLocationIPVersionGetParamsFormat = "JSON"
	HTTPLocationIPVersionGetParamsFormatCsv  HTTPLocationIPVersionGetParamsFormat = "CSV"
)

func (HTTPLocationIPVersionGetParamsFormat) IsKnown

type HTTPLocationIPVersionGetParamsHTTPProtocol

type HTTPLocationIPVersionGetParamsHTTPProtocol string
const (
	HTTPLocationIPVersionGetParamsHTTPProtocolHTTP  HTTPLocationIPVersionGetParamsHTTPProtocol = "HTTP"
	HTTPLocationIPVersionGetParamsHTTPProtocolHTTPS HTTPLocationIPVersionGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationIPVersionGetParamsHTTPProtocol) IsKnown

type HTTPLocationIPVersionGetParamsHTTPVersion

type HTTPLocationIPVersionGetParamsHTTPVersion string
const (
	HTTPLocationIPVersionGetParamsHTTPVersionHttPv1 HTTPLocationIPVersionGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationIPVersionGetParamsHTTPVersionHttPv2 HTTPLocationIPVersionGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationIPVersionGetParamsHTTPVersionHttPv3 HTTPLocationIPVersionGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationIPVersionGetParamsHTTPVersion) IsKnown

type HTTPLocationIPVersionGetParamsIPVersion

type HTTPLocationIPVersionGetParamsIPVersion string

IP version.

const (
	HTTPLocationIPVersionGetParamsIPVersionIPv4 HTTPLocationIPVersionGetParamsIPVersion = "IPv4"
	HTTPLocationIPVersionGetParamsIPVersionIPv6 HTTPLocationIPVersionGetParamsIPVersion = "IPv6"
)

func (HTTPLocationIPVersionGetParamsIPVersion) IsKnown

type HTTPLocationIPVersionGetParamsOS

type HTTPLocationIPVersionGetParamsOS string
const (
	HTTPLocationIPVersionGetParamsOSWindows  HTTPLocationIPVersionGetParamsOS = "WINDOWS"
	HTTPLocationIPVersionGetParamsOSMacosx   HTTPLocationIPVersionGetParamsOS = "MACOSX"
	HTTPLocationIPVersionGetParamsOSIos      HTTPLocationIPVersionGetParamsOS = "IOS"
	HTTPLocationIPVersionGetParamsOSAndroid  HTTPLocationIPVersionGetParamsOS = "ANDROID"
	HTTPLocationIPVersionGetParamsOSChromeos HTTPLocationIPVersionGetParamsOS = "CHROMEOS"
	HTTPLocationIPVersionGetParamsOSLinux    HTTPLocationIPVersionGetParamsOS = "LINUX"
	HTTPLocationIPVersionGetParamsOSSmartTv  HTTPLocationIPVersionGetParamsOS = "SMART_TV"
)

func (HTTPLocationIPVersionGetParamsOS) IsKnown

type HTTPLocationIPVersionGetParamsTLSVersion

type HTTPLocationIPVersionGetParamsTLSVersion string
const (
	HTTPLocationIPVersionGetParamsTLSVersionTlSv1_0  HTTPLocationIPVersionGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationIPVersionGetParamsTLSVersionTlSv1_1  HTTPLocationIPVersionGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationIPVersionGetParamsTLSVersionTlSv1_2  HTTPLocationIPVersionGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationIPVersionGetParamsTLSVersionTlSv1_3  HTTPLocationIPVersionGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationIPVersionGetParamsTLSVersionTlSvQuic HTTPLocationIPVersionGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationIPVersionGetParamsTLSVersion) IsKnown

type HTTPLocationIPVersionGetResponse

type HTTPLocationIPVersionGetResponse struct {
	Meta HTTPLocationIPVersionGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationIPVersionGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationIPVersionGetResponseJSON   `json:"-"`
}

func (*HTTPLocationIPVersionGetResponse) UnmarshalJSON

func (r *HTTPLocationIPVersionGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationIPVersionGetResponseEnvelope

type HTTPLocationIPVersionGetResponseEnvelope struct {
	Result  HTTPLocationIPVersionGetResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    httpLocationIPVersionGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationIPVersionGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationIPVersionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationIPVersionGetResponseMeta

type HTTPLocationIPVersionGetResponseMeta struct {
	DateRange      []HTTPLocationIPVersionGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                             `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationIPVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationIPVersionGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationIPVersionGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationIPVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationIPVersionGetResponseMetaConfidenceInfo

type HTTPLocationIPVersionGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                          `json:"level"`
	JSON        httpLocationIPVersionGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationIPVersionGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationIPVersionGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                           `json:"dataSource,required"`
	Description     string                                                           `json:"description,required"`
	EventType       string                                                           `json:"eventType,required"`
	IsInstantaneous bool                                                             `json:"isInstantaneous,required"`
	EndTime         time.Time                                                        `json:"endTime" format:"date-time"`
	LinkedURL       string                                                           `json:"linkedUrl"`
	StartTime       time.Time                                                        `json:"startTime" format:"date-time"`
	JSON            httpLocationIPVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPLocationIPVersionGetResponseMetaDateRange

type HTTPLocationIPVersionGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                         `json:"startTime,required" format:"date-time"`
	JSON      httpLocationIPVersionGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationIPVersionGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationIPVersionGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationIPVersionGetResponseTop0

type HTTPLocationIPVersionGetResponseTop0 struct {
	ClientCountryAlpha2 string                                   `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                   `json:"clientCountryName,required"`
	Value               string                                   `json:"value,required"`
	JSON                httpLocationIPVersionGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationIPVersionGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationIPVersionGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationIPVersionService

type HTTPLocationIPVersionService struct {
	Options []option.RequestOption
}

HTTPLocationIPVersionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationIPVersionService method instead.

func NewHTTPLocationIPVersionService

func NewHTTPLocationIPVersionService(opts ...option.RequestOption) (r *HTTPLocationIPVersionService)

NewHTTPLocationIPVersionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationIPVersionService) Get

Get the top locations, by HTTP traffic, of the requested IP version. Values are a percentage out of the total traffic.

type HTTPLocationOSGetParams

type HTTPLocationOSGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationOSGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationOSGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationOSGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationOSGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationOSGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationOSGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationOSGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationOSGetParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPLocationOSGetParams) URLQuery

func (r HTTPLocationOSGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationOSGetParams's query parameters as `url.Values`.

type HTTPLocationOSGetParamsBotClass

type HTTPLocationOSGetParamsBotClass string
const (
	HTTPLocationOSGetParamsBotClassLikelyAutomated HTTPLocationOSGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationOSGetParamsBotClassLikelyHuman     HTTPLocationOSGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationOSGetParamsBotClass) IsKnown

type HTTPLocationOSGetParamsBrowserFamily

type HTTPLocationOSGetParamsBrowserFamily string
const (
	HTTPLocationOSGetParamsBrowserFamilyChrome  HTTPLocationOSGetParamsBrowserFamily = "CHROME"
	HTTPLocationOSGetParamsBrowserFamilyEdge    HTTPLocationOSGetParamsBrowserFamily = "EDGE"
	HTTPLocationOSGetParamsBrowserFamilyFirefox HTTPLocationOSGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationOSGetParamsBrowserFamilySafari  HTTPLocationOSGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationOSGetParamsBrowserFamily) IsKnown

type HTTPLocationOSGetParamsDeviceType

type HTTPLocationOSGetParamsDeviceType string
const (
	HTTPLocationOSGetParamsDeviceTypeDesktop HTTPLocationOSGetParamsDeviceType = "DESKTOP"
	HTTPLocationOSGetParamsDeviceTypeMobile  HTTPLocationOSGetParamsDeviceType = "MOBILE"
	HTTPLocationOSGetParamsDeviceTypeOther   HTTPLocationOSGetParamsDeviceType = "OTHER"
)

func (HTTPLocationOSGetParamsDeviceType) IsKnown

type HTTPLocationOSGetParamsFormat

type HTTPLocationOSGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationOSGetParamsFormatJson HTTPLocationOSGetParamsFormat = "JSON"
	HTTPLocationOSGetParamsFormatCsv  HTTPLocationOSGetParamsFormat = "CSV"
)

func (HTTPLocationOSGetParamsFormat) IsKnown

func (r HTTPLocationOSGetParamsFormat) IsKnown() bool

type HTTPLocationOSGetParamsHTTPProtocol

type HTTPLocationOSGetParamsHTTPProtocol string
const (
	HTTPLocationOSGetParamsHTTPProtocolHTTP  HTTPLocationOSGetParamsHTTPProtocol = "HTTP"
	HTTPLocationOSGetParamsHTTPProtocolHTTPS HTTPLocationOSGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationOSGetParamsHTTPProtocol) IsKnown

type HTTPLocationOSGetParamsHTTPVersion

type HTTPLocationOSGetParamsHTTPVersion string
const (
	HTTPLocationOSGetParamsHTTPVersionHttPv1 HTTPLocationOSGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationOSGetParamsHTTPVersionHttPv2 HTTPLocationOSGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationOSGetParamsHTTPVersionHttPv3 HTTPLocationOSGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationOSGetParamsHTTPVersion) IsKnown

type HTTPLocationOSGetParamsIPVersion

type HTTPLocationOSGetParamsIPVersion string
const (
	HTTPLocationOSGetParamsIPVersionIPv4 HTTPLocationOSGetParamsIPVersion = "IPv4"
	HTTPLocationOSGetParamsIPVersionIPv6 HTTPLocationOSGetParamsIPVersion = "IPv6"
)

func (HTTPLocationOSGetParamsIPVersion) IsKnown

type HTTPLocationOSGetParamsOS

type HTTPLocationOSGetParamsOS string

Operating system.

const (
	HTTPLocationOSGetParamsOSWindows  HTTPLocationOSGetParamsOS = "WINDOWS"
	HTTPLocationOSGetParamsOSMacosx   HTTPLocationOSGetParamsOS = "MACOSX"
	HTTPLocationOSGetParamsOSIos      HTTPLocationOSGetParamsOS = "IOS"
	HTTPLocationOSGetParamsOSAndroid  HTTPLocationOSGetParamsOS = "ANDROID"
	HTTPLocationOSGetParamsOSChromeos HTTPLocationOSGetParamsOS = "CHROMEOS"
	HTTPLocationOSGetParamsOSLinux    HTTPLocationOSGetParamsOS = "LINUX"
	HTTPLocationOSGetParamsOSSmartTv  HTTPLocationOSGetParamsOS = "SMART_TV"
)

func (HTTPLocationOSGetParamsOS) IsKnown

func (r HTTPLocationOSGetParamsOS) IsKnown() bool

type HTTPLocationOSGetParamsTLSVersion

type HTTPLocationOSGetParamsTLSVersion string
const (
	HTTPLocationOSGetParamsTLSVersionTlSv1_0  HTTPLocationOSGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationOSGetParamsTLSVersionTlSv1_1  HTTPLocationOSGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationOSGetParamsTLSVersionTlSv1_2  HTTPLocationOSGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationOSGetParamsTLSVersionTlSv1_3  HTTPLocationOSGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationOSGetParamsTLSVersionTlSvQuic HTTPLocationOSGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationOSGetParamsTLSVersion) IsKnown

type HTTPLocationOSGetResponse

type HTTPLocationOSGetResponse struct {
	Meta HTTPLocationOSGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationOSGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationOSGetResponseJSON   `json:"-"`
}

func (*HTTPLocationOSGetResponse) UnmarshalJSON

func (r *HTTPLocationOSGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationOSGetResponseEnvelope

type HTTPLocationOSGetResponseEnvelope struct {
	Result  HTTPLocationOSGetResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    httpLocationOSGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationOSGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationOSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationOSGetResponseMeta

type HTTPLocationOSGetResponseMeta struct {
	DateRange      []HTTPLocationOSGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                      `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationOSGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationOSGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationOSGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationOSGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationOSGetResponseMetaConfidenceInfo

type HTTPLocationOSGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                   `json:"level"`
	JSON        httpLocationOSGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationOSGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationOSGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                    `json:"dataSource,required"`
	Description     string                                                    `json:"description,required"`
	EventType       string                                                    `json:"eventType,required"`
	IsInstantaneous bool                                                      `json:"isInstantaneous,required"`
	EndTime         time.Time                                                 `json:"endTime" format:"date-time"`
	LinkedURL       string                                                    `json:"linkedUrl"`
	StartTime       time.Time                                                 `json:"startTime" format:"date-time"`
	JSON            httpLocationOSGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPLocationOSGetResponseMetaDateRange

type HTTPLocationOSGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                  `json:"startTime,required" format:"date-time"`
	JSON      httpLocationOSGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationOSGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationOSGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationOSGetResponseTop0

type HTTPLocationOSGetResponseTop0 struct {
	ClientCountryAlpha2 string                            `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                            `json:"clientCountryName,required"`
	Value               string                            `json:"value,required"`
	JSON                httpLocationOSGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationOSGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationOSGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationOSService

type HTTPLocationOSService struct {
	Options []option.RequestOption
}

HTTPLocationOSService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationOSService method instead.

func NewHTTPLocationOSService

func NewHTTPLocationOSService(opts ...option.RequestOption) (r *HTTPLocationOSService)

NewHTTPLocationOSService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationOSService) Get

Get the top locations, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.

type HTTPLocationService

HTTPLocationService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationService method instead.

func NewHTTPLocationService

func NewHTTPLocationService(opts ...option.RequestOption) (r *HTTPLocationService)

NewHTTPLocationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationService) Get

Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.

type HTTPLocationTLSVersionGetParams

type HTTPLocationTLSVersionGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationTLSVersionGetParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPLocationTLSVersionGetParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationTLSVersionGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationTLSVersionGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationTLSVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationTLSVersionGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationTLSVersionGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPLocationTLSVersionGetParamsOS] `query:"os"`
}

func (HTTPLocationTLSVersionGetParams) URLQuery

func (r HTTPLocationTLSVersionGetParams) URLQuery() (v url.Values)

URLQuery serializes HTTPLocationTLSVersionGetParams's query parameters as `url.Values`.

type HTTPLocationTLSVersionGetParamsBotClass

type HTTPLocationTLSVersionGetParamsBotClass string
const (
	HTTPLocationTLSVersionGetParamsBotClassLikelyAutomated HTTPLocationTLSVersionGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationTLSVersionGetParamsBotClassLikelyHuman     HTTPLocationTLSVersionGetParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPLocationTLSVersionGetParamsBotClass) IsKnown

type HTTPLocationTLSVersionGetParamsBrowserFamily

type HTTPLocationTLSVersionGetParamsBrowserFamily string
const (
	HTTPLocationTLSVersionGetParamsBrowserFamilyChrome  HTTPLocationTLSVersionGetParamsBrowserFamily = "CHROME"
	HTTPLocationTLSVersionGetParamsBrowserFamilyEdge    HTTPLocationTLSVersionGetParamsBrowserFamily = "EDGE"
	HTTPLocationTLSVersionGetParamsBrowserFamilyFirefox HTTPLocationTLSVersionGetParamsBrowserFamily = "FIREFOX"
	HTTPLocationTLSVersionGetParamsBrowserFamilySafari  HTTPLocationTLSVersionGetParamsBrowserFamily = "SAFARI"
)

func (HTTPLocationTLSVersionGetParamsBrowserFamily) IsKnown

type HTTPLocationTLSVersionGetParamsDeviceType

type HTTPLocationTLSVersionGetParamsDeviceType string
const (
	HTTPLocationTLSVersionGetParamsDeviceTypeDesktop HTTPLocationTLSVersionGetParamsDeviceType = "DESKTOP"
	HTTPLocationTLSVersionGetParamsDeviceTypeMobile  HTTPLocationTLSVersionGetParamsDeviceType = "MOBILE"
	HTTPLocationTLSVersionGetParamsDeviceTypeOther   HTTPLocationTLSVersionGetParamsDeviceType = "OTHER"
)

func (HTTPLocationTLSVersionGetParamsDeviceType) IsKnown

type HTTPLocationTLSVersionGetParamsFormat

type HTTPLocationTLSVersionGetParamsFormat string

Format results are returned in.

const (
	HTTPLocationTLSVersionGetParamsFormatJson HTTPLocationTLSVersionGetParamsFormat = "JSON"
	HTTPLocationTLSVersionGetParamsFormatCsv  HTTPLocationTLSVersionGetParamsFormat = "CSV"
)

func (HTTPLocationTLSVersionGetParamsFormat) IsKnown

type HTTPLocationTLSVersionGetParamsHTTPProtocol

type HTTPLocationTLSVersionGetParamsHTTPProtocol string
const (
	HTTPLocationTLSVersionGetParamsHTTPProtocolHTTP  HTTPLocationTLSVersionGetParamsHTTPProtocol = "HTTP"
	HTTPLocationTLSVersionGetParamsHTTPProtocolHTTPS HTTPLocationTLSVersionGetParamsHTTPProtocol = "HTTPS"
)

func (HTTPLocationTLSVersionGetParamsHTTPProtocol) IsKnown

type HTTPLocationTLSVersionGetParamsHTTPVersion

type HTTPLocationTLSVersionGetParamsHTTPVersion string
const (
	HTTPLocationTLSVersionGetParamsHTTPVersionHttPv1 HTTPLocationTLSVersionGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationTLSVersionGetParamsHTTPVersionHttPv2 HTTPLocationTLSVersionGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationTLSVersionGetParamsHTTPVersionHttPv3 HTTPLocationTLSVersionGetParamsHTTPVersion = "HTTPv3"
)

func (HTTPLocationTLSVersionGetParamsHTTPVersion) IsKnown

type HTTPLocationTLSVersionGetParamsIPVersion

type HTTPLocationTLSVersionGetParamsIPVersion string
const (
	HTTPLocationTLSVersionGetParamsIPVersionIPv4 HTTPLocationTLSVersionGetParamsIPVersion = "IPv4"
	HTTPLocationTLSVersionGetParamsIPVersionIPv6 HTTPLocationTLSVersionGetParamsIPVersion = "IPv6"
)

func (HTTPLocationTLSVersionGetParamsIPVersion) IsKnown

type HTTPLocationTLSVersionGetParamsOS

type HTTPLocationTLSVersionGetParamsOS string
const (
	HTTPLocationTLSVersionGetParamsOSWindows  HTTPLocationTLSVersionGetParamsOS = "WINDOWS"
	HTTPLocationTLSVersionGetParamsOSMacosx   HTTPLocationTLSVersionGetParamsOS = "MACOSX"
	HTTPLocationTLSVersionGetParamsOSIos      HTTPLocationTLSVersionGetParamsOS = "IOS"
	HTTPLocationTLSVersionGetParamsOSAndroid  HTTPLocationTLSVersionGetParamsOS = "ANDROID"
	HTTPLocationTLSVersionGetParamsOSChromeos HTTPLocationTLSVersionGetParamsOS = "CHROMEOS"
	HTTPLocationTLSVersionGetParamsOSLinux    HTTPLocationTLSVersionGetParamsOS = "LINUX"
	HTTPLocationTLSVersionGetParamsOSSmartTv  HTTPLocationTLSVersionGetParamsOS = "SMART_TV"
)

func (HTTPLocationTLSVersionGetParamsOS) IsKnown

type HTTPLocationTLSVersionGetParamsTLSVersion

type HTTPLocationTLSVersionGetParamsTLSVersion string

TLS version.

const (
	HTTPLocationTLSVersionGetParamsTLSVersionTlSv1_0  HTTPLocationTLSVersionGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationTLSVersionGetParamsTLSVersionTlSv1_1  HTTPLocationTLSVersionGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationTLSVersionGetParamsTLSVersionTlSv1_2  HTTPLocationTLSVersionGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationTLSVersionGetParamsTLSVersionTlSv1_3  HTTPLocationTLSVersionGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationTLSVersionGetParamsTLSVersionTlSvQuic HTTPLocationTLSVersionGetParamsTLSVersion = "TLSvQUIC"
)

func (HTTPLocationTLSVersionGetParamsTLSVersion) IsKnown

type HTTPLocationTLSVersionGetResponse

type HTTPLocationTLSVersionGetResponse struct {
	Meta HTTPLocationTLSVersionGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationTLSVersionGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationTLSVersionGetResponseJSON   `json:"-"`
}

func (*HTTPLocationTLSVersionGetResponse) UnmarshalJSON

func (r *HTTPLocationTLSVersionGetResponse) UnmarshalJSON(data []byte) (err error)

type HTTPLocationTLSVersionGetResponseEnvelope

type HTTPLocationTLSVersionGetResponseEnvelope struct {
	Result  HTTPLocationTLSVersionGetResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    httpLocationTLSVersionGetResponseEnvelopeJSON `json:"-"`
}

func (*HTTPLocationTLSVersionGetResponseEnvelope) UnmarshalJSON

func (r *HTTPLocationTLSVersionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPLocationTLSVersionGetResponseMeta

type HTTPLocationTLSVersionGetResponseMeta struct {
	DateRange      []HTTPLocationTLSVersionGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                              `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationTLSVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationTLSVersionGetResponseMetaJSON           `json:"-"`
}

func (*HTTPLocationTLSVersionGetResponseMeta) UnmarshalJSON

func (r *HTTPLocationTLSVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPLocationTLSVersionGetResponseMetaConfidenceInfo

type HTTPLocationTLSVersionGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                           `json:"level"`
	JSON        httpLocationTLSVersionGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPLocationTLSVersionGetResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPLocationTLSVersionGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation

type HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                            `json:"dataSource,required"`
	Description     string                                                            `json:"description,required"`
	EventType       string                                                            `json:"eventType,required"`
	IsInstantaneous bool                                                              `json:"isInstantaneous,required"`
	EndTime         time.Time                                                         `json:"endTime" format:"date-time"`
	LinkedURL       string                                                            `json:"linkedUrl"`
	StartTime       time.Time                                                         `json:"startTime" format:"date-time"`
	JSON            httpLocationTLSVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPLocationTLSVersionGetResponseMetaDateRange

type HTTPLocationTLSVersionGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                          `json:"startTime,required" format:"date-time"`
	JSON      httpLocationTLSVersionGetResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPLocationTLSVersionGetResponseMetaDateRange) UnmarshalJSON

func (r *HTTPLocationTLSVersionGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPLocationTLSVersionGetResponseTop0

type HTTPLocationTLSVersionGetResponseTop0 struct {
	ClientCountryAlpha2 string                                    `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                    `json:"clientCountryName,required"`
	Value               string                                    `json:"value,required"`
	JSON                httpLocationTLSVersionGetResponseTop0JSON `json:"-"`
}

func (*HTTPLocationTLSVersionGetResponseTop0) UnmarshalJSON

func (r *HTTPLocationTLSVersionGetResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPLocationTLSVersionService

type HTTPLocationTLSVersionService struct {
	Options []option.RequestOption
}

HTTPLocationTLSVersionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPLocationTLSVersionService method instead.

func NewHTTPLocationTLSVersionService

func NewHTTPLocationTLSVersionService(opts ...option.RequestOption) (r *HTTPLocationTLSVersionService)

NewHTTPLocationTLSVersionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPLocationTLSVersionService) Get

Get the top locations, by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.

type HTTPService

type HTTPService struct {
	Options          []option.RequestOption
	Locations        *HTTPLocationService
	Ases             *HTTPAseService
	Summary          *HTTPSummaryService
	TimeseriesGroups *HTTPTimeseriesGroupService
	Top              *HTTPTopService
}

HTTPService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPService method instead.

func NewHTTPService

func NewHTTPService(opts ...option.RequestOption) (r *HTTPService)

NewHTTPService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPService) Timeseries

func (r *HTTPService) Timeseries(ctx context.Context, query HTTPTimeseriesParams, opts ...option.RequestOption) (res *HTTPTimeseriesResponse, err error)

Get HTTP requests over time.

type HTTPSummaryBotClassParams

type HTTPSummaryBotClassParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPSummaryBotClassParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryBotClassParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPSummaryBotClassParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPSummaryBotClassParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPSummaryBotClassParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPSummaryBotClassParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPSummaryBotClassParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPSummaryBotClassParams) URLQuery

func (r HTTPSummaryBotClassParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryBotClassParams's query parameters as `url.Values`.

type HTTPSummaryBotClassParamsDeviceType

type HTTPSummaryBotClassParamsDeviceType string
const (
	HTTPSummaryBotClassParamsDeviceTypeDesktop HTTPSummaryBotClassParamsDeviceType = "DESKTOP"
	HTTPSummaryBotClassParamsDeviceTypeMobile  HTTPSummaryBotClassParamsDeviceType = "MOBILE"
	HTTPSummaryBotClassParamsDeviceTypeOther   HTTPSummaryBotClassParamsDeviceType = "OTHER"
)

func (HTTPSummaryBotClassParamsDeviceType) IsKnown

type HTTPSummaryBotClassParamsFormat

type HTTPSummaryBotClassParamsFormat string

Format results are returned in.

const (
	HTTPSummaryBotClassParamsFormatJson HTTPSummaryBotClassParamsFormat = "JSON"
	HTTPSummaryBotClassParamsFormatCsv  HTTPSummaryBotClassParamsFormat = "CSV"
)

func (HTTPSummaryBotClassParamsFormat) IsKnown

type HTTPSummaryBotClassParamsHTTPProtocol

type HTTPSummaryBotClassParamsHTTPProtocol string
const (
	HTTPSummaryBotClassParamsHTTPProtocolHTTP  HTTPSummaryBotClassParamsHTTPProtocol = "HTTP"
	HTTPSummaryBotClassParamsHTTPProtocolHTTPS HTTPSummaryBotClassParamsHTTPProtocol = "HTTPS"
)

func (HTTPSummaryBotClassParamsHTTPProtocol) IsKnown

type HTTPSummaryBotClassParamsHTTPVersion

type HTTPSummaryBotClassParamsHTTPVersion string
const (
	HTTPSummaryBotClassParamsHTTPVersionHttPv1 HTTPSummaryBotClassParamsHTTPVersion = "HTTPv1"
	HTTPSummaryBotClassParamsHTTPVersionHttPv2 HTTPSummaryBotClassParamsHTTPVersion = "HTTPv2"
	HTTPSummaryBotClassParamsHTTPVersionHttPv3 HTTPSummaryBotClassParamsHTTPVersion = "HTTPv3"
)

func (HTTPSummaryBotClassParamsHTTPVersion) IsKnown

type HTTPSummaryBotClassParamsIPVersion

type HTTPSummaryBotClassParamsIPVersion string
const (
	HTTPSummaryBotClassParamsIPVersionIPv4 HTTPSummaryBotClassParamsIPVersion = "IPv4"
	HTTPSummaryBotClassParamsIPVersionIPv6 HTTPSummaryBotClassParamsIPVersion = "IPv6"
)

func (HTTPSummaryBotClassParamsIPVersion) IsKnown

type HTTPSummaryBotClassParamsOS

type HTTPSummaryBotClassParamsOS string
const (
	HTTPSummaryBotClassParamsOSWindows  HTTPSummaryBotClassParamsOS = "WINDOWS"
	HTTPSummaryBotClassParamsOSMacosx   HTTPSummaryBotClassParamsOS = "MACOSX"
	HTTPSummaryBotClassParamsOSIos      HTTPSummaryBotClassParamsOS = "IOS"
	HTTPSummaryBotClassParamsOSAndroid  HTTPSummaryBotClassParamsOS = "ANDROID"
	HTTPSummaryBotClassParamsOSChromeos HTTPSummaryBotClassParamsOS = "CHROMEOS"
	HTTPSummaryBotClassParamsOSLinux    HTTPSummaryBotClassParamsOS = "LINUX"
	HTTPSummaryBotClassParamsOSSmartTv  HTTPSummaryBotClassParamsOS = "SMART_TV"
)

func (HTTPSummaryBotClassParamsOS) IsKnown

func (r HTTPSummaryBotClassParamsOS) IsKnown() bool

type HTTPSummaryBotClassParamsTLSVersion

type HTTPSummaryBotClassParamsTLSVersion string
const (
	HTTPSummaryBotClassParamsTLSVersionTlSv1_0  HTTPSummaryBotClassParamsTLSVersion = "TLSv1_0"
	HTTPSummaryBotClassParamsTLSVersionTlSv1_1  HTTPSummaryBotClassParamsTLSVersion = "TLSv1_1"
	HTTPSummaryBotClassParamsTLSVersionTlSv1_2  HTTPSummaryBotClassParamsTLSVersion = "TLSv1_2"
	HTTPSummaryBotClassParamsTLSVersionTlSv1_3  HTTPSummaryBotClassParamsTLSVersion = "TLSv1_3"
	HTTPSummaryBotClassParamsTLSVersionTlSvQuic HTTPSummaryBotClassParamsTLSVersion = "TLSvQUIC"
)

func (HTTPSummaryBotClassParamsTLSVersion) IsKnown

type HTTPSummaryBotClassResponse

type HTTPSummaryBotClassResponse struct {
	Meta     HTTPSummaryBotClassResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryBotClassResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryBotClassResponseJSON     `json:"-"`
}

func (*HTTPSummaryBotClassResponse) UnmarshalJSON

func (r *HTTPSummaryBotClassResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryBotClassResponseEnvelope

type HTTPSummaryBotClassResponseEnvelope struct {
	Result  HTTPSummaryBotClassResponse             `json:"result,required"`
	Success bool                                    `json:"success,required"`
	JSON    httpSummaryBotClassResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryBotClassResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryBotClassResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryBotClassResponseMeta

type HTTPSummaryBotClassResponseMeta struct {
	DateRange      []HTTPSummaryBotClassResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                        `json:"lastUpdated,required"`
	Normalization  string                                        `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryBotClassResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryBotClassResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryBotClassResponseMeta) UnmarshalJSON

func (r *HTTPSummaryBotClassResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryBotClassResponseMetaConfidenceInfo

type HTTPSummaryBotClassResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                     `json:"level"`
	JSON        httpSummaryBotClassResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryBotClassResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryBotClassResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation

type HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                      `json:"dataSource,required"`
	Description     string                                                      `json:"description,required"`
	EventType       string                                                      `json:"eventType,required"`
	IsInstantaneous bool                                                        `json:"isInstantaneous,required"`
	EndTime         time.Time                                                   `json:"endTime" format:"date-time"`
	LinkedURL       string                                                      `json:"linkedUrl"`
	StartTime       time.Time                                                   `json:"startTime" format:"date-time"`
	JSON            httpSummaryBotClassResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPSummaryBotClassResponseMetaDateRange

type HTTPSummaryBotClassResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                    `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryBotClassResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryBotClassResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryBotClassResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryBotClassResponseSummary0

type HTTPSummaryBotClassResponseSummary0 struct {
	Bot   string                                  `json:"bot,required"`
	Human string                                  `json:"human,required"`
	JSON  httpSummaryBotClassResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryBotClassResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryBotClassResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryDeviceTypeParams

type HTTPSummaryDeviceTypeParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPSummaryDeviceTypeParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryDeviceTypeParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPSummaryDeviceTypeParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPSummaryDeviceTypeParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPSummaryDeviceTypeParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPSummaryDeviceTypeParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPSummaryDeviceTypeParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPSummaryDeviceTypeParams) URLQuery

func (r HTTPSummaryDeviceTypeParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryDeviceTypeParams's query parameters as `url.Values`.

type HTTPSummaryDeviceTypeParamsBotClass

type HTTPSummaryDeviceTypeParamsBotClass string
const (
	HTTPSummaryDeviceTypeParamsBotClassLikelyAutomated HTTPSummaryDeviceTypeParamsBotClass = "LIKELY_AUTOMATED"
	HTTPSummaryDeviceTypeParamsBotClassLikelyHuman     HTTPSummaryDeviceTypeParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPSummaryDeviceTypeParamsBotClass) IsKnown

type HTTPSummaryDeviceTypeParamsFormat

type HTTPSummaryDeviceTypeParamsFormat string

Format results are returned in.

const (
	HTTPSummaryDeviceTypeParamsFormatJson HTTPSummaryDeviceTypeParamsFormat = "JSON"
	HTTPSummaryDeviceTypeParamsFormatCsv  HTTPSummaryDeviceTypeParamsFormat = "CSV"
)

func (HTTPSummaryDeviceTypeParamsFormat) IsKnown

type HTTPSummaryDeviceTypeParamsHTTPProtocol

type HTTPSummaryDeviceTypeParamsHTTPProtocol string
const (
	HTTPSummaryDeviceTypeParamsHTTPProtocolHTTP  HTTPSummaryDeviceTypeParamsHTTPProtocol = "HTTP"
	HTTPSummaryDeviceTypeParamsHTTPProtocolHTTPS HTTPSummaryDeviceTypeParamsHTTPProtocol = "HTTPS"
)

func (HTTPSummaryDeviceTypeParamsHTTPProtocol) IsKnown

type HTTPSummaryDeviceTypeParamsHTTPVersion

type HTTPSummaryDeviceTypeParamsHTTPVersion string
const (
	HTTPSummaryDeviceTypeParamsHTTPVersionHttPv1 HTTPSummaryDeviceTypeParamsHTTPVersion = "HTTPv1"
	HTTPSummaryDeviceTypeParamsHTTPVersionHttPv2 HTTPSummaryDeviceTypeParamsHTTPVersion = "HTTPv2"
	HTTPSummaryDeviceTypeParamsHTTPVersionHttPv3 HTTPSummaryDeviceTypeParamsHTTPVersion = "HTTPv3"
)

func (HTTPSummaryDeviceTypeParamsHTTPVersion) IsKnown

type HTTPSummaryDeviceTypeParamsIPVersion

type HTTPSummaryDeviceTypeParamsIPVersion string
const (
	HTTPSummaryDeviceTypeParamsIPVersionIPv4 HTTPSummaryDeviceTypeParamsIPVersion = "IPv4"
	HTTPSummaryDeviceTypeParamsIPVersionIPv6 HTTPSummaryDeviceTypeParamsIPVersion = "IPv6"
)

func (HTTPSummaryDeviceTypeParamsIPVersion) IsKnown

type HTTPSummaryDeviceTypeParamsOS

type HTTPSummaryDeviceTypeParamsOS string
const (
	HTTPSummaryDeviceTypeParamsOSWindows  HTTPSummaryDeviceTypeParamsOS = "WINDOWS"
	HTTPSummaryDeviceTypeParamsOSMacosx   HTTPSummaryDeviceTypeParamsOS = "MACOSX"
	HTTPSummaryDeviceTypeParamsOSIos      HTTPSummaryDeviceTypeParamsOS = "IOS"
	HTTPSummaryDeviceTypeParamsOSAndroid  HTTPSummaryDeviceTypeParamsOS = "ANDROID"
	HTTPSummaryDeviceTypeParamsOSChromeos HTTPSummaryDeviceTypeParamsOS = "CHROMEOS"
	HTTPSummaryDeviceTypeParamsOSLinux    HTTPSummaryDeviceTypeParamsOS = "LINUX"
	HTTPSummaryDeviceTypeParamsOSSmartTv  HTTPSummaryDeviceTypeParamsOS = "SMART_TV"
)

func (HTTPSummaryDeviceTypeParamsOS) IsKnown

func (r HTTPSummaryDeviceTypeParamsOS) IsKnown() bool

type HTTPSummaryDeviceTypeParamsTLSVersion

type HTTPSummaryDeviceTypeParamsTLSVersion string
const (
	HTTPSummaryDeviceTypeParamsTLSVersionTlSv1_0  HTTPSummaryDeviceTypeParamsTLSVersion = "TLSv1_0"
	HTTPSummaryDeviceTypeParamsTLSVersionTlSv1_1  HTTPSummaryDeviceTypeParamsTLSVersion = "TLSv1_1"
	HTTPSummaryDeviceTypeParamsTLSVersionTlSv1_2  HTTPSummaryDeviceTypeParamsTLSVersion = "TLSv1_2"
	HTTPSummaryDeviceTypeParamsTLSVersionTlSv1_3  HTTPSummaryDeviceTypeParamsTLSVersion = "TLSv1_3"
	HTTPSummaryDeviceTypeParamsTLSVersionTlSvQuic HTTPSummaryDeviceTypeParamsTLSVersion = "TLSvQUIC"
)

func (HTTPSummaryDeviceTypeParamsTLSVersion) IsKnown

type HTTPSummaryDeviceTypeResponse

type HTTPSummaryDeviceTypeResponse struct {
	Meta     HTTPSummaryDeviceTypeResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryDeviceTypeResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryDeviceTypeResponseJSON     `json:"-"`
}

func (*HTTPSummaryDeviceTypeResponse) UnmarshalJSON

func (r *HTTPSummaryDeviceTypeResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryDeviceTypeResponseEnvelope

type HTTPSummaryDeviceTypeResponseEnvelope struct {
	Result  HTTPSummaryDeviceTypeResponse             `json:"result,required"`
	Success bool                                      `json:"success,required"`
	JSON    httpSummaryDeviceTypeResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryDeviceTypeResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryDeviceTypeResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryDeviceTypeResponseMeta

type HTTPSummaryDeviceTypeResponseMeta struct {
	DateRange      []HTTPSummaryDeviceTypeResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                          `json:"lastUpdated,required"`
	Normalization  string                                          `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryDeviceTypeResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryDeviceTypeResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryDeviceTypeResponseMeta) UnmarshalJSON

func (r *HTTPSummaryDeviceTypeResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryDeviceTypeResponseMetaConfidenceInfo

type HTTPSummaryDeviceTypeResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                       `json:"level"`
	JSON        httpSummaryDeviceTypeResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryDeviceTypeResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryDeviceTypeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation

type HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                        `json:"dataSource,required"`
	Description     string                                                        `json:"description,required"`
	EventType       string                                                        `json:"eventType,required"`
	IsInstantaneous bool                                                          `json:"isInstantaneous,required"`
	EndTime         time.Time                                                     `json:"endTime" format:"date-time"`
	LinkedURL       string                                                        `json:"linkedUrl"`
	StartTime       time.Time                                                     `json:"startTime" format:"date-time"`
	JSON            httpSummaryDeviceTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPSummaryDeviceTypeResponseMetaDateRange

type HTTPSummaryDeviceTypeResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                      `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryDeviceTypeResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryDeviceTypeResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryDeviceTypeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryDeviceTypeResponseSummary0

type HTTPSummaryDeviceTypeResponseSummary0 struct {
	Desktop string                                    `json:"desktop,required"`
	Mobile  string                                    `json:"mobile,required"`
	Other   string                                    `json:"other,required"`
	JSON    httpSummaryDeviceTypeResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryDeviceTypeResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryDeviceTypeResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPProtocolParams

type HTTPSummaryHTTPProtocolParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPSummaryHTTPProtocolParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPSummaryHTTPProtocolParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryHTTPProtocolParamsFormat] `query:"format"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPSummaryHTTPProtocolParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPSummaryHTTPProtocolParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPSummaryHTTPProtocolParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPSummaryHTTPProtocolParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPSummaryHTTPProtocolParams) URLQuery

func (r HTTPSummaryHTTPProtocolParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryHTTPProtocolParams's query parameters as `url.Values`.

type HTTPSummaryHTTPProtocolParamsBotClass

type HTTPSummaryHTTPProtocolParamsBotClass string
const (
	HTTPSummaryHTTPProtocolParamsBotClassLikelyAutomated HTTPSummaryHTTPProtocolParamsBotClass = "LIKELY_AUTOMATED"
	HTTPSummaryHTTPProtocolParamsBotClassLikelyHuman     HTTPSummaryHTTPProtocolParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPSummaryHTTPProtocolParamsBotClass) IsKnown

type HTTPSummaryHTTPProtocolParamsDeviceType

type HTTPSummaryHTTPProtocolParamsDeviceType string
const (
	HTTPSummaryHTTPProtocolParamsDeviceTypeDesktop HTTPSummaryHTTPProtocolParamsDeviceType = "DESKTOP"
	HTTPSummaryHTTPProtocolParamsDeviceTypeMobile  HTTPSummaryHTTPProtocolParamsDeviceType = "MOBILE"
	HTTPSummaryHTTPProtocolParamsDeviceTypeOther   HTTPSummaryHTTPProtocolParamsDeviceType = "OTHER"
)

func (HTTPSummaryHTTPProtocolParamsDeviceType) IsKnown

type HTTPSummaryHTTPProtocolParamsFormat

type HTTPSummaryHTTPProtocolParamsFormat string

Format results are returned in.

const (
	HTTPSummaryHTTPProtocolParamsFormatJson HTTPSummaryHTTPProtocolParamsFormat = "JSON"
	HTTPSummaryHTTPProtocolParamsFormatCsv  HTTPSummaryHTTPProtocolParamsFormat = "CSV"
)

func (HTTPSummaryHTTPProtocolParamsFormat) IsKnown

type HTTPSummaryHTTPProtocolParamsHTTPVersion

type HTTPSummaryHTTPProtocolParamsHTTPVersion string
const (
	HTTPSummaryHTTPProtocolParamsHTTPVersionHttPv1 HTTPSummaryHTTPProtocolParamsHTTPVersion = "HTTPv1"
	HTTPSummaryHTTPProtocolParamsHTTPVersionHttPv2 HTTPSummaryHTTPProtocolParamsHTTPVersion = "HTTPv2"
	HTTPSummaryHTTPProtocolParamsHTTPVersionHttPv3 HTTPSummaryHTTPProtocolParamsHTTPVersion = "HTTPv3"
)

func (HTTPSummaryHTTPProtocolParamsHTTPVersion) IsKnown

type HTTPSummaryHTTPProtocolParamsIPVersion

type HTTPSummaryHTTPProtocolParamsIPVersion string
const (
	HTTPSummaryHTTPProtocolParamsIPVersionIPv4 HTTPSummaryHTTPProtocolParamsIPVersion = "IPv4"
	HTTPSummaryHTTPProtocolParamsIPVersionIPv6 HTTPSummaryHTTPProtocolParamsIPVersion = "IPv6"
)

func (HTTPSummaryHTTPProtocolParamsIPVersion) IsKnown

type HTTPSummaryHTTPProtocolParamsOS

type HTTPSummaryHTTPProtocolParamsOS string
const (
	HTTPSummaryHTTPProtocolParamsOSWindows  HTTPSummaryHTTPProtocolParamsOS = "WINDOWS"
	HTTPSummaryHTTPProtocolParamsOSMacosx   HTTPSummaryHTTPProtocolParamsOS = "MACOSX"
	HTTPSummaryHTTPProtocolParamsOSIos      HTTPSummaryHTTPProtocolParamsOS = "IOS"
	HTTPSummaryHTTPProtocolParamsOSAndroid  HTTPSummaryHTTPProtocolParamsOS = "ANDROID"
	HTTPSummaryHTTPProtocolParamsOSChromeos HTTPSummaryHTTPProtocolParamsOS = "CHROMEOS"
	HTTPSummaryHTTPProtocolParamsOSLinux    HTTPSummaryHTTPProtocolParamsOS = "LINUX"
	HTTPSummaryHTTPProtocolParamsOSSmartTv  HTTPSummaryHTTPProtocolParamsOS = "SMART_TV"
)

func (HTTPSummaryHTTPProtocolParamsOS) IsKnown

type HTTPSummaryHTTPProtocolParamsTLSVersion

type HTTPSummaryHTTPProtocolParamsTLSVersion string
const (
	HTTPSummaryHTTPProtocolParamsTLSVersionTlSv1_0  HTTPSummaryHTTPProtocolParamsTLSVersion = "TLSv1_0"
	HTTPSummaryHTTPProtocolParamsTLSVersionTlSv1_1  HTTPSummaryHTTPProtocolParamsTLSVersion = "TLSv1_1"
	HTTPSummaryHTTPProtocolParamsTLSVersionTlSv1_2  HTTPSummaryHTTPProtocolParamsTLSVersion = "TLSv1_2"
	HTTPSummaryHTTPProtocolParamsTLSVersionTlSv1_3  HTTPSummaryHTTPProtocolParamsTLSVersion = "TLSv1_3"
	HTTPSummaryHTTPProtocolParamsTLSVersionTlSvQuic HTTPSummaryHTTPProtocolParamsTLSVersion = "TLSvQUIC"
)

func (HTTPSummaryHTTPProtocolParamsTLSVersion) IsKnown

type HTTPSummaryHTTPProtocolResponse

type HTTPSummaryHTTPProtocolResponse struct {
	Meta     HTTPSummaryHTTPProtocolResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryHTTPProtocolResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryHTTPProtocolResponseJSON     `json:"-"`
}

func (*HTTPSummaryHTTPProtocolResponse) UnmarshalJSON

func (r *HTTPSummaryHTTPProtocolResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPProtocolResponseEnvelope

type HTTPSummaryHTTPProtocolResponseEnvelope struct {
	Result  HTTPSummaryHTTPProtocolResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    httpSummaryHTTPProtocolResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryHTTPProtocolResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryHTTPProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPProtocolResponseMeta

type HTTPSummaryHTTPProtocolResponseMeta struct {
	DateRange      []HTTPSummaryHTTPProtocolResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                            `json:"lastUpdated,required"`
	Normalization  string                                            `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryHTTPProtocolResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryHTTPProtocolResponseMeta) UnmarshalJSON

func (r *HTTPSummaryHTTPProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo

type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        httpSummaryHTTPProtocolResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation

type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            httpSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPSummaryHTTPProtocolResponseMetaDateRange

type HTTPSummaryHTTPProtocolResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryHTTPProtocolResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryHTTPProtocolResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryHTTPProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPProtocolResponseSummary0

type HTTPSummaryHTTPProtocolResponseSummary0 struct {
	HTTP  string                                      `json:"http,required"`
	HTTPS string                                      `json:"https,required"`
	JSON  httpSummaryHTTPProtocolResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryHTTPProtocolResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryHTTPProtocolResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPVersionParams

type HTTPSummaryHTTPVersionParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPSummaryHTTPVersionParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPSummaryHTTPVersionParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryHTTPVersionParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPSummaryHTTPVersionParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPSummaryHTTPVersionParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPSummaryHTTPVersionParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPSummaryHTTPVersionParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPSummaryHTTPVersionParams) URLQuery

func (r HTTPSummaryHTTPVersionParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryHTTPVersionParams's query parameters as `url.Values`.

type HTTPSummaryHTTPVersionParamsBotClass

type HTTPSummaryHTTPVersionParamsBotClass string
const (
	HTTPSummaryHTTPVersionParamsBotClassLikelyAutomated HTTPSummaryHTTPVersionParamsBotClass = "LIKELY_AUTOMATED"
	HTTPSummaryHTTPVersionParamsBotClassLikelyHuman     HTTPSummaryHTTPVersionParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPSummaryHTTPVersionParamsBotClass) IsKnown

type HTTPSummaryHTTPVersionParamsDeviceType

type HTTPSummaryHTTPVersionParamsDeviceType string
const (
	HTTPSummaryHTTPVersionParamsDeviceTypeDesktop HTTPSummaryHTTPVersionParamsDeviceType = "DESKTOP"
	HTTPSummaryHTTPVersionParamsDeviceTypeMobile  HTTPSummaryHTTPVersionParamsDeviceType = "MOBILE"
	HTTPSummaryHTTPVersionParamsDeviceTypeOther   HTTPSummaryHTTPVersionParamsDeviceType = "OTHER"
)

func (HTTPSummaryHTTPVersionParamsDeviceType) IsKnown

type HTTPSummaryHTTPVersionParamsFormat

type HTTPSummaryHTTPVersionParamsFormat string

Format results are returned in.

const (
	HTTPSummaryHTTPVersionParamsFormatJson HTTPSummaryHTTPVersionParamsFormat = "JSON"
	HTTPSummaryHTTPVersionParamsFormatCsv  HTTPSummaryHTTPVersionParamsFormat = "CSV"
)

func (HTTPSummaryHTTPVersionParamsFormat) IsKnown

type HTTPSummaryHTTPVersionParamsHTTPProtocol

type HTTPSummaryHTTPVersionParamsHTTPProtocol string
const (
	HTTPSummaryHTTPVersionParamsHTTPProtocolHTTP  HTTPSummaryHTTPVersionParamsHTTPProtocol = "HTTP"
	HTTPSummaryHTTPVersionParamsHTTPProtocolHTTPS HTTPSummaryHTTPVersionParamsHTTPProtocol = "HTTPS"
)

func (HTTPSummaryHTTPVersionParamsHTTPProtocol) IsKnown

type HTTPSummaryHTTPVersionParamsIPVersion

type HTTPSummaryHTTPVersionParamsIPVersion string
const (
	HTTPSummaryHTTPVersionParamsIPVersionIPv4 HTTPSummaryHTTPVersionParamsIPVersion = "IPv4"
	HTTPSummaryHTTPVersionParamsIPVersionIPv6 HTTPSummaryHTTPVersionParamsIPVersion = "IPv6"
)

func (HTTPSummaryHTTPVersionParamsIPVersion) IsKnown

type HTTPSummaryHTTPVersionParamsOS

type HTTPSummaryHTTPVersionParamsOS string
const (
	HTTPSummaryHTTPVersionParamsOSWindows  HTTPSummaryHTTPVersionParamsOS = "WINDOWS"
	HTTPSummaryHTTPVersionParamsOSMacosx   HTTPSummaryHTTPVersionParamsOS = "MACOSX"
	HTTPSummaryHTTPVersionParamsOSIos      HTTPSummaryHTTPVersionParamsOS = "IOS"
	HTTPSummaryHTTPVersionParamsOSAndroid  HTTPSummaryHTTPVersionParamsOS = "ANDROID"
	HTTPSummaryHTTPVersionParamsOSChromeos HTTPSummaryHTTPVersionParamsOS = "CHROMEOS"
	HTTPSummaryHTTPVersionParamsOSLinux    HTTPSummaryHTTPVersionParamsOS = "LINUX"
	HTTPSummaryHTTPVersionParamsOSSmartTv  HTTPSummaryHTTPVersionParamsOS = "SMART_TV"
)

func (HTTPSummaryHTTPVersionParamsOS) IsKnown

type HTTPSummaryHTTPVersionParamsTLSVersion

type HTTPSummaryHTTPVersionParamsTLSVersion string
const (
	HTTPSummaryHTTPVersionParamsTLSVersionTlSv1_0  HTTPSummaryHTTPVersionParamsTLSVersion = "TLSv1_0"
	HTTPSummaryHTTPVersionParamsTLSVersionTlSv1_1  HTTPSummaryHTTPVersionParamsTLSVersion = "TLSv1_1"
	HTTPSummaryHTTPVersionParamsTLSVersionTlSv1_2  HTTPSummaryHTTPVersionParamsTLSVersion = "TLSv1_2"
	HTTPSummaryHTTPVersionParamsTLSVersionTlSv1_3  HTTPSummaryHTTPVersionParamsTLSVersion = "TLSv1_3"
	HTTPSummaryHTTPVersionParamsTLSVersionTlSvQuic HTTPSummaryHTTPVersionParamsTLSVersion = "TLSvQUIC"
)

func (HTTPSummaryHTTPVersionParamsTLSVersion) IsKnown

type HTTPSummaryHTTPVersionResponse

type HTTPSummaryHTTPVersionResponse struct {
	Meta     HTTPSummaryHTTPVersionResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryHTTPVersionResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryHTTPVersionResponseJSON     `json:"-"`
}

func (*HTTPSummaryHTTPVersionResponse) UnmarshalJSON

func (r *HTTPSummaryHTTPVersionResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPVersionResponseEnvelope

type HTTPSummaryHTTPVersionResponseEnvelope struct {
	Result  HTTPSummaryHTTPVersionResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    httpSummaryHTTPVersionResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryHTTPVersionResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryHTTPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPVersionResponseMeta

type HTTPSummaryHTTPVersionResponseMeta struct {
	DateRange      []HTTPSummaryHTTPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	Normalization  string                                           `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryHTTPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryHTTPVersionResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryHTTPVersionResponseMeta) UnmarshalJSON

func (r *HTTPSummaryHTTPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPVersionResponseMetaConfidenceInfo

type HTTPSummaryHTTPVersionResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        httpSummaryHTTPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation

type HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            httpSummaryHTTPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPSummaryHTTPVersionResponseMetaDateRange

type HTTPSummaryHTTPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryHTTPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryHTTPVersionResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryHTTPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryHTTPVersionResponseSummary0

type HTTPSummaryHTTPVersionResponseSummary0 struct {
	HTTP1X string                                     `json:"HTTP/1.x,required"`
	HTTP2  string                                     `json:"HTTP/2,required"`
	HTTP3  string                                     `json:"HTTP/3,required"`
	JSON   httpSummaryHTTPVersionResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryHTTPVersionResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryHTTPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryIPVersionParams

type HTTPSummaryIPVersionParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPSummaryIPVersionParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPSummaryIPVersionParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryIPVersionParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPSummaryIPVersionParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPSummaryIPVersionParamsHTTPVersion] `query:"httpVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPSummaryIPVersionParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPSummaryIPVersionParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPSummaryIPVersionParams) URLQuery

func (r HTTPSummaryIPVersionParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryIPVersionParams's query parameters as `url.Values`.

type HTTPSummaryIPVersionParamsBotClass

type HTTPSummaryIPVersionParamsBotClass string
const (
	HTTPSummaryIPVersionParamsBotClassLikelyAutomated HTTPSummaryIPVersionParamsBotClass = "LIKELY_AUTOMATED"
	HTTPSummaryIPVersionParamsBotClassLikelyHuman     HTTPSummaryIPVersionParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPSummaryIPVersionParamsBotClass) IsKnown

type HTTPSummaryIPVersionParamsDeviceType

type HTTPSummaryIPVersionParamsDeviceType string
const (
	HTTPSummaryIPVersionParamsDeviceTypeDesktop HTTPSummaryIPVersionParamsDeviceType = "DESKTOP"
	HTTPSummaryIPVersionParamsDeviceTypeMobile  HTTPSummaryIPVersionParamsDeviceType = "MOBILE"
	HTTPSummaryIPVersionParamsDeviceTypeOther   HTTPSummaryIPVersionParamsDeviceType = "OTHER"
)

func (HTTPSummaryIPVersionParamsDeviceType) IsKnown

type HTTPSummaryIPVersionParamsFormat

type HTTPSummaryIPVersionParamsFormat string

Format results are returned in.

const (
	HTTPSummaryIPVersionParamsFormatJson HTTPSummaryIPVersionParamsFormat = "JSON"
	HTTPSummaryIPVersionParamsFormatCsv  HTTPSummaryIPVersionParamsFormat = "CSV"
)

func (HTTPSummaryIPVersionParamsFormat) IsKnown

type HTTPSummaryIPVersionParamsHTTPProtocol

type HTTPSummaryIPVersionParamsHTTPProtocol string
const (
	HTTPSummaryIPVersionParamsHTTPProtocolHTTP  HTTPSummaryIPVersionParamsHTTPProtocol = "HTTP"
	HTTPSummaryIPVersionParamsHTTPProtocolHTTPS HTTPSummaryIPVersionParamsHTTPProtocol = "HTTPS"
)

func (HTTPSummaryIPVersionParamsHTTPProtocol) IsKnown

type HTTPSummaryIPVersionParamsHTTPVersion

type HTTPSummaryIPVersionParamsHTTPVersion string
const (
	HTTPSummaryIPVersionParamsHTTPVersionHttPv1 HTTPSummaryIPVersionParamsHTTPVersion = "HTTPv1"
	HTTPSummaryIPVersionParamsHTTPVersionHttPv2 HTTPSummaryIPVersionParamsHTTPVersion = "HTTPv2"
	HTTPSummaryIPVersionParamsHTTPVersionHttPv3 HTTPSummaryIPVersionParamsHTTPVersion = "HTTPv3"
)

func (HTTPSummaryIPVersionParamsHTTPVersion) IsKnown

type HTTPSummaryIPVersionParamsOS

type HTTPSummaryIPVersionParamsOS string
const (
	HTTPSummaryIPVersionParamsOSWindows  HTTPSummaryIPVersionParamsOS = "WINDOWS"
	HTTPSummaryIPVersionParamsOSMacosx   HTTPSummaryIPVersionParamsOS = "MACOSX"
	HTTPSummaryIPVersionParamsOSIos      HTTPSummaryIPVersionParamsOS = "IOS"
	HTTPSummaryIPVersionParamsOSAndroid  HTTPSummaryIPVersionParamsOS = "ANDROID"
	HTTPSummaryIPVersionParamsOSChromeos HTTPSummaryIPVersionParamsOS = "CHROMEOS"
	HTTPSummaryIPVersionParamsOSLinux    HTTPSummaryIPVersionParamsOS = "LINUX"
	HTTPSummaryIPVersionParamsOSSmartTv  HTTPSummaryIPVersionParamsOS = "SMART_TV"
)

func (HTTPSummaryIPVersionParamsOS) IsKnown

func (r HTTPSummaryIPVersionParamsOS) IsKnown() bool

type HTTPSummaryIPVersionParamsTLSVersion

type HTTPSummaryIPVersionParamsTLSVersion string
const (
	HTTPSummaryIPVersionParamsTLSVersionTlSv1_0  HTTPSummaryIPVersionParamsTLSVersion = "TLSv1_0"
	HTTPSummaryIPVersionParamsTLSVersionTlSv1_1  HTTPSummaryIPVersionParamsTLSVersion = "TLSv1_1"
	HTTPSummaryIPVersionParamsTLSVersionTlSv1_2  HTTPSummaryIPVersionParamsTLSVersion = "TLSv1_2"
	HTTPSummaryIPVersionParamsTLSVersionTlSv1_3  HTTPSummaryIPVersionParamsTLSVersion = "TLSv1_3"
	HTTPSummaryIPVersionParamsTLSVersionTlSvQuic HTTPSummaryIPVersionParamsTLSVersion = "TLSvQUIC"
)

func (HTTPSummaryIPVersionParamsTLSVersion) IsKnown

type HTTPSummaryIPVersionResponse

type HTTPSummaryIPVersionResponse struct {
	Meta     HTTPSummaryIPVersionResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryIPVersionResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryIPVersionResponseJSON     `json:"-"`
}

func (*HTTPSummaryIPVersionResponse) UnmarshalJSON

func (r *HTTPSummaryIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryIPVersionResponseEnvelope

type HTTPSummaryIPVersionResponseEnvelope struct {
	Result  HTTPSummaryIPVersionResponse             `json:"result,required"`
	Success bool                                     `json:"success,required"`
	JSON    httpSummaryIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryIPVersionResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryIPVersionResponseMeta

type HTTPSummaryIPVersionResponseMeta struct {
	DateRange      []HTTPSummaryIPVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                         `json:"lastUpdated,required"`
	Normalization  string                                         `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryIPVersionResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryIPVersionResponseMeta) UnmarshalJSON

func (r *HTTPSummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryIPVersionResponseMetaConfidenceInfo

type HTTPSummaryIPVersionResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                      `json:"level"`
	JSON        httpSummaryIPVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation

type HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                       `json:"dataSource,required"`
	Description     string                                                       `json:"description,required"`
	EventType       string                                                       `json:"eventType,required"`
	IsInstantaneous bool                                                         `json:"isInstantaneous,required"`
	EndTime         time.Time                                                    `json:"endTime" format:"date-time"`
	LinkedURL       string                                                       `json:"linkedUrl"`
	StartTime       time.Time                                                    `json:"startTime" format:"date-time"`
	JSON            httpSummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPSummaryIPVersionResponseMetaDateRange

type HTTPSummaryIPVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                     `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryIPVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryIPVersionResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryIPVersionResponseSummary0

type HTTPSummaryIPVersionResponseSummary0 struct {
	IPv4 string                                   `json:"IPv4,required"`
	IPv6 string                                   `json:"IPv6,required"`
	JSON httpSummaryIPVersionResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryIPVersionResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryOSParams

type HTTPSummaryOSParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPSummaryOSParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPSummaryOSParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryOSParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPSummaryOSParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPSummaryOSParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPSummaryOSParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPSummaryOSParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPSummaryOSParams) URLQuery

func (r HTTPSummaryOSParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryOSParams's query parameters as `url.Values`.

type HTTPSummaryOSParamsBotClass

type HTTPSummaryOSParamsBotClass string
const (
	HTTPSummaryOSParamsBotClassLikelyAutomated HTTPSummaryOSParamsBotClass = "LIKELY_AUTOMATED"
	HTTPSummaryOSParamsBotClassLikelyHuman     HTTPSummaryOSParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPSummaryOSParamsBotClass) IsKnown

func (r HTTPSummaryOSParamsBotClass) IsKnown() bool

type HTTPSummaryOSParamsDeviceType

type HTTPSummaryOSParamsDeviceType string
const (
	HTTPSummaryOSParamsDeviceTypeDesktop HTTPSummaryOSParamsDeviceType = "DESKTOP"
	HTTPSummaryOSParamsDeviceTypeMobile  HTTPSummaryOSParamsDeviceType = "MOBILE"
	HTTPSummaryOSParamsDeviceTypeOther   HTTPSummaryOSParamsDeviceType = "OTHER"
)

func (HTTPSummaryOSParamsDeviceType) IsKnown

func (r HTTPSummaryOSParamsDeviceType) IsKnown() bool

type HTTPSummaryOSParamsFormat

type HTTPSummaryOSParamsFormat string

Format results are returned in.

const (
	HTTPSummaryOSParamsFormatJson HTTPSummaryOSParamsFormat = "JSON"
	HTTPSummaryOSParamsFormatCsv  HTTPSummaryOSParamsFormat = "CSV"
)

func (HTTPSummaryOSParamsFormat) IsKnown

func (r HTTPSummaryOSParamsFormat) IsKnown() bool

type HTTPSummaryOSParamsHTTPProtocol

type HTTPSummaryOSParamsHTTPProtocol string
const (
	HTTPSummaryOSParamsHTTPProtocolHTTP  HTTPSummaryOSParamsHTTPProtocol = "HTTP"
	HTTPSummaryOSParamsHTTPProtocolHTTPS HTTPSummaryOSParamsHTTPProtocol = "HTTPS"
)

func (HTTPSummaryOSParamsHTTPProtocol) IsKnown

type HTTPSummaryOSParamsHTTPVersion

type HTTPSummaryOSParamsHTTPVersion string
const (
	HTTPSummaryOSParamsHTTPVersionHttPv1 HTTPSummaryOSParamsHTTPVersion = "HTTPv1"
	HTTPSummaryOSParamsHTTPVersionHttPv2 HTTPSummaryOSParamsHTTPVersion = "HTTPv2"
	HTTPSummaryOSParamsHTTPVersionHttPv3 HTTPSummaryOSParamsHTTPVersion = "HTTPv3"
)

func (HTTPSummaryOSParamsHTTPVersion) IsKnown

type HTTPSummaryOSParamsIPVersion

type HTTPSummaryOSParamsIPVersion string
const (
	HTTPSummaryOSParamsIPVersionIPv4 HTTPSummaryOSParamsIPVersion = "IPv4"
	HTTPSummaryOSParamsIPVersionIPv6 HTTPSummaryOSParamsIPVersion = "IPv6"
)

func (HTTPSummaryOSParamsIPVersion) IsKnown

func (r HTTPSummaryOSParamsIPVersion) IsKnown() bool

type HTTPSummaryOSParamsTLSVersion

type HTTPSummaryOSParamsTLSVersion string
const (
	HTTPSummaryOSParamsTLSVersionTlSv1_0  HTTPSummaryOSParamsTLSVersion = "TLSv1_0"
	HTTPSummaryOSParamsTLSVersionTlSv1_1  HTTPSummaryOSParamsTLSVersion = "TLSv1_1"
	HTTPSummaryOSParamsTLSVersionTlSv1_2  HTTPSummaryOSParamsTLSVersion = "TLSv1_2"
	HTTPSummaryOSParamsTLSVersionTlSv1_3  HTTPSummaryOSParamsTLSVersion = "TLSv1_3"
	HTTPSummaryOSParamsTLSVersionTlSvQuic HTTPSummaryOSParamsTLSVersion = "TLSvQUIC"
)

func (HTTPSummaryOSParamsTLSVersion) IsKnown

func (r HTTPSummaryOSParamsTLSVersion) IsKnown() bool

type HTTPSummaryOSResponse

type HTTPSummaryOSResponse struct {
	Meta     HTTPSummaryOSResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryOSResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryOSResponseJSON     `json:"-"`
}

func (*HTTPSummaryOSResponse) UnmarshalJSON

func (r *HTTPSummaryOSResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryOSResponseEnvelope

type HTTPSummaryOSResponseEnvelope struct {
	Result  HTTPSummaryOSResponse             `json:"result,required"`
	Success bool                              `json:"success,required"`
	JSON    httpSummaryOSResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryOSResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryOSResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryOSResponseMeta

type HTTPSummaryOSResponseMeta struct {
	DateRange      []HTTPSummaryOSResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                  `json:"lastUpdated,required"`
	Normalization  string                                  `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryOSResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryOSResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryOSResponseMeta) UnmarshalJSON

func (r *HTTPSummaryOSResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryOSResponseMetaConfidenceInfo

type HTTPSummaryOSResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryOSResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                               `json:"level"`
	JSON        httpSummaryOSResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryOSResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryOSResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryOSResponseMetaConfidenceInfoAnnotation

type HTTPSummaryOSResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                `json:"dataSource,required"`
	Description     string                                                `json:"description,required"`
	EventType       string                                                `json:"eventType,required"`
	IsInstantaneous bool                                                  `json:"isInstantaneous,required"`
	EndTime         time.Time                                             `json:"endTime" format:"date-time"`
	LinkedURL       string                                                `json:"linkedUrl"`
	StartTime       time.Time                                             `json:"startTime" format:"date-time"`
	JSON            httpSummaryOSResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryOSResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPSummaryOSResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryOSResponseMetaDateRange

type HTTPSummaryOSResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                              `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryOSResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryOSResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryOSResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryOSResponseSummary0

type HTTPSummaryOSResponseSummary0 struct {
	Android string                            `json:"ANDROID,required"`
	Ios     string                            `json:"IOS,required"`
	JSON    httpSummaryOSResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryOSResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryOSResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryPostQuantumParams

type HTTPSummaryPostQuantumParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPSummaryPostQuantumParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPSummaryPostQuantumParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryPostQuantumParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPSummaryPostQuantumParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPSummaryPostQuantumParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPSummaryPostQuantumParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPSummaryPostQuantumParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPSummaryPostQuantumParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPSummaryPostQuantumParams) URLQuery

func (r HTTPSummaryPostQuantumParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryPostQuantumParams's query parameters as `url.Values`.

type HTTPSummaryPostQuantumParamsBotClass

type HTTPSummaryPostQuantumParamsBotClass string
const (
	HTTPSummaryPostQuantumParamsBotClassLikelyAutomated HTTPSummaryPostQuantumParamsBotClass = "LIKELY_AUTOMATED"
	HTTPSummaryPostQuantumParamsBotClassLikelyHuman     HTTPSummaryPostQuantumParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPSummaryPostQuantumParamsBotClass) IsKnown

type HTTPSummaryPostQuantumParamsDeviceType

type HTTPSummaryPostQuantumParamsDeviceType string
const (
	HTTPSummaryPostQuantumParamsDeviceTypeDesktop HTTPSummaryPostQuantumParamsDeviceType = "DESKTOP"
	HTTPSummaryPostQuantumParamsDeviceTypeMobile  HTTPSummaryPostQuantumParamsDeviceType = "MOBILE"
	HTTPSummaryPostQuantumParamsDeviceTypeOther   HTTPSummaryPostQuantumParamsDeviceType = "OTHER"
)

func (HTTPSummaryPostQuantumParamsDeviceType) IsKnown

type HTTPSummaryPostQuantumParamsFormat

type HTTPSummaryPostQuantumParamsFormat string

Format results are returned in.

const (
	HTTPSummaryPostQuantumParamsFormatJson HTTPSummaryPostQuantumParamsFormat = "JSON"
	HTTPSummaryPostQuantumParamsFormatCsv  HTTPSummaryPostQuantumParamsFormat = "CSV"
)

func (HTTPSummaryPostQuantumParamsFormat) IsKnown

type HTTPSummaryPostQuantumParamsHTTPProtocol

type HTTPSummaryPostQuantumParamsHTTPProtocol string
const (
	HTTPSummaryPostQuantumParamsHTTPProtocolHTTP  HTTPSummaryPostQuantumParamsHTTPProtocol = "HTTP"
	HTTPSummaryPostQuantumParamsHTTPProtocolHTTPS HTTPSummaryPostQuantumParamsHTTPProtocol = "HTTPS"
)

func (HTTPSummaryPostQuantumParamsHTTPProtocol) IsKnown

type HTTPSummaryPostQuantumParamsHTTPVersion

type HTTPSummaryPostQuantumParamsHTTPVersion string
const (
	HTTPSummaryPostQuantumParamsHTTPVersionHttPv1 HTTPSummaryPostQuantumParamsHTTPVersion = "HTTPv1"
	HTTPSummaryPostQuantumParamsHTTPVersionHttPv2 HTTPSummaryPostQuantumParamsHTTPVersion = "HTTPv2"
	HTTPSummaryPostQuantumParamsHTTPVersionHttPv3 HTTPSummaryPostQuantumParamsHTTPVersion = "HTTPv3"
)

func (HTTPSummaryPostQuantumParamsHTTPVersion) IsKnown

type HTTPSummaryPostQuantumParamsIPVersion

type HTTPSummaryPostQuantumParamsIPVersion string
const (
	HTTPSummaryPostQuantumParamsIPVersionIPv4 HTTPSummaryPostQuantumParamsIPVersion = "IPv4"
	HTTPSummaryPostQuantumParamsIPVersionIPv6 HTTPSummaryPostQuantumParamsIPVersion = "IPv6"
)

func (HTTPSummaryPostQuantumParamsIPVersion) IsKnown

type HTTPSummaryPostQuantumParamsOS

type HTTPSummaryPostQuantumParamsOS string
const (
	HTTPSummaryPostQuantumParamsOSWindows  HTTPSummaryPostQuantumParamsOS = "WINDOWS"
	HTTPSummaryPostQuantumParamsOSMacosx   HTTPSummaryPostQuantumParamsOS = "MACOSX"
	HTTPSummaryPostQuantumParamsOSIos      HTTPSummaryPostQuantumParamsOS = "IOS"
	HTTPSummaryPostQuantumParamsOSAndroid  HTTPSummaryPostQuantumParamsOS = "ANDROID"
	HTTPSummaryPostQuantumParamsOSChromeos HTTPSummaryPostQuantumParamsOS = "CHROMEOS"
	HTTPSummaryPostQuantumParamsOSLinux    HTTPSummaryPostQuantumParamsOS = "LINUX"
	HTTPSummaryPostQuantumParamsOSSmartTv  HTTPSummaryPostQuantumParamsOS = "SMART_TV"
)

func (HTTPSummaryPostQuantumParamsOS) IsKnown

type HTTPSummaryPostQuantumParamsTLSVersion

type HTTPSummaryPostQuantumParamsTLSVersion string
const (
	HTTPSummaryPostQuantumParamsTLSVersionTlSv1_0  HTTPSummaryPostQuantumParamsTLSVersion = "TLSv1_0"
	HTTPSummaryPostQuantumParamsTLSVersionTlSv1_1  HTTPSummaryPostQuantumParamsTLSVersion = "TLSv1_1"
	HTTPSummaryPostQuantumParamsTLSVersionTlSv1_2  HTTPSummaryPostQuantumParamsTLSVersion = "TLSv1_2"
	HTTPSummaryPostQuantumParamsTLSVersionTlSv1_3  HTTPSummaryPostQuantumParamsTLSVersion = "TLSv1_3"
	HTTPSummaryPostQuantumParamsTLSVersionTlSvQuic HTTPSummaryPostQuantumParamsTLSVersion = "TLSvQUIC"
)

func (HTTPSummaryPostQuantumParamsTLSVersion) IsKnown

type HTTPSummaryPostQuantumResponse

type HTTPSummaryPostQuantumResponse struct {
	Meta     HTTPSummaryPostQuantumResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryPostQuantumResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryPostQuantumResponseJSON     `json:"-"`
}

func (*HTTPSummaryPostQuantumResponse) UnmarshalJSON

func (r *HTTPSummaryPostQuantumResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryPostQuantumResponseEnvelope

type HTTPSummaryPostQuantumResponseEnvelope struct {
	Result  HTTPSummaryPostQuantumResponse             `json:"result,required"`
	Success bool                                       `json:"success,required"`
	JSON    httpSummaryPostQuantumResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryPostQuantumResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryPostQuantumResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryPostQuantumResponseMeta

type HTTPSummaryPostQuantumResponseMeta struct {
	DateRange      []HTTPSummaryPostQuantumResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                           `json:"lastUpdated,required"`
	Normalization  string                                           `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryPostQuantumResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryPostQuantumResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryPostQuantumResponseMeta) UnmarshalJSON

func (r *HTTPSummaryPostQuantumResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryPostQuantumResponseMetaConfidenceInfo

type HTTPSummaryPostQuantumResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                        `json:"level"`
	JSON        httpSummaryPostQuantumResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryPostQuantumResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryPostQuantumResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation

type HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                         `json:"dataSource,required"`
	Description     string                                                         `json:"description,required"`
	EventType       string                                                         `json:"eventType,required"`
	IsInstantaneous bool                                                           `json:"isInstantaneous,required"`
	EndTime         time.Time                                                      `json:"endTime" format:"date-time"`
	LinkedURL       string                                                         `json:"linkedUrl"`
	StartTime       time.Time                                                      `json:"startTime" format:"date-time"`
	JSON            httpSummaryPostQuantumResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPSummaryPostQuantumResponseMetaDateRange

type HTTPSummaryPostQuantumResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                       `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryPostQuantumResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryPostQuantumResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryPostQuantumResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryPostQuantumResponseSummary0

type HTTPSummaryPostQuantumResponseSummary0 struct {
	NotSupported string                                     `json:"NOT_SUPPORTED,required"`
	Supported    string                                     `json:"SUPPORTED,required"`
	JSON         httpSummaryPostQuantumResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryPostQuantumResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryPostQuantumResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryService

type HTTPSummaryService struct {
	Options []option.RequestOption
}

HTTPSummaryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPSummaryService method instead.

func NewHTTPSummaryService

func NewHTTPSummaryService(opts ...option.RequestOption) (r *HTTPSummaryService)

NewHTTPSummaryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPSummaryService) BotClass

Percentage distribution of bot-generated traffic to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.

func (*HTTPSummaryService) DeviceType

Percentage of Internet traffic generated by mobile, desktop, and other types of devices over a given time period.

func (*HTTPSummaryService) HTTPProtocol

Percentage distribution of traffic by HTTP protocol over a given time period.

func (*HTTPSummaryService) HTTPVersion

Percentage distribution of traffic by HTTP version over a given time period.

func (*HTTPSummaryService) IPVersion

Percentage distribution of Internet traffic based on IP versions (IPv4 and IPv6) over a given time period.

func (*HTTPSummaryService) OS

Percentage distribution of Internet traffic generated by different operating systems like Windows, macOS, Android, iOS, and others, over a given time period.

func (*HTTPSummaryService) PostQuantum

Percentage distribution of traffic by post-quantum support over a given time period.

func (*HTTPSummaryService) TLSVersion

Percentage distribution of traffic by TLS protocol version, over a given time period.

type HTTPSummaryTLSVersionParams

type HTTPSummaryTLSVersionParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPSummaryTLSVersionParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPSummaryTLSVersionParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPSummaryTLSVersionParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPSummaryTLSVersionParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPSummaryTLSVersionParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPSummaryTLSVersionParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPSummaryTLSVersionParamsOS] `query:"os"`
}

func (HTTPSummaryTLSVersionParams) URLQuery

func (r HTTPSummaryTLSVersionParams) URLQuery() (v url.Values)

URLQuery serializes HTTPSummaryTLSVersionParams's query parameters as `url.Values`.

type HTTPSummaryTLSVersionParamsBotClass

type HTTPSummaryTLSVersionParamsBotClass string
const (
	HTTPSummaryTLSVersionParamsBotClassLikelyAutomated HTTPSummaryTLSVersionParamsBotClass = "LIKELY_AUTOMATED"
	HTTPSummaryTLSVersionParamsBotClassLikelyHuman     HTTPSummaryTLSVersionParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPSummaryTLSVersionParamsBotClass) IsKnown

type HTTPSummaryTLSVersionParamsDeviceType

type HTTPSummaryTLSVersionParamsDeviceType string
const (
	HTTPSummaryTLSVersionParamsDeviceTypeDesktop HTTPSummaryTLSVersionParamsDeviceType = "DESKTOP"
	HTTPSummaryTLSVersionParamsDeviceTypeMobile  HTTPSummaryTLSVersionParamsDeviceType = "MOBILE"
	HTTPSummaryTLSVersionParamsDeviceTypeOther   HTTPSummaryTLSVersionParamsDeviceType = "OTHER"
)

func (HTTPSummaryTLSVersionParamsDeviceType) IsKnown

type HTTPSummaryTLSVersionParamsFormat

type HTTPSummaryTLSVersionParamsFormat string

Format results are returned in.

const (
	HTTPSummaryTLSVersionParamsFormatJson HTTPSummaryTLSVersionParamsFormat = "JSON"
	HTTPSummaryTLSVersionParamsFormatCsv  HTTPSummaryTLSVersionParamsFormat = "CSV"
)

func (HTTPSummaryTLSVersionParamsFormat) IsKnown

type HTTPSummaryTLSVersionParamsHTTPProtocol

type HTTPSummaryTLSVersionParamsHTTPProtocol string
const (
	HTTPSummaryTLSVersionParamsHTTPProtocolHTTP  HTTPSummaryTLSVersionParamsHTTPProtocol = "HTTP"
	HTTPSummaryTLSVersionParamsHTTPProtocolHTTPS HTTPSummaryTLSVersionParamsHTTPProtocol = "HTTPS"
)

func (HTTPSummaryTLSVersionParamsHTTPProtocol) IsKnown

type HTTPSummaryTLSVersionParamsHTTPVersion

type HTTPSummaryTLSVersionParamsHTTPVersion string
const (
	HTTPSummaryTLSVersionParamsHTTPVersionHttPv1 HTTPSummaryTLSVersionParamsHTTPVersion = "HTTPv1"
	HTTPSummaryTLSVersionParamsHTTPVersionHttPv2 HTTPSummaryTLSVersionParamsHTTPVersion = "HTTPv2"
	HTTPSummaryTLSVersionParamsHTTPVersionHttPv3 HTTPSummaryTLSVersionParamsHTTPVersion = "HTTPv3"
)

func (HTTPSummaryTLSVersionParamsHTTPVersion) IsKnown

type HTTPSummaryTLSVersionParamsIPVersion

type HTTPSummaryTLSVersionParamsIPVersion string
const (
	HTTPSummaryTLSVersionParamsIPVersionIPv4 HTTPSummaryTLSVersionParamsIPVersion = "IPv4"
	HTTPSummaryTLSVersionParamsIPVersionIPv6 HTTPSummaryTLSVersionParamsIPVersion = "IPv6"
)

func (HTTPSummaryTLSVersionParamsIPVersion) IsKnown

type HTTPSummaryTLSVersionParamsOS

type HTTPSummaryTLSVersionParamsOS string
const (
	HTTPSummaryTLSVersionParamsOSWindows  HTTPSummaryTLSVersionParamsOS = "WINDOWS"
	HTTPSummaryTLSVersionParamsOSMacosx   HTTPSummaryTLSVersionParamsOS = "MACOSX"
	HTTPSummaryTLSVersionParamsOSIos      HTTPSummaryTLSVersionParamsOS = "IOS"
	HTTPSummaryTLSVersionParamsOSAndroid  HTTPSummaryTLSVersionParamsOS = "ANDROID"
	HTTPSummaryTLSVersionParamsOSChromeos HTTPSummaryTLSVersionParamsOS = "CHROMEOS"
	HTTPSummaryTLSVersionParamsOSLinux    HTTPSummaryTLSVersionParamsOS = "LINUX"
	HTTPSummaryTLSVersionParamsOSSmartTv  HTTPSummaryTLSVersionParamsOS = "SMART_TV"
)

func (HTTPSummaryTLSVersionParamsOS) IsKnown

func (r HTTPSummaryTLSVersionParamsOS) IsKnown() bool

type HTTPSummaryTLSVersionResponse

type HTTPSummaryTLSVersionResponse struct {
	Meta     HTTPSummaryTLSVersionResponseMeta     `json:"meta,required"`
	Summary0 HTTPSummaryTLSVersionResponseSummary0 `json:"summary_0,required"`
	JSON     httpSummaryTLSVersionResponseJSON     `json:"-"`
}

func (*HTTPSummaryTLSVersionResponse) UnmarshalJSON

func (r *HTTPSummaryTLSVersionResponse) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryTLSVersionResponseEnvelope

type HTTPSummaryTLSVersionResponseEnvelope struct {
	Result  HTTPSummaryTLSVersionResponse             `json:"result,required"`
	Success bool                                      `json:"success,required"`
	JSON    httpSummaryTLSVersionResponseEnvelopeJSON `json:"-"`
}

func (*HTTPSummaryTLSVersionResponseEnvelope) UnmarshalJSON

func (r *HTTPSummaryTLSVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryTLSVersionResponseMeta

type HTTPSummaryTLSVersionResponseMeta struct {
	DateRange      []HTTPSummaryTLSVersionResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                          `json:"lastUpdated,required"`
	Normalization  string                                          `json:"normalization,required"`
	ConfidenceInfo HTTPSummaryTLSVersionResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpSummaryTLSVersionResponseMetaJSON           `json:"-"`
}

func (*HTTPSummaryTLSVersionResponseMeta) UnmarshalJSON

func (r *HTTPSummaryTLSVersionResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryTLSVersionResponseMetaConfidenceInfo

type HTTPSummaryTLSVersionResponseMetaConfidenceInfo struct {
	Annotations []HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                       `json:"level"`
	JSON        httpSummaryTLSVersionResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPSummaryTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPSummaryTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation

type HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                        `json:"dataSource,required"`
	Description     string                                                        `json:"description,required"`
	EventType       string                                                        `json:"eventType,required"`
	IsInstantaneous bool                                                          `json:"isInstantaneous,required"`
	EndTime         time.Time                                                     `json:"endTime" format:"date-time"`
	LinkedURL       string                                                        `json:"linkedUrl"`
	StartTime       time.Time                                                     `json:"startTime" format:"date-time"`
	JSON            httpSummaryTLSVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPSummaryTLSVersionResponseMetaDateRange

type HTTPSummaryTLSVersionResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                      `json:"startTime,required" format:"date-time"`
	JSON      httpSummaryTLSVersionResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPSummaryTLSVersionResponseMetaDateRange) UnmarshalJSON

func (r *HTTPSummaryTLSVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPSummaryTLSVersionResponseSummary0

type HTTPSummaryTLSVersionResponseSummary0 struct {
	TLS1_0  string                                    `json:"TLS 1.0,required"`
	TLS1_1  string                                    `json:"TLS 1.1,required"`
	TLS1_2  string                                    `json:"TLS 1.2,required"`
	TLS1_3  string                                    `json:"TLS 1.3,required"`
	TLSQuic string                                    `json:"TLS QUIC,required"`
	JSON    httpSummaryTLSVersionResponseSummary0JSON `json:"-"`
}

func (*HTTPSummaryTLSVersionResponseSummary0) UnmarshalJSON

func (r *HTTPSummaryTLSVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBotClassParams

type HTTPTimeseriesGroupBotClassParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupBotClassParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupBotClassParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupBotClassParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupBotClassParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupBotClassParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupBotClassParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupBotClassParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupBotClassParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupBotClassParams) URLQuery

func (r HTTPTimeseriesGroupBotClassParams) URLQuery() (v url.Values)

URLQuery serializes HTTPTimeseriesGroupBotClassParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupBotClassParamsAggInterval

type HTTPTimeseriesGroupBotClassParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupBotClassParamsAggInterval15m HTTPTimeseriesGroupBotClassParamsAggInterval = "15m"
	HTTPTimeseriesGroupBotClassParamsAggInterval1h  HTTPTimeseriesGroupBotClassParamsAggInterval = "1h"
	HTTPTimeseriesGroupBotClassParamsAggInterval1d  HTTPTimeseriesGroupBotClassParamsAggInterval = "1d"
	HTTPTimeseriesGroupBotClassParamsAggInterval1w  HTTPTimeseriesGroupBotClassParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupBotClassParamsAggInterval) IsKnown

type HTTPTimeseriesGroupBotClassParamsDeviceType

type HTTPTimeseriesGroupBotClassParamsDeviceType string
const (
	HTTPTimeseriesGroupBotClassParamsDeviceTypeDesktop HTTPTimeseriesGroupBotClassParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupBotClassParamsDeviceTypeMobile  HTTPTimeseriesGroupBotClassParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupBotClassParamsDeviceTypeOther   HTTPTimeseriesGroupBotClassParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupBotClassParamsDeviceType) IsKnown

type HTTPTimeseriesGroupBotClassParamsFormat

type HTTPTimeseriesGroupBotClassParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupBotClassParamsFormatJson HTTPTimeseriesGroupBotClassParamsFormat = "JSON"
	HTTPTimeseriesGroupBotClassParamsFormatCsv  HTTPTimeseriesGroupBotClassParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupBotClassParamsFormat) IsKnown

type HTTPTimeseriesGroupBotClassParamsHTTPProtocol

type HTTPTimeseriesGroupBotClassParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupBotClassParamsHTTPProtocolHTTP  HTTPTimeseriesGroupBotClassParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupBotClassParamsHTTPProtocolHTTPS HTTPTimeseriesGroupBotClassParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupBotClassParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupBotClassParamsHTTPVersion

type HTTPTimeseriesGroupBotClassParamsHTTPVersion string
const (
	HTTPTimeseriesGroupBotClassParamsHTTPVersionHttPv1 HTTPTimeseriesGroupBotClassParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupBotClassParamsHTTPVersionHttPv2 HTTPTimeseriesGroupBotClassParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupBotClassParamsHTTPVersionHttPv3 HTTPTimeseriesGroupBotClassParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupBotClassParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupBotClassParamsIPVersion

type HTTPTimeseriesGroupBotClassParamsIPVersion string
const (
	HTTPTimeseriesGroupBotClassParamsIPVersionIPv4 HTTPTimeseriesGroupBotClassParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupBotClassParamsIPVersionIPv6 HTTPTimeseriesGroupBotClassParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupBotClassParamsIPVersion) IsKnown

type HTTPTimeseriesGroupBotClassParamsOS

type HTTPTimeseriesGroupBotClassParamsOS string
const (
	HTTPTimeseriesGroupBotClassParamsOSWindows  HTTPTimeseriesGroupBotClassParamsOS = "WINDOWS"
	HTTPTimeseriesGroupBotClassParamsOSMacosx   HTTPTimeseriesGroupBotClassParamsOS = "MACOSX"
	HTTPTimeseriesGroupBotClassParamsOSIos      HTTPTimeseriesGroupBotClassParamsOS = "IOS"
	HTTPTimeseriesGroupBotClassParamsOSAndroid  HTTPTimeseriesGroupBotClassParamsOS = "ANDROID"
	HTTPTimeseriesGroupBotClassParamsOSChromeos HTTPTimeseriesGroupBotClassParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupBotClassParamsOSLinux    HTTPTimeseriesGroupBotClassParamsOS = "LINUX"
	HTTPTimeseriesGroupBotClassParamsOSSmartTv  HTTPTimeseriesGroupBotClassParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupBotClassParamsOS) IsKnown

type HTTPTimeseriesGroupBotClassParamsTLSVersion

type HTTPTimeseriesGroupBotClassParamsTLSVersion string
const (
	HTTPTimeseriesGroupBotClassParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupBotClassParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupBotClassParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupBotClassParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupBotClassParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupBotClassParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupBotClassParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupBotClassParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupBotClassParamsTLSVersionTlSvQuic HTTPTimeseriesGroupBotClassParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupBotClassParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupBotClassResponse

type HTTPTimeseriesGroupBotClassResponse struct {
	Meta   interface{}                               `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupBotClassResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupBotClassResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupBotClassResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupBotClassResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBotClassResponseEnvelope

type HTTPTimeseriesGroupBotClassResponseEnvelope struct {
	Result  HTTPTimeseriesGroupBotClassResponse             `json:"result,required"`
	Success bool                                            `json:"success,required"`
	JSON    httpTimeseriesGroupBotClassResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupBotClassResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupBotClassResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBotClassResponseSerie0

type HTTPTimeseriesGroupBotClassResponseSerie0 struct {
	Bot        []string                                      `json:"bot,required"`
	Human      []string                                      `json:"human,required"`
	Timestamps []string                                      `json:"timestamps,required"`
	JSON       httpTimeseriesGroupBotClassResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupBotClassResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupBotClassResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBrowserFamilyParams

type HTTPTimeseriesGroupBrowserFamilyParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupBrowserFamilyParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupBrowserFamilyParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupBrowserFamilyParams) URLQuery

URLQuery serializes HTTPTimeseriesGroupBrowserFamilyParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupBrowserFamilyParamsAggInterval

type HTTPTimeseriesGroupBrowserFamilyParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupBrowserFamilyParamsAggInterval15m HTTPTimeseriesGroupBrowserFamilyParamsAggInterval = "15m"
	HTTPTimeseriesGroupBrowserFamilyParamsAggInterval1h  HTTPTimeseriesGroupBrowserFamilyParamsAggInterval = "1h"
	HTTPTimeseriesGroupBrowserFamilyParamsAggInterval1d  HTTPTimeseriesGroupBrowserFamilyParamsAggInterval = "1d"
	HTTPTimeseriesGroupBrowserFamilyParamsAggInterval1w  HTTPTimeseriesGroupBrowserFamilyParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsAggInterval) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsBotClass

type HTTPTimeseriesGroupBrowserFamilyParamsBotClass string
const (
	HTTPTimeseriesGroupBrowserFamilyParamsBotClassLikelyAutomated HTTPTimeseriesGroupBrowserFamilyParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupBrowserFamilyParamsBotClassLikelyHuman     HTTPTimeseriesGroupBrowserFamilyParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsBotClass) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsDeviceType

type HTTPTimeseriesGroupBrowserFamilyParamsDeviceType string
const (
	HTTPTimeseriesGroupBrowserFamilyParamsDeviceTypeDesktop HTTPTimeseriesGroupBrowserFamilyParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupBrowserFamilyParamsDeviceTypeMobile  HTTPTimeseriesGroupBrowserFamilyParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupBrowserFamilyParamsDeviceTypeOther   HTTPTimeseriesGroupBrowserFamilyParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsDeviceType) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsFormat

type HTTPTimeseriesGroupBrowserFamilyParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupBrowserFamilyParamsFormatJson HTTPTimeseriesGroupBrowserFamilyParamsFormat = "JSON"
	HTTPTimeseriesGroupBrowserFamilyParamsFormatCsv  HTTPTimeseriesGroupBrowserFamilyParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsFormat) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol

type HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocolHTTP  HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocolHTTPS HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion

type HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion string
const (
	HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersionHttPv1 HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersionHttPv2 HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersionHttPv3 HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsIPVersion

type HTTPTimeseriesGroupBrowserFamilyParamsIPVersion string
const (
	HTTPTimeseriesGroupBrowserFamilyParamsIPVersionIPv4 HTTPTimeseriesGroupBrowserFamilyParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupBrowserFamilyParamsIPVersionIPv6 HTTPTimeseriesGroupBrowserFamilyParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsIPVersion) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsOS

type HTTPTimeseriesGroupBrowserFamilyParamsOS string
const (
	HTTPTimeseriesGroupBrowserFamilyParamsOSWindows  HTTPTimeseriesGroupBrowserFamilyParamsOS = "WINDOWS"
	HTTPTimeseriesGroupBrowserFamilyParamsOSMacosx   HTTPTimeseriesGroupBrowserFamilyParamsOS = "MACOSX"
	HTTPTimeseriesGroupBrowserFamilyParamsOSIos      HTTPTimeseriesGroupBrowserFamilyParamsOS = "IOS"
	HTTPTimeseriesGroupBrowserFamilyParamsOSAndroid  HTTPTimeseriesGroupBrowserFamilyParamsOS = "ANDROID"
	HTTPTimeseriesGroupBrowserFamilyParamsOSChromeos HTTPTimeseriesGroupBrowserFamilyParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupBrowserFamilyParamsOSLinux    HTTPTimeseriesGroupBrowserFamilyParamsOS = "LINUX"
	HTTPTimeseriesGroupBrowserFamilyParamsOSSmartTv  HTTPTimeseriesGroupBrowserFamilyParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsOS) IsKnown

type HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion

type HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion string
const (
	HTTPTimeseriesGroupBrowserFamilyParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupBrowserFamilyParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupBrowserFamilyParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupBrowserFamilyParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupBrowserFamilyParamsTLSVersionTlSvQuic HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupBrowserFamilyResponse

type HTTPTimeseriesGroupBrowserFamilyResponse struct {
	Meta   interface{}                                    `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupBrowserFamilyResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupBrowserFamilyResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupBrowserFamilyResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupBrowserFamilyResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBrowserFamilyResponseEnvelope

type HTTPTimeseriesGroupBrowserFamilyResponseEnvelope struct {
	Result  HTTPTimeseriesGroupBrowserFamilyResponse             `json:"result,required"`
	Success bool                                                 `json:"success,required"`
	JSON    httpTimeseriesGroupBrowserFamilyResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupBrowserFamilyResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupBrowserFamilyResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBrowserFamilyResponseSerie0

type HTTPTimeseriesGroupBrowserFamilyResponseSerie0 struct {
	Timestamps  []string                                           `json:"timestamps,required"`
	ExtraFields map[string][]string                                `json:"-,extras"`
	JSON        httpTimeseriesGroupBrowserFamilyResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupBrowserFamilyResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupBrowserFamilyResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBrowserParams

type HTTPTimeseriesGroupBrowserParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupBrowserParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupBrowserParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupBrowserParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupBrowserParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupBrowserParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupBrowserParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupBrowserParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects (eg browsers, verticals, etc) to the top items over
	// the time range.
	LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupBrowserParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupBrowserParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupBrowserParams) URLQuery

func (r HTTPTimeseriesGroupBrowserParams) URLQuery() (v url.Values)

URLQuery serializes HTTPTimeseriesGroupBrowserParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupBrowserParamsAggInterval

type HTTPTimeseriesGroupBrowserParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupBrowserParamsAggInterval15m HTTPTimeseriesGroupBrowserParamsAggInterval = "15m"
	HTTPTimeseriesGroupBrowserParamsAggInterval1h  HTTPTimeseriesGroupBrowserParamsAggInterval = "1h"
	HTTPTimeseriesGroupBrowserParamsAggInterval1d  HTTPTimeseriesGroupBrowserParamsAggInterval = "1d"
	HTTPTimeseriesGroupBrowserParamsAggInterval1w  HTTPTimeseriesGroupBrowserParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupBrowserParamsAggInterval) IsKnown

type HTTPTimeseriesGroupBrowserParamsBotClass

type HTTPTimeseriesGroupBrowserParamsBotClass string
const (
	HTTPTimeseriesGroupBrowserParamsBotClassLikelyAutomated HTTPTimeseriesGroupBrowserParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupBrowserParamsBotClassLikelyHuman     HTTPTimeseriesGroupBrowserParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupBrowserParamsBotClass) IsKnown

type HTTPTimeseriesGroupBrowserParamsDeviceType

type HTTPTimeseriesGroupBrowserParamsDeviceType string
const (
	HTTPTimeseriesGroupBrowserParamsDeviceTypeDesktop HTTPTimeseriesGroupBrowserParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupBrowserParamsDeviceTypeMobile  HTTPTimeseriesGroupBrowserParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupBrowserParamsDeviceTypeOther   HTTPTimeseriesGroupBrowserParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupBrowserParamsDeviceType) IsKnown

type HTTPTimeseriesGroupBrowserParamsFormat

type HTTPTimeseriesGroupBrowserParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupBrowserParamsFormatJson HTTPTimeseriesGroupBrowserParamsFormat = "JSON"
	HTTPTimeseriesGroupBrowserParamsFormatCsv  HTTPTimeseriesGroupBrowserParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupBrowserParamsFormat) IsKnown

type HTTPTimeseriesGroupBrowserParamsHTTPProtocol

type HTTPTimeseriesGroupBrowserParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupBrowserParamsHTTPProtocolHTTP  HTTPTimeseriesGroupBrowserParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupBrowserParamsHTTPProtocolHTTPS HTTPTimeseriesGroupBrowserParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupBrowserParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupBrowserParamsHTTPVersion

type HTTPTimeseriesGroupBrowserParamsHTTPVersion string
const (
	HTTPTimeseriesGroupBrowserParamsHTTPVersionHttPv1 HTTPTimeseriesGroupBrowserParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupBrowserParamsHTTPVersionHttPv2 HTTPTimeseriesGroupBrowserParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupBrowserParamsHTTPVersionHttPv3 HTTPTimeseriesGroupBrowserParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupBrowserParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupBrowserParamsIPVersion

type HTTPTimeseriesGroupBrowserParamsIPVersion string
const (
	HTTPTimeseriesGroupBrowserParamsIPVersionIPv4 HTTPTimeseriesGroupBrowserParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupBrowserParamsIPVersionIPv6 HTTPTimeseriesGroupBrowserParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupBrowserParamsIPVersion) IsKnown

type HTTPTimeseriesGroupBrowserParamsOS

type HTTPTimeseriesGroupBrowserParamsOS string
const (
	HTTPTimeseriesGroupBrowserParamsOSWindows  HTTPTimeseriesGroupBrowserParamsOS = "WINDOWS"
	HTTPTimeseriesGroupBrowserParamsOSMacosx   HTTPTimeseriesGroupBrowserParamsOS = "MACOSX"
	HTTPTimeseriesGroupBrowserParamsOSIos      HTTPTimeseriesGroupBrowserParamsOS = "IOS"
	HTTPTimeseriesGroupBrowserParamsOSAndroid  HTTPTimeseriesGroupBrowserParamsOS = "ANDROID"
	HTTPTimeseriesGroupBrowserParamsOSChromeos HTTPTimeseriesGroupBrowserParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupBrowserParamsOSLinux    HTTPTimeseriesGroupBrowserParamsOS = "LINUX"
	HTTPTimeseriesGroupBrowserParamsOSSmartTv  HTTPTimeseriesGroupBrowserParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupBrowserParamsOS) IsKnown

type HTTPTimeseriesGroupBrowserParamsTLSVersion

type HTTPTimeseriesGroupBrowserParamsTLSVersion string
const (
	HTTPTimeseriesGroupBrowserParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupBrowserParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupBrowserParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupBrowserParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupBrowserParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupBrowserParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupBrowserParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupBrowserParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupBrowserParamsTLSVersionTlSvQuic HTTPTimeseriesGroupBrowserParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupBrowserParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupBrowserResponse

type HTTPTimeseriesGroupBrowserResponse struct {
	Meta   interface{}                              `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupBrowserResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupBrowserResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupBrowserResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupBrowserResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBrowserResponseEnvelope

type HTTPTimeseriesGroupBrowserResponseEnvelope struct {
	Result  HTTPTimeseriesGroupBrowserResponse             `json:"result,required"`
	Success bool                                           `json:"success,required"`
	JSON    httpTimeseriesGroupBrowserResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupBrowserResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupBrowserResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupBrowserResponseSerie0

type HTTPTimeseriesGroupBrowserResponseSerie0 struct {
	Timestamps  []string                                     `json:"timestamps,required"`
	ExtraFields map[string][]string                          `json:"-,extras"`
	JSON        httpTimeseriesGroupBrowserResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupBrowserResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupBrowserResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupDeviceTypeParams

type HTTPTimeseriesGroupDeviceTypeParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupDeviceTypeParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupDeviceTypeParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupDeviceTypeParams) URLQuery

URLQuery serializes HTTPTimeseriesGroupDeviceTypeParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupDeviceTypeParamsAggInterval

type HTTPTimeseriesGroupDeviceTypeParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupDeviceTypeParamsAggInterval15m HTTPTimeseriesGroupDeviceTypeParamsAggInterval = "15m"
	HTTPTimeseriesGroupDeviceTypeParamsAggInterval1h  HTTPTimeseriesGroupDeviceTypeParamsAggInterval = "1h"
	HTTPTimeseriesGroupDeviceTypeParamsAggInterval1d  HTTPTimeseriesGroupDeviceTypeParamsAggInterval = "1d"
	HTTPTimeseriesGroupDeviceTypeParamsAggInterval1w  HTTPTimeseriesGroupDeviceTypeParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupDeviceTypeParamsAggInterval) IsKnown

type HTTPTimeseriesGroupDeviceTypeParamsBotClass

type HTTPTimeseriesGroupDeviceTypeParamsBotClass string
const (
	HTTPTimeseriesGroupDeviceTypeParamsBotClassLikelyAutomated HTTPTimeseriesGroupDeviceTypeParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupDeviceTypeParamsBotClassLikelyHuman     HTTPTimeseriesGroupDeviceTypeParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupDeviceTypeParamsBotClass) IsKnown

type HTTPTimeseriesGroupDeviceTypeParamsFormat

type HTTPTimeseriesGroupDeviceTypeParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupDeviceTypeParamsFormatJson HTTPTimeseriesGroupDeviceTypeParamsFormat = "JSON"
	HTTPTimeseriesGroupDeviceTypeParamsFormatCsv  HTTPTimeseriesGroupDeviceTypeParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupDeviceTypeParamsFormat) IsKnown

type HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol

type HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocolHTTP  HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocolHTTPS HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion

type HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion string
const (
	HTTPTimeseriesGroupDeviceTypeParamsHTTPVersionHttPv1 HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupDeviceTypeParamsHTTPVersionHttPv2 HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupDeviceTypeParamsHTTPVersionHttPv3 HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupDeviceTypeParamsIPVersion

type HTTPTimeseriesGroupDeviceTypeParamsIPVersion string
const (
	HTTPTimeseriesGroupDeviceTypeParamsIPVersionIPv4 HTTPTimeseriesGroupDeviceTypeParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupDeviceTypeParamsIPVersionIPv6 HTTPTimeseriesGroupDeviceTypeParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupDeviceTypeParamsIPVersion) IsKnown

type HTTPTimeseriesGroupDeviceTypeParamsOS

type HTTPTimeseriesGroupDeviceTypeParamsOS string
const (
	HTTPTimeseriesGroupDeviceTypeParamsOSWindows  HTTPTimeseriesGroupDeviceTypeParamsOS = "WINDOWS"
	HTTPTimeseriesGroupDeviceTypeParamsOSMacosx   HTTPTimeseriesGroupDeviceTypeParamsOS = "MACOSX"
	HTTPTimeseriesGroupDeviceTypeParamsOSIos      HTTPTimeseriesGroupDeviceTypeParamsOS = "IOS"
	HTTPTimeseriesGroupDeviceTypeParamsOSAndroid  HTTPTimeseriesGroupDeviceTypeParamsOS = "ANDROID"
	HTTPTimeseriesGroupDeviceTypeParamsOSChromeos HTTPTimeseriesGroupDeviceTypeParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupDeviceTypeParamsOSLinux    HTTPTimeseriesGroupDeviceTypeParamsOS = "LINUX"
	HTTPTimeseriesGroupDeviceTypeParamsOSSmartTv  HTTPTimeseriesGroupDeviceTypeParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupDeviceTypeParamsOS) IsKnown

type HTTPTimeseriesGroupDeviceTypeParamsTLSVersion

type HTTPTimeseriesGroupDeviceTypeParamsTLSVersion string
const (
	HTTPTimeseriesGroupDeviceTypeParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupDeviceTypeParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupDeviceTypeParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupDeviceTypeParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupDeviceTypeParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupDeviceTypeParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupDeviceTypeParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupDeviceTypeParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupDeviceTypeParamsTLSVersionTlSvQuic HTTPTimeseriesGroupDeviceTypeParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupDeviceTypeParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupDeviceTypeResponse

type HTTPTimeseriesGroupDeviceTypeResponse struct {
	Meta   interface{}                                 `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupDeviceTypeResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupDeviceTypeResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupDeviceTypeResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupDeviceTypeResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupDeviceTypeResponseEnvelope

type HTTPTimeseriesGroupDeviceTypeResponseEnvelope struct {
	Result  HTTPTimeseriesGroupDeviceTypeResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    httpTimeseriesGroupDeviceTypeResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupDeviceTypeResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupDeviceTypeResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupDeviceTypeResponseSerie0

type HTTPTimeseriesGroupDeviceTypeResponseSerie0 struct {
	Desktop    []string                                        `json:"desktop,required"`
	Mobile     []string                                        `json:"mobile,required"`
	Other      []string                                        `json:"other,required"`
	Timestamps []string                                        `json:"timestamps,required"`
	JSON       httpTimeseriesGroupDeviceTypeResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupDeviceTypeResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupDeviceTypeResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupHTTPProtocolParams

type HTTPTimeseriesGroupHTTPProtocolParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupHTTPProtocolParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupHTTPProtocolParamsFormat] `query:"format"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupHTTPProtocolParams) URLQuery

URLQuery serializes HTTPTimeseriesGroupHTTPProtocolParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupHTTPProtocolParamsAggInterval

type HTTPTimeseriesGroupHTTPProtocolParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupHTTPProtocolParamsAggInterval15m HTTPTimeseriesGroupHTTPProtocolParamsAggInterval = "15m"
	HTTPTimeseriesGroupHTTPProtocolParamsAggInterval1h  HTTPTimeseriesGroupHTTPProtocolParamsAggInterval = "1h"
	HTTPTimeseriesGroupHTTPProtocolParamsAggInterval1d  HTTPTimeseriesGroupHTTPProtocolParamsAggInterval = "1d"
	HTTPTimeseriesGroupHTTPProtocolParamsAggInterval1w  HTTPTimeseriesGroupHTTPProtocolParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsAggInterval) IsKnown

type HTTPTimeseriesGroupHTTPProtocolParamsBotClass

type HTTPTimeseriesGroupHTTPProtocolParamsBotClass string
const (
	HTTPTimeseriesGroupHTTPProtocolParamsBotClassLikelyAutomated HTTPTimeseriesGroupHTTPProtocolParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupHTTPProtocolParamsBotClassLikelyHuman     HTTPTimeseriesGroupHTTPProtocolParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsBotClass) IsKnown

type HTTPTimeseriesGroupHTTPProtocolParamsDeviceType

type HTTPTimeseriesGroupHTTPProtocolParamsDeviceType string
const (
	HTTPTimeseriesGroupHTTPProtocolParamsDeviceTypeDesktop HTTPTimeseriesGroupHTTPProtocolParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupHTTPProtocolParamsDeviceTypeMobile  HTTPTimeseriesGroupHTTPProtocolParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupHTTPProtocolParamsDeviceTypeOther   HTTPTimeseriesGroupHTTPProtocolParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsDeviceType) IsKnown

type HTTPTimeseriesGroupHTTPProtocolParamsFormat

type HTTPTimeseriesGroupHTTPProtocolParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupHTTPProtocolParamsFormatJson HTTPTimeseriesGroupHTTPProtocolParamsFormat = "JSON"
	HTTPTimeseriesGroupHTTPProtocolParamsFormatCsv  HTTPTimeseriesGroupHTTPProtocolParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsFormat) IsKnown

type HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion

type HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion string
const (
	HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersionHttPv1 HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersionHttPv2 HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersionHttPv3 HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupHTTPProtocolParamsIPVersion

type HTTPTimeseriesGroupHTTPProtocolParamsIPVersion string
const (
	HTTPTimeseriesGroupHTTPProtocolParamsIPVersionIPv4 HTTPTimeseriesGroupHTTPProtocolParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupHTTPProtocolParamsIPVersionIPv6 HTTPTimeseriesGroupHTTPProtocolParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsIPVersion) IsKnown

type HTTPTimeseriesGroupHTTPProtocolParamsOS

type HTTPTimeseriesGroupHTTPProtocolParamsOS string
const (
	HTTPTimeseriesGroupHTTPProtocolParamsOSWindows  HTTPTimeseriesGroupHTTPProtocolParamsOS = "WINDOWS"
	HTTPTimeseriesGroupHTTPProtocolParamsOSMacosx   HTTPTimeseriesGroupHTTPProtocolParamsOS = "MACOSX"
	HTTPTimeseriesGroupHTTPProtocolParamsOSIos      HTTPTimeseriesGroupHTTPProtocolParamsOS = "IOS"
	HTTPTimeseriesGroupHTTPProtocolParamsOSAndroid  HTTPTimeseriesGroupHTTPProtocolParamsOS = "ANDROID"
	HTTPTimeseriesGroupHTTPProtocolParamsOSChromeos HTTPTimeseriesGroupHTTPProtocolParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupHTTPProtocolParamsOSLinux    HTTPTimeseriesGroupHTTPProtocolParamsOS = "LINUX"
	HTTPTimeseriesGroupHTTPProtocolParamsOSSmartTv  HTTPTimeseriesGroupHTTPProtocolParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsOS) IsKnown

type HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion

type HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion string
const (
	HTTPTimeseriesGroupHTTPProtocolParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupHTTPProtocolParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupHTTPProtocolParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupHTTPProtocolParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupHTTPProtocolParamsTLSVersionTlSvQuic HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupHTTPProtocolResponse

type HTTPTimeseriesGroupHTTPProtocolResponse struct {
	Meta   interface{}                                   `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupHTTPProtocolResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupHTTPProtocolResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupHTTPProtocolResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupHTTPProtocolResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupHTTPProtocolResponseEnvelope

type HTTPTimeseriesGroupHTTPProtocolResponseEnvelope struct {
	Result  HTTPTimeseriesGroupHTTPProtocolResponse             `json:"result,required"`
	Success bool                                                `json:"success,required"`
	JSON    httpTimeseriesGroupHTTPProtocolResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupHTTPProtocolResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupHTTPProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupHTTPProtocolResponseSerie0

type HTTPTimeseriesGroupHTTPProtocolResponseSerie0 struct {
	HTTP       []string                                          `json:"http,required"`
	HTTPS      []string                                          `json:"https,required"`
	Timestamps []string                                          `json:"timestamps,required"`
	JSON       httpTimeseriesGroupHTTPProtocolResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupHTTPProtocolResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupHTTPProtocolResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupHTTPVersionParams

type HTTPTimeseriesGroupHTTPVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupHTTPVersionParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupHTTPVersionParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupHTTPVersionParams) URLQuery

URLQuery serializes HTTPTimeseriesGroupHTTPVersionParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupHTTPVersionParamsAggInterval

type HTTPTimeseriesGroupHTTPVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupHTTPVersionParamsAggInterval15m HTTPTimeseriesGroupHTTPVersionParamsAggInterval = "15m"
	HTTPTimeseriesGroupHTTPVersionParamsAggInterval1h  HTTPTimeseriesGroupHTTPVersionParamsAggInterval = "1h"
	HTTPTimeseriesGroupHTTPVersionParamsAggInterval1d  HTTPTimeseriesGroupHTTPVersionParamsAggInterval = "1d"
	HTTPTimeseriesGroupHTTPVersionParamsAggInterval1w  HTTPTimeseriesGroupHTTPVersionParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupHTTPVersionParamsAggInterval) IsKnown

type HTTPTimeseriesGroupHTTPVersionParamsBotClass

type HTTPTimeseriesGroupHTTPVersionParamsBotClass string
const (
	HTTPTimeseriesGroupHTTPVersionParamsBotClassLikelyAutomated HTTPTimeseriesGroupHTTPVersionParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupHTTPVersionParamsBotClassLikelyHuman     HTTPTimeseriesGroupHTTPVersionParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupHTTPVersionParamsBotClass) IsKnown

type HTTPTimeseriesGroupHTTPVersionParamsDeviceType

type HTTPTimeseriesGroupHTTPVersionParamsDeviceType string
const (
	HTTPTimeseriesGroupHTTPVersionParamsDeviceTypeDesktop HTTPTimeseriesGroupHTTPVersionParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupHTTPVersionParamsDeviceTypeMobile  HTTPTimeseriesGroupHTTPVersionParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupHTTPVersionParamsDeviceTypeOther   HTTPTimeseriesGroupHTTPVersionParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupHTTPVersionParamsDeviceType) IsKnown

type HTTPTimeseriesGroupHTTPVersionParamsFormat

type HTTPTimeseriesGroupHTTPVersionParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupHTTPVersionParamsFormatJson HTTPTimeseriesGroupHTTPVersionParamsFormat = "JSON"
	HTTPTimeseriesGroupHTTPVersionParamsFormatCsv  HTTPTimeseriesGroupHTTPVersionParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupHTTPVersionParamsFormat) IsKnown

type HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol

type HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocolHTTP  HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocolHTTPS HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupHTTPVersionParamsIPVersion

type HTTPTimeseriesGroupHTTPVersionParamsIPVersion string
const (
	HTTPTimeseriesGroupHTTPVersionParamsIPVersionIPv4 HTTPTimeseriesGroupHTTPVersionParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupHTTPVersionParamsIPVersionIPv6 HTTPTimeseriesGroupHTTPVersionParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupHTTPVersionParamsIPVersion) IsKnown

type HTTPTimeseriesGroupHTTPVersionParamsOS

type HTTPTimeseriesGroupHTTPVersionParamsOS string
const (
	HTTPTimeseriesGroupHTTPVersionParamsOSWindows  HTTPTimeseriesGroupHTTPVersionParamsOS = "WINDOWS"
	HTTPTimeseriesGroupHTTPVersionParamsOSMacosx   HTTPTimeseriesGroupHTTPVersionParamsOS = "MACOSX"
	HTTPTimeseriesGroupHTTPVersionParamsOSIos      HTTPTimeseriesGroupHTTPVersionParamsOS = "IOS"
	HTTPTimeseriesGroupHTTPVersionParamsOSAndroid  HTTPTimeseriesGroupHTTPVersionParamsOS = "ANDROID"
	HTTPTimeseriesGroupHTTPVersionParamsOSChromeos HTTPTimeseriesGroupHTTPVersionParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupHTTPVersionParamsOSLinux    HTTPTimeseriesGroupHTTPVersionParamsOS = "LINUX"
	HTTPTimeseriesGroupHTTPVersionParamsOSSmartTv  HTTPTimeseriesGroupHTTPVersionParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupHTTPVersionParamsOS) IsKnown

type HTTPTimeseriesGroupHTTPVersionParamsTLSVersion

type HTTPTimeseriesGroupHTTPVersionParamsTLSVersion string
const (
	HTTPTimeseriesGroupHTTPVersionParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupHTTPVersionParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupHTTPVersionParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupHTTPVersionParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupHTTPVersionParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupHTTPVersionParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupHTTPVersionParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupHTTPVersionParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupHTTPVersionParamsTLSVersionTlSvQuic HTTPTimeseriesGroupHTTPVersionParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupHTTPVersionParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupHTTPVersionResponse

type HTTPTimeseriesGroupHTTPVersionResponse struct {
	Meta   interface{}                                  `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupHTTPVersionResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupHTTPVersionResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupHTTPVersionResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupHTTPVersionResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupHTTPVersionResponseEnvelope

type HTTPTimeseriesGroupHTTPVersionResponseEnvelope struct {
	Result  HTTPTimeseriesGroupHTTPVersionResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    httpTimeseriesGroupHTTPVersionResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupHTTPVersionResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupHTTPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupHTTPVersionResponseSerie0

type HTTPTimeseriesGroupHTTPVersionResponseSerie0 struct {
	HTTP1X     []string                                         `json:"HTTP/1.x,required"`
	HTTP2      []string                                         `json:"HTTP/2,required"`
	HTTP3      []string                                         `json:"HTTP/3,required"`
	Timestamps []string                                         `json:"timestamps,required"`
	JSON       httpTimeseriesGroupHTTPVersionResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupIPVersionParams

type HTTPTimeseriesGroupIPVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupIPVersionParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupIPVersionParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupIPVersionParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupIPVersionParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupIPVersionParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupIPVersionParamsHTTPVersion] `query:"httpVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupIPVersionParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupIPVersionParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupIPVersionParams) URLQuery

URLQuery serializes HTTPTimeseriesGroupIPVersionParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupIPVersionParamsAggInterval

type HTTPTimeseriesGroupIPVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupIPVersionParamsAggInterval15m HTTPTimeseriesGroupIPVersionParamsAggInterval = "15m"
	HTTPTimeseriesGroupIPVersionParamsAggInterval1h  HTTPTimeseriesGroupIPVersionParamsAggInterval = "1h"
	HTTPTimeseriesGroupIPVersionParamsAggInterval1d  HTTPTimeseriesGroupIPVersionParamsAggInterval = "1d"
	HTTPTimeseriesGroupIPVersionParamsAggInterval1w  HTTPTimeseriesGroupIPVersionParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupIPVersionParamsAggInterval) IsKnown

type HTTPTimeseriesGroupIPVersionParamsBotClass

type HTTPTimeseriesGroupIPVersionParamsBotClass string
const (
	HTTPTimeseriesGroupIPVersionParamsBotClassLikelyAutomated HTTPTimeseriesGroupIPVersionParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupIPVersionParamsBotClassLikelyHuman     HTTPTimeseriesGroupIPVersionParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupIPVersionParamsBotClass) IsKnown

type HTTPTimeseriesGroupIPVersionParamsDeviceType

type HTTPTimeseriesGroupIPVersionParamsDeviceType string
const (
	HTTPTimeseriesGroupIPVersionParamsDeviceTypeDesktop HTTPTimeseriesGroupIPVersionParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupIPVersionParamsDeviceTypeMobile  HTTPTimeseriesGroupIPVersionParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupIPVersionParamsDeviceTypeOther   HTTPTimeseriesGroupIPVersionParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupIPVersionParamsDeviceType) IsKnown

type HTTPTimeseriesGroupIPVersionParamsFormat

type HTTPTimeseriesGroupIPVersionParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupIPVersionParamsFormatJson HTTPTimeseriesGroupIPVersionParamsFormat = "JSON"
	HTTPTimeseriesGroupIPVersionParamsFormatCsv  HTTPTimeseriesGroupIPVersionParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupIPVersionParamsFormat) IsKnown

type HTTPTimeseriesGroupIPVersionParamsHTTPProtocol

type HTTPTimeseriesGroupIPVersionParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupIPVersionParamsHTTPProtocolHTTP  HTTPTimeseriesGroupIPVersionParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupIPVersionParamsHTTPProtocolHTTPS HTTPTimeseriesGroupIPVersionParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupIPVersionParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupIPVersionParamsHTTPVersion

type HTTPTimeseriesGroupIPVersionParamsHTTPVersion string
const (
	HTTPTimeseriesGroupIPVersionParamsHTTPVersionHttPv1 HTTPTimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupIPVersionParamsHTTPVersionHttPv2 HTTPTimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupIPVersionParamsHTTPVersionHttPv3 HTTPTimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupIPVersionParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupIPVersionParamsOS

type HTTPTimeseriesGroupIPVersionParamsOS string
const (
	HTTPTimeseriesGroupIPVersionParamsOSWindows  HTTPTimeseriesGroupIPVersionParamsOS = "WINDOWS"
	HTTPTimeseriesGroupIPVersionParamsOSMacosx   HTTPTimeseriesGroupIPVersionParamsOS = "MACOSX"
	HTTPTimeseriesGroupIPVersionParamsOSIos      HTTPTimeseriesGroupIPVersionParamsOS = "IOS"
	HTTPTimeseriesGroupIPVersionParamsOSAndroid  HTTPTimeseriesGroupIPVersionParamsOS = "ANDROID"
	HTTPTimeseriesGroupIPVersionParamsOSChromeos HTTPTimeseriesGroupIPVersionParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupIPVersionParamsOSLinux    HTTPTimeseriesGroupIPVersionParamsOS = "LINUX"
	HTTPTimeseriesGroupIPVersionParamsOSSmartTv  HTTPTimeseriesGroupIPVersionParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupIPVersionParamsOS) IsKnown

type HTTPTimeseriesGroupIPVersionParamsTLSVersion

type HTTPTimeseriesGroupIPVersionParamsTLSVersion string
const (
	HTTPTimeseriesGroupIPVersionParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupIPVersionParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupIPVersionParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupIPVersionParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupIPVersionParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupIPVersionParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupIPVersionParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupIPVersionParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupIPVersionParamsTLSVersionTlSvQuic HTTPTimeseriesGroupIPVersionParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupIPVersionParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupIPVersionResponse

type HTTPTimeseriesGroupIPVersionResponse struct {
	Meta   interface{}                                `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupIPVersionResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupIPVersionResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupIPVersionResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupIPVersionResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupIPVersionResponseEnvelope

type HTTPTimeseriesGroupIPVersionResponseEnvelope struct {
	Result  HTTPTimeseriesGroupIPVersionResponse             `json:"result,required"`
	Success bool                                             `json:"success,required"`
	JSON    httpTimeseriesGroupIPVersionResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupIPVersionResponseSerie0

type HTTPTimeseriesGroupIPVersionResponseSerie0 struct {
	IPv4       []string                                       `json:"IPv4,required"`
	IPv6       []string                                       `json:"IPv6,required"`
	Timestamps []string                                       `json:"timestamps,required"`
	JSON       httpTimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupOSParams

type HTTPTimeseriesGroupOSParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupOSParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupOSParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupOSParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupOSParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupOSParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupOSParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupOSParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupOSParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupOSParams) URLQuery

func (r HTTPTimeseriesGroupOSParams) URLQuery() (v url.Values)

URLQuery serializes HTTPTimeseriesGroupOSParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupOSParamsAggInterval

type HTTPTimeseriesGroupOSParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupOSParamsAggInterval15m HTTPTimeseriesGroupOSParamsAggInterval = "15m"
	HTTPTimeseriesGroupOSParamsAggInterval1h  HTTPTimeseriesGroupOSParamsAggInterval = "1h"
	HTTPTimeseriesGroupOSParamsAggInterval1d  HTTPTimeseriesGroupOSParamsAggInterval = "1d"
	HTTPTimeseriesGroupOSParamsAggInterval1w  HTTPTimeseriesGroupOSParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupOSParamsAggInterval) IsKnown

type HTTPTimeseriesGroupOSParamsBotClass

type HTTPTimeseriesGroupOSParamsBotClass string
const (
	HTTPTimeseriesGroupOSParamsBotClassLikelyAutomated HTTPTimeseriesGroupOSParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupOSParamsBotClassLikelyHuman     HTTPTimeseriesGroupOSParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupOSParamsBotClass) IsKnown

type HTTPTimeseriesGroupOSParamsDeviceType

type HTTPTimeseriesGroupOSParamsDeviceType string
const (
	HTTPTimeseriesGroupOSParamsDeviceTypeDesktop HTTPTimeseriesGroupOSParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupOSParamsDeviceTypeMobile  HTTPTimeseriesGroupOSParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupOSParamsDeviceTypeOther   HTTPTimeseriesGroupOSParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupOSParamsDeviceType) IsKnown

type HTTPTimeseriesGroupOSParamsFormat

type HTTPTimeseriesGroupOSParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupOSParamsFormatJson HTTPTimeseriesGroupOSParamsFormat = "JSON"
	HTTPTimeseriesGroupOSParamsFormatCsv  HTTPTimeseriesGroupOSParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupOSParamsFormat) IsKnown

type HTTPTimeseriesGroupOSParamsHTTPProtocol

type HTTPTimeseriesGroupOSParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupOSParamsHTTPProtocolHTTP  HTTPTimeseriesGroupOSParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupOSParamsHTTPProtocolHTTPS HTTPTimeseriesGroupOSParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupOSParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupOSParamsHTTPVersion

type HTTPTimeseriesGroupOSParamsHTTPVersion string
const (
	HTTPTimeseriesGroupOSParamsHTTPVersionHttPv1 HTTPTimeseriesGroupOSParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupOSParamsHTTPVersionHttPv2 HTTPTimeseriesGroupOSParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupOSParamsHTTPVersionHttPv3 HTTPTimeseriesGroupOSParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupOSParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupOSParamsIPVersion

type HTTPTimeseriesGroupOSParamsIPVersion string
const (
	HTTPTimeseriesGroupOSParamsIPVersionIPv4 HTTPTimeseriesGroupOSParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupOSParamsIPVersionIPv6 HTTPTimeseriesGroupOSParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupOSParamsIPVersion) IsKnown

type HTTPTimeseriesGroupOSParamsTLSVersion

type HTTPTimeseriesGroupOSParamsTLSVersion string
const (
	HTTPTimeseriesGroupOSParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupOSParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupOSParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupOSParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupOSParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupOSParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupOSParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupOSParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupOSParamsTLSVersionTlSvQuic HTTPTimeseriesGroupOSParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupOSParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupOSResponse

type HTTPTimeseriesGroupOSResponse struct {
	Meta   interface{}                         `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupOSResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupOSResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupOSResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupOSResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupOSResponseEnvelope

type HTTPTimeseriesGroupOSResponseEnvelope struct {
	Result  HTTPTimeseriesGroupOSResponse             `json:"result,required"`
	Success bool                                      `json:"success,required"`
	JSON    httpTimeseriesGroupOSResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupOSResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupOSResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupOSResponseSerie0

type HTTPTimeseriesGroupOSResponseSerie0 struct {
	Timestamps  []string                                `json:"timestamps,required"`
	ExtraFields map[string][]string                     `json:"-,extras"`
	JSON        httpTimeseriesGroupOSResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupOSResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupOSResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupPostQuantumParams

type HTTPTimeseriesGroupPostQuantumParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupPostQuantumParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupPostQuantumParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupPostQuantumParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupPostQuantumParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupPostQuantumParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupPostQuantumParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupPostQuantumParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTimeseriesGroupPostQuantumParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTimeseriesGroupPostQuantumParams) URLQuery

URLQuery serializes HTTPTimeseriesGroupPostQuantumParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupPostQuantumParamsAggInterval

type HTTPTimeseriesGroupPostQuantumParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupPostQuantumParamsAggInterval15m HTTPTimeseriesGroupPostQuantumParamsAggInterval = "15m"
	HTTPTimeseriesGroupPostQuantumParamsAggInterval1h  HTTPTimeseriesGroupPostQuantumParamsAggInterval = "1h"
	HTTPTimeseriesGroupPostQuantumParamsAggInterval1d  HTTPTimeseriesGroupPostQuantumParamsAggInterval = "1d"
	HTTPTimeseriesGroupPostQuantumParamsAggInterval1w  HTTPTimeseriesGroupPostQuantumParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupPostQuantumParamsAggInterval) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsBotClass

type HTTPTimeseriesGroupPostQuantumParamsBotClass string
const (
	HTTPTimeseriesGroupPostQuantumParamsBotClassLikelyAutomated HTTPTimeseriesGroupPostQuantumParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupPostQuantumParamsBotClassLikelyHuman     HTTPTimeseriesGroupPostQuantumParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupPostQuantumParamsBotClass) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsDeviceType

type HTTPTimeseriesGroupPostQuantumParamsDeviceType string
const (
	HTTPTimeseriesGroupPostQuantumParamsDeviceTypeDesktop HTTPTimeseriesGroupPostQuantumParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupPostQuantumParamsDeviceTypeMobile  HTTPTimeseriesGroupPostQuantumParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupPostQuantumParamsDeviceTypeOther   HTTPTimeseriesGroupPostQuantumParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupPostQuantumParamsDeviceType) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsFormat

type HTTPTimeseriesGroupPostQuantumParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupPostQuantumParamsFormatJson HTTPTimeseriesGroupPostQuantumParamsFormat = "JSON"
	HTTPTimeseriesGroupPostQuantumParamsFormatCsv  HTTPTimeseriesGroupPostQuantumParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupPostQuantumParamsFormat) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol

type HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupPostQuantumParamsHTTPProtocolHTTP  HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupPostQuantumParamsHTTPProtocolHTTPS HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsHTTPVersion

type HTTPTimeseriesGroupPostQuantumParamsHTTPVersion string
const (
	HTTPTimeseriesGroupPostQuantumParamsHTTPVersionHttPv1 HTTPTimeseriesGroupPostQuantumParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupPostQuantumParamsHTTPVersionHttPv2 HTTPTimeseriesGroupPostQuantumParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupPostQuantumParamsHTTPVersionHttPv3 HTTPTimeseriesGroupPostQuantumParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupPostQuantumParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsIPVersion

type HTTPTimeseriesGroupPostQuantumParamsIPVersion string
const (
	HTTPTimeseriesGroupPostQuantumParamsIPVersionIPv4 HTTPTimeseriesGroupPostQuantumParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupPostQuantumParamsIPVersionIPv6 HTTPTimeseriesGroupPostQuantumParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupPostQuantumParamsIPVersion) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsOS

type HTTPTimeseriesGroupPostQuantumParamsOS string
const (
	HTTPTimeseriesGroupPostQuantumParamsOSWindows  HTTPTimeseriesGroupPostQuantumParamsOS = "WINDOWS"
	HTTPTimeseriesGroupPostQuantumParamsOSMacosx   HTTPTimeseriesGroupPostQuantumParamsOS = "MACOSX"
	HTTPTimeseriesGroupPostQuantumParamsOSIos      HTTPTimeseriesGroupPostQuantumParamsOS = "IOS"
	HTTPTimeseriesGroupPostQuantumParamsOSAndroid  HTTPTimeseriesGroupPostQuantumParamsOS = "ANDROID"
	HTTPTimeseriesGroupPostQuantumParamsOSChromeos HTTPTimeseriesGroupPostQuantumParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupPostQuantumParamsOSLinux    HTTPTimeseriesGroupPostQuantumParamsOS = "LINUX"
	HTTPTimeseriesGroupPostQuantumParamsOSSmartTv  HTTPTimeseriesGroupPostQuantumParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupPostQuantumParamsOS) IsKnown

type HTTPTimeseriesGroupPostQuantumParamsTLSVersion

type HTTPTimeseriesGroupPostQuantumParamsTLSVersion string
const (
	HTTPTimeseriesGroupPostQuantumParamsTLSVersionTlSv1_0  HTTPTimeseriesGroupPostQuantumParamsTLSVersion = "TLSv1_0"
	HTTPTimeseriesGroupPostQuantumParamsTLSVersionTlSv1_1  HTTPTimeseriesGroupPostQuantumParamsTLSVersion = "TLSv1_1"
	HTTPTimeseriesGroupPostQuantumParamsTLSVersionTlSv1_2  HTTPTimeseriesGroupPostQuantumParamsTLSVersion = "TLSv1_2"
	HTTPTimeseriesGroupPostQuantumParamsTLSVersionTlSv1_3  HTTPTimeseriesGroupPostQuantumParamsTLSVersion = "TLSv1_3"
	HTTPTimeseriesGroupPostQuantumParamsTLSVersionTlSvQuic HTTPTimeseriesGroupPostQuantumParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTimeseriesGroupPostQuantumParamsTLSVersion) IsKnown

type HTTPTimeseriesGroupPostQuantumResponse

type HTTPTimeseriesGroupPostQuantumResponse struct {
	Meta   interface{}                                  `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupPostQuantumResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupPostQuantumResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupPostQuantumResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupPostQuantumResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupPostQuantumResponseEnvelope

type HTTPTimeseriesGroupPostQuantumResponseEnvelope struct {
	Result  HTTPTimeseriesGroupPostQuantumResponse             `json:"result,required"`
	Success bool                                               `json:"success,required"`
	JSON    httpTimeseriesGroupPostQuantumResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupPostQuantumResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupPostQuantumResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupPostQuantumResponseSerie0

type HTTPTimeseriesGroupPostQuantumResponseSerie0 struct {
	NotSupported []string                                         `json:"NOT_SUPPORTED,required"`
	Supported    []string                                         `json:"SUPPORTED,required"`
	Timestamps   []string                                         `json:"timestamps,required"`
	JSON         httpTimeseriesGroupPostQuantumResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupPostQuantumResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupPostQuantumResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupService

type HTTPTimeseriesGroupService struct {
	Options []option.RequestOption
}

HTTPTimeseriesGroupService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPTimeseriesGroupService method instead.

func NewHTTPTimeseriesGroupService

func NewHTTPTimeseriesGroupService(opts ...option.RequestOption) (r *HTTPTimeseriesGroupService)

NewHTTPTimeseriesGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPTimeseriesGroupService) BotClass

Get a time series of the percentage distribution of traffic classified as automated or human. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.

func (*HTTPTimeseriesGroupService) Browser

Get a time series of the percentage distribution of traffic of the top user agents.

func (*HTTPTimeseriesGroupService) BrowserFamily

Get a time series of the percentage distribution of traffic of the top user agents aggregated in families.

func (*HTTPTimeseriesGroupService) DeviceType

Get a time series of the percentage distribution of traffic by device type.

func (*HTTPTimeseriesGroupService) HTTPProtocol

Get a time series of the percentage distribution of traffic by HTTP protocol.

func (*HTTPTimeseriesGroupService) HTTPVersion

Get a time series of the percentage distribution of traffic by HTTP version.

func (*HTTPTimeseriesGroupService) IPVersion

Get a time series of the percentage distribution of traffic by IP version.

func (*HTTPTimeseriesGroupService) OS

Get a time series of the percentage distribution of traffic of the top operating systems.

func (*HTTPTimeseriesGroupService) PostQuantum

Get a time series of the percentage distribution of traffic by post-quantum suport.

func (*HTTPTimeseriesGroupService) TLSVersion

Get a time series of the percentage distribution of traffic by TLS protocol version.

type HTTPTimeseriesGroupTLSVersionParams

type HTTPTimeseriesGroupTLSVersionParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesGroupTLSVersionParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTimeseriesGroupTLSVersionParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTimeseriesGroupTLSVersionParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesGroupTLSVersionParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTimeseriesGroupTLSVersionParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTimeseriesGroupTLSVersionParamsIPVersion] `query:"ipVersion"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTimeseriesGroupTLSVersionParamsOS] `query:"os"`
}

func (HTTPTimeseriesGroupTLSVersionParams) URLQuery

URLQuery serializes HTTPTimeseriesGroupTLSVersionParams's query parameters as `url.Values`.

type HTTPTimeseriesGroupTLSVersionParamsAggInterval

type HTTPTimeseriesGroupTLSVersionParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesGroupTLSVersionParamsAggInterval15m HTTPTimeseriesGroupTLSVersionParamsAggInterval = "15m"
	HTTPTimeseriesGroupTLSVersionParamsAggInterval1h  HTTPTimeseriesGroupTLSVersionParamsAggInterval = "1h"
	HTTPTimeseriesGroupTLSVersionParamsAggInterval1d  HTTPTimeseriesGroupTLSVersionParamsAggInterval = "1d"
	HTTPTimeseriesGroupTLSVersionParamsAggInterval1w  HTTPTimeseriesGroupTLSVersionParamsAggInterval = "1w"
)

func (HTTPTimeseriesGroupTLSVersionParamsAggInterval) IsKnown

type HTTPTimeseriesGroupTLSVersionParamsBotClass

type HTTPTimeseriesGroupTLSVersionParamsBotClass string
const (
	HTTPTimeseriesGroupTLSVersionParamsBotClassLikelyAutomated HTTPTimeseriesGroupTLSVersionParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTimeseriesGroupTLSVersionParamsBotClassLikelyHuman     HTTPTimeseriesGroupTLSVersionParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTimeseriesGroupTLSVersionParamsBotClass) IsKnown

type HTTPTimeseriesGroupTLSVersionParamsDeviceType

type HTTPTimeseriesGroupTLSVersionParamsDeviceType string
const (
	HTTPTimeseriesGroupTLSVersionParamsDeviceTypeDesktop HTTPTimeseriesGroupTLSVersionParamsDeviceType = "DESKTOP"
	HTTPTimeseriesGroupTLSVersionParamsDeviceTypeMobile  HTTPTimeseriesGroupTLSVersionParamsDeviceType = "MOBILE"
	HTTPTimeseriesGroupTLSVersionParamsDeviceTypeOther   HTTPTimeseriesGroupTLSVersionParamsDeviceType = "OTHER"
)

func (HTTPTimeseriesGroupTLSVersionParamsDeviceType) IsKnown

type HTTPTimeseriesGroupTLSVersionParamsFormat

type HTTPTimeseriesGroupTLSVersionParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesGroupTLSVersionParamsFormatJson HTTPTimeseriesGroupTLSVersionParamsFormat = "JSON"
	HTTPTimeseriesGroupTLSVersionParamsFormatCsv  HTTPTimeseriesGroupTLSVersionParamsFormat = "CSV"
)

func (HTTPTimeseriesGroupTLSVersionParamsFormat) IsKnown

type HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol

type HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol string
const (
	HTTPTimeseriesGroupTLSVersionParamsHTTPProtocolHTTP  HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol = "HTTP"
	HTTPTimeseriesGroupTLSVersionParamsHTTPProtocolHTTPS HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol = "HTTPS"
)

func (HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol) IsKnown

type HTTPTimeseriesGroupTLSVersionParamsHTTPVersion

type HTTPTimeseriesGroupTLSVersionParamsHTTPVersion string
const (
	HTTPTimeseriesGroupTLSVersionParamsHTTPVersionHttPv1 HTTPTimeseriesGroupTLSVersionParamsHTTPVersion = "HTTPv1"
	HTTPTimeseriesGroupTLSVersionParamsHTTPVersionHttPv2 HTTPTimeseriesGroupTLSVersionParamsHTTPVersion = "HTTPv2"
	HTTPTimeseriesGroupTLSVersionParamsHTTPVersionHttPv3 HTTPTimeseriesGroupTLSVersionParamsHTTPVersion = "HTTPv3"
)

func (HTTPTimeseriesGroupTLSVersionParamsHTTPVersion) IsKnown

type HTTPTimeseriesGroupTLSVersionParamsIPVersion

type HTTPTimeseriesGroupTLSVersionParamsIPVersion string
const (
	HTTPTimeseriesGroupTLSVersionParamsIPVersionIPv4 HTTPTimeseriesGroupTLSVersionParamsIPVersion = "IPv4"
	HTTPTimeseriesGroupTLSVersionParamsIPVersionIPv6 HTTPTimeseriesGroupTLSVersionParamsIPVersion = "IPv6"
)

func (HTTPTimeseriesGroupTLSVersionParamsIPVersion) IsKnown

type HTTPTimeseriesGroupTLSVersionParamsOS

type HTTPTimeseriesGroupTLSVersionParamsOS string
const (
	HTTPTimeseriesGroupTLSVersionParamsOSWindows  HTTPTimeseriesGroupTLSVersionParamsOS = "WINDOWS"
	HTTPTimeseriesGroupTLSVersionParamsOSMacosx   HTTPTimeseriesGroupTLSVersionParamsOS = "MACOSX"
	HTTPTimeseriesGroupTLSVersionParamsOSIos      HTTPTimeseriesGroupTLSVersionParamsOS = "IOS"
	HTTPTimeseriesGroupTLSVersionParamsOSAndroid  HTTPTimeseriesGroupTLSVersionParamsOS = "ANDROID"
	HTTPTimeseriesGroupTLSVersionParamsOSChromeos HTTPTimeseriesGroupTLSVersionParamsOS = "CHROMEOS"
	HTTPTimeseriesGroupTLSVersionParamsOSLinux    HTTPTimeseriesGroupTLSVersionParamsOS = "LINUX"
	HTTPTimeseriesGroupTLSVersionParamsOSSmartTv  HTTPTimeseriesGroupTLSVersionParamsOS = "SMART_TV"
)

func (HTTPTimeseriesGroupTLSVersionParamsOS) IsKnown

type HTTPTimeseriesGroupTLSVersionResponse

type HTTPTimeseriesGroupTLSVersionResponse struct {
	Meta   interface{}                                 `json:"meta,required"`
	Serie0 HTTPTimeseriesGroupTLSVersionResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesGroupTLSVersionResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesGroupTLSVersionResponse) UnmarshalJSON

func (r *HTTPTimeseriesGroupTLSVersionResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupTLSVersionResponseEnvelope

type HTTPTimeseriesGroupTLSVersionResponseEnvelope struct {
	Result  HTTPTimeseriesGroupTLSVersionResponse             `json:"result,required"`
	Success bool                                              `json:"success,required"`
	JSON    httpTimeseriesGroupTLSVersionResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesGroupTLSVersionResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesGroupTLSVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesGroupTLSVersionResponseSerie0

type HTTPTimeseriesGroupTLSVersionResponseSerie0 struct {
	Timestamps []string                                        `json:"timestamps,required"`
	TLS1_0     []string                                        `json:"TLS 1.0,required"`
	TLS1_1     []string                                        `json:"TLS 1.1,required"`
	TLS1_2     []string                                        `json:"TLS 1.2,required"`
	TLS1_3     []string                                        `json:"TLS 1.3,required"`
	TLSQuic    []string                                        `json:"TLS QUIC,required"`
	JSON       httpTimeseriesGroupTLSVersionResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesGroupTLSVersionResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesGroupTLSVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesParams

type HTTPTimeseriesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[HTTPTimeseriesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[HTTPTimeseriesParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[HTTPTimeseriesParamsNormalization] `query:"normalization"`
}

func (HTTPTimeseriesParams) URLQuery

func (r HTTPTimeseriesParams) URLQuery() (v url.Values)

URLQuery serializes HTTPTimeseriesParams's query parameters as `url.Values`.

type HTTPTimeseriesParamsAggInterval

type HTTPTimeseriesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	HTTPTimeseriesParamsAggInterval15m HTTPTimeseriesParamsAggInterval = "15m"
	HTTPTimeseriesParamsAggInterval1h  HTTPTimeseriesParamsAggInterval = "1h"
	HTTPTimeseriesParamsAggInterval1d  HTTPTimeseriesParamsAggInterval = "1d"
	HTTPTimeseriesParamsAggInterval1w  HTTPTimeseriesParamsAggInterval = "1w"
)

func (HTTPTimeseriesParamsAggInterval) IsKnown

type HTTPTimeseriesParamsFormat

type HTTPTimeseriesParamsFormat string

Format results are returned in.

const (
	HTTPTimeseriesParamsFormatJson HTTPTimeseriesParamsFormat = "JSON"
	HTTPTimeseriesParamsFormatCsv  HTTPTimeseriesParamsFormat = "CSV"
)

func (HTTPTimeseriesParamsFormat) IsKnown

func (r HTTPTimeseriesParamsFormat) IsKnown() bool

type HTTPTimeseriesParamsNormalization

type HTTPTimeseriesParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	HTTPTimeseriesParamsNormalizationPercentageChange HTTPTimeseriesParamsNormalization = "PERCENTAGE_CHANGE"
	HTTPTimeseriesParamsNormalizationMin0Max          HTTPTimeseriesParamsNormalization = "MIN0_MAX"
)

func (HTTPTimeseriesParamsNormalization) IsKnown

type HTTPTimeseriesResponse

type HTTPTimeseriesResponse struct {
	Meta   HTTPTimeseriesResponseMeta   `json:"meta,required"`
	Serie0 HTTPTimeseriesResponseSerie0 `json:"serie_0,required"`
	JSON   httpTimeseriesResponseJSON   `json:"-"`
}

func (*HTTPTimeseriesResponse) UnmarshalJSON

func (r *HTTPTimeseriesResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesResponseEnvelope

type HTTPTimeseriesResponseEnvelope struct {
	Result  HTTPTimeseriesResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    httpTimeseriesResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTimeseriesResponseEnvelope) UnmarshalJSON

func (r *HTTPTimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesResponseMeta

type HTTPTimeseriesResponseMeta struct {
	AggInterval    string                                   `json:"aggInterval,required"`
	DateRange      []HTTPTimeseriesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                                `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo HTTPTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpTimeseriesResponseMetaJSON           `json:"-"`
}

func (*HTTPTimeseriesResponseMeta) UnmarshalJSON

func (r *HTTPTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesResponseMetaConfidenceInfo

type HTTPTimeseriesResponseMetaConfidenceInfo struct {
	Annotations []HTTPTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                `json:"level"`
	JSON        httpTimeseriesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesResponseMetaConfidenceInfoAnnotation

type HTTPTimeseriesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                 `json:"dataSource,required"`
	Description     string                                                 `json:"description,required"`
	EventType       string                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                 `json:"linkedUrl"`
	StartTime       time.Time                                              `json:"startTime" format:"date-time"`
	JSON            httpTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesResponseMetaDateRange

type HTTPTimeseriesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                               `json:"startTime,required" format:"date-time"`
	JSON      httpTimeseriesResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPTimeseriesResponseMetaDateRange) UnmarshalJSON

func (r *HTTPTimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPTimeseriesResponseSerie0

type HTTPTimeseriesResponseSerie0 struct {
	Timestamps []time.Time                      `json:"timestamps,required" format:"date-time"`
	Values     []string                         `json:"values,required"`
	JSON       httpTimeseriesResponseSerie0JSON `json:"-"`
}

func (*HTTPTimeseriesResponseSerie0) UnmarshalJSON

func (r *HTTPTimeseriesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserFamilyParams

type HTTPTopBrowserFamilyParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTopBrowserFamilyParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPTopBrowserFamilyParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTopBrowserFamilyParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTopBrowserFamilyParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTopBrowserFamilyParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTopBrowserFamilyParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTopBrowserFamilyParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTopBrowserFamilyParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTopBrowserFamilyParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTopBrowserFamilyParams) URLQuery

func (r HTTPTopBrowserFamilyParams) URLQuery() (v url.Values)

URLQuery serializes HTTPTopBrowserFamilyParams's query parameters as `url.Values`.

type HTTPTopBrowserFamilyParamsBotClass

type HTTPTopBrowserFamilyParamsBotClass string
const (
	HTTPTopBrowserFamilyParamsBotClassLikelyAutomated HTTPTopBrowserFamilyParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTopBrowserFamilyParamsBotClassLikelyHuman     HTTPTopBrowserFamilyParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTopBrowserFamilyParamsBotClass) IsKnown

type HTTPTopBrowserFamilyParamsBrowserFamily

type HTTPTopBrowserFamilyParamsBrowserFamily string
const (
	HTTPTopBrowserFamilyParamsBrowserFamilyChrome  HTTPTopBrowserFamilyParamsBrowserFamily = "CHROME"
	HTTPTopBrowserFamilyParamsBrowserFamilyEdge    HTTPTopBrowserFamilyParamsBrowserFamily = "EDGE"
	HTTPTopBrowserFamilyParamsBrowserFamilyFirefox HTTPTopBrowserFamilyParamsBrowserFamily = "FIREFOX"
	HTTPTopBrowserFamilyParamsBrowserFamilySafari  HTTPTopBrowserFamilyParamsBrowserFamily = "SAFARI"
)

func (HTTPTopBrowserFamilyParamsBrowserFamily) IsKnown

type HTTPTopBrowserFamilyParamsDeviceType

type HTTPTopBrowserFamilyParamsDeviceType string
const (
	HTTPTopBrowserFamilyParamsDeviceTypeDesktop HTTPTopBrowserFamilyParamsDeviceType = "DESKTOP"
	HTTPTopBrowserFamilyParamsDeviceTypeMobile  HTTPTopBrowserFamilyParamsDeviceType = "MOBILE"
	HTTPTopBrowserFamilyParamsDeviceTypeOther   HTTPTopBrowserFamilyParamsDeviceType = "OTHER"
)

func (HTTPTopBrowserFamilyParamsDeviceType) IsKnown

type HTTPTopBrowserFamilyParamsFormat

type HTTPTopBrowserFamilyParamsFormat string

Format results are returned in.

const (
	HTTPTopBrowserFamilyParamsFormatJson HTTPTopBrowserFamilyParamsFormat = "JSON"
	HTTPTopBrowserFamilyParamsFormatCsv  HTTPTopBrowserFamilyParamsFormat = "CSV"
)

func (HTTPTopBrowserFamilyParamsFormat) IsKnown

type HTTPTopBrowserFamilyParamsHTTPProtocol

type HTTPTopBrowserFamilyParamsHTTPProtocol string
const (
	HTTPTopBrowserFamilyParamsHTTPProtocolHTTP  HTTPTopBrowserFamilyParamsHTTPProtocol = "HTTP"
	HTTPTopBrowserFamilyParamsHTTPProtocolHTTPS HTTPTopBrowserFamilyParamsHTTPProtocol = "HTTPS"
)

func (HTTPTopBrowserFamilyParamsHTTPProtocol) IsKnown

type HTTPTopBrowserFamilyParamsHTTPVersion

type HTTPTopBrowserFamilyParamsHTTPVersion string
const (
	HTTPTopBrowserFamilyParamsHTTPVersionHttPv1 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv1"
	HTTPTopBrowserFamilyParamsHTTPVersionHttPv2 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv2"
	HTTPTopBrowserFamilyParamsHTTPVersionHttPv3 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv3"
)

func (HTTPTopBrowserFamilyParamsHTTPVersion) IsKnown

type HTTPTopBrowserFamilyParamsIPVersion

type HTTPTopBrowserFamilyParamsIPVersion string
const (
	HTTPTopBrowserFamilyParamsIPVersionIPv4 HTTPTopBrowserFamilyParamsIPVersion = "IPv4"
	HTTPTopBrowserFamilyParamsIPVersionIPv6 HTTPTopBrowserFamilyParamsIPVersion = "IPv6"
)

func (HTTPTopBrowserFamilyParamsIPVersion) IsKnown

type HTTPTopBrowserFamilyParamsOS

type HTTPTopBrowserFamilyParamsOS string
const (
	HTTPTopBrowserFamilyParamsOSWindows  HTTPTopBrowserFamilyParamsOS = "WINDOWS"
	HTTPTopBrowserFamilyParamsOSMacosx   HTTPTopBrowserFamilyParamsOS = "MACOSX"
	HTTPTopBrowserFamilyParamsOSIos      HTTPTopBrowserFamilyParamsOS = "IOS"
	HTTPTopBrowserFamilyParamsOSAndroid  HTTPTopBrowserFamilyParamsOS = "ANDROID"
	HTTPTopBrowserFamilyParamsOSChromeos HTTPTopBrowserFamilyParamsOS = "CHROMEOS"
	HTTPTopBrowserFamilyParamsOSLinux    HTTPTopBrowserFamilyParamsOS = "LINUX"
	HTTPTopBrowserFamilyParamsOSSmartTv  HTTPTopBrowserFamilyParamsOS = "SMART_TV"
)

func (HTTPTopBrowserFamilyParamsOS) IsKnown

func (r HTTPTopBrowserFamilyParamsOS) IsKnown() bool

type HTTPTopBrowserFamilyParamsTLSVersion

type HTTPTopBrowserFamilyParamsTLSVersion string
const (
	HTTPTopBrowserFamilyParamsTLSVersionTlSv1_0  HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_0"
	HTTPTopBrowserFamilyParamsTLSVersionTlSv1_1  HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_1"
	HTTPTopBrowserFamilyParamsTLSVersionTlSv1_2  HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_2"
	HTTPTopBrowserFamilyParamsTLSVersionTlSv1_3  HTTPTopBrowserFamilyParamsTLSVersion = "TLSv1_3"
	HTTPTopBrowserFamilyParamsTLSVersionTlSvQuic HTTPTopBrowserFamilyParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTopBrowserFamilyParamsTLSVersion) IsKnown

type HTTPTopBrowserFamilyResponse

type HTTPTopBrowserFamilyResponse struct {
	Meta HTTPTopBrowserFamilyResponseMeta   `json:"meta,required"`
	Top0 []HTTPTopBrowserFamilyResponseTop0 `json:"top_0,required"`
	JSON httpTopBrowserFamilyResponseJSON   `json:"-"`
}

func (*HTTPTopBrowserFamilyResponse) UnmarshalJSON

func (r *HTTPTopBrowserFamilyResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserFamilyResponseEnvelope

type HTTPTopBrowserFamilyResponseEnvelope struct {
	Result  HTTPTopBrowserFamilyResponse             `json:"result,required"`
	Success bool                                     `json:"success,required"`
	JSON    httpTopBrowserFamilyResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTopBrowserFamilyResponseEnvelope) UnmarshalJSON

func (r *HTTPTopBrowserFamilyResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserFamilyResponseMeta

type HTTPTopBrowserFamilyResponseMeta struct {
	DateRange      []HTTPTopBrowserFamilyResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                         `json:"lastUpdated,required"`
	ConfidenceInfo HTTPTopBrowserFamilyResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpTopBrowserFamilyResponseMetaJSON           `json:"-"`
}

func (*HTTPTopBrowserFamilyResponseMeta) UnmarshalJSON

func (r *HTTPTopBrowserFamilyResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserFamilyResponseMetaConfidenceInfo

type HTTPTopBrowserFamilyResponseMetaConfidenceInfo struct {
	Annotations []HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                      `json:"level"`
	JSON        httpTopBrowserFamilyResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPTopBrowserFamilyResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPTopBrowserFamilyResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation

type HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                       `json:"dataSource,required"`
	Description     string                                                       `json:"description,required"`
	EventType       string                                                       `json:"eventType,required"`
	IsInstantaneous bool                                                         `json:"isInstantaneous,required"`
	EndTime         time.Time                                                    `json:"endTime" format:"date-time"`
	LinkedURL       string                                                       `json:"linkedUrl"`
	StartTime       time.Time                                                    `json:"startTime" format:"date-time"`
	JSON            httpTopBrowserFamilyResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type HTTPTopBrowserFamilyResponseMetaDateRange

type HTTPTopBrowserFamilyResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                     `json:"startTime,required" format:"date-time"`
	JSON      httpTopBrowserFamilyResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPTopBrowserFamilyResponseMetaDateRange) UnmarshalJSON

func (r *HTTPTopBrowserFamilyResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserFamilyResponseTop0

type HTTPTopBrowserFamilyResponseTop0 struct {
	Name  string                               `json:"name,required"`
	Value string                               `json:"value,required"`
	JSON  httpTopBrowserFamilyResponseTop0JSON `json:"-"`
}

func (*HTTPTopBrowserFamilyResponseTop0) UnmarshalJSON

func (r *HTTPTopBrowserFamilyResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserParams

type HTTPTopBrowserParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPTopBrowserParamsBotClass] `query:"botClass"`
	// Filter for browser family.
	BrowserFamily param.Field[[]HTTPTopBrowserParamsBrowserFamily] `query:"browserFamily"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPTopBrowserParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPTopBrowserParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPTopBrowserParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPTopBrowserParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPTopBrowserParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for os name.
	OS param.Field[[]HTTPTopBrowserParamsOS] `query:"os"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPTopBrowserParamsTLSVersion] `query:"tlsVersion"`
}

func (HTTPTopBrowserParams) URLQuery

func (r HTTPTopBrowserParams) URLQuery() (v url.Values)

URLQuery serializes HTTPTopBrowserParams's query parameters as `url.Values`.

type HTTPTopBrowserParamsBotClass

type HTTPTopBrowserParamsBotClass string
const (
	HTTPTopBrowserParamsBotClassLikelyAutomated HTTPTopBrowserParamsBotClass = "LIKELY_AUTOMATED"
	HTTPTopBrowserParamsBotClassLikelyHuman     HTTPTopBrowserParamsBotClass = "LIKELY_HUMAN"
)

func (HTTPTopBrowserParamsBotClass) IsKnown

func (r HTTPTopBrowserParamsBotClass) IsKnown() bool

type HTTPTopBrowserParamsBrowserFamily

type HTTPTopBrowserParamsBrowserFamily string
const (
	HTTPTopBrowserParamsBrowserFamilyChrome  HTTPTopBrowserParamsBrowserFamily = "CHROME"
	HTTPTopBrowserParamsBrowserFamilyEdge    HTTPTopBrowserParamsBrowserFamily = "EDGE"
	HTTPTopBrowserParamsBrowserFamilyFirefox HTTPTopBrowserParamsBrowserFamily = "FIREFOX"
	HTTPTopBrowserParamsBrowserFamilySafari  HTTPTopBrowserParamsBrowserFamily = "SAFARI"
)

func (HTTPTopBrowserParamsBrowserFamily) IsKnown

type HTTPTopBrowserParamsDeviceType

type HTTPTopBrowserParamsDeviceType string
const (
	HTTPTopBrowserParamsDeviceTypeDesktop HTTPTopBrowserParamsDeviceType = "DESKTOP"
	HTTPTopBrowserParamsDeviceTypeMobile  HTTPTopBrowserParamsDeviceType = "MOBILE"
	HTTPTopBrowserParamsDeviceTypeOther   HTTPTopBrowserParamsDeviceType = "OTHER"
)

func (HTTPTopBrowserParamsDeviceType) IsKnown

type HTTPTopBrowserParamsFormat

type HTTPTopBrowserParamsFormat string

Format results are returned in.

const (
	HTTPTopBrowserParamsFormatJson HTTPTopBrowserParamsFormat = "JSON"
	HTTPTopBrowserParamsFormatCsv  HTTPTopBrowserParamsFormat = "CSV"
)

func (HTTPTopBrowserParamsFormat) IsKnown

func (r HTTPTopBrowserParamsFormat) IsKnown() bool

type HTTPTopBrowserParamsHTTPProtocol

type HTTPTopBrowserParamsHTTPProtocol string
const (
	HTTPTopBrowserParamsHTTPProtocolHTTP  HTTPTopBrowserParamsHTTPProtocol = "HTTP"
	HTTPTopBrowserParamsHTTPProtocolHTTPS HTTPTopBrowserParamsHTTPProtocol = "HTTPS"
)

func (HTTPTopBrowserParamsHTTPProtocol) IsKnown

type HTTPTopBrowserParamsHTTPVersion

type HTTPTopBrowserParamsHTTPVersion string
const (
	HTTPTopBrowserParamsHTTPVersionHttPv1 HTTPTopBrowserParamsHTTPVersion = "HTTPv1"
	HTTPTopBrowserParamsHTTPVersionHttPv2 HTTPTopBrowserParamsHTTPVersion = "HTTPv2"
	HTTPTopBrowserParamsHTTPVersionHttPv3 HTTPTopBrowserParamsHTTPVersion = "HTTPv3"
)

func (HTTPTopBrowserParamsHTTPVersion) IsKnown

type HTTPTopBrowserParamsIPVersion

type HTTPTopBrowserParamsIPVersion string
const (
	HTTPTopBrowserParamsIPVersionIPv4 HTTPTopBrowserParamsIPVersion = "IPv4"
	HTTPTopBrowserParamsIPVersionIPv6 HTTPTopBrowserParamsIPVersion = "IPv6"
)

func (HTTPTopBrowserParamsIPVersion) IsKnown

func (r HTTPTopBrowserParamsIPVersion) IsKnown() bool

type HTTPTopBrowserParamsOS

type HTTPTopBrowserParamsOS string
const (
	HTTPTopBrowserParamsOSWindows  HTTPTopBrowserParamsOS = "WINDOWS"
	HTTPTopBrowserParamsOSMacosx   HTTPTopBrowserParamsOS = "MACOSX"
	HTTPTopBrowserParamsOSIos      HTTPTopBrowserParamsOS = "IOS"
	HTTPTopBrowserParamsOSAndroid  HTTPTopBrowserParamsOS = "ANDROID"
	HTTPTopBrowserParamsOSChromeos HTTPTopBrowserParamsOS = "CHROMEOS"
	HTTPTopBrowserParamsOSLinux    HTTPTopBrowserParamsOS = "LINUX"
	HTTPTopBrowserParamsOSSmartTv  HTTPTopBrowserParamsOS = "SMART_TV"
)

func (HTTPTopBrowserParamsOS) IsKnown

func (r HTTPTopBrowserParamsOS) IsKnown() bool

type HTTPTopBrowserParamsTLSVersion

type HTTPTopBrowserParamsTLSVersion string
const (
	HTTPTopBrowserParamsTLSVersionTlSv1_0  HTTPTopBrowserParamsTLSVersion = "TLSv1_0"
	HTTPTopBrowserParamsTLSVersionTlSv1_1  HTTPTopBrowserParamsTLSVersion = "TLSv1_1"
	HTTPTopBrowserParamsTLSVersionTlSv1_2  HTTPTopBrowserParamsTLSVersion = "TLSv1_2"
	HTTPTopBrowserParamsTLSVersionTlSv1_3  HTTPTopBrowserParamsTLSVersion = "TLSv1_3"
	HTTPTopBrowserParamsTLSVersionTlSvQuic HTTPTopBrowserParamsTLSVersion = "TLSvQUIC"
)

func (HTTPTopBrowserParamsTLSVersion) IsKnown

type HTTPTopBrowserResponse

type HTTPTopBrowserResponse struct {
	Meta HTTPTopBrowserResponseMeta   `json:"meta,required"`
	Top0 []HTTPTopBrowserResponseTop0 `json:"top_0,required"`
	JSON httpTopBrowserResponseJSON   `json:"-"`
}

func (*HTTPTopBrowserResponse) UnmarshalJSON

func (r *HTTPTopBrowserResponse) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserResponseEnvelope

type HTTPTopBrowserResponseEnvelope struct {
	Result  HTTPTopBrowserResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    httpTopBrowserResponseEnvelopeJSON `json:"-"`
}

func (*HTTPTopBrowserResponseEnvelope) UnmarshalJSON

func (r *HTTPTopBrowserResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserResponseMeta

type HTTPTopBrowserResponseMeta struct {
	DateRange      []HTTPTopBrowserResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                   `json:"lastUpdated,required"`
	ConfidenceInfo HTTPTopBrowserResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpTopBrowserResponseMetaJSON           `json:"-"`
}

func (*HTTPTopBrowserResponseMeta) UnmarshalJSON

func (r *HTTPTopBrowserResponseMeta) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserResponseMetaConfidenceInfo

type HTTPTopBrowserResponseMetaConfidenceInfo struct {
	Annotations []HTTPTopBrowserResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                `json:"level"`
	JSON        httpTopBrowserResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*HTTPTopBrowserResponseMetaConfidenceInfo) UnmarshalJSON

func (r *HTTPTopBrowserResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserResponseMetaConfidenceInfoAnnotation

type HTTPTopBrowserResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                 `json:"dataSource,required"`
	Description     string                                                 `json:"description,required"`
	EventType       string                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                 `json:"linkedUrl"`
	StartTime       time.Time                                              `json:"startTime" format:"date-time"`
	JSON            httpTopBrowserResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*HTTPTopBrowserResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *HTTPTopBrowserResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserResponseMetaDateRange

type HTTPTopBrowserResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                               `json:"startTime,required" format:"date-time"`
	JSON      httpTopBrowserResponseMetaDateRangeJSON `json:"-"`
}

func (*HTTPTopBrowserResponseMetaDateRange) UnmarshalJSON

func (r *HTTPTopBrowserResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type HTTPTopBrowserResponseTop0

type HTTPTopBrowserResponseTop0 struct {
	Name  string                         `json:"name,required"`
	Value string                         `json:"value,required"`
	JSON  httpTopBrowserResponseTop0JSON `json:"-"`
}

func (*HTTPTopBrowserResponseTop0) UnmarshalJSON

func (r *HTTPTopBrowserResponseTop0) UnmarshalJSON(data []byte) (err error)

type HTTPTopService

type HTTPTopService struct {
	Options []option.RequestOption
}

HTTPTopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHTTPTopService method instead.

func NewHTTPTopService

func NewHTTPTopService(opts ...option.RequestOption) (r *HTTPTopService)

NewHTTPTopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HTTPTopService) Browser

Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic.

func (*HTTPTopService) BrowserFamily

Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic.

type MemberParam

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type NetflowService

type NetflowService struct {
	Options []option.RequestOption
	Top     *NetflowTopService
}

NetflowService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewNetflowService method instead.

func NewNetflowService

func NewNetflowService(opts ...option.RequestOption) (r *NetflowService)

NewNetflowService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*NetflowService) Summary

Percentage distribution of HTTP vs other protocols traffic over a given time period.

func (*NetflowService) Timeseries

Get network traffic change over time. Visit https://en.wikipedia.org/wiki/NetFlow for more information on NetFlows.

type NetflowSummaryParams

type NetflowSummaryParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[NetflowSummaryParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (NetflowSummaryParams) URLQuery

func (r NetflowSummaryParams) URLQuery() (v url.Values)

URLQuery serializes NetflowSummaryParams's query parameters as `url.Values`.

type NetflowSummaryParamsFormat

type NetflowSummaryParamsFormat string

Format results are returned in.

const (
	NetflowSummaryParamsFormatJson NetflowSummaryParamsFormat = "JSON"
	NetflowSummaryParamsFormatCsv  NetflowSummaryParamsFormat = "CSV"
)

func (NetflowSummaryParamsFormat) IsKnown

func (r NetflowSummaryParamsFormat) IsKnown() bool

type NetflowSummaryResponse

type NetflowSummaryResponse struct {
	Meta     NetflowSummaryResponseMeta     `json:"meta,required"`
	Summary0 NetflowSummaryResponseSummary0 `json:"summary_0,required"`
	JSON     netflowSummaryResponseJSON     `json:"-"`
}

func (*NetflowSummaryResponse) UnmarshalJSON

func (r *NetflowSummaryResponse) UnmarshalJSON(data []byte) (err error)

type NetflowSummaryResponseEnvelope

type NetflowSummaryResponseEnvelope struct {
	Result  NetflowSummaryResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    netflowSummaryResponseEnvelopeJSON `json:"-"`
}

func (*NetflowSummaryResponseEnvelope) UnmarshalJSON

func (r *NetflowSummaryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetflowSummaryResponseMeta

type NetflowSummaryResponseMeta struct {
	DateRange      []NetflowSummaryResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo NetflowSummaryResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           netflowSummaryResponseMetaJSON           `json:"-"`
}

func (*NetflowSummaryResponseMeta) UnmarshalJSON

func (r *NetflowSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)

type NetflowSummaryResponseMetaConfidenceInfo

type NetflowSummaryResponseMetaConfidenceInfo struct {
	Annotations []NetflowSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                `json:"level"`
	JSON        netflowSummaryResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*NetflowSummaryResponseMetaConfidenceInfo) UnmarshalJSON

func (r *NetflowSummaryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type NetflowSummaryResponseMetaConfidenceInfoAnnotation

type NetflowSummaryResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                 `json:"dataSource,required"`
	Description     string                                                 `json:"description,required"`
	EventType       string                                                 `json:"eventType,required"`
	IsInstantaneous bool                                                   `json:"isInstantaneous,required"`
	EndTime         time.Time                                              `json:"endTime" format:"date-time"`
	LinkedURL       string                                                 `json:"linkedUrl"`
	StartTime       time.Time                                              `json:"startTime" format:"date-time"`
	JSON            netflowSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*NetflowSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *NetflowSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type NetflowSummaryResponseMetaDateRange

type NetflowSummaryResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                               `json:"startTime,required" format:"date-time"`
	JSON      netflowSummaryResponseMetaDateRangeJSON `json:"-"`
}

func (*NetflowSummaryResponseMetaDateRange) UnmarshalJSON

func (r *NetflowSummaryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type NetflowSummaryResponseSummary0

type NetflowSummaryResponseSummary0 struct {
	HTTP  string                             `json:"HTTP,required"`
	Other string                             `json:"OTHER,required"`
	JSON  netflowSummaryResponseSummary0JSON `json:"-"`
}

func (*NetflowSummaryResponseSummary0) UnmarshalJSON

func (r *NetflowSummaryResponseSummary0) UnmarshalJSON(data []byte) (err error)

type NetflowTimeseriesParams

type NetflowTimeseriesParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[NetflowTimeseriesParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[NetflowTimeseriesParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Normalization method applied. Refer to
	// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
	Normalization param.Field[NetflowTimeseriesParamsNormalization] `query:"normalization"`
	// Array of network traffic product types.
	Product param.Field[[]NetflowTimeseriesParamsProduct] `query:"product"`
}

func (NetflowTimeseriesParams) URLQuery

func (r NetflowTimeseriesParams) URLQuery() (v url.Values)

URLQuery serializes NetflowTimeseriesParams's query parameters as `url.Values`.

type NetflowTimeseriesParamsAggInterval

type NetflowTimeseriesParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	NetflowTimeseriesParamsAggInterval15m NetflowTimeseriesParamsAggInterval = "15m"
	NetflowTimeseriesParamsAggInterval1h  NetflowTimeseriesParamsAggInterval = "1h"
	NetflowTimeseriesParamsAggInterval1d  NetflowTimeseriesParamsAggInterval = "1d"
	NetflowTimeseriesParamsAggInterval1w  NetflowTimeseriesParamsAggInterval = "1w"
)

func (NetflowTimeseriesParamsAggInterval) IsKnown

type NetflowTimeseriesParamsFormat

type NetflowTimeseriesParamsFormat string

Format results are returned in.

const (
	NetflowTimeseriesParamsFormatJson NetflowTimeseriesParamsFormat = "JSON"
	NetflowTimeseriesParamsFormatCsv  NetflowTimeseriesParamsFormat = "CSV"
)

func (NetflowTimeseriesParamsFormat) IsKnown

func (r NetflowTimeseriesParamsFormat) IsKnown() bool

type NetflowTimeseriesParamsNormalization

type NetflowTimeseriesParamsNormalization string

Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).

const (
	NetflowTimeseriesParamsNormalizationPercentageChange NetflowTimeseriesParamsNormalization = "PERCENTAGE_CHANGE"
	NetflowTimeseriesParamsNormalizationMin0Max          NetflowTimeseriesParamsNormalization = "MIN0_MAX"
)

func (NetflowTimeseriesParamsNormalization) IsKnown

type NetflowTimeseriesParamsProduct

type NetflowTimeseriesParamsProduct string
const (
	NetflowTimeseriesParamsProductHTTP NetflowTimeseriesParamsProduct = "HTTP"
	NetflowTimeseriesParamsProductAll  NetflowTimeseriesParamsProduct = "ALL"
)

func (NetflowTimeseriesParamsProduct) IsKnown

type NetflowTimeseriesResponse

type NetflowTimeseriesResponse struct {
	Meta   NetflowTimeseriesResponseMeta   `json:"meta,required"`
	Serie0 NetflowTimeseriesResponseSerie0 `json:"serie_0,required"`
	JSON   netflowTimeseriesResponseJSON   `json:"-"`
}

func (*NetflowTimeseriesResponse) UnmarshalJSON

func (r *NetflowTimeseriesResponse) UnmarshalJSON(data []byte) (err error)

type NetflowTimeseriesResponseEnvelope

type NetflowTimeseriesResponseEnvelope struct {
	Result  NetflowTimeseriesResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    netflowTimeseriesResponseEnvelopeJSON `json:"-"`
}

func (*NetflowTimeseriesResponseEnvelope) UnmarshalJSON

func (r *NetflowTimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetflowTimeseriesResponseMeta

type NetflowTimeseriesResponseMeta struct {
	AggInterval    string                                      `json:"aggInterval,required"`
	DateRange      []NetflowTimeseriesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                                   `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo NetflowTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           netflowTimeseriesResponseMetaJSON           `json:"-"`
}

func (*NetflowTimeseriesResponseMeta) UnmarshalJSON

func (r *NetflowTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)

type NetflowTimeseriesResponseMetaConfidenceInfo

type NetflowTimeseriesResponseMetaConfidenceInfo struct {
	Annotations []NetflowTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                   `json:"level"`
	JSON        netflowTimeseriesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*NetflowTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *NetflowTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type NetflowTimeseriesResponseMetaConfidenceInfoAnnotation

type NetflowTimeseriesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                    `json:"dataSource,required"`
	Description     string                                                    `json:"description,required"`
	EventType       string                                                    `json:"eventType,required"`
	IsInstantaneous bool                                                      `json:"isInstantaneous,required"`
	EndTime         time.Time                                                 `json:"endTime" format:"date-time"`
	LinkedURL       string                                                    `json:"linkedUrl"`
	StartTime       time.Time                                                 `json:"startTime" format:"date-time"`
	JSON            netflowTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*NetflowTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *NetflowTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type NetflowTimeseriesResponseMetaDateRange

type NetflowTimeseriesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                  `json:"startTime,required" format:"date-time"`
	JSON      netflowTimeseriesResponseMetaDateRangeJSON `json:"-"`
}

func (*NetflowTimeseriesResponseMetaDateRange) UnmarshalJSON

func (r *NetflowTimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type NetflowTimeseriesResponseSerie0

type NetflowTimeseriesResponseSerie0 struct {
	Timestamps []time.Time                         `json:"timestamps,required" format:"date-time"`
	Values     []string                            `json:"values,required"`
	JSON       netflowTimeseriesResponseSerie0JSON `json:"-"`
}

func (*NetflowTimeseriesResponseSerie0) UnmarshalJSON

func (r *NetflowTimeseriesResponseSerie0) UnmarshalJSON(data []byte) (err error)

type NetflowTopAsesParams

type NetflowTopAsesParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[NetflowTopAsesParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (NetflowTopAsesParams) URLQuery

func (r NetflowTopAsesParams) URLQuery() (v url.Values)

URLQuery serializes NetflowTopAsesParams's query parameters as `url.Values`.

type NetflowTopAsesParamsFormat

type NetflowTopAsesParamsFormat string

Format results are returned in.

const (
	NetflowTopAsesParamsFormatJson NetflowTopAsesParamsFormat = "JSON"
	NetflowTopAsesParamsFormatCsv  NetflowTopAsesParamsFormat = "CSV"
)

func (NetflowTopAsesParamsFormat) IsKnown

func (r NetflowTopAsesParamsFormat) IsKnown() bool

type NetflowTopAsesResponse

type NetflowTopAsesResponse struct {
	Top0 []NetflowTopAsesResponseTop0 `json:"top_0,required"`
	JSON netflowTopAsesResponseJSON   `json:"-"`
}

func (*NetflowTopAsesResponse) UnmarshalJSON

func (r *NetflowTopAsesResponse) UnmarshalJSON(data []byte) (err error)

type NetflowTopAsesResponseEnvelope

type NetflowTopAsesResponseEnvelope struct {
	Result  NetflowTopAsesResponse             `json:"result,required"`
	Success bool                               `json:"success,required"`
	JSON    netflowTopAsesResponseEnvelopeJSON `json:"-"`
}

func (*NetflowTopAsesResponseEnvelope) UnmarshalJSON

func (r *NetflowTopAsesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetflowTopAsesResponseTop0

type NetflowTopAsesResponseTop0 struct {
	ClientASN    float64                        `json:"clientASN,required"`
	ClientAsName string                         `json:"clientASName,required"`
	Value        string                         `json:"value,required"`
	JSON         netflowTopAsesResponseTop0JSON `json:"-"`
}

func (*NetflowTopAsesResponseTop0) UnmarshalJSON

func (r *NetflowTopAsesResponseTop0) UnmarshalJSON(data []byte) (err error)

type NetflowTopLocationsParams

type NetflowTopLocationsParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[NetflowTopLocationsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (NetflowTopLocationsParams) URLQuery

func (r NetflowTopLocationsParams) URLQuery() (v url.Values)

URLQuery serializes NetflowTopLocationsParams's query parameters as `url.Values`.

type NetflowTopLocationsParamsFormat

type NetflowTopLocationsParamsFormat string

Format results are returned in.

const (
	NetflowTopLocationsParamsFormatJson NetflowTopLocationsParamsFormat = "JSON"
	NetflowTopLocationsParamsFormatCsv  NetflowTopLocationsParamsFormat = "CSV"
)

func (NetflowTopLocationsParamsFormat) IsKnown

type NetflowTopLocationsResponse

type NetflowTopLocationsResponse struct {
	Top0 []NetflowTopLocationsResponseTop0 `json:"top_0,required"`
	JSON netflowTopLocationsResponseJSON   `json:"-"`
}

func (*NetflowTopLocationsResponse) UnmarshalJSON

func (r *NetflowTopLocationsResponse) UnmarshalJSON(data []byte) (err error)

type NetflowTopLocationsResponseEnvelope

type NetflowTopLocationsResponseEnvelope struct {
	Result  NetflowTopLocationsResponse             `json:"result,required"`
	Success bool                                    `json:"success,required"`
	JSON    netflowTopLocationsResponseEnvelopeJSON `json:"-"`
}

func (*NetflowTopLocationsResponseEnvelope) UnmarshalJSON

func (r *NetflowTopLocationsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NetflowTopLocationsResponseTop0

type NetflowTopLocationsResponseTop0 struct {
	ClientCountryAlpha2 string                              `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                              `json:"clientCountryName,required"`
	Value               string                              `json:"value,required"`
	JSON                netflowTopLocationsResponseTop0JSON `json:"-"`
}

func (*NetflowTopLocationsResponseTop0) UnmarshalJSON

func (r *NetflowTopLocationsResponseTop0) UnmarshalJSON(data []byte) (err error)

type NetflowTopService

type NetflowTopService struct {
	Options []option.RequestOption
}

NetflowTopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewNetflowTopService method instead.

func NewNetflowTopService

func NewNetflowTopService(opts ...option.RequestOption) (r *NetflowTopService)

NewNetflowTopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*NetflowTopService) Ases

Get the top autonomous systems (AS) by network traffic (NetFlows) over a given time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information.

func (*NetflowTopService) Locations

Get the top locations by network traffic (NetFlows) over a given time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type QualityIQIService

type QualityIQIService struct {
	Options []option.RequestOption
}

QualityIQIService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewQualityIQIService method instead.

func NewQualityIQIService

func NewQualityIQIService(opts ...option.RequestOption) (r *QualityIQIService)

NewQualityIQIService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*QualityIQIService) Summary

Get a summary (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI).

func (*QualityIQIService) TimeseriesGroups

Get a time series (percentiles) of bandwidth, latency or DNS response time from the Radar Internet Quality Index (IQI).

type QualityIQISummaryParams

type QualityIQISummaryParams struct {
	// Which metric to return: bandwidth, latency or DNS response time.
	Metric param.Field[QualityIQISummaryParamsMetric] `query:"metric,required"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[QualityIQISummaryParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (QualityIQISummaryParams) URLQuery

func (r QualityIQISummaryParams) URLQuery() (v url.Values)

URLQuery serializes QualityIQISummaryParams's query parameters as `url.Values`.

type QualityIQISummaryParamsFormat

type QualityIQISummaryParamsFormat string

Format results are returned in.

const (
	QualityIQISummaryParamsFormatJson QualityIQISummaryParamsFormat = "JSON"
	QualityIQISummaryParamsFormatCsv  QualityIQISummaryParamsFormat = "CSV"
)

func (QualityIQISummaryParamsFormat) IsKnown

func (r QualityIQISummaryParamsFormat) IsKnown() bool

type QualityIQISummaryParamsMetric

type QualityIQISummaryParamsMetric string

Which metric to return: bandwidth, latency or DNS response time.

const (
	QualityIQISummaryParamsMetricBandwidth QualityIQISummaryParamsMetric = "BANDWIDTH"
	QualityIQISummaryParamsMetricDNS       QualityIQISummaryParamsMetric = "DNS"
	QualityIQISummaryParamsMetricLatency   QualityIQISummaryParamsMetric = "LATENCY"
)

func (QualityIQISummaryParamsMetric) IsKnown

func (r QualityIQISummaryParamsMetric) IsKnown() bool

type QualityIQISummaryResponse

type QualityIQISummaryResponse struct {
	Meta     QualityIQISummaryResponseMeta     `json:"meta,required"`
	Summary0 QualityIQISummaryResponseSummary0 `json:"summary_0,required"`
	JSON     qualityIQISummaryResponseJSON     `json:"-"`
}

func (*QualityIQISummaryResponse) UnmarshalJSON

func (r *QualityIQISummaryResponse) UnmarshalJSON(data []byte) (err error)

type QualityIQISummaryResponseEnvelope

type QualityIQISummaryResponseEnvelope struct {
	Result  QualityIQISummaryResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    qualityIQISummaryResponseEnvelopeJSON `json:"-"`
}

func (*QualityIQISummaryResponseEnvelope) UnmarshalJSON

func (r *QualityIQISummaryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type QualityIQISummaryResponseMeta

type QualityIQISummaryResponseMeta struct {
	DateRange      []QualityIQISummaryResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                      `json:"lastUpdated,required"`
	Normalization  string                                      `json:"normalization,required"`
	ConfidenceInfo QualityIQISummaryResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           qualityIQISummaryResponseMetaJSON           `json:"-"`
}

func (*QualityIQISummaryResponseMeta) UnmarshalJSON

func (r *QualityIQISummaryResponseMeta) UnmarshalJSON(data []byte) (err error)

type QualityIQISummaryResponseMetaConfidenceInfo

type QualityIQISummaryResponseMetaConfidenceInfo struct {
	Annotations []QualityIQISummaryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                   `json:"level"`
	JSON        qualityIQISummaryResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*QualityIQISummaryResponseMetaConfidenceInfo) UnmarshalJSON

func (r *QualityIQISummaryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type QualityIQISummaryResponseMetaConfidenceInfoAnnotation

type QualityIQISummaryResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                    `json:"dataSource,required"`
	Description     string                                                    `json:"description,required"`
	EventType       string                                                    `json:"eventType,required"`
	IsInstantaneous bool                                                      `json:"isInstantaneous,required"`
	EndTime         time.Time                                                 `json:"endTime" format:"date-time"`
	LinkedURL       string                                                    `json:"linkedUrl"`
	StartTime       time.Time                                                 `json:"startTime" format:"date-time"`
	JSON            qualityIQISummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*QualityIQISummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *QualityIQISummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type QualityIQISummaryResponseMetaDateRange

type QualityIQISummaryResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                  `json:"startTime,required" format:"date-time"`
	JSON      qualityIQISummaryResponseMetaDateRangeJSON `json:"-"`
}

func (*QualityIQISummaryResponseMetaDateRange) UnmarshalJSON

func (r *QualityIQISummaryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type QualityIQISummaryResponseSummary0

type QualityIQISummaryResponseSummary0 struct {
	P25  string                                `json:"p25,required"`
	P50  string                                `json:"p50,required"`
	P75  string                                `json:"p75,required"`
	JSON qualityIQISummaryResponseSummary0JSON `json:"-"`
}

func (*QualityIQISummaryResponseSummary0) UnmarshalJSON

func (r *QualityIQISummaryResponseSummary0) UnmarshalJSON(data []byte) (err error)

type QualityIQITimeseriesGroupsParams

type QualityIQITimeseriesGroupsParams struct {
	// Which metric to return: bandwidth, latency or DNS response time.
	Metric param.Field[QualityIQITimeseriesGroupsParamsMetric] `query:"metric,required"`
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[QualityIQITimeseriesGroupsParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[QualityIQITimeseriesGroupsParamsFormat] `query:"format"`
	// Enable interpolation for all series (using the average).
	Interpolation param.Field[bool] `query:"interpolation"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (QualityIQITimeseriesGroupsParams) URLQuery

func (r QualityIQITimeseriesGroupsParams) URLQuery() (v url.Values)

URLQuery serializes QualityIQITimeseriesGroupsParams's query parameters as `url.Values`.

type QualityIQITimeseriesGroupsParamsAggInterval

type QualityIQITimeseriesGroupsParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	QualityIQITimeseriesGroupsParamsAggInterval15m QualityIQITimeseriesGroupsParamsAggInterval = "15m"
	QualityIQITimeseriesGroupsParamsAggInterval1h  QualityIQITimeseriesGroupsParamsAggInterval = "1h"
	QualityIQITimeseriesGroupsParamsAggInterval1d  QualityIQITimeseriesGroupsParamsAggInterval = "1d"
	QualityIQITimeseriesGroupsParamsAggInterval1w  QualityIQITimeseriesGroupsParamsAggInterval = "1w"
)

func (QualityIQITimeseriesGroupsParamsAggInterval) IsKnown

type QualityIQITimeseriesGroupsParamsFormat

type QualityIQITimeseriesGroupsParamsFormat string

Format results are returned in.

const (
	QualityIQITimeseriesGroupsParamsFormatJson QualityIQITimeseriesGroupsParamsFormat = "JSON"
	QualityIQITimeseriesGroupsParamsFormatCsv  QualityIQITimeseriesGroupsParamsFormat = "CSV"
)

func (QualityIQITimeseriesGroupsParamsFormat) IsKnown

type QualityIQITimeseriesGroupsParamsMetric

type QualityIQITimeseriesGroupsParamsMetric string

Which metric to return: bandwidth, latency or DNS response time.

const (
	QualityIQITimeseriesGroupsParamsMetricBandwidth QualityIQITimeseriesGroupsParamsMetric = "BANDWIDTH"
	QualityIQITimeseriesGroupsParamsMetricDNS       QualityIQITimeseriesGroupsParamsMetric = "DNS"
	QualityIQITimeseriesGroupsParamsMetricLatency   QualityIQITimeseriesGroupsParamsMetric = "LATENCY"
)

func (QualityIQITimeseriesGroupsParamsMetric) IsKnown

type QualityIQITimeseriesGroupsResponse

type QualityIQITimeseriesGroupsResponse struct {
	Meta   interface{}                              `json:"meta,required"`
	Serie0 QualityIQITimeseriesGroupsResponseSerie0 `json:"serie_0,required"`
	JSON   qualityIQITimeseriesGroupsResponseJSON   `json:"-"`
}

func (*QualityIQITimeseriesGroupsResponse) UnmarshalJSON

func (r *QualityIQITimeseriesGroupsResponse) UnmarshalJSON(data []byte) (err error)

type QualityIQITimeseriesGroupsResponseEnvelope

type QualityIQITimeseriesGroupsResponseEnvelope struct {
	Result  QualityIQITimeseriesGroupsResponse             `json:"result,required"`
	Success bool                                           `json:"success,required"`
	JSON    qualityIQITimeseriesGroupsResponseEnvelopeJSON `json:"-"`
}

func (*QualityIQITimeseriesGroupsResponseEnvelope) UnmarshalJSON

func (r *QualityIQITimeseriesGroupsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type QualityIQITimeseriesGroupsResponseSerie0

type QualityIQITimeseriesGroupsResponseSerie0 struct {
	P25        []string                                     `json:"p25,required"`
	P50        []string                                     `json:"p50,required"`
	P75        []string                                     `json:"p75,required"`
	Timestamps []string                                     `json:"timestamps,required"`
	JSON       qualityIQITimeseriesGroupsResponseSerie0JSON `json:"-"`
}

func (*QualityIQITimeseriesGroupsResponseSerie0) UnmarshalJSON

func (r *QualityIQITimeseriesGroupsResponseSerie0) UnmarshalJSON(data []byte) (err error)

type QualityService

type QualityService struct {
	Options []option.RequestOption
	IQI     *QualityIQIService
	Speed   *QualitySpeedService
}

QualityService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewQualityService method instead.

func NewQualityService

func NewQualityService(opts ...option.RequestOption) (r *QualityService)

NewQualityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type QualitySpeedHistogramParams

type QualitySpeedHistogramParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// The width for every bucket in the histogram.
	BucketSize param.Field[int64] `query:"bucketSize"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// Format results are returned in.
	Format param.Field[QualitySpeedHistogramParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Metrics to be returned.
	MetricGroup param.Field[QualitySpeedHistogramParamsMetricGroup] `query:"metricGroup"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (QualitySpeedHistogramParams) URLQuery

func (r QualitySpeedHistogramParams) URLQuery() (v url.Values)

URLQuery serializes QualitySpeedHistogramParams's query parameters as `url.Values`.

type QualitySpeedHistogramParamsFormat

type QualitySpeedHistogramParamsFormat string

Format results are returned in.

const (
	QualitySpeedHistogramParamsFormatJson QualitySpeedHistogramParamsFormat = "JSON"
	QualitySpeedHistogramParamsFormatCsv  QualitySpeedHistogramParamsFormat = "CSV"
)

func (QualitySpeedHistogramParamsFormat) IsKnown

type QualitySpeedHistogramParamsMetricGroup

type QualitySpeedHistogramParamsMetricGroup string

Metrics to be returned.

const (
	QualitySpeedHistogramParamsMetricGroupBandwidth QualitySpeedHistogramParamsMetricGroup = "BANDWIDTH"
	QualitySpeedHistogramParamsMetricGroupLatency   QualitySpeedHistogramParamsMetricGroup = "LATENCY"
	QualitySpeedHistogramParamsMetricGroupJitter    QualitySpeedHistogramParamsMetricGroup = "JITTER"
)

func (QualitySpeedHistogramParamsMetricGroup) IsKnown

type QualitySpeedHistogramResponse

type QualitySpeedHistogramResponse struct {
	Histogram0 QualitySpeedHistogramResponseHistogram0 `json:"histogram_0,required"`
	Meta       interface{}                             `json:"meta,required"`
	JSON       qualitySpeedHistogramResponseJSON       `json:"-"`
}

func (*QualitySpeedHistogramResponse) UnmarshalJSON

func (r *QualitySpeedHistogramResponse) UnmarshalJSON(data []byte) (err error)

type QualitySpeedHistogramResponseEnvelope

type QualitySpeedHistogramResponseEnvelope struct {
	Result  QualitySpeedHistogramResponse             `json:"result,required"`
	Success bool                                      `json:"success,required"`
	JSON    qualitySpeedHistogramResponseEnvelopeJSON `json:"-"`
}

func (*QualitySpeedHistogramResponseEnvelope) UnmarshalJSON

func (r *QualitySpeedHistogramResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type QualitySpeedHistogramResponseHistogram0

type QualitySpeedHistogramResponseHistogram0 struct {
	BandwidthDownload []string                                    `json:"bandwidthDownload,required"`
	BandwidthUpload   []string                                    `json:"bandwidthUpload,required"`
	BucketMin         []string                                    `json:"bucketMin,required"`
	JSON              qualitySpeedHistogramResponseHistogram0JSON `json:"-"`
}

func (*QualitySpeedHistogramResponseHistogram0) UnmarshalJSON

func (r *QualitySpeedHistogramResponseHistogram0) UnmarshalJSON(data []byte) (err error)

type QualitySpeedService

type QualitySpeedService struct {
	Options []option.RequestOption
	Top     *QualitySpeedTopService
}

QualitySpeedService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewQualitySpeedService method instead.

func NewQualitySpeedService

func NewQualitySpeedService(opts ...option.RequestOption) (r *QualitySpeedService)

NewQualitySpeedService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*QualitySpeedService) Histogram

Get an histogram from the previous 90 days of Cloudflare Speed Test data, split into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets.

func (*QualitySpeedService) Summary

Get a summary of bandwidth, latency, jitter and packet loss, from the previous 90 days of Cloudflare Speed Test data.

type QualitySpeedSummaryParams

type QualitySpeedSummaryParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// Format results are returned in.
	Format param.Field[QualitySpeedSummaryParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (QualitySpeedSummaryParams) URLQuery

func (r QualitySpeedSummaryParams) URLQuery() (v url.Values)

URLQuery serializes QualitySpeedSummaryParams's query parameters as `url.Values`.

type QualitySpeedSummaryParamsFormat

type QualitySpeedSummaryParamsFormat string

Format results are returned in.

const (
	QualitySpeedSummaryParamsFormatJson QualitySpeedSummaryParamsFormat = "JSON"
	QualitySpeedSummaryParamsFormatCsv  QualitySpeedSummaryParamsFormat = "CSV"
)

func (QualitySpeedSummaryParamsFormat) IsKnown

type QualitySpeedSummaryResponse

type QualitySpeedSummaryResponse struct {
	Meta     QualitySpeedSummaryResponseMeta     `json:"meta,required"`
	Summary0 QualitySpeedSummaryResponseSummary0 `json:"summary_0,required"`
	JSON     qualitySpeedSummaryResponseJSON     `json:"-"`
}

func (*QualitySpeedSummaryResponse) UnmarshalJSON

func (r *QualitySpeedSummaryResponse) UnmarshalJSON(data []byte) (err error)

type QualitySpeedSummaryResponseEnvelope

type QualitySpeedSummaryResponseEnvelope struct {
	Result  QualitySpeedSummaryResponse             `json:"result,required"`
	Success bool                                    `json:"success,required"`
	JSON    qualitySpeedSummaryResponseEnvelopeJSON `json:"-"`
}

func (*QualitySpeedSummaryResponseEnvelope) UnmarshalJSON

func (r *QualitySpeedSummaryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type QualitySpeedSummaryResponseMeta

type QualitySpeedSummaryResponseMeta struct {
	DateRange      []QualitySpeedSummaryResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                        `json:"lastUpdated,required"`
	Normalization  string                                        `json:"normalization,required"`
	ConfidenceInfo QualitySpeedSummaryResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           qualitySpeedSummaryResponseMetaJSON           `json:"-"`
}

func (*QualitySpeedSummaryResponseMeta) UnmarshalJSON

func (r *QualitySpeedSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)

type QualitySpeedSummaryResponseMetaConfidenceInfo

type QualitySpeedSummaryResponseMetaConfidenceInfo struct {
	Annotations []QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                     `json:"level"`
	JSON        qualitySpeedSummaryResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*QualitySpeedSummaryResponseMetaConfidenceInfo) UnmarshalJSON

func (r *QualitySpeedSummaryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation

type QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                      `json:"dataSource,required"`
	Description     string                                                      `json:"description,required"`
	EventType       string                                                      `json:"eventType,required"`
	IsInstantaneous bool                                                        `json:"isInstantaneous,required"`
	EndTime         time.Time                                                   `json:"endTime" format:"date-time"`
	LinkedURL       string                                                      `json:"linkedUrl"`
	StartTime       time.Time                                                   `json:"startTime" format:"date-time"`
	JSON            qualitySpeedSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type QualitySpeedSummaryResponseMetaDateRange

type QualitySpeedSummaryResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                    `json:"startTime,required" format:"date-time"`
	JSON      qualitySpeedSummaryResponseMetaDateRangeJSON `json:"-"`
}

func (*QualitySpeedSummaryResponseMetaDateRange) UnmarshalJSON

func (r *QualitySpeedSummaryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type QualitySpeedSummaryResponseSummary0

type QualitySpeedSummaryResponseSummary0 struct {
	BandwidthDownload string                                  `json:"bandwidthDownload,required"`
	BandwidthUpload   string                                  `json:"bandwidthUpload,required"`
	JitterIdle        string                                  `json:"jitterIdle,required"`
	JitterLoaded      string                                  `json:"jitterLoaded,required"`
	LatencyIdle       string                                  `json:"latencyIdle,required"`
	LatencyLoaded     string                                  `json:"latencyLoaded,required"`
	PacketLoss        string                                  `json:"packetLoss,required"`
	JSON              qualitySpeedSummaryResponseSummary0JSON `json:"-"`
}

func (*QualitySpeedSummaryResponseSummary0) UnmarshalJSON

func (r *QualitySpeedSummaryResponseSummary0) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopAsesParams

type QualitySpeedTopAsesParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// Format results are returned in.
	Format param.Field[QualitySpeedTopAsesParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Metric to order the results by.
	OrderBy param.Field[QualitySpeedTopAsesParamsOrderBy] `query:"orderBy"`
	// Reverse the order of results.
	Reverse param.Field[bool] `query:"reverse"`
}

func (QualitySpeedTopAsesParams) URLQuery

func (r QualitySpeedTopAsesParams) URLQuery() (v url.Values)

URLQuery serializes QualitySpeedTopAsesParams's query parameters as `url.Values`.

type QualitySpeedTopAsesParamsFormat

type QualitySpeedTopAsesParamsFormat string

Format results are returned in.

const (
	QualitySpeedTopAsesParamsFormatJson QualitySpeedTopAsesParamsFormat = "JSON"
	QualitySpeedTopAsesParamsFormatCsv  QualitySpeedTopAsesParamsFormat = "CSV"
)

func (QualitySpeedTopAsesParamsFormat) IsKnown

type QualitySpeedTopAsesParamsOrderBy

type QualitySpeedTopAsesParamsOrderBy string

Metric to order the results by.

const (
	QualitySpeedTopAsesParamsOrderByBandwidthDownload QualitySpeedTopAsesParamsOrderBy = "BANDWIDTH_DOWNLOAD"
	QualitySpeedTopAsesParamsOrderByBandwidthUpload   QualitySpeedTopAsesParamsOrderBy = "BANDWIDTH_UPLOAD"
	QualitySpeedTopAsesParamsOrderByLatencyIdle       QualitySpeedTopAsesParamsOrderBy = "LATENCY_IDLE"
	QualitySpeedTopAsesParamsOrderByLatencyLoaded     QualitySpeedTopAsesParamsOrderBy = "LATENCY_LOADED"
	QualitySpeedTopAsesParamsOrderByJitterIdle        QualitySpeedTopAsesParamsOrderBy = "JITTER_IDLE"
	QualitySpeedTopAsesParamsOrderByJitterLoaded      QualitySpeedTopAsesParamsOrderBy = "JITTER_LOADED"
)

func (QualitySpeedTopAsesParamsOrderBy) IsKnown

type QualitySpeedTopAsesResponse

type QualitySpeedTopAsesResponse struct {
	Meta QualitySpeedTopAsesResponseMeta   `json:"meta,required"`
	Top0 []QualitySpeedTopAsesResponseTop0 `json:"top_0,required"`
	JSON qualitySpeedTopAsesResponseJSON   `json:"-"`
}

func (*QualitySpeedTopAsesResponse) UnmarshalJSON

func (r *QualitySpeedTopAsesResponse) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopAsesResponseEnvelope

type QualitySpeedTopAsesResponseEnvelope struct {
	Result  QualitySpeedTopAsesResponse             `json:"result,required"`
	Success bool                                    `json:"success,required"`
	JSON    qualitySpeedTopAsesResponseEnvelopeJSON `json:"-"`
}

func (*QualitySpeedTopAsesResponseEnvelope) UnmarshalJSON

func (r *QualitySpeedTopAsesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopAsesResponseMeta

type QualitySpeedTopAsesResponseMeta struct {
	DateRange      []QualitySpeedTopAsesResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                        `json:"lastUpdated,required"`
	ConfidenceInfo QualitySpeedTopAsesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           qualitySpeedTopAsesResponseMetaJSON           `json:"-"`
}

func (*QualitySpeedTopAsesResponseMeta) UnmarshalJSON

func (r *QualitySpeedTopAsesResponseMeta) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopAsesResponseMetaConfidenceInfo

type QualitySpeedTopAsesResponseMetaConfidenceInfo struct {
	Annotations []QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                     `json:"level"`
	JSON        qualitySpeedTopAsesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*QualitySpeedTopAsesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *QualitySpeedTopAsesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation

type QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                      `json:"dataSource,required"`
	Description     string                                                      `json:"description,required"`
	EventType       string                                                      `json:"eventType,required"`
	IsInstantaneous bool                                                        `json:"isInstantaneous,required"`
	EndTime         time.Time                                                   `json:"endTime" format:"date-time"`
	LinkedURL       string                                                      `json:"linkedUrl"`
	StartTime       time.Time                                                   `json:"startTime" format:"date-time"`
	JSON            qualitySpeedTopAsesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type QualitySpeedTopAsesResponseMetaDateRange

type QualitySpeedTopAsesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                    `json:"startTime,required" format:"date-time"`
	JSON      qualitySpeedTopAsesResponseMetaDateRangeJSON `json:"-"`
}

func (*QualitySpeedTopAsesResponseMetaDateRange) UnmarshalJSON

func (r *QualitySpeedTopAsesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopAsesResponseTop0

type QualitySpeedTopAsesResponseTop0 struct {
	BandwidthDownload string                              `json:"bandwidthDownload,required"`
	BandwidthUpload   string                              `json:"bandwidthUpload,required"`
	ClientASN         float64                             `json:"clientASN,required"`
	ClientAsName      string                              `json:"clientASName,required"`
	JitterIdle        string                              `json:"jitterIdle,required"`
	JitterLoaded      string                              `json:"jitterLoaded,required"`
	LatencyIdle       string                              `json:"latencyIdle,required"`
	LatencyLoaded     string                              `json:"latencyLoaded,required"`
	NumTests          float64                             `json:"numTests,required"`
	RankPower         float64                             `json:"rankPower,required"`
	JSON              qualitySpeedTopAsesResponseTop0JSON `json:"-"`
}

func (*QualitySpeedTopAsesResponseTop0) UnmarshalJSON

func (r *QualitySpeedTopAsesResponseTop0) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopLocationsParams

type QualitySpeedTopLocationsParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// Format results are returned in.
	Format param.Field[QualitySpeedTopLocationsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Metric to order the results by.
	OrderBy param.Field[QualitySpeedTopLocationsParamsOrderBy] `query:"orderBy"`
	// Reverse the order of results.
	Reverse param.Field[bool] `query:"reverse"`
}

func (QualitySpeedTopLocationsParams) URLQuery

func (r QualitySpeedTopLocationsParams) URLQuery() (v url.Values)

URLQuery serializes QualitySpeedTopLocationsParams's query parameters as `url.Values`.

type QualitySpeedTopLocationsParamsFormat

type QualitySpeedTopLocationsParamsFormat string

Format results are returned in.

const (
	QualitySpeedTopLocationsParamsFormatJson QualitySpeedTopLocationsParamsFormat = "JSON"
	QualitySpeedTopLocationsParamsFormatCsv  QualitySpeedTopLocationsParamsFormat = "CSV"
)

func (QualitySpeedTopLocationsParamsFormat) IsKnown

type QualitySpeedTopLocationsParamsOrderBy

type QualitySpeedTopLocationsParamsOrderBy string

Metric to order the results by.

const (
	QualitySpeedTopLocationsParamsOrderByBandwidthDownload QualitySpeedTopLocationsParamsOrderBy = "BANDWIDTH_DOWNLOAD"
	QualitySpeedTopLocationsParamsOrderByBandwidthUpload   QualitySpeedTopLocationsParamsOrderBy = "BANDWIDTH_UPLOAD"
	QualitySpeedTopLocationsParamsOrderByLatencyIdle       QualitySpeedTopLocationsParamsOrderBy = "LATENCY_IDLE"
	QualitySpeedTopLocationsParamsOrderByLatencyLoaded     QualitySpeedTopLocationsParamsOrderBy = "LATENCY_LOADED"
	QualitySpeedTopLocationsParamsOrderByJitterIdle        QualitySpeedTopLocationsParamsOrderBy = "JITTER_IDLE"
	QualitySpeedTopLocationsParamsOrderByJitterLoaded      QualitySpeedTopLocationsParamsOrderBy = "JITTER_LOADED"
)

func (QualitySpeedTopLocationsParamsOrderBy) IsKnown

type QualitySpeedTopLocationsResponse

type QualitySpeedTopLocationsResponse struct {
	Meta QualitySpeedTopLocationsResponseMeta   `json:"meta,required"`
	Top0 []QualitySpeedTopLocationsResponseTop0 `json:"top_0,required"`
	JSON qualitySpeedTopLocationsResponseJSON   `json:"-"`
}

func (*QualitySpeedTopLocationsResponse) UnmarshalJSON

func (r *QualitySpeedTopLocationsResponse) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopLocationsResponseEnvelope

type QualitySpeedTopLocationsResponseEnvelope struct {
	Result  QualitySpeedTopLocationsResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    qualitySpeedTopLocationsResponseEnvelopeJSON `json:"-"`
}

func (*QualitySpeedTopLocationsResponseEnvelope) UnmarshalJSON

func (r *QualitySpeedTopLocationsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopLocationsResponseMeta

type QualitySpeedTopLocationsResponseMeta struct {
	DateRange      []QualitySpeedTopLocationsResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                             `json:"lastUpdated,required"`
	ConfidenceInfo QualitySpeedTopLocationsResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           qualitySpeedTopLocationsResponseMetaJSON           `json:"-"`
}

func (*QualitySpeedTopLocationsResponseMeta) UnmarshalJSON

func (r *QualitySpeedTopLocationsResponseMeta) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopLocationsResponseMetaConfidenceInfo

type QualitySpeedTopLocationsResponseMetaConfidenceInfo struct {
	Annotations []QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                          `json:"level"`
	JSON        qualitySpeedTopLocationsResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*QualitySpeedTopLocationsResponseMetaConfidenceInfo) UnmarshalJSON

func (r *QualitySpeedTopLocationsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation

type QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                           `json:"dataSource,required"`
	Description     string                                                           `json:"description,required"`
	EventType       string                                                           `json:"eventType,required"`
	IsInstantaneous bool                                                             `json:"isInstantaneous,required"`
	EndTime         time.Time                                                        `json:"endTime" format:"date-time"`
	LinkedURL       string                                                           `json:"linkedUrl"`
	StartTime       time.Time                                                        `json:"startTime" format:"date-time"`
	JSON            qualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type QualitySpeedTopLocationsResponseMetaDateRange

type QualitySpeedTopLocationsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                         `json:"startTime,required" format:"date-time"`
	JSON      qualitySpeedTopLocationsResponseMetaDateRangeJSON `json:"-"`
}

func (*QualitySpeedTopLocationsResponseMetaDateRange) UnmarshalJSON

func (r *QualitySpeedTopLocationsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopLocationsResponseTop0

type QualitySpeedTopLocationsResponseTop0 struct {
	BandwidthDownload   string                                   `json:"bandwidthDownload,required"`
	BandwidthUpload     string                                   `json:"bandwidthUpload,required"`
	ClientCountryAlpha2 string                                   `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                   `json:"clientCountryName,required"`
	JitterIdle          string                                   `json:"jitterIdle,required"`
	JitterLoaded        string                                   `json:"jitterLoaded,required"`
	LatencyIdle         string                                   `json:"latencyIdle,required"`
	LatencyLoaded       string                                   `json:"latencyLoaded,required"`
	NumTests            float64                                  `json:"numTests,required"`
	RankPower           float64                                  `json:"rankPower,required"`
	JSON                qualitySpeedTopLocationsResponseTop0JSON `json:"-"`
}

func (*QualitySpeedTopLocationsResponseTop0) UnmarshalJSON

func (r *QualitySpeedTopLocationsResponseTop0) UnmarshalJSON(data []byte) (err error)

type QualitySpeedTopService

type QualitySpeedTopService struct {
	Options []option.RequestOption
}

QualitySpeedTopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewQualitySpeedTopService method instead.

func NewQualitySpeedTopService

func NewQualitySpeedTopService(opts ...option.RequestOption) (r *QualitySpeedTopService)

NewQualitySpeedTopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*QualitySpeedTopService) Ases

Get the top autonomous systems by bandwidth, latency, jitter or packet loss, from the previous 90 days of Cloudflare Speed Test data.

func (*QualitySpeedTopService) Locations

Get the top locations by bandwidth, latency, jitter or packet loss, from the previous 90 days of Cloudflare Speed Test data.

type RadarEmailSeries

type RadarEmailSeries struct {
	Fail []string             `json:"FAIL,required"`
	None []string             `json:"NONE,required"`
	Pass []string             `json:"PASS,required"`
	JSON radarEmailSeriesJSON `json:"-"`
}

func (*RadarEmailSeries) UnmarshalJSON

func (r *RadarEmailSeries) UnmarshalJSON(data []byte) (err error)

type RadarEmailSummary

type RadarEmailSummary struct {
	Fail string                `json:"FAIL,required"`
	None string                `json:"NONE,required"`
	Pass string                `json:"PASS,required"`
	JSON radarEmailSummaryJSON `json:"-"`
}

func (*RadarEmailSummary) UnmarshalJSON

func (r *RadarEmailSummary) UnmarshalJSON(data []byte) (err error)

type RadarService

type RadarService struct {
	Options           []option.RequestOption
	AI                *AIService
	Annotations       *AnnotationService
	BGP               *BGPService
	Datasets          *DatasetService
	DNS               *DNSService
	Netflows          *NetflowService
	Search            *SearchService
	VerifiedBots      *VerifiedBotService
	AS112             *AS112Service
	Email             *EmailService
	Attacks           *AttackService
	Entities          *EntityService
	HTTP              *HTTPService
	Quality           *QualityService
	Ranking           *RankingService
	TrafficAnomalies  *TrafficAnomalyService
	TCPResetsTimeouts *TCPResetsTimeoutService
}

RadarService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRadarService method instead.

func NewRadarService

func NewRadarService(opts ...option.RequestOption) (r *RadarService)

NewRadarService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type RankingDomainGetParams

type RankingDomainGetParams struct {
	// Array of dates to filter the ranking.
	Date param.Field[[]string] `query:"date"`
	// Format results are returned in.
	Format param.Field[RankingDomainGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// The ranking type.
	RankingType param.Field[RankingDomainGetParamsRankingType] `query:"rankingType"`
}

func (RankingDomainGetParams) URLQuery

func (r RankingDomainGetParams) URLQuery() (v url.Values)

URLQuery serializes RankingDomainGetParams's query parameters as `url.Values`.

type RankingDomainGetParamsFormat

type RankingDomainGetParamsFormat string

Format results are returned in.

const (
	RankingDomainGetParamsFormatJson RankingDomainGetParamsFormat = "JSON"
	RankingDomainGetParamsFormatCsv  RankingDomainGetParamsFormat = "CSV"
)

func (RankingDomainGetParamsFormat) IsKnown

func (r RankingDomainGetParamsFormat) IsKnown() bool

type RankingDomainGetParamsRankingType

type RankingDomainGetParamsRankingType string

The ranking type.

const (
	RankingDomainGetParamsRankingTypePopular        RankingDomainGetParamsRankingType = "POPULAR"
	RankingDomainGetParamsRankingTypeTrendingRise   RankingDomainGetParamsRankingType = "TRENDING_RISE"
	RankingDomainGetParamsRankingTypeTrendingSteady RankingDomainGetParamsRankingType = "TRENDING_STEADY"
)

func (RankingDomainGetParamsRankingType) IsKnown

type RankingDomainGetResponse

type RankingDomainGetResponse struct {
	Details0 RankingDomainGetResponseDetails0 `json:"details_0,required"`
	JSON     rankingDomainGetResponseJSON     `json:"-"`
}

func (*RankingDomainGetResponse) UnmarshalJSON

func (r *RankingDomainGetResponse) UnmarshalJSON(data []byte) (err error)

type RankingDomainGetResponseDetails0

type RankingDomainGetResponseDetails0 struct {
	Categories   []RankingDomainGetResponseDetails0Category    `json:"categories,required"`
	TopLocations []RankingDomainGetResponseDetails0TopLocation `json:"top_locations,required"`
	// Only available in POPULAR ranking for the most recent ranking.
	Bucket string                               `json:"bucket"`
	Rank   int64                                `json:"rank"`
	JSON   rankingDomainGetResponseDetails0JSON `json:"-"`
}

func (*RankingDomainGetResponseDetails0) UnmarshalJSON

func (r *RankingDomainGetResponseDetails0) UnmarshalJSON(data []byte) (err error)

type RankingDomainGetResponseDetails0Category

type RankingDomainGetResponseDetails0Category struct {
	ID              float64                                      `json:"id,required"`
	Name            string                                       `json:"name,required"`
	SuperCategoryID float64                                      `json:"superCategoryId,required"`
	JSON            rankingDomainGetResponseDetails0CategoryJSON `json:"-"`
}

func (*RankingDomainGetResponseDetails0Category) UnmarshalJSON

func (r *RankingDomainGetResponseDetails0Category) UnmarshalJSON(data []byte) (err error)

type RankingDomainGetResponseDetails0TopLocation

type RankingDomainGetResponseDetails0TopLocation struct {
	LocationCode string                                          `json:"locationCode,required"`
	LocationName string                                          `json:"locationName,required"`
	Rank         int64                                           `json:"rank,required"`
	JSON         rankingDomainGetResponseDetails0TopLocationJSON `json:"-"`
}

func (*RankingDomainGetResponseDetails0TopLocation) UnmarshalJSON

func (r *RankingDomainGetResponseDetails0TopLocation) UnmarshalJSON(data []byte) (err error)

type RankingDomainGetResponseEnvelope

type RankingDomainGetResponseEnvelope struct {
	Result  RankingDomainGetResponse             `json:"result,required"`
	Success bool                                 `json:"success,required"`
	JSON    rankingDomainGetResponseEnvelopeJSON `json:"-"`
}

func (*RankingDomainGetResponseEnvelope) UnmarshalJSON

func (r *RankingDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type RankingDomainService

type RankingDomainService struct {
	Options []option.RequestOption
}

RankingDomainService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRankingDomainService method instead.

func NewRankingDomainService

func NewRankingDomainService(opts ...option.RequestOption) (r *RankingDomainService)

NewRankingDomainService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*RankingDomainService) Get

Gets Domains Rank details. Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints.

type RankingService

type RankingService struct {
	Options []option.RequestOption
	Domain  *RankingDomainService
}

RankingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRankingService method instead.

func NewRankingService

func NewRankingService(opts ...option.RequestOption) (r *RankingService)

NewRankingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*RankingService) TimeseriesGroups

Gets Domains Rank updates change over time. Raw values are returned.

func (*RankingService) Top

Get top or trending domains based on their rank. Popular domains are domains of broad appeal based on how people use the Internet. Trending domains are domains that are generating a surge in interest. For more information on top domains, see https://blog.cloudflare.com/radar-domain-rankings/.

type RankingTimeseriesGroupsParams

type RankingTimeseriesGroupsParams struct {
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Array of comma separated list of domains names.
	Domains param.Field[[]string] `query:"domains"`
	// Format results are returned in.
	Format param.Field[RankingTimeseriesGroupsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of locations (alpha-2 country codes).
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// The ranking type.
	RankingType param.Field[RankingTimeseriesGroupsParamsRankingType] `query:"rankingType"`
}

func (RankingTimeseriesGroupsParams) URLQuery

func (r RankingTimeseriesGroupsParams) URLQuery() (v url.Values)

URLQuery serializes RankingTimeseriesGroupsParams's query parameters as `url.Values`.

type RankingTimeseriesGroupsParamsFormat

type RankingTimeseriesGroupsParamsFormat string

Format results are returned in.

const (
	RankingTimeseriesGroupsParamsFormatJson RankingTimeseriesGroupsParamsFormat = "JSON"
	RankingTimeseriesGroupsParamsFormatCsv  RankingTimeseriesGroupsParamsFormat = "CSV"
)

func (RankingTimeseriesGroupsParamsFormat) IsKnown

type RankingTimeseriesGroupsParamsRankingType

type RankingTimeseriesGroupsParamsRankingType string

The ranking type.

const (
	RankingTimeseriesGroupsParamsRankingTypePopular        RankingTimeseriesGroupsParamsRankingType = "POPULAR"
	RankingTimeseriesGroupsParamsRankingTypeTrendingRise   RankingTimeseriesGroupsParamsRankingType = "TRENDING_RISE"
	RankingTimeseriesGroupsParamsRankingTypeTrendingSteady RankingTimeseriesGroupsParamsRankingType = "TRENDING_STEADY"
)

func (RankingTimeseriesGroupsParamsRankingType) IsKnown

type RankingTimeseriesGroupsResponse

type RankingTimeseriesGroupsResponse struct {
	Meta   RankingTimeseriesGroupsResponseMeta   `json:"meta,required"`
	Serie0 RankingTimeseriesGroupsResponseSerie0 `json:"serie_0,required"`
	JSON   rankingTimeseriesGroupsResponseJSON   `json:"-"`
}

func (*RankingTimeseriesGroupsResponse) UnmarshalJSON

func (r *RankingTimeseriesGroupsResponse) UnmarshalJSON(data []byte) (err error)

type RankingTimeseriesGroupsResponseEnvelope

type RankingTimeseriesGroupsResponseEnvelope struct {
	Result  RankingTimeseriesGroupsResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    rankingTimeseriesGroupsResponseEnvelopeJSON `json:"-"`
}

func (*RankingTimeseriesGroupsResponseEnvelope) UnmarshalJSON

func (r *RankingTimeseriesGroupsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type RankingTimeseriesGroupsResponseMeta

type RankingTimeseriesGroupsResponseMeta struct {
	DateRange []RankingTimeseriesGroupsResponseMetaDateRange `json:"dateRange,required"`
	JSON      rankingTimeseriesGroupsResponseMetaJSON        `json:"-"`
}

func (*RankingTimeseriesGroupsResponseMeta) UnmarshalJSON

func (r *RankingTimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)

type RankingTimeseriesGroupsResponseMetaDateRange

type RankingTimeseriesGroupsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      rankingTimeseriesGroupsResponseMetaDateRangeJSON `json:"-"`
}

func (*RankingTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON

func (r *RankingTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type RankingTimeseriesGroupsResponseSerie0

type RankingTimeseriesGroupsResponseSerie0 struct {
	Timestamps  []string                                                `json:"timestamps,required"`
	ExtraFields map[string][]RankingTimeseriesGroupsResponseSerie0Union `json:"-,extras"`
	JSON        rankingTimeseriesGroupsResponseSerie0JSON               `json:"-"`
}

func (*RankingTimeseriesGroupsResponseSerie0) UnmarshalJSON

func (r *RankingTimeseriesGroupsResponseSerie0) UnmarshalJSON(data []byte) (err error)

type RankingTimeseriesGroupsResponseSerie0Union

type RankingTimeseriesGroupsResponseSerie0Union interface {
	ImplementsRadarRankingTimeseriesGroupsResponseSerie0Union()
}

Union satisfied by shared.UnionString or shared.UnionFloat.

type RankingTopParams

type RankingTopParams struct {
	// Array of dates to filter the ranking.
	Date param.Field[[]string] `query:"date"`
	// Format results are returned in.
	Format param.Field[RankingTopParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of locations (alpha-2 country codes).
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// The ranking type.
	RankingType param.Field[RankingTopParamsRankingType] `query:"rankingType"`
}

func (RankingTopParams) URLQuery

func (r RankingTopParams) URLQuery() (v url.Values)

URLQuery serializes RankingTopParams's query parameters as `url.Values`.

type RankingTopParamsFormat

type RankingTopParamsFormat string

Format results are returned in.

const (
	RankingTopParamsFormatJson RankingTopParamsFormat = "JSON"
	RankingTopParamsFormatCsv  RankingTopParamsFormat = "CSV"
)

func (RankingTopParamsFormat) IsKnown

func (r RankingTopParamsFormat) IsKnown() bool

type RankingTopParamsRankingType

type RankingTopParamsRankingType string

The ranking type.

const (
	RankingTopParamsRankingTypePopular        RankingTopParamsRankingType = "POPULAR"
	RankingTopParamsRankingTypeTrendingRise   RankingTopParamsRankingType = "TRENDING_RISE"
	RankingTopParamsRankingTypeTrendingSteady RankingTopParamsRankingType = "TRENDING_STEADY"
)

func (RankingTopParamsRankingType) IsKnown

func (r RankingTopParamsRankingType) IsKnown() bool

type RankingTopResponse

type RankingTopResponse struct {
	Meta RankingTopResponseMeta   `json:"meta,required"`
	Top0 []RankingTopResponseTop0 `json:"top_0,required"`
	JSON rankingTopResponseJSON   `json:"-"`
}

func (*RankingTopResponse) UnmarshalJSON

func (r *RankingTopResponse) UnmarshalJSON(data []byte) (err error)

type RankingTopResponseEnvelope

type RankingTopResponseEnvelope struct {
	Result  RankingTopResponse             `json:"result,required"`
	Success bool                           `json:"success,required"`
	JSON    rankingTopResponseEnvelopeJSON `json:"-"`
}

func (*RankingTopResponseEnvelope) UnmarshalJSON

func (r *RankingTopResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type RankingTopResponseMeta

type RankingTopResponseMeta struct {
	Top0 RankingTopResponseMetaTop0 `json:"top_0,required"`
	JSON rankingTopResponseMetaJSON `json:"-"`
}

func (*RankingTopResponseMeta) UnmarshalJSON

func (r *RankingTopResponseMeta) UnmarshalJSON(data []byte) (err error)

type RankingTopResponseMetaTop0

type RankingTopResponseMetaTop0 struct {
	Date string                         `json:"date,required"`
	JSON rankingTopResponseMetaTop0JSON `json:"-"`
}

func (*RankingTopResponseMetaTop0) UnmarshalJSON

func (r *RankingTopResponseMetaTop0) UnmarshalJSON(data []byte) (err error)

type RankingTopResponseTop0

type RankingTopResponseTop0 struct {
	Categories []RankingTopResponseTop0Category `json:"categories,required"`
	Domain     string                           `json:"domain,required"`
	Rank       int64                            `json:"rank,required"`
	// Only available in TRENDING rankings.
	PctRankChange float64                    `json:"pctRankChange"`
	JSON          rankingTopResponseTop0JSON `json:"-"`
}

func (*RankingTopResponseTop0) UnmarshalJSON

func (r *RankingTopResponseTop0) UnmarshalJSON(data []byte) (err error)

type RankingTopResponseTop0Category

type RankingTopResponseTop0Category struct {
	ID              float64                            `json:"id,required"`
	Name            string                             `json:"name,required"`
	SuperCategoryID float64                            `json:"superCategoryId,required"`
	JSON            rankingTopResponseTop0CategoryJSON `json:"-"`
}

func (*RankingTopResponseTop0Category) UnmarshalJSON

func (r *RankingTopResponseTop0Category) UnmarshalJSON(data []byte) (err error)

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type SearchGlobalParams

type SearchGlobalParams struct {
	// Search for locations, AS and reports.
	Query param.Field[string] `query:"query,required"`
	// Search types to be excluded from results.
	Exclude param.Field[[]SearchGlobalParamsExclude] `query:"exclude"`
	// Format results are returned in.
	Format param.Field[SearchGlobalParamsFormat] `query:"format"`
	// Search types to be included in results.
	Include param.Field[[]SearchGlobalParamsInclude] `query:"include"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Limit the number of objects per search category.
	LimitPerGroup param.Field[float64] `query:"limitPerGroup"`
}

func (SearchGlobalParams) URLQuery

func (r SearchGlobalParams) URLQuery() (v url.Values)

URLQuery serializes SearchGlobalParams's query parameters as `url.Values`.

type SearchGlobalParamsExclude

type SearchGlobalParamsExclude string
const (
	SearchGlobalParamsExcludeSpecialEvents SearchGlobalParamsExclude = "SPECIAL_EVENTS"
	SearchGlobalParamsExcludeNotebooks     SearchGlobalParamsExclude = "NOTEBOOKS"
	SearchGlobalParamsExcludeLocations     SearchGlobalParamsExclude = "LOCATIONS"
	SearchGlobalParamsExcludeASNs          SearchGlobalParamsExclude = "ASNS"
)

func (SearchGlobalParamsExclude) IsKnown

func (r SearchGlobalParamsExclude) IsKnown() bool

type SearchGlobalParamsFormat

type SearchGlobalParamsFormat string

Format results are returned in.

const (
	SearchGlobalParamsFormatJson SearchGlobalParamsFormat = "JSON"
	SearchGlobalParamsFormatCsv  SearchGlobalParamsFormat = "CSV"
)

func (SearchGlobalParamsFormat) IsKnown

func (r SearchGlobalParamsFormat) IsKnown() bool

type SearchGlobalParamsInclude

type SearchGlobalParamsInclude string
const (
	SearchGlobalParamsIncludeSpecialEvents SearchGlobalParamsInclude = "SPECIAL_EVENTS"
	SearchGlobalParamsIncludeNotebooks     SearchGlobalParamsInclude = "NOTEBOOKS"
	SearchGlobalParamsIncludeLocations     SearchGlobalParamsInclude = "LOCATIONS"
	SearchGlobalParamsIncludeASNs          SearchGlobalParamsInclude = "ASNS"
)

func (SearchGlobalParamsInclude) IsKnown

func (r SearchGlobalParamsInclude) IsKnown() bool

type SearchGlobalResponse

type SearchGlobalResponse struct {
	Search []SearchGlobalResponseSearch `json:"search,required"`
	JSON   searchGlobalResponseJSON     `json:"-"`
}

func (*SearchGlobalResponse) UnmarshalJSON

func (r *SearchGlobalResponse) UnmarshalJSON(data []byte) (err error)

type SearchGlobalResponseEnvelope

type SearchGlobalResponseEnvelope struct {
	Result  SearchGlobalResponse             `json:"result,required"`
	Success bool                             `json:"success,required"`
	JSON    searchGlobalResponseEnvelopeJSON `json:"-"`
}

func (*SearchGlobalResponseEnvelope) UnmarshalJSON

func (r *SearchGlobalResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SearchGlobalResponseSearch

type SearchGlobalResponseSearch struct {
	Code string                         `json:"code,required"`
	Name string                         `json:"name,required"`
	Type string                         `json:"type,required"`
	JSON searchGlobalResponseSearchJSON `json:"-"`
}

func (*SearchGlobalResponseSearch) UnmarshalJSON

func (r *SearchGlobalResponseSearch) UnmarshalJSON(data []byte) (err error)

type SearchService

type SearchService struct {
	Options []option.RequestOption
}

SearchService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSearchService method instead.

func NewSearchService

func NewSearchService(opts ...option.RequestOption) (r *SearchService)

NewSearchService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SearchService) Global

Lets you search for locations, autonomous systems (ASes), and reports.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type TCPResetsTimeoutService

type TCPResetsTimeoutService struct {
	Options []option.RequestOption
}

TCPResetsTimeoutService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTCPResetsTimeoutService method instead.

func NewTCPResetsTimeoutService

func NewTCPResetsTimeoutService(opts ...option.RequestOption) (r *TCPResetsTimeoutService)

NewTCPResetsTimeoutService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TCPResetsTimeoutService) Summary

Percentage distribution by connection stage of TCP connections terminated within the first 10 packets by a reset or timeout, for a given time period.

func (*TCPResetsTimeoutService) TimeseriesGroups

Percentage distribution by connection stage of TCP connections terminated within the first 10 packets by a reset or timeout, over time.

type TCPResetsTimeoutSummaryParams

type TCPResetsTimeoutSummaryParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[TCPResetsTimeoutSummaryParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (TCPResetsTimeoutSummaryParams) URLQuery

func (r TCPResetsTimeoutSummaryParams) URLQuery() (v url.Values)

URLQuery serializes TCPResetsTimeoutSummaryParams's query parameters as `url.Values`.

type TCPResetsTimeoutSummaryParamsFormat

type TCPResetsTimeoutSummaryParamsFormat string

Format results are returned in.

const (
	TCPResetsTimeoutSummaryParamsFormatJson TCPResetsTimeoutSummaryParamsFormat = "JSON"
	TCPResetsTimeoutSummaryParamsFormatCsv  TCPResetsTimeoutSummaryParamsFormat = "CSV"
)

func (TCPResetsTimeoutSummaryParamsFormat) IsKnown

type TCPResetsTimeoutSummaryResponse

type TCPResetsTimeoutSummaryResponse struct {
	Meta     TCPResetsTimeoutSummaryResponseMeta     `json:"meta,required"`
	Summary0 TCPResetsTimeoutSummaryResponseSummary0 `json:"summary_0,required"`
	JSON     tcpResetsTimeoutSummaryResponseJSON     `json:"-"`
}

func (*TCPResetsTimeoutSummaryResponse) UnmarshalJSON

func (r *TCPResetsTimeoutSummaryResponse) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutSummaryResponseEnvelope

type TCPResetsTimeoutSummaryResponseEnvelope struct {
	Result  TCPResetsTimeoutSummaryResponse             `json:"result,required"`
	Success bool                                        `json:"success,required"`
	JSON    tcpResetsTimeoutSummaryResponseEnvelopeJSON `json:"-"`
}

func (*TCPResetsTimeoutSummaryResponseEnvelope) UnmarshalJSON

func (r *TCPResetsTimeoutSummaryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutSummaryResponseMeta

type TCPResetsTimeoutSummaryResponseMeta struct {
	DateRange      []TCPResetsTimeoutSummaryResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo TCPResetsTimeoutSummaryResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           tcpResetsTimeoutSummaryResponseMetaJSON           `json:"-"`
}

func (*TCPResetsTimeoutSummaryResponseMeta) UnmarshalJSON

func (r *TCPResetsTimeoutSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutSummaryResponseMetaConfidenceInfo

type TCPResetsTimeoutSummaryResponseMetaConfidenceInfo struct {
	Annotations []TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                         `json:"level"`
	JSON        tcpResetsTimeoutSummaryResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*TCPResetsTimeoutSummaryResponseMetaConfidenceInfo) UnmarshalJSON

func (r *TCPResetsTimeoutSummaryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation

type TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                          `json:"dataSource,required"`
	Description     string                                                          `json:"description,required"`
	EventType       string                                                          `json:"eventType,required"`
	IsInstantaneous bool                                                            `json:"isInstantaneous,required"`
	EndTime         time.Time                                                       `json:"endTime" format:"date-time"`
	LinkedURL       string                                                          `json:"linkedUrl"`
	StartTime       time.Time                                                       `json:"startTime" format:"date-time"`
	JSON            tcpResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type TCPResetsTimeoutSummaryResponseMetaDateRange

type TCPResetsTimeoutSummaryResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                        `json:"startTime,required" format:"date-time"`
	JSON      tcpResetsTimeoutSummaryResponseMetaDateRangeJSON `json:"-"`
}

func (*TCPResetsTimeoutSummaryResponseMetaDateRange) UnmarshalJSON

func (r *TCPResetsTimeoutSummaryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutSummaryResponseSummary0

type TCPResetsTimeoutSummaryResponseSummary0 struct {
	// Connection resets within the first 10 packets from the client, but after the
	// server has received multiple data packets.
	LaterInFlow string `json:"later_in_flow,required"`
	// All other connections.
	NoMatch string `json:"no_match,required"`
	// Connection resets or timeouts after the server received both a SYN packet and an
	// ACK packet, meaning the connection was successfully established.
	PostAck string `json:"post_ack,required"`
	// Connection resets or timeouts after the server received a packet with PSH flag
	// set, following connection establishment.
	PostPsh string `json:"post_psh,required"`
	// Connection resets or timeouts after the server received only a single SYN
	// packet.
	PostSyn string                                      `json:"post_syn,required"`
	JSON    tcpResetsTimeoutSummaryResponseSummary0JSON `json:"-"`
}

func (*TCPResetsTimeoutSummaryResponseSummary0) UnmarshalJSON

func (r *TCPResetsTimeoutSummaryResponseSummary0) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutTimeseriesGroupsParams

type TCPResetsTimeoutTimeseriesGroupsParams struct {
	// Aggregation interval results should be returned in (for example, in 15 minutes
	// or 1 hour intervals). Refer to
	// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
	AggInterval param.Field[TCPResetsTimeoutTimeseriesGroupsParamsAggInterval] `query:"aggInterval"`
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[TCPResetsTimeoutTimeseriesGroupsParamsFormat] `query:"format"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (TCPResetsTimeoutTimeseriesGroupsParams) URLQuery

URLQuery serializes TCPResetsTimeoutTimeseriesGroupsParams's query parameters as `url.Values`.

type TCPResetsTimeoutTimeseriesGroupsParamsAggInterval

type TCPResetsTimeoutTimeseriesGroupsParamsAggInterval string

Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).

const (
	TCPResetsTimeoutTimeseriesGroupsParamsAggInterval15m TCPResetsTimeoutTimeseriesGroupsParamsAggInterval = "15m"
	TCPResetsTimeoutTimeseriesGroupsParamsAggInterval1h  TCPResetsTimeoutTimeseriesGroupsParamsAggInterval = "1h"
	TCPResetsTimeoutTimeseriesGroupsParamsAggInterval1d  TCPResetsTimeoutTimeseriesGroupsParamsAggInterval = "1d"
	TCPResetsTimeoutTimeseriesGroupsParamsAggInterval1w  TCPResetsTimeoutTimeseriesGroupsParamsAggInterval = "1w"
)

func (TCPResetsTimeoutTimeseriesGroupsParamsAggInterval) IsKnown

type TCPResetsTimeoutTimeseriesGroupsParamsFormat

type TCPResetsTimeoutTimeseriesGroupsParamsFormat string

Format results are returned in.

const (
	TCPResetsTimeoutTimeseriesGroupsParamsFormatJson TCPResetsTimeoutTimeseriesGroupsParamsFormat = "JSON"
	TCPResetsTimeoutTimeseriesGroupsParamsFormatCsv  TCPResetsTimeoutTimeseriesGroupsParamsFormat = "CSV"
)

func (TCPResetsTimeoutTimeseriesGroupsParamsFormat) IsKnown

type TCPResetsTimeoutTimeseriesGroupsResponse

type TCPResetsTimeoutTimeseriesGroupsResponse struct {
	Meta   TCPResetsTimeoutTimeseriesGroupsResponseMeta   `json:"meta,required"`
	Serie0 TCPResetsTimeoutTimeseriesGroupsResponseSerie0 `json:"serie_0,required"`
	JSON   tcpResetsTimeoutTimeseriesGroupsResponseJSON   `json:"-"`
}

func (*TCPResetsTimeoutTimeseriesGroupsResponse) UnmarshalJSON

func (r *TCPResetsTimeoutTimeseriesGroupsResponse) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutTimeseriesGroupsResponseEnvelope

type TCPResetsTimeoutTimeseriesGroupsResponseEnvelope struct {
	Result  TCPResetsTimeoutTimeseriesGroupsResponse             `json:"result,required"`
	Success bool                                                 `json:"success,required"`
	JSON    tcpResetsTimeoutTimeseriesGroupsResponseEnvelopeJSON `json:"-"`
}

func (*TCPResetsTimeoutTimeseriesGroupsResponseEnvelope) UnmarshalJSON

func (r *TCPResetsTimeoutTimeseriesGroupsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutTimeseriesGroupsResponseMeta

type TCPResetsTimeoutTimeseriesGroupsResponseMeta struct {
	AggInterval    string                                                     `json:"aggInterval,required"`
	DateRange      []TCPResetsTimeoutTimeseriesGroupsResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    time.Time                                                  `json:"lastUpdated,required" format:"date-time"`
	ConfidenceInfo TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           tcpResetsTimeoutTimeseriesGroupsResponseMetaJSON           `json:"-"`
}

func (*TCPResetsTimeoutTimeseriesGroupsResponseMeta) UnmarshalJSON

func (r *TCPResetsTimeoutTimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo

type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo struct {
	Annotations []TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                                  `json:"level"`
	JSON        tcpResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON

type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation

type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                                   `json:"dataSource,required"`
	Description     string                                                                   `json:"description,required"`
	EventType       string                                                                   `json:"eventType,required"`
	IsInstantaneous bool                                                                     `json:"isInstantaneous,required"`
	EndTime         time.Time                                                                `json:"endTime" format:"date-time"`
	LinkedURL       string                                                                   `json:"linkedUrl"`
	StartTime       time.Time                                                                `json:"startTime" format:"date-time"`
	JSON            tcpResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type TCPResetsTimeoutTimeseriesGroupsResponseMetaDateRange

type TCPResetsTimeoutTimeseriesGroupsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                                 `json:"startTime,required" format:"date-time"`
	JSON      tcpResetsTimeoutTimeseriesGroupsResponseMetaDateRangeJSON `json:"-"`
}

func (*TCPResetsTimeoutTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON

func (r *TCPResetsTimeoutTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type TCPResetsTimeoutTimeseriesGroupsResponseSerie0

type TCPResetsTimeoutTimeseriesGroupsResponseSerie0 struct {
	// Connection resets within the first 10 packets from the client, but after the
	// server has received multiple data packets.
	LaterInFlow []string `json:"later_in_flow,required"`
	// All other connections.
	NoMatch []string `json:"no_match,required"`
	// Connection resets or timeouts after the server received both a SYN packet and an
	// ACK packet, meaning the connection was successfully established.
	PostAck []string `json:"post_ack,required"`
	// Connection resets or timeouts after the server received a packet with PSH flag
	// set, following connection establishment.
	PostPsh []string `json:"post_psh,required"`
	// Connection resets or timeouts after the server received only a single SYN
	// packet.
	PostSyn    []string                                           `json:"post_syn,required"`
	Timestamps []time.Time                                        `json:"timestamps,required" format:"date-time"`
	JSON       tcpResetsTimeoutTimeseriesGroupsResponseSerie0JSON `json:"-"`
}

func (*TCPResetsTimeoutTimeseriesGroupsResponseSerie0) UnmarshalJSON

func (r *TCPResetsTimeoutTimeseriesGroupsResponseSerie0) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyGetParams

type TrafficAnomalyGetParams struct {
	// Single ASN as integer.
	ASN param.Field[int64] `query:"asn"`
	// End of the date range (inclusive).
	DateEnd param.Field[time.Time] `query:"dateEnd" format:"date-time"`
	// Shorthand date ranges for the last X days - use when you don't need specific
	// start and end dates.
	DateRange param.Field[string] `query:"dateRange"`
	// Start of the date range (inclusive).
	DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[TrafficAnomalyGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Location Alpha2 code.
	Location param.Field[string] `query:"location"`
	// Number of objects to skip before grabbing results.
	Offset param.Field[int64]                         `query:"offset"`
	Status param.Field[TrafficAnomalyGetParamsStatus] `query:"status"`
}

func (TrafficAnomalyGetParams) URLQuery

func (r TrafficAnomalyGetParams) URLQuery() (v url.Values)

URLQuery serializes TrafficAnomalyGetParams's query parameters as `url.Values`.

type TrafficAnomalyGetParamsFormat

type TrafficAnomalyGetParamsFormat string

Format results are returned in.

const (
	TrafficAnomalyGetParamsFormatJson TrafficAnomalyGetParamsFormat = "JSON"
	TrafficAnomalyGetParamsFormatCsv  TrafficAnomalyGetParamsFormat = "CSV"
)

func (TrafficAnomalyGetParamsFormat) IsKnown

func (r TrafficAnomalyGetParamsFormat) IsKnown() bool

type TrafficAnomalyGetParamsStatus

type TrafficAnomalyGetParamsStatus string
const (
	TrafficAnomalyGetParamsStatusVerified   TrafficAnomalyGetParamsStatus = "VERIFIED"
	TrafficAnomalyGetParamsStatusUnverified TrafficAnomalyGetParamsStatus = "UNVERIFIED"
)

func (TrafficAnomalyGetParamsStatus) IsKnown

func (r TrafficAnomalyGetParamsStatus) IsKnown() bool

type TrafficAnomalyGetResponse

type TrafficAnomalyGetResponse struct {
	TrafficAnomalies []TrafficAnomalyGetResponseTrafficAnomaly `json:"trafficAnomalies,required"`
	JSON             trafficAnomalyGetResponseJSON             `json:"-"`
}

func (*TrafficAnomalyGetResponse) UnmarshalJSON

func (r *TrafficAnomalyGetResponse) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyGetResponseEnvelope

type TrafficAnomalyGetResponseEnvelope struct {
	Result  TrafficAnomalyGetResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    trafficAnomalyGetResponseEnvelopeJSON `json:"-"`
}

func (*TrafficAnomalyGetResponseEnvelope) UnmarshalJSON

func (r *TrafficAnomalyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyGetResponseTrafficAnomaliesASNDetails

type TrafficAnomalyGetResponseTrafficAnomaliesASNDetails struct {
	ASN       string                                                       `json:"asn,required"`
	Name      string                                                       `json:"name,required"`
	Locations TrafficAnomalyGetResponseTrafficAnomaliesASNDetailsLocations `json:"locations"`
	JSON      trafficAnomalyGetResponseTrafficAnomaliesASNDetailsJSON      `json:"-"`
}

func (*TrafficAnomalyGetResponseTrafficAnomaliesASNDetails) UnmarshalJSON

func (r *TrafficAnomalyGetResponseTrafficAnomaliesASNDetails) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyGetResponseTrafficAnomaliesASNDetailsLocations

type TrafficAnomalyGetResponseTrafficAnomaliesASNDetailsLocations struct {
	Code string                                                           `json:"code,required"`
	Name string                                                           `json:"name,required"`
	JSON trafficAnomalyGetResponseTrafficAnomaliesASNDetailsLocationsJSON `json:"-"`
}

func (*TrafficAnomalyGetResponseTrafficAnomaliesASNDetailsLocations) UnmarshalJSON

type TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails

type TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails struct {
	Code string                                                       `json:"code,required"`
	Name string                                                       `json:"name,required"`
	JSON trafficAnomalyGetResponseTrafficAnomaliesLocationDetailsJSON `json:"-"`
}

func (*TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails) UnmarshalJSON

type TrafficAnomalyGetResponseTrafficAnomaly

type TrafficAnomalyGetResponseTrafficAnomaly struct {
	StartDate            string                                                   `json:"startDate,required"`
	Status               string                                                   `json:"status,required"`
	Type                 string                                                   `json:"type,required"`
	UUID                 string                                                   `json:"uuid,required"`
	ASNDetails           TrafficAnomalyGetResponseTrafficAnomaliesASNDetails      `json:"asnDetails"`
	EndDate              string                                                   `json:"endDate"`
	LocationDetails      TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails `json:"locationDetails"`
	VisibleInDataSources []string                                                 `json:"visibleInDataSources"`
	JSON                 trafficAnomalyGetResponseTrafficAnomalyJSON              `json:"-"`
}

func (*TrafficAnomalyGetResponseTrafficAnomaly) UnmarshalJSON

func (r *TrafficAnomalyGetResponseTrafficAnomaly) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyLocationGetParams

type TrafficAnomalyLocationGetParams struct {
	// End of the date range (inclusive).
	DateEnd param.Field[time.Time] `query:"dateEnd" format:"date-time"`
	// Shorthand date ranges for the last X days - use when you don't need specific
	// start and end dates.
	DateRange param.Field[string] `query:"dateRange"`
	// Start of the date range (inclusive).
	DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[TrafficAnomalyLocationGetParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit  param.Field[int64]                                 `query:"limit"`
	Status param.Field[TrafficAnomalyLocationGetParamsStatus] `query:"status"`
}

func (TrafficAnomalyLocationGetParams) URLQuery

func (r TrafficAnomalyLocationGetParams) URLQuery() (v url.Values)

URLQuery serializes TrafficAnomalyLocationGetParams's query parameters as `url.Values`.

type TrafficAnomalyLocationGetParamsFormat

type TrafficAnomalyLocationGetParamsFormat string

Format results are returned in.

const (
	TrafficAnomalyLocationGetParamsFormatJson TrafficAnomalyLocationGetParamsFormat = "JSON"
	TrafficAnomalyLocationGetParamsFormatCsv  TrafficAnomalyLocationGetParamsFormat = "CSV"
)

func (TrafficAnomalyLocationGetParamsFormat) IsKnown

type TrafficAnomalyLocationGetParamsStatus

type TrafficAnomalyLocationGetParamsStatus string
const (
	TrafficAnomalyLocationGetParamsStatusVerified   TrafficAnomalyLocationGetParamsStatus = "VERIFIED"
	TrafficAnomalyLocationGetParamsStatusUnverified TrafficAnomalyLocationGetParamsStatus = "UNVERIFIED"
)

func (TrafficAnomalyLocationGetParamsStatus) IsKnown

type TrafficAnomalyLocationGetResponse

type TrafficAnomalyLocationGetResponse struct {
	TrafficAnomalies []TrafficAnomalyLocationGetResponseTrafficAnomaly `json:"trafficAnomalies,required"`
	JSON             trafficAnomalyLocationGetResponseJSON             `json:"-"`
}

func (*TrafficAnomalyLocationGetResponse) UnmarshalJSON

func (r *TrafficAnomalyLocationGetResponse) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyLocationGetResponseEnvelope

type TrafficAnomalyLocationGetResponseEnvelope struct {
	Result  TrafficAnomalyLocationGetResponse             `json:"result,required"`
	Success bool                                          `json:"success,required"`
	JSON    trafficAnomalyLocationGetResponseEnvelopeJSON `json:"-"`
}

func (*TrafficAnomalyLocationGetResponseEnvelope) UnmarshalJSON

func (r *TrafficAnomalyLocationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyLocationGetResponseTrafficAnomaly

type TrafficAnomalyLocationGetResponseTrafficAnomaly struct {
	ClientCountryAlpha2 string                                              `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                                              `json:"clientCountryName,required"`
	Value               string                                              `json:"value,required"`
	JSON                trafficAnomalyLocationGetResponseTrafficAnomalyJSON `json:"-"`
}

func (*TrafficAnomalyLocationGetResponseTrafficAnomaly) UnmarshalJSON

func (r *TrafficAnomalyLocationGetResponseTrafficAnomaly) UnmarshalJSON(data []byte) (err error)

type TrafficAnomalyLocationService

type TrafficAnomalyLocationService struct {
	Options []option.RequestOption
}

TrafficAnomalyLocationService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTrafficAnomalyLocationService method instead.

func NewTrafficAnomalyLocationService

func NewTrafficAnomalyLocationService(opts ...option.RequestOption) (r *TrafficAnomalyLocationService)

NewTrafficAnomalyLocationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TrafficAnomalyLocationService) Get

Internet traffic anomalies are signals that might point to an outage. These alerts are automatically detected by Radar and then manually verified by our team. This endpoint returns the sum of alerts grouped by location.

type TrafficAnomalyService

type TrafficAnomalyService struct {
	Options   []option.RequestOption
	Locations *TrafficAnomalyLocationService
}

TrafficAnomalyService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTrafficAnomalyService method instead.

func NewTrafficAnomalyService

func NewTrafficAnomalyService(opts ...option.RequestOption) (r *TrafficAnomalyService)

NewTrafficAnomalyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TrafficAnomalyService) Get

Internet traffic anomalies are signals that might point to an outage. These alerts are automatically detected by Radar and then manually verified by our team. This endpoint returns the latest alerts.

type VerifiedBotService

type VerifiedBotService struct {
	Options []option.RequestOption
	Top     *VerifiedBotTopService
}

VerifiedBotService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewVerifiedBotService method instead.

func NewVerifiedBotService

func NewVerifiedBotService(opts ...option.RequestOption) (r *VerifiedBotService)

NewVerifiedBotService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type VerifiedBotTopBotsParams

type VerifiedBotTopBotsParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[VerifiedBotTopBotsParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (VerifiedBotTopBotsParams) URLQuery

func (r VerifiedBotTopBotsParams) URLQuery() (v url.Values)

URLQuery serializes VerifiedBotTopBotsParams's query parameters as `url.Values`.

type VerifiedBotTopBotsParamsFormat

type VerifiedBotTopBotsParamsFormat string

Format results are returned in.

const (
	VerifiedBotTopBotsParamsFormatJson VerifiedBotTopBotsParamsFormat = "JSON"
	VerifiedBotTopBotsParamsFormatCsv  VerifiedBotTopBotsParamsFormat = "CSV"
)

func (VerifiedBotTopBotsParamsFormat) IsKnown

type VerifiedBotTopBotsResponse

type VerifiedBotTopBotsResponse struct {
	Meta VerifiedBotTopBotsResponseMeta   `json:"meta,required"`
	Top0 []VerifiedBotTopBotsResponseTop0 `json:"top_0,required"`
	JSON verifiedBotTopBotsResponseJSON   `json:"-"`
}

func (*VerifiedBotTopBotsResponse) UnmarshalJSON

func (r *VerifiedBotTopBotsResponse) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopBotsResponseEnvelope

type VerifiedBotTopBotsResponseEnvelope struct {
	Result  VerifiedBotTopBotsResponse             `json:"result,required"`
	Success bool                                   `json:"success,required"`
	JSON    verifiedBotTopBotsResponseEnvelopeJSON `json:"-"`
}

func (*VerifiedBotTopBotsResponseEnvelope) UnmarshalJSON

func (r *VerifiedBotTopBotsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopBotsResponseMeta

type VerifiedBotTopBotsResponseMeta struct {
	DateRange      []VerifiedBotTopBotsResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo VerifiedBotTopBotsResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           verifiedBotTopBotsResponseMetaJSON           `json:"-"`
}

func (*VerifiedBotTopBotsResponseMeta) UnmarshalJSON

func (r *VerifiedBotTopBotsResponseMeta) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopBotsResponseMetaConfidenceInfo

type VerifiedBotTopBotsResponseMetaConfidenceInfo struct {
	Annotations []VerifiedBotTopBotsResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                    `json:"level"`
	JSON        verifiedBotTopBotsResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*VerifiedBotTopBotsResponseMetaConfidenceInfo) UnmarshalJSON

func (r *VerifiedBotTopBotsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopBotsResponseMetaConfidenceInfoAnnotation

type VerifiedBotTopBotsResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                     `json:"dataSource,required"`
	Description     string                                                     `json:"description,required"`
	EventType       string                                                     `json:"eventType,required"`
	IsInstantaneous bool                                                       `json:"isInstantaneous,required"`
	EndTime         time.Time                                                  `json:"endTime" format:"date-time"`
	LinkedURL       string                                                     `json:"linkedUrl"`
	StartTime       time.Time                                                  `json:"startTime" format:"date-time"`
	JSON            verifiedBotTopBotsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*VerifiedBotTopBotsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

func (r *VerifiedBotTopBotsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopBotsResponseMetaDateRange

type VerifiedBotTopBotsResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                   `json:"startTime,required" format:"date-time"`
	JSON      verifiedBotTopBotsResponseMetaDateRangeJSON `json:"-"`
}

func (*VerifiedBotTopBotsResponseMetaDateRange) UnmarshalJSON

func (r *VerifiedBotTopBotsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopBotsResponseTop0

type VerifiedBotTopBotsResponseTop0 struct {
	BotCategory string                             `json:"botCategory,required"`
	BotName     string                             `json:"botName,required"`
	BotOwner    string                             `json:"botOwner,required"`
	Value       string                             `json:"value,required"`
	JSON        verifiedBotTopBotsResponseTop0JSON `json:"-"`
}

func (*VerifiedBotTopBotsResponseTop0) UnmarshalJSON

func (r *VerifiedBotTopBotsResponseTop0) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopCategoriesParams

type VerifiedBotTopCategoriesParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]string] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Format results are returned in.
	Format param.Field[VerifiedBotTopCategoriesParamsFormat] `query:"format"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
}

func (VerifiedBotTopCategoriesParams) URLQuery

func (r VerifiedBotTopCategoriesParams) URLQuery() (v url.Values)

URLQuery serializes VerifiedBotTopCategoriesParams's query parameters as `url.Values`.

type VerifiedBotTopCategoriesParamsFormat

type VerifiedBotTopCategoriesParamsFormat string

Format results are returned in.

const (
	VerifiedBotTopCategoriesParamsFormatJson VerifiedBotTopCategoriesParamsFormat = "JSON"
	VerifiedBotTopCategoriesParamsFormatCsv  VerifiedBotTopCategoriesParamsFormat = "CSV"
)

func (VerifiedBotTopCategoriesParamsFormat) IsKnown

type VerifiedBotTopCategoriesResponse

type VerifiedBotTopCategoriesResponse struct {
	Meta VerifiedBotTopCategoriesResponseMeta   `json:"meta,required"`
	Top0 []VerifiedBotTopCategoriesResponseTop0 `json:"top_0,required"`
	JSON verifiedBotTopCategoriesResponseJSON   `json:"-"`
}

func (*VerifiedBotTopCategoriesResponse) UnmarshalJSON

func (r *VerifiedBotTopCategoriesResponse) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopCategoriesResponseEnvelope

type VerifiedBotTopCategoriesResponseEnvelope struct {
	Result  VerifiedBotTopCategoriesResponse             `json:"result,required"`
	Success bool                                         `json:"success,required"`
	JSON    verifiedBotTopCategoriesResponseEnvelopeJSON `json:"-"`
}

func (*VerifiedBotTopCategoriesResponseEnvelope) UnmarshalJSON

func (r *VerifiedBotTopCategoriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopCategoriesResponseMeta

type VerifiedBotTopCategoriesResponseMeta struct {
	DateRange      []VerifiedBotTopCategoriesResponseMetaDateRange    `json:"dateRange,required"`
	ConfidenceInfo VerifiedBotTopCategoriesResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           verifiedBotTopCategoriesResponseMetaJSON           `json:"-"`
}

func (*VerifiedBotTopCategoriesResponseMeta) UnmarshalJSON

func (r *VerifiedBotTopCategoriesResponseMeta) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopCategoriesResponseMetaConfidenceInfo

type VerifiedBotTopCategoriesResponseMetaConfidenceInfo struct {
	Annotations []VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                          `json:"level"`
	JSON        verifiedBotTopCategoriesResponseMetaConfidenceInfoJSON         `json:"-"`
}

func (*VerifiedBotTopCategoriesResponseMetaConfidenceInfo) UnmarshalJSON

func (r *VerifiedBotTopCategoriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation

type VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                           `json:"dataSource,required"`
	Description     string                                                           `json:"description,required"`
	EventType       string                                                           `json:"eventType,required"`
	IsInstantaneous bool                                                             `json:"isInstantaneous,required"`
	EndTime         time.Time                                                        `json:"endTime" format:"date-time"`
	LinkedURL       string                                                           `json:"linkedUrl"`
	StartTime       time.Time                                                        `json:"startTime" format:"date-time"`
	JSON            verifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

func (*VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON

type VerifiedBotTopCategoriesResponseMetaDateRange

type VerifiedBotTopCategoriesResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                         `json:"startTime,required" format:"date-time"`
	JSON      verifiedBotTopCategoriesResponseMetaDateRangeJSON `json:"-"`
}

func (*VerifiedBotTopCategoriesResponseMetaDateRange) UnmarshalJSON

func (r *VerifiedBotTopCategoriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopCategoriesResponseTop0

type VerifiedBotTopCategoriesResponseTop0 struct {
	BotCategory string                                   `json:"botCategory,required"`
	Value       string                                   `json:"value,required"`
	JSON        verifiedBotTopCategoriesResponseTop0JSON `json:"-"`
}

func (*VerifiedBotTopCategoriesResponseTop0) UnmarshalJSON

func (r *VerifiedBotTopCategoriesResponseTop0) UnmarshalJSON(data []byte) (err error)

type VerifiedBotTopService

type VerifiedBotTopService struct {
	Options []option.RequestOption
}

VerifiedBotTopService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewVerifiedBotTopService method instead.

func NewVerifiedBotTopService

func NewVerifiedBotTopService(opts ...option.RequestOption) (r *VerifiedBotTopService)

NewVerifiedBotTopService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*VerifiedBotTopService) Bots

Get top verified bots by HTTP requests, with owner and category.

func (*VerifiedBotTopService) Categories

Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL