Documentation
¶
Index ¶
- Constants
- type AIBotService
- type AIBotSummaryService
- type AIBotSummaryUserAgentParams
- type AIBotSummaryUserAgentParamsFormat
- type AIBotSummaryUserAgentResponse
- type AIBotSummaryUserAgentResponseEnvelope
- type AIBotSummaryUserAgentResponseMeta
- type AIBotSummaryUserAgentResponseMetaConfidenceInfo
- type AIBotSummaryUserAgentResponseMetaConfidenceInfoAnnotation
- type AIBotSummaryUserAgentResponseMetaDateRange
- type AIBotSummaryUserAgentResponseMetaNormalization
- type AIBotSummaryUserAgentResponseMetaUnit
- type AIInferenceService
- type AIInferenceSummaryModelParams
- type AIInferenceSummaryModelParamsFormat
- type AIInferenceSummaryModelResponse
- type AIInferenceSummaryModelResponseEnvelope
- type AIInferenceSummaryModelResponseMeta
- type AIInferenceSummaryModelResponseMetaConfidenceInfo
- type AIInferenceSummaryModelResponseMetaConfidenceInfoAnnotation
- type AIInferenceSummaryModelResponseMetaDateRange
- type AIInferenceSummaryModelResponseMetaNormalization
- type AIInferenceSummaryModelResponseMetaUnit
- type AIInferenceSummaryService
- func (r *AIInferenceSummaryService) Model(ctx context.Context, query AIInferenceSummaryModelParams, ...) (res *AIInferenceSummaryModelResponse, err error)
- func (r *AIInferenceSummaryService) Task(ctx context.Context, query AIInferenceSummaryTaskParams, ...) (res *AIInferenceSummaryTaskResponse, err error)
- type AIInferenceSummaryTaskParams
- type AIInferenceSummaryTaskParamsFormat
- type AIInferenceSummaryTaskResponse
- type AIInferenceSummaryTaskResponseEnvelope
- type AIInferenceSummaryTaskResponseMeta
- type AIInferenceSummaryTaskResponseMetaConfidenceInfo
- type AIInferenceSummaryTaskResponseMetaConfidenceInfoAnnotation
- type AIInferenceSummaryTaskResponseMetaDateRange
- type AIInferenceSummaryTaskResponseMetaNormalization
- type AIInferenceSummaryTaskResponseMetaUnit
- type AIInferenceTimeseriesGroupService
- type AIInferenceTimeseriesGroupSummaryModelParams
- type AIInferenceTimeseriesGroupSummaryModelParamsAggInterval
- type AIInferenceTimeseriesGroupSummaryModelParamsFormat
- type AIInferenceTimeseriesGroupSummaryModelResponse
- type AIInferenceTimeseriesGroupSummaryModelResponseEnvelope
- type AIInferenceTimeseriesGroupSummaryModelResponseMeta
- type AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval
- type AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfo
- type AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoAnnotation
- type AIInferenceTimeseriesGroupSummaryModelResponseMetaDateRange
- type AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization
- type AIInferenceTimeseriesGroupSummaryModelResponseMetaUnit
- type AIInferenceTimeseriesGroupSummaryModelResponseSerie0
- type AIInferenceTimeseriesGroupSummaryService
- func (r *AIInferenceTimeseriesGroupSummaryService) Model(ctx context.Context, query AIInferenceTimeseriesGroupSummaryModelParams, ...) (res *AIInferenceTimeseriesGroupSummaryModelResponse, err error)
- func (r *AIInferenceTimeseriesGroupSummaryService) Task(ctx context.Context, query AIInferenceTimeseriesGroupSummaryTaskParams, ...) (res *AIInferenceTimeseriesGroupSummaryTaskResponse, err error)
- type AIInferenceTimeseriesGroupSummaryTaskParams
- type AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval
- type AIInferenceTimeseriesGroupSummaryTaskParamsFormat
- type AIInferenceTimeseriesGroupSummaryTaskResponse
- type AIInferenceTimeseriesGroupSummaryTaskResponseEnvelope
- type AIInferenceTimeseriesGroupSummaryTaskResponseMeta
- type AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval
- type AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfo
- type AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoAnnotation
- type AIInferenceTimeseriesGroupSummaryTaskResponseMetaDateRange
- type AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization
- type AIInferenceTimeseriesGroupSummaryTaskResponseMetaUnit
- type AIInferenceTimeseriesGroupSummaryTaskResponseSerie0
- type AIService
- type AITimeseriesGroupService
- type AITimeseriesGroupUserAgentParams
- type AITimeseriesGroupUserAgentParamsAggInterval
- type AITimeseriesGroupUserAgentParamsFormat
- type AITimeseriesGroupUserAgentResponse
- type AITimeseriesGroupUserAgentResponseEnvelope
- type AITimeseriesGroupUserAgentResponseMeta
- type AITimeseriesGroupUserAgentResponseMetaAggInterval
- type AITimeseriesGroupUserAgentResponseMetaConfidenceInfo
- type AITimeseriesGroupUserAgentResponseMetaConfidenceInfoAnnotation
- type AITimeseriesGroupUserAgentResponseMetaDateRange
- type AITimeseriesGroupUserAgentResponseMetaNormalization
- type AITimeseriesGroupUserAgentResponseMetaUnit
- type AITimeseriesGroupUserAgentResponseSerie0
- type AIToMarkdownNewParams
- type AIToMarkdownNewResponse
- type AIToMarkdownService
- func (r *AIToMarkdownService) New(ctx context.Context, Body io.Reader, body AIToMarkdownNewParams, ...) (res *pagination.SinglePage[AIToMarkdownNewResponse], err error)
- func (r *AIToMarkdownService) NewAutoPaging(ctx context.Context, Body io.Reader, body AIToMarkdownNewParams, ...) *pagination.SinglePageAutoPager[AIToMarkdownNewResponse]
- type AS112Service
- type AS112SummaryDNSSECParams
- type AS112SummaryDNSSECParamsFormat
- type AS112SummaryDNSSECParamsProtocol
- type AS112SummaryDNSSECParamsQueryType
- type AS112SummaryDNSSECParamsResponseCode
- type AS112SummaryDNSSECResponse
- type AS112SummaryDNSSECResponseEnvelope
- type AS112SummaryDNSSECResponseMeta
- type AS112SummaryDNSSECResponseMetaConfidenceInfo
- type AS112SummaryDNSSECResponseMetaConfidenceInfoAnnotation
- type AS112SummaryDNSSECResponseMetaDateRange
- type AS112SummaryDNSSECResponseMetaNormalization
- type AS112SummaryDNSSECResponseMetaUnit
- type AS112SummaryDNSSECResponseSummary0
- type AS112SummaryEdnsParams
- type AS112SummaryEdnsParamsFormat
- type AS112SummaryEdnsParamsProtocol
- type AS112SummaryEdnsParamsQueryType
- type AS112SummaryEdnsParamsResponseCode
- type AS112SummaryEdnsResponse
- type AS112SummaryEdnsResponseEnvelope
- type AS112SummaryEdnsResponseMeta
- type AS112SummaryEdnsResponseMetaConfidenceInfo
- type AS112SummaryEdnsResponseMetaConfidenceInfoAnnotation
- type AS112SummaryEdnsResponseMetaDateRange
- type AS112SummaryEdnsResponseMetaNormalization
- type AS112SummaryEdnsResponseMetaUnit
- type AS112SummaryEdnsResponseSummary0
- type AS112SummaryIPVersionParams
- type AS112SummaryIPVersionParamsFormat
- type AS112SummaryIPVersionParamsProtocol
- type AS112SummaryIPVersionParamsQueryType
- type AS112SummaryIPVersionParamsResponseCode
- type AS112SummaryIPVersionResponse
- type AS112SummaryIPVersionResponseEnvelope
- type AS112SummaryIPVersionResponseMeta
- type AS112SummaryIPVersionResponseMetaConfidenceInfo
- type AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation
- type AS112SummaryIPVersionResponseMetaDateRange
- type AS112SummaryIPVersionResponseMetaNormalization
- type AS112SummaryIPVersionResponseMetaUnit
- type AS112SummaryIPVersionResponseSummary0
- type AS112SummaryProtocolParams
- type AS112SummaryProtocolParamsFormat
- type AS112SummaryProtocolParamsQueryType
- type AS112SummaryProtocolParamsResponseCode
- type AS112SummaryProtocolResponse
- type AS112SummaryProtocolResponseEnvelope
- type AS112SummaryProtocolResponseMeta
- type AS112SummaryProtocolResponseMetaConfidenceInfo
- type AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation
- type AS112SummaryProtocolResponseMetaDateRange
- type AS112SummaryProtocolResponseMetaNormalization
- type AS112SummaryProtocolResponseMetaUnit
- type AS112SummaryProtocolResponseSummary0
- type AS112SummaryQueryTypeParams
- type AS112SummaryQueryTypeParamsFormat
- type AS112SummaryQueryTypeParamsProtocol
- type AS112SummaryQueryTypeParamsResponseCode
- type AS112SummaryQueryTypeResponse
- type AS112SummaryQueryTypeResponseEnvelope
- type AS112SummaryQueryTypeResponseMeta
- type AS112SummaryQueryTypeResponseMetaConfidenceInfo
- type AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation
- type AS112SummaryQueryTypeResponseMetaDateRange
- type AS112SummaryQueryTypeResponseMetaNormalization
- type AS112SummaryQueryTypeResponseMetaUnit
- type AS112SummaryResponseCodesParams
- type AS112SummaryResponseCodesParamsFormat
- type AS112SummaryResponseCodesParamsProtocol
- type AS112SummaryResponseCodesParamsQueryType
- type AS112SummaryResponseCodesResponse
- type AS112SummaryResponseCodesResponseEnvelope
- type AS112SummaryResponseCodesResponseMeta
- type AS112SummaryResponseCodesResponseMetaConfidenceInfo
- type AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation
- type AS112SummaryResponseCodesResponseMetaDateRange
- type AS112SummaryResponseCodesResponseMetaNormalization
- type AS112SummaryResponseCodesResponseMetaUnit
- type AS112SummaryService
- func (r *AS112SummaryService) DNSSEC(ctx context.Context, query AS112SummaryDNSSECParams, ...) (res *AS112SummaryDNSSECResponse, err error)
- func (r *AS112SummaryService) Edns(ctx context.Context, query AS112SummaryEdnsParams, ...) (res *AS112SummaryEdnsResponse, err error)
- func (r *AS112SummaryService) IPVersion(ctx context.Context, query AS112SummaryIPVersionParams, ...) (res *AS112SummaryIPVersionResponse, err error)
- func (r *AS112SummaryService) Protocol(ctx context.Context, query AS112SummaryProtocolParams, ...) (res *AS112SummaryProtocolResponse, err error)
- func (r *AS112SummaryService) QueryType(ctx context.Context, query AS112SummaryQueryTypeParams, ...) (res *AS112SummaryQueryTypeResponse, err error)
- func (r *AS112SummaryService) ResponseCodes(ctx context.Context, query AS112SummaryResponseCodesParams, ...) (res *AS112SummaryResponseCodesResponse, err error)
- type AS112TimeseriesGroupDNSSECParams
- type AS112TimeseriesGroupDNSSECParamsAggInterval
- type AS112TimeseriesGroupDNSSECParamsFormat
- type AS112TimeseriesGroupDNSSECParamsProtocol
- type AS112TimeseriesGroupDNSSECParamsQueryType
- type AS112TimeseriesGroupDNSSECParamsResponseCode
- type AS112TimeseriesGroupDNSSECResponse
- type AS112TimeseriesGroupDNSSECResponseEnvelope
- type AS112TimeseriesGroupDNSSECResponseMeta
- type AS112TimeseriesGroupDNSSECResponseMetaAggInterval
- type AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfo
- type AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation
- type AS112TimeseriesGroupDNSSECResponseMetaDateRange
- type AS112TimeseriesGroupDNSSECResponseMetaNormalization
- type AS112TimeseriesGroupDNSSECResponseMetaUnit
- type AS112TimeseriesGroupDNSSECResponseSerie0
- type AS112TimeseriesGroupEdnsParams
- type AS112TimeseriesGroupEdnsParamsAggInterval
- type AS112TimeseriesGroupEdnsParamsFormat
- type AS112TimeseriesGroupEdnsParamsProtocol
- type AS112TimeseriesGroupEdnsParamsQueryType
- type AS112TimeseriesGroupEdnsParamsResponseCode
- type AS112TimeseriesGroupEdnsResponse
- type AS112TimeseriesGroupEdnsResponseEnvelope
- type AS112TimeseriesGroupEdnsResponseMeta
- type AS112TimeseriesGroupEdnsResponseMetaAggInterval
- type AS112TimeseriesGroupEdnsResponseMetaConfidenceInfo
- type AS112TimeseriesGroupEdnsResponseMetaConfidenceInfoAnnotation
- type AS112TimeseriesGroupEdnsResponseMetaDateRange
- type AS112TimeseriesGroupEdnsResponseMetaNormalization
- type AS112TimeseriesGroupEdnsResponseMetaUnit
- type AS112TimeseriesGroupEdnsResponseSerie0
- type AS112TimeseriesGroupIPVersionParams
- type AS112TimeseriesGroupIPVersionParamsAggInterval
- type AS112TimeseriesGroupIPVersionParamsFormat
- type AS112TimeseriesGroupIPVersionParamsProtocol
- type AS112TimeseriesGroupIPVersionParamsQueryType
- type AS112TimeseriesGroupIPVersionParamsResponseCode
- type AS112TimeseriesGroupIPVersionResponse
- type AS112TimeseriesGroupIPVersionResponseEnvelope
- type AS112TimeseriesGroupIPVersionResponseMeta
- type AS112TimeseriesGroupIPVersionResponseMetaAggInterval
- type AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfo
- type AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation
- type AS112TimeseriesGroupIPVersionResponseMetaDateRange
- type AS112TimeseriesGroupIPVersionResponseMetaNormalization
- type AS112TimeseriesGroupIPVersionResponseMetaUnit
- type AS112TimeseriesGroupIPVersionResponseSerie0
- type AS112TimeseriesGroupProtocolParams
- type AS112TimeseriesGroupProtocolParamsAggInterval
- type AS112TimeseriesGroupProtocolParamsFormat
- type AS112TimeseriesGroupProtocolParamsQueryType
- type AS112TimeseriesGroupProtocolParamsResponseCode
- type AS112TimeseriesGroupProtocolResponse
- type AS112TimeseriesGroupProtocolResponseEnvelope
- type AS112TimeseriesGroupProtocolResponseMeta
- type AS112TimeseriesGroupProtocolResponseMetaAggInterval
- type AS112TimeseriesGroupProtocolResponseMetaConfidenceInfo
- type AS112TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation
- type AS112TimeseriesGroupProtocolResponseMetaDateRange
- type AS112TimeseriesGroupProtocolResponseMetaNormalization
- type AS112TimeseriesGroupProtocolResponseMetaUnit
- type AS112TimeseriesGroupProtocolResponseSerie0
- type AS112TimeseriesGroupQueryTypeParams
- type AS112TimeseriesGroupQueryTypeParamsAggInterval
- type AS112TimeseriesGroupQueryTypeParamsFormat
- type AS112TimeseriesGroupQueryTypeParamsProtocol
- type AS112TimeseriesGroupQueryTypeParamsResponseCode
- type AS112TimeseriesGroupQueryTypeResponse
- type AS112TimeseriesGroupQueryTypeResponseEnvelope
- type AS112TimeseriesGroupQueryTypeResponseMeta
- type AS112TimeseriesGroupQueryTypeResponseMetaAggInterval
- type AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfo
- type AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation
- type AS112TimeseriesGroupQueryTypeResponseMetaDateRange
- type AS112TimeseriesGroupQueryTypeResponseMetaNormalization
- type AS112TimeseriesGroupQueryTypeResponseMetaUnit
- type AS112TimeseriesGroupQueryTypeResponseSerie0
- type AS112TimeseriesGroupResponseCodesParams
- type AS112TimeseriesGroupResponseCodesParamsAggInterval
- type AS112TimeseriesGroupResponseCodesParamsFormat
- type AS112TimeseriesGroupResponseCodesParamsProtocol
- type AS112TimeseriesGroupResponseCodesParamsQueryType
- type AS112TimeseriesGroupResponseCodesResponse
- type AS112TimeseriesGroupResponseCodesResponseEnvelope
- type AS112TimeseriesGroupResponseCodesResponseMeta
- type AS112TimeseriesGroupResponseCodesResponseMetaAggInterval
- type AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfo
- type AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoAnnotation
- type AS112TimeseriesGroupResponseCodesResponseMetaDateRange
- type AS112TimeseriesGroupResponseCodesResponseMetaNormalization
- type AS112TimeseriesGroupResponseCodesResponseMetaUnit
- type AS112TimeseriesGroupResponseCodesResponseSerie0
- type AS112TimeseriesGroupService
- func (r *AS112TimeseriesGroupService) DNSSEC(ctx context.Context, query AS112TimeseriesGroupDNSSECParams, ...) (res *AS112TimeseriesGroupDNSSECResponse, err error)
- func (r *AS112TimeseriesGroupService) Edns(ctx context.Context, query AS112TimeseriesGroupEdnsParams, ...) (res *AS112TimeseriesGroupEdnsResponse, err error)
- func (r *AS112TimeseriesGroupService) IPVersion(ctx context.Context, query AS112TimeseriesGroupIPVersionParams, ...) (res *AS112TimeseriesGroupIPVersionResponse, err error)
- func (r *AS112TimeseriesGroupService) Protocol(ctx context.Context, query AS112TimeseriesGroupProtocolParams, ...) (res *AS112TimeseriesGroupProtocolResponse, err error)
- func (r *AS112TimeseriesGroupService) QueryType(ctx context.Context, query AS112TimeseriesGroupQueryTypeParams, ...) (res *AS112TimeseriesGroupQueryTypeResponse, err error)
- func (r *AS112TimeseriesGroupService) ResponseCodes(ctx context.Context, query AS112TimeseriesGroupResponseCodesParams, ...) (res *AS112TimeseriesGroupResponseCodesResponse, err error)
- type AS112TimeseriesParams
- type AS112TimeseriesParamsAggInterval
- type AS112TimeseriesParamsFormat
- type AS112TimeseriesParamsProtocol
- type AS112TimeseriesParamsQueryType
- type AS112TimeseriesParamsResponseCode
- type AS112TimeseriesResponse
- type AS112TimeseriesResponseEnvelope
- type AS112TimeseriesResponseMeta
- type AS112TimeseriesResponseMetaAggInterval
- type AS112TimeseriesResponseMetaConfidenceInfo
- type AS112TimeseriesResponseMetaConfidenceInfoAnnotation
- type AS112TimeseriesResponseMetaDateRange
- type AS112TimeseriesResponseMetaNormalization
- type AS112TimeseriesResponseMetaUnit
- type AS112TopDNSSECParams
- type AS112TopDNSSECParamsDNSSEC
- type AS112TopDNSSECParamsFormat
- type AS112TopDNSSECResponse
- type AS112TopDNSSECResponseEnvelope
- type AS112TopDNSSECResponseMeta
- type AS112TopDNSSECResponseMetaConfidenceInfo
- type AS112TopDNSSECResponseMetaConfidenceInfoAnnotation
- type AS112TopDNSSECResponseMetaDateRange
- type AS112TopDNSSECResponseMetaNormalization
- type AS112TopDNSSECResponseMetaUnit
- type AS112TopDNSSECResponseTop0
- type AS112TopEdnsParams
- type AS112TopEdnsParamsEdns
- type AS112TopEdnsParamsFormat
- type AS112TopEdnsResponse
- type AS112TopEdnsResponseEnvelope
- type AS112TopEdnsResponseMeta
- type AS112TopEdnsResponseMetaConfidenceInfo
- type AS112TopEdnsResponseMetaConfidenceInfoAnnotation
- type AS112TopEdnsResponseMetaDateRange
- type AS112TopEdnsResponseMetaNormalization
- type AS112TopEdnsResponseMetaUnit
- type AS112TopEdnsResponseTop0
- type AS112TopIPVersionParams
- type AS112TopIPVersionParamsFormat
- type AS112TopIPVersionParamsIPVersion
- type AS112TopIPVersionResponse
- type AS112TopIPVersionResponseEnvelope
- type AS112TopIPVersionResponseMeta
- type AS112TopIPVersionResponseMetaConfidenceInfo
- type AS112TopIPVersionResponseMetaConfidenceInfoAnnotation
- type AS112TopIPVersionResponseMetaDateRange
- type AS112TopIPVersionResponseMetaNormalization
- type AS112TopIPVersionResponseMetaUnit
- type AS112TopIPVersionResponseTop0
- type AS112TopLocationsParams
- type AS112TopLocationsParamsFormat
- type AS112TopLocationsResponse
- type AS112TopLocationsResponseEnvelope
- type AS112TopLocationsResponseMeta
- type AS112TopLocationsResponseMetaConfidenceInfo
- type AS112TopLocationsResponseMetaConfidenceInfoAnnotation
- type AS112TopLocationsResponseMetaDateRange
- type AS112TopLocationsResponseMetaNormalization
- type AS112TopLocationsResponseMetaUnit
- type AS112TopLocationsResponseTop0
- type AS112TopService
- func (r *AS112TopService) DNSSEC(ctx context.Context, dnssec AS112TopDNSSECParamsDNSSEC, ...) (res *AS112TopDNSSECResponse, err error)
- func (r *AS112TopService) Edns(ctx context.Context, edns AS112TopEdnsParamsEdns, query AS112TopEdnsParams, ...) (res *AS112TopEdnsResponse, err error)
- func (r *AS112TopService) IPVersion(ctx context.Context, ipVersion AS112TopIPVersionParamsIPVersion, ...) (res *AS112TopIPVersionResponse, err error)
- func (r *AS112TopService) Locations(ctx context.Context, query AS112TopLocationsParams, ...) (res *AS112TopLocationsResponse, err error)
- type ASN
- type ASNParam
- type AnnotationListParams
- type AnnotationListParamsFormat
- type AnnotationListResponse
- type AnnotationListResponseAnnotation
- type AnnotationListResponseAnnotationsASNsDetail
- type AnnotationListResponseAnnotationsASNsDetailsLocations
- type AnnotationListResponseAnnotationsLocationsDetail
- type AnnotationListResponseAnnotationsOutage
- type AnnotationListResponseEnvelope
- type AnnotationOutageGetParams
- type AnnotationOutageGetParamsFormat
- type AnnotationOutageGetResponse
- type AnnotationOutageGetResponseAnnotation
- type AnnotationOutageGetResponseAnnotationsASNsDetail
- type AnnotationOutageGetResponseAnnotationsASNsDetailsLocations
- type AnnotationOutageGetResponseAnnotationsLocationsDetail
- type AnnotationOutageGetResponseAnnotationsOutage
- type AnnotationOutageGetResponseEnvelope
- type AnnotationOutageLocationsParams
- type AnnotationOutageLocationsParamsFormat
- type AnnotationOutageLocationsResponse
- type AnnotationOutageLocationsResponseAnnotation
- type AnnotationOutageLocationsResponseEnvelope
- type AnnotationOutageService
- func (r *AnnotationOutageService) Get(ctx context.Context, query AnnotationOutageGetParams, ...) (res *AnnotationOutageGetResponse, err error)
- func (r *AnnotationOutageService) Locations(ctx context.Context, query AnnotationOutageLocationsParams, ...) (res *AnnotationOutageLocationsResponse, err error)
- type AnnotationService
- type AttackLayer3Service
- type AttackLayer3SummaryBitrateParams
- type AttackLayer3SummaryBitrateParamsDirection
- type AttackLayer3SummaryBitrateParamsFormat
- type AttackLayer3SummaryBitrateParamsIPVersion
- type AttackLayer3SummaryBitrateParamsProtocol
- type AttackLayer3SummaryBitrateResponse
- type AttackLayer3SummaryBitrateResponseEnvelope
- type AttackLayer3SummaryBitrateResponseMeta
- type AttackLayer3SummaryBitrateResponseMetaConfidenceInfo
- type AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation
- type AttackLayer3SummaryBitrateResponseMetaDateRange
- type AttackLayer3SummaryBitrateResponseMetaNormalization
- type AttackLayer3SummaryBitrateResponseMetaUnit
- type AttackLayer3SummaryBitrateResponseSummary0
- type AttackLayer3SummaryDurationParams
- type AttackLayer3SummaryDurationParamsDirection
- type AttackLayer3SummaryDurationParamsFormat
- type AttackLayer3SummaryDurationParamsIPVersion
- type AttackLayer3SummaryDurationParamsProtocol
- type AttackLayer3SummaryDurationResponse
- type AttackLayer3SummaryDurationResponseEnvelope
- type AttackLayer3SummaryDurationResponseMeta
- type AttackLayer3SummaryDurationResponseMetaConfidenceInfo
- type AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation
- type AttackLayer3SummaryDurationResponseMetaDateRange
- type AttackLayer3SummaryDurationResponseMetaNormalization
- type AttackLayer3SummaryDurationResponseMetaUnit
- type AttackLayer3SummaryDurationResponseSummary0
- type AttackLayer3SummaryIPVersionParams
- type AttackLayer3SummaryIPVersionParamsDirection
- type AttackLayer3SummaryIPVersionParamsFormat
- type AttackLayer3SummaryIPVersionParamsProtocol
- type AttackLayer3SummaryIPVersionResponse
- type AttackLayer3SummaryIPVersionResponseEnvelope
- type AttackLayer3SummaryIPVersionResponseMeta
- type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo
- type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation
- type AttackLayer3SummaryIPVersionResponseMetaDateRange
- type AttackLayer3SummaryIPVersionResponseMetaNormalization
- type AttackLayer3SummaryIPVersionResponseMetaUnit
- type AttackLayer3SummaryIPVersionResponseSummary0
- type AttackLayer3SummaryIndustryParams
- type AttackLayer3SummaryIndustryParamsDirection
- type AttackLayer3SummaryIndustryParamsFormat
- type AttackLayer3SummaryIndustryParamsIPVersion
- type AttackLayer3SummaryIndustryParamsProtocol
- type AttackLayer3SummaryIndustryResponse
- type AttackLayer3SummaryIndustryResponseEnvelope
- type AttackLayer3SummaryIndustryResponseMeta
- type AttackLayer3SummaryIndustryResponseMetaConfidenceInfo
- type AttackLayer3SummaryIndustryResponseMetaConfidenceInfoAnnotation
- type AttackLayer3SummaryIndustryResponseMetaDateRange
- type AttackLayer3SummaryIndustryResponseMetaNormalization
- type AttackLayer3SummaryIndustryResponseMetaUnit
- type AttackLayer3SummaryProtocolParams
- type AttackLayer3SummaryProtocolParamsDirection
- type AttackLayer3SummaryProtocolParamsFormat
- type AttackLayer3SummaryProtocolParamsIPVersion
- type AttackLayer3SummaryProtocolResponse
- type AttackLayer3SummaryProtocolResponseEnvelope
- type AttackLayer3SummaryProtocolResponseMeta
- type AttackLayer3SummaryProtocolResponseMetaConfidenceInfo
- type AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation
- type AttackLayer3SummaryProtocolResponseMetaDateRange
- type AttackLayer3SummaryProtocolResponseMetaNormalization
- type AttackLayer3SummaryProtocolResponseMetaUnit
- type AttackLayer3SummaryProtocolResponseSummary0
- type AttackLayer3SummaryService
- func (r *AttackLayer3SummaryService) Bitrate(ctx context.Context, query AttackLayer3SummaryBitrateParams, ...) (res *AttackLayer3SummaryBitrateResponse, err error)
- func (r *AttackLayer3SummaryService) Duration(ctx context.Context, query AttackLayer3SummaryDurationParams, ...) (res *AttackLayer3SummaryDurationResponse, err error)
- func (r *AttackLayer3SummaryService) IPVersion(ctx context.Context, query AttackLayer3SummaryIPVersionParams, ...) (res *AttackLayer3SummaryIPVersionResponse, err error)
- func (r *AttackLayer3SummaryService) Industry(ctx context.Context, query AttackLayer3SummaryIndustryParams, ...) (res *AttackLayer3SummaryIndustryResponse, err error)
- func (r *AttackLayer3SummaryService) Protocol(ctx context.Context, query AttackLayer3SummaryProtocolParams, ...) (res *AttackLayer3SummaryProtocolResponse, err error)
- func (r *AttackLayer3SummaryService) Vector(ctx context.Context, query AttackLayer3SummaryVectorParams, ...) (res *AttackLayer3SummaryVectorResponse, err error)
- func (r *AttackLayer3SummaryService) Vertical(ctx context.Context, query AttackLayer3SummaryVerticalParams, ...) (res *AttackLayer3SummaryVerticalResponse, err error)
- type AttackLayer3SummaryVectorParams
- type AttackLayer3SummaryVectorParamsDirection
- type AttackLayer3SummaryVectorParamsFormat
- type AttackLayer3SummaryVectorParamsIPVersion
- type AttackLayer3SummaryVectorParamsProtocol
- type AttackLayer3SummaryVectorResponse
- type AttackLayer3SummaryVectorResponseEnvelope
- type AttackLayer3SummaryVectorResponseMeta
- type AttackLayer3SummaryVectorResponseMetaConfidenceInfo
- type AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation
- type AttackLayer3SummaryVectorResponseMetaDateRange
- type AttackLayer3SummaryVectorResponseMetaNormalization
- type AttackLayer3SummaryVectorResponseMetaUnit
- type AttackLayer3SummaryVerticalParams
- type AttackLayer3SummaryVerticalParamsDirection
- type AttackLayer3SummaryVerticalParamsFormat
- type AttackLayer3SummaryVerticalParamsIPVersion
- type AttackLayer3SummaryVerticalParamsProtocol
- type AttackLayer3SummaryVerticalResponse
- type AttackLayer3SummaryVerticalResponseEnvelope
- type AttackLayer3SummaryVerticalResponseMeta
- type AttackLayer3SummaryVerticalResponseMetaConfidenceInfo
- type AttackLayer3SummaryVerticalResponseMetaConfidenceInfoAnnotation
- type AttackLayer3SummaryVerticalResponseMetaDateRange
- type AttackLayer3SummaryVerticalResponseMetaNormalization
- type AttackLayer3SummaryVerticalResponseMetaUnit
- type AttackLayer3TimeseriesGroupBitrateParams
- type AttackLayer3TimeseriesGroupBitrateParamsAggInterval
- type AttackLayer3TimeseriesGroupBitrateParamsDirection
- type AttackLayer3TimeseriesGroupBitrateParamsFormat
- type AttackLayer3TimeseriesGroupBitrateParamsIPVersion
- type AttackLayer3TimeseriesGroupBitrateParamsNormalization
- type AttackLayer3TimeseriesGroupBitrateParamsProtocol
- type AttackLayer3TimeseriesGroupBitrateResponse
- type AttackLayer3TimeseriesGroupBitrateResponseEnvelope
- type AttackLayer3TimeseriesGroupBitrateResponseMeta
- type AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval
- type AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesGroupBitrateResponseMetaDateRange
- type AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization
- type AttackLayer3TimeseriesGroupBitrateResponseMetaUnit
- type AttackLayer3TimeseriesGroupBitrateResponseSerie0
- type AttackLayer3TimeseriesGroupDurationParams
- type AttackLayer3TimeseriesGroupDurationParamsAggInterval
- type AttackLayer3TimeseriesGroupDurationParamsDirection
- type AttackLayer3TimeseriesGroupDurationParamsFormat
- type AttackLayer3TimeseriesGroupDurationParamsIPVersion
- type AttackLayer3TimeseriesGroupDurationParamsNormalization
- type AttackLayer3TimeseriesGroupDurationParamsProtocol
- type AttackLayer3TimeseriesGroupDurationResponse
- type AttackLayer3TimeseriesGroupDurationResponseEnvelope
- type AttackLayer3TimeseriesGroupDurationResponseMeta
- type AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval
- type AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesGroupDurationResponseMetaDateRange
- type AttackLayer3TimeseriesGroupDurationResponseMetaNormalization
- type AttackLayer3TimeseriesGroupDurationResponseMetaUnit
- type AttackLayer3TimeseriesGroupDurationResponseSerie0
- type AttackLayer3TimeseriesGroupIPVersionParams
- type AttackLayer3TimeseriesGroupIPVersionParamsAggInterval
- type AttackLayer3TimeseriesGroupIPVersionParamsDirection
- type AttackLayer3TimeseriesGroupIPVersionParamsFormat
- type AttackLayer3TimeseriesGroupIPVersionParamsNormalization
- type AttackLayer3TimeseriesGroupIPVersionParamsProtocol
- type AttackLayer3TimeseriesGroupIPVersionResponse
- type AttackLayer3TimeseriesGroupIPVersionResponseEnvelope
- type AttackLayer3TimeseriesGroupIPVersionResponseMeta
- type AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval
- type AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesGroupIPVersionResponseMetaDateRange
- type AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization
- type AttackLayer3TimeseriesGroupIPVersionResponseMetaUnit
- type AttackLayer3TimeseriesGroupIPVersionResponseSerie0
- type AttackLayer3TimeseriesGroupIndustryParams
- type AttackLayer3TimeseriesGroupIndustryParamsAggInterval
- type AttackLayer3TimeseriesGroupIndustryParamsDirection
- type AttackLayer3TimeseriesGroupIndustryParamsFormat
- type AttackLayer3TimeseriesGroupIndustryParamsIPVersion
- type AttackLayer3TimeseriesGroupIndustryParamsNormalization
- type AttackLayer3TimeseriesGroupIndustryParamsProtocol
- type AttackLayer3TimeseriesGroupIndustryResponse
- type AttackLayer3TimeseriesGroupIndustryResponseEnvelope
- type AttackLayer3TimeseriesGroupIndustryResponseMeta
- type AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval
- type AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesGroupIndustryResponseMetaDateRange
- type AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization
- type AttackLayer3TimeseriesGroupIndustryResponseMetaUnit
- type AttackLayer3TimeseriesGroupIndustryResponseSerie0
- type AttackLayer3TimeseriesGroupProtocolParams
- type AttackLayer3TimeseriesGroupProtocolParamsAggInterval
- type AttackLayer3TimeseriesGroupProtocolParamsDirection
- type AttackLayer3TimeseriesGroupProtocolParamsFormat
- type AttackLayer3TimeseriesGroupProtocolParamsIPVersion
- type AttackLayer3TimeseriesGroupProtocolParamsNormalization
- type AttackLayer3TimeseriesGroupProtocolResponse
- type AttackLayer3TimeseriesGroupProtocolResponseEnvelope
- type AttackLayer3TimeseriesGroupProtocolResponseMeta
- type AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval
- type AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesGroupProtocolResponseMetaDateRange
- type AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization
- type AttackLayer3TimeseriesGroupProtocolResponseMetaUnit
- type AttackLayer3TimeseriesGroupProtocolResponseSerie0
- type AttackLayer3TimeseriesGroupService
- func (r *AttackLayer3TimeseriesGroupService) Bitrate(ctx context.Context, query AttackLayer3TimeseriesGroupBitrateParams, ...) (res *AttackLayer3TimeseriesGroupBitrateResponse, err error)
- func (r *AttackLayer3TimeseriesGroupService) Duration(ctx context.Context, query AttackLayer3TimeseriesGroupDurationParams, ...) (res *AttackLayer3TimeseriesGroupDurationResponse, err error)
- func (r *AttackLayer3TimeseriesGroupService) IPVersion(ctx context.Context, query AttackLayer3TimeseriesGroupIPVersionParams, ...) (res *AttackLayer3TimeseriesGroupIPVersionResponse, err error)
- func (r *AttackLayer3TimeseriesGroupService) Industry(ctx context.Context, query AttackLayer3TimeseriesGroupIndustryParams, ...) (res *AttackLayer3TimeseriesGroupIndustryResponse, err error)
- func (r *AttackLayer3TimeseriesGroupService) Protocol(ctx context.Context, query AttackLayer3TimeseriesGroupProtocolParams, ...) (res *AttackLayer3TimeseriesGroupProtocolResponse, err error)
- func (r *AttackLayer3TimeseriesGroupService) Vector(ctx context.Context, query AttackLayer3TimeseriesGroupVectorParams, ...) (res *AttackLayer3TimeseriesGroupVectorResponse, err error)
- func (r *AttackLayer3TimeseriesGroupService) Vertical(ctx context.Context, query AttackLayer3TimeseriesGroupVerticalParams, ...) (res *AttackLayer3TimeseriesGroupVerticalResponse, err error)
- type AttackLayer3TimeseriesGroupVectorParams
- type AttackLayer3TimeseriesGroupVectorParamsAggInterval
- type AttackLayer3TimeseriesGroupVectorParamsDirection
- type AttackLayer3TimeseriesGroupVectorParamsFormat
- type AttackLayer3TimeseriesGroupVectorParamsIPVersion
- type AttackLayer3TimeseriesGroupVectorParamsNormalization
- type AttackLayer3TimeseriesGroupVectorParamsProtocol
- type AttackLayer3TimeseriesGroupVectorResponse
- type AttackLayer3TimeseriesGroupVectorResponseEnvelope
- type AttackLayer3TimeseriesGroupVectorResponseMeta
- type AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval
- type AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesGroupVectorResponseMetaDateRange
- type AttackLayer3TimeseriesGroupVectorResponseMetaNormalization
- type AttackLayer3TimeseriesGroupVectorResponseMetaUnit
- type AttackLayer3TimeseriesGroupVectorResponseSerie0
- type AttackLayer3TimeseriesGroupVerticalParams
- type AttackLayer3TimeseriesGroupVerticalParamsAggInterval
- type AttackLayer3TimeseriesGroupVerticalParamsDirection
- type AttackLayer3TimeseriesGroupVerticalParamsFormat
- type AttackLayer3TimeseriesGroupVerticalParamsIPVersion
- type AttackLayer3TimeseriesGroupVerticalParamsNormalization
- type AttackLayer3TimeseriesGroupVerticalParamsProtocol
- type AttackLayer3TimeseriesGroupVerticalResponse
- type AttackLayer3TimeseriesGroupVerticalResponseEnvelope
- type AttackLayer3TimeseriesGroupVerticalResponseMeta
- type AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval
- type AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesGroupVerticalResponseMetaDateRange
- type AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization
- type AttackLayer3TimeseriesGroupVerticalResponseMetaUnit
- type AttackLayer3TimeseriesGroupVerticalResponseSerie0
- type AttackLayer3TimeseriesParams
- type AttackLayer3TimeseriesParamsAggInterval
- type AttackLayer3TimeseriesParamsDirection
- type AttackLayer3TimeseriesParamsFormat
- type AttackLayer3TimeseriesParamsIPVersion
- type AttackLayer3TimeseriesParamsMetric
- type AttackLayer3TimeseriesParamsNormalization
- type AttackLayer3TimeseriesParamsProtocol
- type AttackLayer3TimeseriesResponse
- type AttackLayer3TimeseriesResponseEnvelope
- type AttackLayer3TimeseriesResponseMeta
- type AttackLayer3TimeseriesResponseMetaAggInterval
- type AttackLayer3TimeseriesResponseMetaConfidenceInfo
- type AttackLayer3TimeseriesResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TimeseriesResponseMetaDateRange
- type AttackLayer3TimeseriesResponseMetaNormalization
- type AttackLayer3TimeseriesResponseMetaUnit
- type AttackLayer3TopAttacksParams
- type AttackLayer3TopAttacksParamsFormat
- type AttackLayer3TopAttacksParamsIPVersion
- type AttackLayer3TopAttacksParamsLimitDirection
- type AttackLayer3TopAttacksParamsMagnitude
- type AttackLayer3TopAttacksParamsNormalization
- type AttackLayer3TopAttacksParamsProtocol
- type AttackLayer3TopAttacksResponse
- type AttackLayer3TopAttacksResponseEnvelope
- type AttackLayer3TopAttacksResponseMeta
- type AttackLayer3TopAttacksResponseMetaConfidenceInfo
- type AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TopAttacksResponseMetaDateRange
- type AttackLayer3TopAttacksResponseMetaNormalization
- type AttackLayer3TopAttacksResponseMetaUnit
- type AttackLayer3TopAttacksResponseTop0
- type AttackLayer3TopIndustryParams
- type AttackLayer3TopIndustryParamsFormat
- type AttackLayer3TopIndustryParamsIPVersion
- type AttackLayer3TopIndustryParamsProtocol
- type AttackLayer3TopIndustryResponse
- type AttackLayer3TopIndustryResponseEnvelope
- type AttackLayer3TopIndustryResponseMeta
- type AttackLayer3TopIndustryResponseMetaConfidenceInfo
- type AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TopIndustryResponseMetaDateRange
- type AttackLayer3TopIndustryResponseMetaNormalization
- type AttackLayer3TopIndustryResponseMetaUnit
- type AttackLayer3TopIndustryResponseTop0
- type AttackLayer3TopLocationOriginParams
- type AttackLayer3TopLocationOriginParamsFormat
- type AttackLayer3TopLocationOriginParamsIPVersion
- type AttackLayer3TopLocationOriginParamsProtocol
- type AttackLayer3TopLocationOriginResponse
- type AttackLayer3TopLocationOriginResponseEnvelope
- type AttackLayer3TopLocationOriginResponseMeta
- type AttackLayer3TopLocationOriginResponseMetaConfidenceInfo
- type AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TopLocationOriginResponseMetaDateRange
- type AttackLayer3TopLocationOriginResponseMetaNormalization
- type AttackLayer3TopLocationOriginResponseMetaUnit
- type AttackLayer3TopLocationOriginResponseTop0
- type AttackLayer3TopLocationService
- func (r *AttackLayer3TopLocationService) Origin(ctx context.Context, query AttackLayer3TopLocationOriginParams, ...) (res *AttackLayer3TopLocationOriginResponse, err error)
- func (r *AttackLayer3TopLocationService) Target(ctx context.Context, query AttackLayer3TopLocationTargetParams, ...) (res *AttackLayer3TopLocationTargetResponse, err error)
- type AttackLayer3TopLocationTargetParams
- type AttackLayer3TopLocationTargetParamsFormat
- type AttackLayer3TopLocationTargetParamsIPVersion
- type AttackLayer3TopLocationTargetParamsProtocol
- type AttackLayer3TopLocationTargetResponse
- type AttackLayer3TopLocationTargetResponseEnvelope
- type AttackLayer3TopLocationTargetResponseMeta
- type AttackLayer3TopLocationTargetResponseMetaConfidenceInfo
- type AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TopLocationTargetResponseMetaDateRange
- type AttackLayer3TopLocationTargetResponseMetaNormalization
- type AttackLayer3TopLocationTargetResponseMetaUnit
- type AttackLayer3TopLocationTargetResponseTop0
- type AttackLayer3TopService
- func (r *AttackLayer3TopService) Attacks(ctx context.Context, query AttackLayer3TopAttacksParams, ...) (res *AttackLayer3TopAttacksResponse, err error)
- func (r *AttackLayer3TopService) Industry(ctx context.Context, query AttackLayer3TopIndustryParams, ...) (res *AttackLayer3TopIndustryResponse, err error)deprecated
- func (r *AttackLayer3TopService) Vertical(ctx context.Context, query AttackLayer3TopVerticalParams, ...) (res *AttackLayer3TopVerticalResponse, err error)deprecated
- type AttackLayer3TopVerticalParams
- type AttackLayer3TopVerticalParamsFormat
- type AttackLayer3TopVerticalParamsIPVersion
- type AttackLayer3TopVerticalParamsProtocol
- type AttackLayer3TopVerticalResponse
- type AttackLayer3TopVerticalResponseEnvelope
- type AttackLayer3TopVerticalResponseMeta
- type AttackLayer3TopVerticalResponseMetaConfidenceInfo
- type AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation
- type AttackLayer3TopVerticalResponseMetaDateRange
- type AttackLayer3TopVerticalResponseMetaNormalization
- type AttackLayer3TopVerticalResponseMetaUnit
- type AttackLayer3TopVerticalResponseTop0
- type AttackLayer7Service
- type AttackLayer7SummaryHTTPMethodParams
- type AttackLayer7SummaryHTTPMethodParamsFormat
- type AttackLayer7SummaryHTTPMethodParamsHTTPVersion
- type AttackLayer7SummaryHTTPMethodParamsIPVersion
- type AttackLayer7SummaryHTTPMethodParamsMitigationProduct
- type AttackLayer7SummaryHTTPMethodResponse
- type AttackLayer7SummaryHTTPMethodResponseEnvelope
- type AttackLayer7SummaryHTTPMethodResponseMeta
- type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo
- type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation
- type AttackLayer7SummaryHTTPMethodResponseMetaDateRange
- type AttackLayer7SummaryHTTPMethodResponseMetaNormalization
- type AttackLayer7SummaryHTTPMethodResponseMetaUnit
- type AttackLayer7SummaryHTTPVersionParams
- type AttackLayer7SummaryHTTPVersionParamsFormat
- type AttackLayer7SummaryHTTPVersionParamsHTTPMethod
- type AttackLayer7SummaryHTTPVersionParamsIPVersion
- type AttackLayer7SummaryHTTPVersionParamsMitigationProduct
- type AttackLayer7SummaryHTTPVersionResponse
- type AttackLayer7SummaryHTTPVersionResponseEnvelope
- type AttackLayer7SummaryHTTPVersionResponseMeta
- type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo
- type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation
- type AttackLayer7SummaryHTTPVersionResponseMetaDateRange
- type AttackLayer7SummaryHTTPVersionResponseMetaNormalization
- type AttackLayer7SummaryHTTPVersionResponseMetaUnit
- type AttackLayer7SummaryHTTPVersionResponseSummary0
- type AttackLayer7SummaryIPVersionParams
- type AttackLayer7SummaryIPVersionParamsFormat
- type AttackLayer7SummaryIPVersionParamsHTTPMethod
- type AttackLayer7SummaryIPVersionParamsHTTPVersion
- type AttackLayer7SummaryIPVersionParamsMitigationProduct
- type AttackLayer7SummaryIPVersionResponse
- type AttackLayer7SummaryIPVersionResponseEnvelope
- type AttackLayer7SummaryIPVersionResponseMeta
- type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo
- type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation
- type AttackLayer7SummaryIPVersionResponseMetaDateRange
- type AttackLayer7SummaryIPVersionResponseMetaNormalization
- type AttackLayer7SummaryIPVersionResponseMetaUnit
- type AttackLayer7SummaryIPVersionResponseSummary0
- type AttackLayer7SummaryIndustryParams
- type AttackLayer7SummaryIndustryParamsFormat
- type AttackLayer7SummaryIndustryParamsHTTPMethod
- type AttackLayer7SummaryIndustryParamsHTTPVersion
- type AttackLayer7SummaryIndustryParamsIPVersion
- type AttackLayer7SummaryIndustryParamsMitigationProduct
- type AttackLayer7SummaryIndustryResponse
- type AttackLayer7SummaryIndustryResponseEnvelope
- type AttackLayer7SummaryIndustryResponseMeta
- type AttackLayer7SummaryIndustryResponseMetaConfidenceInfo
- type AttackLayer7SummaryIndustryResponseMetaConfidenceInfoAnnotation
- type AttackLayer7SummaryIndustryResponseMetaDateRange
- type AttackLayer7SummaryIndustryResponseMetaNormalization
- type AttackLayer7SummaryIndustryResponseMetaUnit
- type AttackLayer7SummaryManagedRulesParams
- type AttackLayer7SummaryManagedRulesParamsFormat
- type AttackLayer7SummaryManagedRulesParamsHTTPMethod
- type AttackLayer7SummaryManagedRulesParamsHTTPVersion
- type AttackLayer7SummaryManagedRulesParamsIPVersion
- type AttackLayer7SummaryManagedRulesParamsMitigationProduct
- type AttackLayer7SummaryManagedRulesResponse
- type AttackLayer7SummaryManagedRulesResponseEnvelope
- type AttackLayer7SummaryManagedRulesResponseMeta
- type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo
- type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation
- type AttackLayer7SummaryManagedRulesResponseMetaDateRange
- type AttackLayer7SummaryManagedRulesResponseMetaNormalization
- type AttackLayer7SummaryManagedRulesResponseMetaUnit
- type AttackLayer7SummaryMitigationProductParams
- type AttackLayer7SummaryMitigationProductParamsFormat
- type AttackLayer7SummaryMitigationProductParamsHTTPMethod
- type AttackLayer7SummaryMitigationProductParamsHTTPVersion
- type AttackLayer7SummaryMitigationProductParamsIPVersion
- type AttackLayer7SummaryMitigationProductResponse
- type AttackLayer7SummaryMitigationProductResponseEnvelope
- type AttackLayer7SummaryMitigationProductResponseMeta
- type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo
- type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation
- type AttackLayer7SummaryMitigationProductResponseMetaDateRange
- type AttackLayer7SummaryMitigationProductResponseMetaNormalization
- type AttackLayer7SummaryMitigationProductResponseMetaUnit
- type AttackLayer7SummaryService
- func (r *AttackLayer7SummaryService) HTTPMethod(ctx context.Context, query AttackLayer7SummaryHTTPMethodParams, ...) (res *AttackLayer7SummaryHTTPMethodResponse, err error)
- func (r *AttackLayer7SummaryService) HTTPVersion(ctx context.Context, query AttackLayer7SummaryHTTPVersionParams, ...) (res *AttackLayer7SummaryHTTPVersionResponse, err error)
- func (r *AttackLayer7SummaryService) IPVersion(ctx context.Context, query AttackLayer7SummaryIPVersionParams, ...) (res *AttackLayer7SummaryIPVersionResponse, err error)
- func (r *AttackLayer7SummaryService) Industry(ctx context.Context, query AttackLayer7SummaryIndustryParams, ...) (res *AttackLayer7SummaryIndustryResponse, err error)
- func (r *AttackLayer7SummaryService) ManagedRules(ctx context.Context, query AttackLayer7SummaryManagedRulesParams, ...) (res *AttackLayer7SummaryManagedRulesResponse, err error)
- func (r *AttackLayer7SummaryService) MitigationProduct(ctx context.Context, query AttackLayer7SummaryMitigationProductParams, ...) (res *AttackLayer7SummaryMitigationProductResponse, err error)
- func (r *AttackLayer7SummaryService) Vertical(ctx context.Context, query AttackLayer7SummaryVerticalParams, ...) (res *AttackLayer7SummaryVerticalResponse, err error)
- type AttackLayer7SummaryVerticalParams
- type AttackLayer7SummaryVerticalParamsFormat
- type AttackLayer7SummaryVerticalParamsHTTPMethod
- type AttackLayer7SummaryVerticalParamsHTTPVersion
- type AttackLayer7SummaryVerticalParamsIPVersion
- type AttackLayer7SummaryVerticalParamsMitigationProduct
- type AttackLayer7SummaryVerticalResponse
- type AttackLayer7SummaryVerticalResponseEnvelope
- type AttackLayer7SummaryVerticalResponseMeta
- type AttackLayer7SummaryVerticalResponseMetaConfidenceInfo
- type AttackLayer7SummaryVerticalResponseMetaConfidenceInfoAnnotation
- type AttackLayer7SummaryVerticalResponseMetaDateRange
- type AttackLayer7SummaryVerticalResponseMetaNormalization
- type AttackLayer7SummaryVerticalResponseMetaUnit
- type AttackLayer7TimeseriesGroupHTTPMethodParams
- type AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval
- type AttackLayer7TimeseriesGroupHTTPMethodParamsFormat
- type AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion
- type AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion
- type AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct
- type AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization
- type AttackLayer7TimeseriesGroupHTTPMethodResponse
- type AttackLayer7TimeseriesGroupHTTPMethodResponseEnvelope
- type AttackLayer7TimeseriesGroupHTTPMethodResponseMeta
- type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval
- type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaDateRange
- type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization
- type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaUnit
- type AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0
- type AttackLayer7TimeseriesGroupHTTPVersionParams
- type AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval
- type AttackLayer7TimeseriesGroupHTTPVersionParamsFormat
- type AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod
- type AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion
- type AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct
- type AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization
- type AttackLayer7TimeseriesGroupHTTPVersionResponse
- type AttackLayer7TimeseriesGroupHTTPVersionResponseEnvelope
- type AttackLayer7TimeseriesGroupHTTPVersionResponseMeta
- type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval
- type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaDateRange
- type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization
- type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaUnit
- type AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0
- type AttackLayer7TimeseriesGroupIPVersionParams
- type AttackLayer7TimeseriesGroupIPVersionParamsAggInterval
- type AttackLayer7TimeseriesGroupIPVersionParamsFormat
- type AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod
- type AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion
- type AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct
- type AttackLayer7TimeseriesGroupIPVersionParamsNormalization
- type AttackLayer7TimeseriesGroupIPVersionResponse
- type AttackLayer7TimeseriesGroupIPVersionResponseEnvelope
- type AttackLayer7TimeseriesGroupIPVersionResponseMeta
- type AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval
- type AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesGroupIPVersionResponseMetaDateRange
- type AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization
- type AttackLayer7TimeseriesGroupIPVersionResponseMetaUnit
- type AttackLayer7TimeseriesGroupIPVersionResponseSerie0
- type AttackLayer7TimeseriesGroupIndustryParams
- type AttackLayer7TimeseriesGroupIndustryParamsAggInterval
- type AttackLayer7TimeseriesGroupIndustryParamsFormat
- type AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod
- type AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion
- type AttackLayer7TimeseriesGroupIndustryParamsIPVersion
- type AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct
- type AttackLayer7TimeseriesGroupIndustryParamsNormalization
- type AttackLayer7TimeseriesGroupIndustryResponse
- type AttackLayer7TimeseriesGroupIndustryResponseEnvelope
- type AttackLayer7TimeseriesGroupIndustryResponseMeta
- type AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval
- type AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesGroupIndustryResponseMetaDateRange
- type AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization
- type AttackLayer7TimeseriesGroupIndustryResponseMetaUnit
- type AttackLayer7TimeseriesGroupIndustryResponseSerie0
- type AttackLayer7TimeseriesGroupManagedRulesParams
- type AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval
- type AttackLayer7TimeseriesGroupManagedRulesParamsFormat
- type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod
- type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion
- type AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion
- type AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct
- type AttackLayer7TimeseriesGroupManagedRulesParamsNormalization
- type AttackLayer7TimeseriesGroupManagedRulesResponse
- type AttackLayer7TimeseriesGroupManagedRulesResponseEnvelope
- type AttackLayer7TimeseriesGroupManagedRulesResponseMeta
- type AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval
- type AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesGroupManagedRulesResponseMetaDateRange
- type AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization
- type AttackLayer7TimeseriesGroupManagedRulesResponseMetaUnit
- type AttackLayer7TimeseriesGroupManagedRulesResponseSerie0
- type AttackLayer7TimeseriesGroupMitigationProductParams
- type AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval
- type AttackLayer7TimeseriesGroupMitigationProductParamsFormat
- type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod
- type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion
- type AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion
- type AttackLayer7TimeseriesGroupMitigationProductParamsNormalization
- type AttackLayer7TimeseriesGroupMitigationProductResponse
- type AttackLayer7TimeseriesGroupMitigationProductResponseEnvelope
- type AttackLayer7TimeseriesGroupMitigationProductResponseMeta
- type AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval
- type AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesGroupMitigationProductResponseMetaDateRange
- type AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization
- type AttackLayer7TimeseriesGroupMitigationProductResponseMetaUnit
- type AttackLayer7TimeseriesGroupMitigationProductResponseSerie0
- type AttackLayer7TimeseriesGroupService
- func (r *AttackLayer7TimeseriesGroupService) HTTPMethod(ctx context.Context, query AttackLayer7TimeseriesGroupHTTPMethodParams, ...) (res *AttackLayer7TimeseriesGroupHTTPMethodResponse, err error)
- func (r *AttackLayer7TimeseriesGroupService) HTTPVersion(ctx context.Context, query AttackLayer7TimeseriesGroupHTTPVersionParams, ...) (res *AttackLayer7TimeseriesGroupHTTPVersionResponse, err error)
- func (r *AttackLayer7TimeseriesGroupService) IPVersion(ctx context.Context, query AttackLayer7TimeseriesGroupIPVersionParams, ...) (res *AttackLayer7TimeseriesGroupIPVersionResponse, err error)
- func (r *AttackLayer7TimeseriesGroupService) Industry(ctx context.Context, query AttackLayer7TimeseriesGroupIndustryParams, ...) (res *AttackLayer7TimeseriesGroupIndustryResponse, err error)
- func (r *AttackLayer7TimeseriesGroupService) ManagedRules(ctx context.Context, query AttackLayer7TimeseriesGroupManagedRulesParams, ...) (res *AttackLayer7TimeseriesGroupManagedRulesResponse, err error)
- func (r *AttackLayer7TimeseriesGroupService) MitigationProduct(ctx context.Context, query AttackLayer7TimeseriesGroupMitigationProductParams, ...) (res *AttackLayer7TimeseriesGroupMitigationProductResponse, err error)
- func (r *AttackLayer7TimeseriesGroupService) Vertical(ctx context.Context, query AttackLayer7TimeseriesGroupVerticalParams, ...) (res *AttackLayer7TimeseriesGroupVerticalResponse, err error)
- type AttackLayer7TimeseriesGroupVerticalParams
- type AttackLayer7TimeseriesGroupVerticalParamsAggInterval
- type AttackLayer7TimeseriesGroupVerticalParamsFormat
- type AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod
- type AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion
- type AttackLayer7TimeseriesGroupVerticalParamsIPVersion
- type AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct
- type AttackLayer7TimeseriesGroupVerticalParamsNormalization
- type AttackLayer7TimeseriesGroupVerticalResponse
- type AttackLayer7TimeseriesGroupVerticalResponseEnvelope
- type AttackLayer7TimeseriesGroupVerticalResponseMeta
- type AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval
- type AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesGroupVerticalResponseMetaDateRange
- type AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization
- type AttackLayer7TimeseriesGroupVerticalResponseMetaUnit
- type AttackLayer7TimeseriesGroupVerticalResponseSerie0
- type AttackLayer7TimeseriesParams
- type AttackLayer7TimeseriesParamsAggInterval
- type AttackLayer7TimeseriesParamsFormat
- type AttackLayer7TimeseriesParamsHTTPMethod
- type AttackLayer7TimeseriesParamsHTTPVersion
- type AttackLayer7TimeseriesParamsIPVersion
- type AttackLayer7TimeseriesParamsMitigationProduct
- type AttackLayer7TimeseriesParamsNormalization
- type AttackLayer7TimeseriesResponse
- type AttackLayer7TimeseriesResponseEnvelope
- type AttackLayer7TimeseriesResponseMeta
- type AttackLayer7TimeseriesResponseMetaAggInterval
- type AttackLayer7TimeseriesResponseMetaConfidenceInfo
- type AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TimeseriesResponseMetaDateRange
- type AttackLayer7TimeseriesResponseMetaNormalization
- type AttackLayer7TimeseriesResponseMetaUnit
- type AttackLayer7TimeseriesResponseSerie0
- type AttackLayer7TopAseOriginParams
- type AttackLayer7TopAseOriginParamsFormat
- type AttackLayer7TopAseOriginParamsHTTPMethod
- type AttackLayer7TopAseOriginParamsHTTPVersion
- type AttackLayer7TopAseOriginParamsIPVersion
- type AttackLayer7TopAseOriginParamsMitigationProduct
- type AttackLayer7TopAseOriginResponse
- type AttackLayer7TopAseOriginResponseEnvelope
- type AttackLayer7TopAseOriginResponseMeta
- type AttackLayer7TopAseOriginResponseMetaConfidenceInfo
- type AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TopAseOriginResponseMetaDateRange
- type AttackLayer7TopAseOriginResponseMetaNormalization
- type AttackLayer7TopAseOriginResponseMetaUnit
- type AttackLayer7TopAseOriginResponseTop0
- type AttackLayer7TopAseService
- type AttackLayer7TopAttacksParams
- type AttackLayer7TopAttacksParamsFormat
- type AttackLayer7TopAttacksParamsLimitDirection
- type AttackLayer7TopAttacksParamsMitigationProduct
- type AttackLayer7TopAttacksParamsNormalization
- type AttackLayer7TopAttacksResponse
- type AttackLayer7TopAttacksResponseEnvelope
- type AttackLayer7TopAttacksResponseMeta
- type AttackLayer7TopAttacksResponseMetaConfidenceInfo
- type AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TopAttacksResponseMetaDateRange
- type AttackLayer7TopAttacksResponseMetaNormalization
- type AttackLayer7TopAttacksResponseMetaUnit
- type AttackLayer7TopAttacksResponseTop0
- type AttackLayer7TopIndustryParams
- type AttackLayer7TopIndustryParamsFormat
- type AttackLayer7TopIndustryParamsHTTPMethod
- type AttackLayer7TopIndustryParamsHTTPVersion
- type AttackLayer7TopIndustryParamsIPVersion
- type AttackLayer7TopIndustryParamsMitigationProduct
- type AttackLayer7TopIndustryResponse
- type AttackLayer7TopIndustryResponseEnvelope
- type AttackLayer7TopIndustryResponseMeta
- type AttackLayer7TopIndustryResponseMetaConfidenceInfo
- type AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TopIndustryResponseMetaDateRange
- type AttackLayer7TopIndustryResponseMetaNormalization
- type AttackLayer7TopIndustryResponseMetaUnit
- type AttackLayer7TopIndustryResponseTop0
- type AttackLayer7TopLocationOriginParams
- type AttackLayer7TopLocationOriginParamsFormat
- type AttackLayer7TopLocationOriginParamsHTTPMethod
- type AttackLayer7TopLocationOriginParamsHTTPVersion
- type AttackLayer7TopLocationOriginParamsIPVersion
- type AttackLayer7TopLocationOriginParamsMitigationProduct
- type AttackLayer7TopLocationOriginResponse
- type AttackLayer7TopLocationOriginResponseEnvelope
- type AttackLayer7TopLocationOriginResponseMeta
- type AttackLayer7TopLocationOriginResponseMetaConfidenceInfo
- type AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TopLocationOriginResponseMetaDateRange
- type AttackLayer7TopLocationOriginResponseMetaNormalization
- type AttackLayer7TopLocationOriginResponseMetaUnit
- type AttackLayer7TopLocationOriginResponseTop0
- type AttackLayer7TopLocationService
- func (r *AttackLayer7TopLocationService) Origin(ctx context.Context, query AttackLayer7TopLocationOriginParams, ...) (res *AttackLayer7TopLocationOriginResponse, err error)
- func (r *AttackLayer7TopLocationService) Target(ctx context.Context, query AttackLayer7TopLocationTargetParams, ...) (res *AttackLayer7TopLocationTargetResponse, err error)
- type AttackLayer7TopLocationTargetParams
- type AttackLayer7TopLocationTargetParamsFormat
- type AttackLayer7TopLocationTargetParamsMitigationProduct
- type AttackLayer7TopLocationTargetResponse
- type AttackLayer7TopLocationTargetResponseEnvelope
- type AttackLayer7TopLocationTargetResponseMeta
- type AttackLayer7TopLocationTargetResponseMetaConfidenceInfo
- type AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TopLocationTargetResponseMetaDateRange
- type AttackLayer7TopLocationTargetResponseMetaNormalization
- type AttackLayer7TopLocationTargetResponseMetaUnit
- type AttackLayer7TopLocationTargetResponseTop0
- type AttackLayer7TopService
- func (r *AttackLayer7TopService) Attacks(ctx context.Context, query AttackLayer7TopAttacksParams, ...) (res *AttackLayer7TopAttacksResponse, err error)
- func (r *AttackLayer7TopService) Industry(ctx context.Context, query AttackLayer7TopIndustryParams, ...) (res *AttackLayer7TopIndustryResponse, err error)deprecated
- func (r *AttackLayer7TopService) Vertical(ctx context.Context, query AttackLayer7TopVerticalParams, ...) (res *AttackLayer7TopVerticalResponse, err error)deprecated
- type AttackLayer7TopVerticalParams
- type AttackLayer7TopVerticalParamsFormat
- type AttackLayer7TopVerticalParamsHTTPMethod
- type AttackLayer7TopVerticalParamsHTTPVersion
- type AttackLayer7TopVerticalParamsIPVersion
- type AttackLayer7TopVerticalParamsMitigationProduct
- type AttackLayer7TopVerticalResponse
- type AttackLayer7TopVerticalResponseEnvelope
- type AttackLayer7TopVerticalResponseMeta
- type AttackLayer7TopVerticalResponseMetaConfidenceInfo
- type AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation
- type AttackLayer7TopVerticalResponseMetaDateRange
- type AttackLayer7TopVerticalResponseMetaNormalization
- type AttackLayer7TopVerticalResponseMetaUnit
- type AttackLayer7TopVerticalResponseTop0
- type AttackService
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type BGPHijackEventListParams
- type BGPHijackEventListParamsFormat
- type BGPHijackEventListParamsSortBy
- type BGPHijackEventListParamsSortOrder
- type BGPHijackEventListResponse
- type BGPHijackEventListResponseASNInfo
- type BGPHijackEventListResponseEvent
- type BGPHijackEventListResponseEventsTag
- type BGPHijackEventService
- func (r *BGPHijackEventService) List(ctx context.Context, query BGPHijackEventListParams, ...) (res *pagination.V4PagePagination[BGPHijackEventListResponse], err error)
- func (r *BGPHijackEventService) ListAutoPaging(ctx context.Context, query BGPHijackEventListParams, ...) *pagination.V4PagePaginationAutoPager[BGPHijackEventListResponse]
- type BGPHijackService
- type BGPIPService
- type BGPIPTimeseriesParams
- type BGPLeakEventListParams
- type BGPLeakEventListParamsFormat
- type BGPLeakEventListParamsSortBy
- type BGPLeakEventListParamsSortOrder
- type BGPLeakEventListResponse
- type BGPLeakEventListResponseASNInfo
- type BGPLeakEventListResponseEvent
- type BGPLeakEventService
- func (r *BGPLeakEventService) List(ctx context.Context, query BGPLeakEventListParams, ...) (res *pagination.V4PagePagination[BGPLeakEventListResponse], err error)
- func (r *BGPLeakEventService) ListAutoPaging(ctx context.Context, query BGPLeakEventListParams, ...) *pagination.V4PagePaginationAutoPager[BGPLeakEventListResponse]
- type BGPLeakService
- type BGPRouteAsesParams
- type BGPRouteAsesParamsFormat
- type BGPRouteAsesParamsSortBy
- type BGPRouteAsesParamsSortOrder
- type BGPRouteAsesResponse
- type BGPRouteAsesResponseASN
- type BGPRouteAsesResponseEnvelope
- type BGPRouteAsesResponseMeta
- type BGPRouteMoasParams
- type BGPRouteMoasParamsFormat
- type BGPRouteMoasResponse
- type BGPRouteMoasResponseEnvelope
- type BGPRouteMoasResponseMeta
- type BGPRouteMoasResponseMoa
- type BGPRouteMoasResponseMoasOrigin
- type BGPRoutePfx2asParams
- type BGPRoutePfx2asParamsFormat
- type BGPRoutePfx2asParamsRPKIStatus
- type BGPRoutePfx2asResponse
- type BGPRoutePfx2asResponseEnvelope
- type BGPRoutePfx2asResponseMeta
- type BGPRoutePfx2asResponsePrefixOrigin
- type BGPRouteRealtimeParams
- type BGPRouteRealtimeParamsFormat
- type BGPRouteRealtimeResponse
- type BGPRouteRealtimeResponseEnvelope
- type BGPRouteRealtimeResponseMeta
- type BGPRouteRealtimeResponseMetaASNInfo
- type BGPRouteRealtimeResponseMetaCollector
- type BGPRouteRealtimeResponseMetaPrefixOrigin
- type BGPRouteRealtimeResponseRoute
- type BGPRouteService
- func (r *BGPRouteService) Ases(ctx context.Context, query BGPRouteAsesParams, opts ...option.RequestOption) (res *BGPRouteAsesResponse, err error)
- func (r *BGPRouteService) Moas(ctx context.Context, query BGPRouteMoasParams, opts ...option.RequestOption) (res *BGPRouteMoasResponse, err error)
- func (r *BGPRouteService) Pfx2as(ctx context.Context, query BGPRoutePfx2asParams, opts ...option.RequestOption) (res *BGPRoutePfx2asResponse, err error)
- func (r *BGPRouteService) Realtime(ctx context.Context, query BGPRouteRealtimeParams, ...) (res *BGPRouteRealtimeResponse, err error)
- func (r *BGPRouteService) Stats(ctx context.Context, query BGPRouteStatsParams, opts ...option.RequestOption) (res *BGPRouteStatsResponse, err error)
- type BGPRouteStatsParams
- type BGPRouteStatsParamsFormat
- type BGPRouteStatsResponse
- type BGPRouteStatsResponseEnvelope
- type BGPRouteStatsResponseMeta
- type BGPRouteStatsResponseStats
- type BGPService
- type BGPTimeseriesParams
- type BGPTimeseriesParamsAggInterval
- type BGPTimeseriesParamsFormat
- type BGPTimeseriesParamsUpdateType
- type BGPTimeseriesResponse
- type BGPTimeseriesResponseEnvelope
- type BGPTimeseriesResponseMeta
- type BGPTimeseriesResponseMetaAggInterval
- type BGPTimeseriesResponseMetaConfidenceInfo
- type BGPTimeseriesResponseMetaConfidenceInfoAnnotation
- type BGPTimeseriesResponseMetaDateRange
- type BGPTimeseriesResponseSerie0
- type BGPTopAseGetParams
- type BGPTopAseGetParamsFormat
- type BGPTopAseGetParamsUpdateType
- type BGPTopAseGetResponse
- type BGPTopAseGetResponseEnvelope
- type BGPTopAseGetResponseMeta
- type BGPTopAseGetResponseMetaDateRange
- type BGPTopAseGetResponseTop0
- type BGPTopAsePrefixesParams
- type BGPTopAsePrefixesParamsFormat
- type BGPTopAsePrefixesResponse
- type BGPTopAsePrefixesResponseASN
- type BGPTopAsePrefixesResponseEnvelope
- type BGPTopAsePrefixesResponseMeta
- type BGPTopAseService
- type BGPTopPrefixesParams
- type BGPTopPrefixesParamsFormat
- type BGPTopPrefixesParamsUpdateType
- type BGPTopPrefixesResponse
- type BGPTopPrefixesResponseEnvelope
- type BGPTopPrefixesResponseMeta
- type BGPTopPrefixesResponseMetaDateRange
- type BGPTopPrefixesResponseTop0
- type BGPTopService
- type BgpipTimeseriesParamsFormat
- type BgpipTimeseriesParamsIPVersion
- type BgpipTimeseriesResponse
- type BgpipTimeseriesResponseEnvelope
- type BgpipTimeseriesResponseMeta
- type BgpipTimeseriesResponseMetaAggInterval
- type BgpipTimeseriesResponseMetaConfidenceInfo
- type BgpipTimeseriesResponseMetaConfidenceInfoAnnotation
- type BgpipTimeseriesResponseMetaDateRange
- type BgpipTimeseriesResponseMetaDelay
- type BgpipTimeseriesResponseMetaDelayASNData
- type BgpipTimeseriesResponseMetaDelayASNDataLatest
- type BgpipTimeseriesResponseMetaDelayCountryData
- type BgpipTimeseriesResponseMetaDelayCountryDataLatest
- type BgpipTimeseriesResponseMetaNormalization
- type BgpipTimeseriesResponseMetaUnit
- type BgpipTimeseriesResponseSerie0
- type BotGetParams
- type BotGetParamsFormat
- type BotGetResponse
- type BotGetResponseBot
- type BotGetResponseEnvelope
- type BotListParams
- type BotListParamsBotCategory
- type BotListParamsBotVerificationStatus
- type BotListParamsFormat
- type BotListResponse
- type BotListResponseBot
- type BotListResponseEnvelope
- type BotService
- func (r *BotService) Get(ctx context.Context, botSlug string, query BotGetParams, ...) (res *BotGetResponse, err error)
- func (r *BotService) List(ctx context.Context, query BotListParams, opts ...option.RequestOption) (res *BotListResponse, err error)
- func (r *BotService) Summary(ctx context.Context, dimension BotSummaryParamsDimension, ...) (res *BotSummaryResponse, err error)
- func (r *BotService) Timeseries(ctx context.Context, query BotTimeseriesParams, opts ...option.RequestOption) (res *BotTimeseriesResponse, err error)
- func (r *BotService) TimeseriesGroups(ctx context.Context, dimension BotTimeseriesGroupsParamsDimension, ...) (res *BotTimeseriesGroupsResponse, err error)
- type BotSummaryParams
- type BotSummaryParamsBotCategory
- type BotSummaryParamsBotVerificationStatus
- type BotSummaryParamsDimension
- type BotSummaryParamsFormat
- type BotSummaryResponse
- type BotSummaryResponseEnvelope
- type BotSummaryResponseMeta
- type BotSummaryResponseMetaConfidenceInfo
- type BotSummaryResponseMetaConfidenceInfoAnnotation
- type BotSummaryResponseMetaDateRange
- type BotSummaryResponseMetaNormalization
- type BotSummaryResponseMetaUnit
- type BotTimeseriesGroupsParams
- type BotTimeseriesGroupsParamsAggInterval
- type BotTimeseriesGroupsParamsBotCategory
- type BotTimeseriesGroupsParamsBotVerificationStatus
- type BotTimeseriesGroupsParamsDimension
- type BotTimeseriesGroupsParamsFormat
- type BotTimeseriesGroupsResponse
- type BotTimeseriesGroupsResponseEnvelope
- type BotTimeseriesGroupsResponseMeta
- type BotTimeseriesGroupsResponseMetaAggInterval
- type BotTimeseriesGroupsResponseMetaConfidenceInfo
- type BotTimeseriesGroupsResponseMetaConfidenceInfoAnnotation
- type BotTimeseriesGroupsResponseMetaDateRange
- type BotTimeseriesGroupsResponseMetaNormalization
- type BotTimeseriesGroupsResponseMetaUnit
- type BotTimeseriesGroupsResponseSerie0
- type BotTimeseriesParams
- type BotTimeseriesParamsAggInterval
- type BotTimeseriesParamsBotCategory
- type BotTimeseriesParamsBotVerificationStatus
- type BotTimeseriesParamsFormat
- type BotTimeseriesResponse
- type BotTimeseriesResponseEnvelope
- type BotTimeseriesResponseMeta
- type BotTimeseriesResponseMetaAggInterval
- type BotTimeseriesResponseMetaConfidenceInfo
- type BotTimeseriesResponseMetaConfidenceInfoAnnotation
- type BotTimeseriesResponseMetaDateRange
- type BotTimeseriesResponseMetaNormalization
- type BotTimeseriesResponseMetaUnit
- type BotWebCrawlerService
- func (r *BotWebCrawlerService) Summary(ctx context.Context, dimension BotWebCrawlerSummaryParamsDimension, ...) (res *BotWebCrawlerSummaryResponse, err error)
- func (r *BotWebCrawlerService) TimeseriesGroups(ctx context.Context, dimension BotWebCrawlerTimeseriesGroupsParamsDimension, ...) (res *BotWebCrawlerTimeseriesGroupsResponse, err error)
- type BotWebCrawlerSummaryParams
- type BotWebCrawlerSummaryParamsDimension
- type BotWebCrawlerSummaryParamsFormat
- type BotWebCrawlerSummaryResponse
- type BotWebCrawlerSummaryResponseEnvelope
- type BotWebCrawlerSummaryResponseMeta
- type BotWebCrawlerSummaryResponseMetaConfidenceInfo
- type BotWebCrawlerSummaryResponseMetaConfidenceInfoAnnotation
- type BotWebCrawlerSummaryResponseMetaDateRange
- type BotWebCrawlerSummaryResponseMetaNormalization
- type BotWebCrawlerSummaryResponseMetaUnit
- type BotWebCrawlerTimeseriesGroupsParams
- type BotWebCrawlerTimeseriesGroupsParamsAggInterval
- type BotWebCrawlerTimeseriesGroupsParamsDimension
- type BotWebCrawlerTimeseriesGroupsParamsFormat
- type BotWebCrawlerTimeseriesGroupsResponse
- type BotWebCrawlerTimeseriesGroupsResponseEnvelope
- type BotWebCrawlerTimeseriesGroupsResponseMeta
- type BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval
- type BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfo
- type BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoAnnotation
- type BotWebCrawlerTimeseriesGroupsResponseMetaDateRange
- type BotWebCrawlerTimeseriesGroupsResponseMetaNormalization
- type BotWebCrawlerTimeseriesGroupsResponseMetaUnit
- type BotWebCrawlerTimeseriesGroupsResponseSerie0
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type DNSService
- type DNSSummaryCacheHitParams
- type DNSSummaryCacheHitParamsFormat
- type DNSSummaryCacheHitParamsProtocol
- type DNSSummaryCacheHitParamsQueryType
- type DNSSummaryCacheHitParamsResponseCode
- type DNSSummaryCacheHitResponse
- type DNSSummaryCacheHitResponseEnvelope
- type DNSSummaryCacheHitResponseMeta
- type DNSSummaryCacheHitResponseMetaConfidenceInfo
- type DNSSummaryCacheHitResponseMetaConfidenceInfoAnnotation
- type DNSSummaryCacheHitResponseMetaDateRange
- type DNSSummaryCacheHitResponseMetaNormalization
- type DNSSummaryCacheHitResponseMetaUnit
- type DNSSummaryCacheHitResponseSummary0
- type DNSSummaryDNSSECAwareParams
- type DNSSummaryDNSSECAwareParamsFormat
- type DNSSummaryDNSSECAwareParamsProtocol
- type DNSSummaryDNSSECAwareParamsQueryType
- type DNSSummaryDNSSECAwareParamsResponseCode
- type DNSSummaryDNSSECAwareResponse
- type DNSSummaryDNSSECAwareResponseEnvelope
- type DNSSummaryDNSSECAwareResponseMeta
- type DNSSummaryDNSSECAwareResponseMetaConfidenceInfo
- type DNSSummaryDNSSECAwareResponseMetaConfidenceInfoAnnotation
- type DNSSummaryDNSSECAwareResponseMetaDateRange
- type DNSSummaryDNSSECAwareResponseMetaNormalization
- type DNSSummaryDNSSECAwareResponseMetaUnit
- type DNSSummaryDNSSECAwareResponseSummary0
- type DNSSummaryDNSSECE2EParams
- type DNSSummaryDNSSECParams
- type DNSSummaryDNSSECParamsFormat
- type DNSSummaryDNSSECParamsProtocol
- type DNSSummaryDNSSECParamsQueryType
- type DNSSummaryDNSSECParamsResponseCode
- type DNSSummaryDNSSECResponse
- type DNSSummaryDNSSECResponseEnvelope
- type DNSSummaryDNSSECResponseMeta
- type DNSSummaryDNSSECResponseMetaConfidenceInfo
- type DNSSummaryDNSSECResponseMetaConfidenceInfoAnnotation
- type DNSSummaryDNSSECResponseMetaDateRange
- type DNSSummaryDNSSECResponseMetaNormalization
- type DNSSummaryDNSSECResponseMetaUnit
- type DNSSummaryDNSSECResponseSummary0
- type DNSSummaryDnssece2EParamsFormat
- type DNSSummaryDnssece2EParamsProtocol
- type DNSSummaryDnssece2EParamsQueryType
- type DNSSummaryDnssece2EParamsResponseCode
- type DNSSummaryDnssece2EResponse
- type DNSSummaryDnssece2EResponseEnvelope
- type DNSSummaryDnssece2EResponseMeta
- type DNSSummaryDnssece2EResponseMetaConfidenceInfo
- type DNSSummaryDnssece2EResponseMetaConfidenceInfoAnnotation
- type DNSSummaryDnssece2EResponseMetaDateRange
- type DNSSummaryDnssece2EResponseMetaNormalization
- type DNSSummaryDnssece2EResponseMetaUnit
- type DNSSummaryDnssece2EResponseSummary0
- type DNSSummaryIPVersionParams
- type DNSSummaryIPVersionParamsFormat
- type DNSSummaryIPVersionParamsProtocol
- type DNSSummaryIPVersionParamsQueryType
- type DNSSummaryIPVersionParamsResponseCode
- type DNSSummaryIPVersionResponse
- type DNSSummaryIPVersionResponseEnvelope
- type DNSSummaryIPVersionResponseMeta
- type DNSSummaryIPVersionResponseMetaConfidenceInfo
- type DNSSummaryIPVersionResponseMetaConfidenceInfoAnnotation
- type DNSSummaryIPVersionResponseMetaDateRange
- type DNSSummaryIPVersionResponseMetaNormalization
- type DNSSummaryIPVersionResponseMetaUnit
- type DNSSummaryIPVersionResponseSummary0
- type DNSSummaryMatchingAnswerParams
- type DNSSummaryMatchingAnswerParamsFormat
- type DNSSummaryMatchingAnswerParamsProtocol
- type DNSSummaryMatchingAnswerParamsQueryType
- type DNSSummaryMatchingAnswerParamsResponseCode
- type DNSSummaryMatchingAnswerResponse
- type DNSSummaryMatchingAnswerResponseEnvelope
- type DNSSummaryMatchingAnswerResponseMeta
- type DNSSummaryMatchingAnswerResponseMetaConfidenceInfo
- type DNSSummaryMatchingAnswerResponseMetaConfidenceInfoAnnotation
- type DNSSummaryMatchingAnswerResponseMetaDateRange
- type DNSSummaryMatchingAnswerResponseMetaNormalization
- type DNSSummaryMatchingAnswerResponseMetaUnit
- type DNSSummaryMatchingAnswerResponseSummary0
- type DNSSummaryProtocolParams
- type DNSSummaryProtocolParamsFormat
- type DNSSummaryProtocolParamsQueryType
- type DNSSummaryProtocolParamsResponseCode
- type DNSSummaryProtocolResponse
- type DNSSummaryProtocolResponseEnvelope
- type DNSSummaryProtocolResponseMeta
- type DNSSummaryProtocolResponseMetaConfidenceInfo
- type DNSSummaryProtocolResponseMetaConfidenceInfoAnnotation
- type DNSSummaryProtocolResponseMetaDateRange
- type DNSSummaryProtocolResponseMetaNormalization
- type DNSSummaryProtocolResponseMetaUnit
- type DNSSummaryProtocolResponseSummary0
- type DNSSummaryQueryTypeParams
- type DNSSummaryQueryTypeParamsFormat
- type DNSSummaryQueryTypeParamsProtocol
- type DNSSummaryQueryTypeParamsResponseCode
- type DNSSummaryQueryTypeResponse
- type DNSSummaryQueryTypeResponseEnvelope
- type DNSSummaryQueryTypeResponseMeta
- type DNSSummaryQueryTypeResponseMetaConfidenceInfo
- type DNSSummaryQueryTypeResponseMetaConfidenceInfoAnnotation
- type DNSSummaryQueryTypeResponseMetaDateRange
- type DNSSummaryQueryTypeResponseMetaNormalization
- type DNSSummaryQueryTypeResponseMetaUnit
- type DNSSummaryResponseCodeParams
- type DNSSummaryResponseCodeParamsFormat
- type DNSSummaryResponseCodeParamsProtocol
- type DNSSummaryResponseCodeParamsQueryType
- type DNSSummaryResponseCodeResponse
- type DNSSummaryResponseCodeResponseEnvelope
- type DNSSummaryResponseCodeResponseMeta
- type DNSSummaryResponseCodeResponseMetaConfidenceInfo
- type DNSSummaryResponseCodeResponseMetaConfidenceInfoAnnotation
- type DNSSummaryResponseCodeResponseMetaDateRange
- type DNSSummaryResponseCodeResponseMetaNormalization
- type DNSSummaryResponseCodeResponseMetaUnit
- type DNSSummaryResponseTTLParams
- type DNSSummaryResponseTTLParamsFormat
- type DNSSummaryResponseTTLParamsProtocol
- type DNSSummaryResponseTTLParamsQueryType
- type DNSSummaryResponseTTLParamsResponseCode
- type DNSSummaryResponseTTLResponse
- type DNSSummaryResponseTTLResponseEnvelope
- type DNSSummaryResponseTTLResponseMeta
- type DNSSummaryResponseTTLResponseMetaConfidenceInfo
- type DNSSummaryResponseTTLResponseMetaConfidenceInfoAnnotation
- type DNSSummaryResponseTTLResponseMetaDateRange
- type DNSSummaryResponseTTLResponseMetaNormalization
- type DNSSummaryResponseTTLResponseMetaUnit
- type DNSSummaryResponseTTLResponseSummary0
- type DNSSummaryService
- func (r *DNSSummaryService) CacheHit(ctx context.Context, query DNSSummaryCacheHitParams, ...) (res *DNSSummaryCacheHitResponse, err error)
- func (r *DNSSummaryService) DNSSEC(ctx context.Context, query DNSSummaryDNSSECParams, ...) (res *DNSSummaryDNSSECResponse, err error)
- func (r *DNSSummaryService) DNSSECAware(ctx context.Context, query DNSSummaryDNSSECAwareParams, ...) (res *DNSSummaryDNSSECAwareResponse, err error)
- func (r *DNSSummaryService) DNSSECE2E(ctx context.Context, query DNSSummaryDNSSECE2EParams, ...) (res *DNSSummaryDnssece2EResponse, err error)
- func (r *DNSSummaryService) IPVersion(ctx context.Context, query DNSSummaryIPVersionParams, ...) (res *DNSSummaryIPVersionResponse, err error)
- func (r *DNSSummaryService) MatchingAnswer(ctx context.Context, query DNSSummaryMatchingAnswerParams, ...) (res *DNSSummaryMatchingAnswerResponse, err error)
- func (r *DNSSummaryService) Protocol(ctx context.Context, query DNSSummaryProtocolParams, ...) (res *DNSSummaryProtocolResponse, err error)
- func (r *DNSSummaryService) QueryType(ctx context.Context, query DNSSummaryQueryTypeParams, ...) (res *DNSSummaryQueryTypeResponse, err error)
- func (r *DNSSummaryService) ResponseCode(ctx context.Context, query DNSSummaryResponseCodeParams, ...) (res *DNSSummaryResponseCodeResponse, err error)
- func (r *DNSSummaryService) ResponseTTL(ctx context.Context, query DNSSummaryResponseTTLParams, ...) (res *DNSSummaryResponseTTLResponse, err error)
- type DNSTimeseriesGroupCacheHitParams
- type DNSTimeseriesGroupCacheHitParamsAggInterval
- type DNSTimeseriesGroupCacheHitParamsFormat
- type DNSTimeseriesGroupCacheHitParamsProtocol
- type DNSTimeseriesGroupCacheHitParamsQueryType
- type DNSTimeseriesGroupCacheHitParamsResponseCode
- type DNSTimeseriesGroupCacheHitResponse
- type DNSTimeseriesGroupCacheHitResponseEnvelope
- type DNSTimeseriesGroupCacheHitResponseMeta
- type DNSTimeseriesGroupCacheHitResponseMetaAggInterval
- type DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfo
- type DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupCacheHitResponseMetaDateRange
- type DNSTimeseriesGroupCacheHitResponseMetaNormalization
- type DNSTimeseriesGroupCacheHitResponseMetaUnit
- type DNSTimeseriesGroupCacheHitResponseSerie0
- type DNSTimeseriesGroupDNSSECAwareParams
- type DNSTimeseriesGroupDNSSECAwareParamsAggInterval
- type DNSTimeseriesGroupDNSSECAwareParamsFormat
- type DNSTimeseriesGroupDNSSECAwareParamsProtocol
- type DNSTimeseriesGroupDNSSECAwareParamsQueryType
- type DNSTimeseriesGroupDNSSECAwareParamsResponseCode
- type DNSTimeseriesGroupDNSSECAwareResponse
- type DNSTimeseriesGroupDNSSECAwareResponseEnvelope
- type DNSTimeseriesGroupDNSSECAwareResponseMeta
- type DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval
- type DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfo
- type DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupDNSSECAwareResponseMetaDateRange
- type DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization
- type DNSTimeseriesGroupDNSSECAwareResponseMetaUnit
- type DNSTimeseriesGroupDNSSECAwareResponseSerie0
- type DNSTimeseriesGroupDNSSECE2EParams
- type DNSTimeseriesGroupDNSSECParams
- type DNSTimeseriesGroupDNSSECParamsAggInterval
- type DNSTimeseriesGroupDNSSECParamsFormat
- type DNSTimeseriesGroupDNSSECParamsProtocol
- type DNSTimeseriesGroupDNSSECParamsQueryType
- type DNSTimeseriesGroupDNSSECParamsResponseCode
- type DNSTimeseriesGroupDNSSECResponse
- type DNSTimeseriesGroupDNSSECResponseEnvelope
- type DNSTimeseriesGroupDNSSECResponseMeta
- type DNSTimeseriesGroupDNSSECResponseMetaAggInterval
- type DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfo
- type DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupDNSSECResponseMetaDateRange
- type DNSTimeseriesGroupDNSSECResponseMetaNormalization
- type DNSTimeseriesGroupDNSSECResponseMetaUnit
- type DNSTimeseriesGroupDNSSECResponseSerie0
- type DNSTimeseriesGroupDnssece2EParamsAggInterval
- type DNSTimeseriesGroupDnssece2EParamsFormat
- type DNSTimeseriesGroupDnssece2EParamsProtocol
- type DNSTimeseriesGroupDnssece2EParamsQueryType
- type DNSTimeseriesGroupDnssece2EParamsResponseCode
- type DNSTimeseriesGroupDnssece2EResponse
- type DNSTimeseriesGroupDnssece2EResponseEnvelope
- type DNSTimeseriesGroupDnssece2EResponseMeta
- type DNSTimeseriesGroupDnssece2EResponseMetaAggInterval
- type DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfo
- type DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupDnssece2EResponseMetaDateRange
- type DNSTimeseriesGroupDnssece2EResponseMetaNormalization
- type DNSTimeseriesGroupDnssece2EResponseMetaUnit
- type DNSTimeseriesGroupDnssece2EResponseSerie0
- type DNSTimeseriesGroupIPVersionParams
- type DNSTimeseriesGroupIPVersionParamsAggInterval
- type DNSTimeseriesGroupIPVersionParamsFormat
- type DNSTimeseriesGroupIPVersionParamsProtocol
- type DNSTimeseriesGroupIPVersionParamsQueryType
- type DNSTimeseriesGroupIPVersionParamsResponseCode
- type DNSTimeseriesGroupIPVersionResponse
- type DNSTimeseriesGroupIPVersionResponseEnvelope
- type DNSTimeseriesGroupIPVersionResponseMeta
- type DNSTimeseriesGroupIPVersionResponseMetaAggInterval
- type DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfo
- type DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupIPVersionResponseMetaDateRange
- type DNSTimeseriesGroupIPVersionResponseMetaNormalization
- type DNSTimeseriesGroupIPVersionResponseMetaUnit
- type DNSTimeseriesGroupIPVersionResponseSerie0
- type DNSTimeseriesGroupMatchingAnswerParams
- type DNSTimeseriesGroupMatchingAnswerParamsAggInterval
- type DNSTimeseriesGroupMatchingAnswerParamsFormat
- type DNSTimeseriesGroupMatchingAnswerParamsProtocol
- type DNSTimeseriesGroupMatchingAnswerParamsQueryType
- type DNSTimeseriesGroupMatchingAnswerParamsResponseCode
- type DNSTimeseriesGroupMatchingAnswerResponse
- type DNSTimeseriesGroupMatchingAnswerResponseEnvelope
- type DNSTimeseriesGroupMatchingAnswerResponseMeta
- type DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval
- type DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfo
- type DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupMatchingAnswerResponseMetaDateRange
- type DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization
- type DNSTimeseriesGroupMatchingAnswerResponseMetaUnit
- type DNSTimeseriesGroupMatchingAnswerResponseSerie0
- type DNSTimeseriesGroupProtocolParams
- type DNSTimeseriesGroupProtocolParamsAggInterval
- type DNSTimeseriesGroupProtocolParamsFormat
- type DNSTimeseriesGroupProtocolParamsQueryType
- type DNSTimeseriesGroupProtocolParamsResponseCode
- type DNSTimeseriesGroupProtocolResponse
- type DNSTimeseriesGroupProtocolResponseEnvelope
- type DNSTimeseriesGroupProtocolResponseMeta
- type DNSTimeseriesGroupProtocolResponseMetaAggInterval
- type DNSTimeseriesGroupProtocolResponseMetaConfidenceInfo
- type DNSTimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupProtocolResponseMetaDateRange
- type DNSTimeseriesGroupProtocolResponseMetaNormalization
- type DNSTimeseriesGroupProtocolResponseMetaUnit
- type DNSTimeseriesGroupProtocolResponseSerie0
- type DNSTimeseriesGroupQueryTypeParams
- type DNSTimeseriesGroupQueryTypeParamsAggInterval
- type DNSTimeseriesGroupQueryTypeParamsFormat
- type DNSTimeseriesGroupQueryTypeParamsProtocol
- type DNSTimeseriesGroupQueryTypeParamsResponseCode
- type DNSTimeseriesGroupQueryTypeResponse
- type DNSTimeseriesGroupQueryTypeResponseEnvelope
- type DNSTimeseriesGroupQueryTypeResponseMeta
- type DNSTimeseriesGroupQueryTypeResponseMetaAggInterval
- type DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfo
- type DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupQueryTypeResponseMetaDateRange
- type DNSTimeseriesGroupQueryTypeResponseMetaNormalization
- type DNSTimeseriesGroupQueryTypeResponseMetaUnit
- type DNSTimeseriesGroupQueryTypeResponseSerie0
- type DNSTimeseriesGroupResponseCodeParams
- type DNSTimeseriesGroupResponseCodeParamsAggInterval
- type DNSTimeseriesGroupResponseCodeParamsFormat
- type DNSTimeseriesGroupResponseCodeParamsProtocol
- type DNSTimeseriesGroupResponseCodeParamsQueryType
- type DNSTimeseriesGroupResponseCodeResponse
- type DNSTimeseriesGroupResponseCodeResponseEnvelope
- type DNSTimeseriesGroupResponseCodeResponseMeta
- type DNSTimeseriesGroupResponseCodeResponseMetaAggInterval
- type DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfo
- type DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupResponseCodeResponseMetaDateRange
- type DNSTimeseriesGroupResponseCodeResponseMetaNormalization
- type DNSTimeseriesGroupResponseCodeResponseMetaUnit
- type DNSTimeseriesGroupResponseCodeResponseSerie0
- type DNSTimeseriesGroupResponseTTLParams
- type DNSTimeseriesGroupResponseTTLParamsAggInterval
- type DNSTimeseriesGroupResponseTTLParamsFormat
- type DNSTimeseriesGroupResponseTTLParamsProtocol
- type DNSTimeseriesGroupResponseTTLParamsQueryType
- type DNSTimeseriesGroupResponseTTLParamsResponseCode
- type DNSTimeseriesGroupResponseTTLResponse
- type DNSTimeseriesGroupResponseTTLResponseEnvelope
- type DNSTimeseriesGroupResponseTTLResponseMeta
- type DNSTimeseriesGroupResponseTTLResponseMetaAggInterval
- type DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfo
- type DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesGroupResponseTTLResponseMetaDateRange
- type DNSTimeseriesGroupResponseTTLResponseMetaNormalization
- type DNSTimeseriesGroupResponseTTLResponseMetaUnit
- type DNSTimeseriesGroupResponseTTLResponseSerie0
- type DNSTimeseriesGroupService
- func (r *DNSTimeseriesGroupService) CacheHit(ctx context.Context, query DNSTimeseriesGroupCacheHitParams, ...) (res *DNSTimeseriesGroupCacheHitResponse, err error)
- func (r *DNSTimeseriesGroupService) DNSSEC(ctx context.Context, query DNSTimeseriesGroupDNSSECParams, ...) (res *DNSTimeseriesGroupDNSSECResponse, err error)
- func (r *DNSTimeseriesGroupService) DNSSECAware(ctx context.Context, query DNSTimeseriesGroupDNSSECAwareParams, ...) (res *DNSTimeseriesGroupDNSSECAwareResponse, err error)
- func (r *DNSTimeseriesGroupService) DNSSECE2E(ctx context.Context, query DNSTimeseriesGroupDNSSECE2EParams, ...) (res *DNSTimeseriesGroupDnssece2EResponse, err error)
- func (r *DNSTimeseriesGroupService) IPVersion(ctx context.Context, query DNSTimeseriesGroupIPVersionParams, ...) (res *DNSTimeseriesGroupIPVersionResponse, err error)
- func (r *DNSTimeseriesGroupService) MatchingAnswer(ctx context.Context, query DNSTimeseriesGroupMatchingAnswerParams, ...) (res *DNSTimeseriesGroupMatchingAnswerResponse, err error)
- func (r *DNSTimeseriesGroupService) Protocol(ctx context.Context, query DNSTimeseriesGroupProtocolParams, ...) (res *DNSTimeseriesGroupProtocolResponse, err error)
- func (r *DNSTimeseriesGroupService) QueryType(ctx context.Context, query DNSTimeseriesGroupQueryTypeParams, ...) (res *DNSTimeseriesGroupQueryTypeResponse, err error)
- func (r *DNSTimeseriesGroupService) ResponseCode(ctx context.Context, query DNSTimeseriesGroupResponseCodeParams, ...) (res *DNSTimeseriesGroupResponseCodeResponse, err error)
- func (r *DNSTimeseriesGroupService) ResponseTTL(ctx context.Context, query DNSTimeseriesGroupResponseTTLParams, ...) (res *DNSTimeseriesGroupResponseTTLResponse, err error)
- type DNSTimeseriesParams
- type DNSTimeseriesParamsAggInterval
- type DNSTimeseriesParamsFormat
- type DNSTimeseriesParamsProtocol
- type DNSTimeseriesParamsQueryType
- type DNSTimeseriesParamsResponseCode
- type DNSTimeseriesResponse
- type DNSTimeseriesResponseEnvelope
- type DNSTimeseriesResponseMeta
- type DNSTimeseriesResponseMetaAggInterval
- type DNSTimeseriesResponseMetaConfidenceInfo
- type DNSTimeseriesResponseMetaConfidenceInfoAnnotation
- type DNSTimeseriesResponseMetaDateRange
- type DNSTimeseriesResponseMetaNormalization
- type DNSTimeseriesResponseMetaUnit
- type DNSTopAsesParams
- type DNSTopAsesParamsFormat
- type DNSTopAsesResponse
- type DNSTopAsesResponseEnvelope
- type DNSTopAsesResponseMeta
- type DNSTopAsesResponseMetaConfidenceInfo
- type DNSTopAsesResponseMetaConfidenceInfoAnnotation
- type DNSTopAsesResponseMetaDateRange
- type DNSTopAsesResponseMetaNormalization
- type DNSTopAsesResponseMetaUnit
- type DNSTopAsesResponseTop0
- type DNSTopLocationsParams
- type DNSTopLocationsParamsFormat
- type DNSTopLocationsResponse
- type DNSTopLocationsResponseEnvelope
- type DNSTopLocationsResponseMeta
- type DNSTopLocationsResponseMetaConfidenceInfo
- type DNSTopLocationsResponseMetaConfidenceInfoAnnotation
- type DNSTopLocationsResponseMetaDateRange
- type DNSTopLocationsResponseMetaNormalization
- type DNSTopLocationsResponseMetaUnit
- type DNSTopLocationsResponseTop0
- type DNSTopService
- type DatasetDownloadParams
- type DatasetDownloadParamsFormat
- type DatasetDownloadResponse
- type DatasetDownloadResponseDataset
- type DatasetDownloadResponseEnvelope
- type DatasetListParams
- type DatasetListParamsDatasetType
- type DatasetListParamsFormat
- type DatasetListResponse
- type DatasetListResponseDataset
- type DatasetListResponseEnvelope
- type DatasetService
- func (r *DatasetService) Download(ctx context.Context, params DatasetDownloadParams, ...) (res *DatasetDownloadResponse, err error)
- func (r *DatasetService) Get(ctx context.Context, alias string, opts ...option.RequestOption) (res *string, err error)
- func (r *DatasetService) List(ctx context.Context, query DatasetListParams, opts ...option.RequestOption) (res *DatasetListResponse, err error)
- type EmailRoutingService
- type EmailRoutingSummaryARCParams
- type EmailRoutingSummaryARCParamsDKIM
- type EmailRoutingSummaryARCParamsDMARC
- type EmailRoutingSummaryARCParamsEncrypted
- type EmailRoutingSummaryARCParamsFormat
- type EmailRoutingSummaryARCParamsIPVersion
- type EmailRoutingSummaryARCParamsSPF
- type EmailRoutingSummaryARCResponse
- type EmailRoutingSummaryARCResponseEnvelope
- type EmailRoutingSummaryARCResponseMeta
- type EmailRoutingSummaryARCResponseMetaConfidenceInfo
- type EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation
- type EmailRoutingSummaryARCResponseMetaDateRange
- type EmailRoutingSummaryARCResponseMetaNormalization
- type EmailRoutingSummaryARCResponseMetaUnit
- type EmailRoutingSummaryDKIMParams
- type EmailRoutingSummaryDKIMParamsARC
- type EmailRoutingSummaryDKIMParamsDMARC
- type EmailRoutingSummaryDKIMParamsEncrypted
- type EmailRoutingSummaryDKIMParamsFormat
- type EmailRoutingSummaryDKIMParamsIPVersion
- type EmailRoutingSummaryDKIMParamsSPF
- type EmailRoutingSummaryDKIMResponse
- type EmailRoutingSummaryDKIMResponseEnvelope
- type EmailRoutingSummaryDKIMResponseMeta
- type EmailRoutingSummaryDKIMResponseMetaConfidenceInfo
- type EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation
- type EmailRoutingSummaryDKIMResponseMetaDateRange
- type EmailRoutingSummaryDKIMResponseMetaNormalization
- type EmailRoutingSummaryDKIMResponseMetaUnit
- type EmailRoutingSummaryDMARCParams
- type EmailRoutingSummaryDMARCParamsARC
- type EmailRoutingSummaryDMARCParamsDKIM
- type EmailRoutingSummaryDMARCParamsEncrypted
- type EmailRoutingSummaryDMARCParamsFormat
- type EmailRoutingSummaryDMARCParamsIPVersion
- type EmailRoutingSummaryDMARCParamsSPF
- type EmailRoutingSummaryDMARCResponse
- type EmailRoutingSummaryDMARCResponseEnvelope
- type EmailRoutingSummaryDMARCResponseMeta
- type EmailRoutingSummaryDMARCResponseMetaConfidenceInfo
- type EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation
- type EmailRoutingSummaryDMARCResponseMetaDateRange
- type EmailRoutingSummaryDMARCResponseMetaNormalization
- type EmailRoutingSummaryDMARCResponseMetaUnit
- type EmailRoutingSummaryEncryptedParams
- type EmailRoutingSummaryEncryptedParamsARC
- type EmailRoutingSummaryEncryptedParamsDKIM
- type EmailRoutingSummaryEncryptedParamsDMARC
- type EmailRoutingSummaryEncryptedParamsFormat
- type EmailRoutingSummaryEncryptedParamsIPVersion
- type EmailRoutingSummaryEncryptedParamsSPF
- type EmailRoutingSummaryEncryptedResponse
- type EmailRoutingSummaryEncryptedResponseEnvelope
- type EmailRoutingSummaryEncryptedResponseMeta
- type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo
- type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation
- type EmailRoutingSummaryEncryptedResponseMetaDateRange
- type EmailRoutingSummaryEncryptedResponseMetaNormalization
- type EmailRoutingSummaryEncryptedResponseMetaUnit
- type EmailRoutingSummaryEncryptedResponseSummary0
- type EmailRoutingSummaryIPVersionParams
- type EmailRoutingSummaryIPVersionParamsARC
- type EmailRoutingSummaryIPVersionParamsDKIM
- type EmailRoutingSummaryIPVersionParamsDMARC
- type EmailRoutingSummaryIPVersionParamsEncrypted
- type EmailRoutingSummaryIPVersionParamsFormat
- type EmailRoutingSummaryIPVersionParamsSPF
- type EmailRoutingSummaryIPVersionResponse
- type EmailRoutingSummaryIPVersionResponseEnvelope
- type EmailRoutingSummaryIPVersionResponseMeta
- type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo
- type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation
- type EmailRoutingSummaryIPVersionResponseMetaDateRange
- type EmailRoutingSummaryIPVersionResponseMetaNormalization
- type EmailRoutingSummaryIPVersionResponseMetaUnit
- type EmailRoutingSummaryIPVersionResponseSummary0
- type EmailRoutingSummarySPFParams
- type EmailRoutingSummarySPFParamsARC
- type EmailRoutingSummarySPFParamsDKIM
- type EmailRoutingSummarySPFParamsDMARC
- type EmailRoutingSummarySPFParamsEncrypted
- type EmailRoutingSummarySPFParamsFormat
- type EmailRoutingSummarySPFParamsIPVersion
- type EmailRoutingSummarySPFResponse
- type EmailRoutingSummarySPFResponseEnvelope
- type EmailRoutingSummarySPFResponseMeta
- type EmailRoutingSummarySPFResponseMetaConfidenceInfo
- type EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation
- type EmailRoutingSummarySPFResponseMetaDateRange
- type EmailRoutingSummarySPFResponseMetaNormalization
- type EmailRoutingSummarySPFResponseMetaUnit
- type EmailRoutingSummaryService
- func (r *EmailRoutingSummaryService) ARC(ctx context.Context, query EmailRoutingSummaryARCParams, ...) (res *EmailRoutingSummaryARCResponse, err error)
- func (r *EmailRoutingSummaryService) DKIM(ctx context.Context, query EmailRoutingSummaryDKIMParams, ...) (res *EmailRoutingSummaryDKIMResponse, err error)
- func (r *EmailRoutingSummaryService) DMARC(ctx context.Context, query EmailRoutingSummaryDMARCParams, ...) (res *EmailRoutingSummaryDMARCResponse, err error)
- func (r *EmailRoutingSummaryService) Encrypted(ctx context.Context, query EmailRoutingSummaryEncryptedParams, ...) (res *EmailRoutingSummaryEncryptedResponse, err error)
- func (r *EmailRoutingSummaryService) IPVersion(ctx context.Context, query EmailRoutingSummaryIPVersionParams, ...) (res *EmailRoutingSummaryIPVersionResponse, err error)
- func (r *EmailRoutingSummaryService) SPF(ctx context.Context, query EmailRoutingSummarySPFParams, ...) (res *EmailRoutingSummarySPFResponse, err error)
- type EmailRoutingTimeseriesGroupARCParams
- type EmailRoutingTimeseriesGroupARCParamsAggInterval
- type EmailRoutingTimeseriesGroupARCParamsDKIM
- type EmailRoutingTimeseriesGroupARCParamsDMARC
- type EmailRoutingTimeseriesGroupARCParamsEncrypted
- type EmailRoutingTimeseriesGroupARCParamsFormat
- type EmailRoutingTimeseriesGroupARCParamsIPVersion
- type EmailRoutingTimeseriesGroupARCParamsSPF
- type EmailRoutingTimeseriesGroupARCResponse
- type EmailRoutingTimeseriesGroupARCResponseEnvelope
- type EmailRoutingTimeseriesGroupARCResponseMeta
- type EmailRoutingTimeseriesGroupARCResponseMetaAggInterval
- type EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfo
- type EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation
- type EmailRoutingTimeseriesGroupARCResponseMetaDateRange
- type EmailRoutingTimeseriesGroupARCResponseMetaNormalization
- type EmailRoutingTimeseriesGroupARCResponseMetaUnit
- type EmailRoutingTimeseriesGroupDKIMParams
- type EmailRoutingTimeseriesGroupDKIMParamsARC
- type EmailRoutingTimeseriesGroupDKIMParamsAggInterval
- type EmailRoutingTimeseriesGroupDKIMParamsDMARC
- type EmailRoutingTimeseriesGroupDKIMParamsEncrypted
- type EmailRoutingTimeseriesGroupDKIMParamsFormat
- type EmailRoutingTimeseriesGroupDKIMParamsIPVersion
- type EmailRoutingTimeseriesGroupDKIMParamsSPF
- type EmailRoutingTimeseriesGroupDKIMResponse
- type EmailRoutingTimeseriesGroupDKIMResponseEnvelope
- type EmailRoutingTimeseriesGroupDKIMResponseMeta
- type EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval
- type EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfo
- type EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation
- type EmailRoutingTimeseriesGroupDKIMResponseMetaDateRange
- type EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization
- type EmailRoutingTimeseriesGroupDKIMResponseMetaUnit
- type EmailRoutingTimeseriesGroupDMARCParams
- type EmailRoutingTimeseriesGroupDMARCParamsARC
- type EmailRoutingTimeseriesGroupDMARCParamsAggInterval
- type EmailRoutingTimeseriesGroupDMARCParamsDKIM
- type EmailRoutingTimeseriesGroupDMARCParamsEncrypted
- type EmailRoutingTimeseriesGroupDMARCParamsFormat
- type EmailRoutingTimeseriesGroupDMARCParamsIPVersion
- type EmailRoutingTimeseriesGroupDMARCParamsSPF
- type EmailRoutingTimeseriesGroupDMARCResponse
- type EmailRoutingTimeseriesGroupDMARCResponseEnvelope
- type EmailRoutingTimeseriesGroupDMARCResponseMeta
- type EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval
- type EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfo
- type EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation
- type EmailRoutingTimeseriesGroupDMARCResponseMetaDateRange
- type EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization
- type EmailRoutingTimeseriesGroupDMARCResponseMetaUnit
- type EmailRoutingTimeseriesGroupEncryptedParams
- type EmailRoutingTimeseriesGroupEncryptedParamsARC
- type EmailRoutingTimeseriesGroupEncryptedParamsAggInterval
- type EmailRoutingTimeseriesGroupEncryptedParamsDKIM
- type EmailRoutingTimeseriesGroupEncryptedParamsDMARC
- type EmailRoutingTimeseriesGroupEncryptedParamsFormat
- type EmailRoutingTimeseriesGroupEncryptedParamsIPVersion
- type EmailRoutingTimeseriesGroupEncryptedParamsSPF
- type EmailRoutingTimeseriesGroupEncryptedResponse
- type EmailRoutingTimeseriesGroupEncryptedResponseEnvelope
- type EmailRoutingTimeseriesGroupEncryptedResponseMeta
- type EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval
- type EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfo
- type EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoAnnotation
- type EmailRoutingTimeseriesGroupEncryptedResponseMetaDateRange
- type EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization
- type EmailRoutingTimeseriesGroupEncryptedResponseMetaUnit
- type EmailRoutingTimeseriesGroupEncryptedResponseSerie0
- type EmailRoutingTimeseriesGroupIPVersionParams
- type EmailRoutingTimeseriesGroupIPVersionParamsARC
- type EmailRoutingTimeseriesGroupIPVersionParamsAggInterval
- type EmailRoutingTimeseriesGroupIPVersionParamsDKIM
- type EmailRoutingTimeseriesGroupIPVersionParamsDMARC
- type EmailRoutingTimeseriesGroupIPVersionParamsEncrypted
- type EmailRoutingTimeseriesGroupIPVersionParamsFormat
- type EmailRoutingTimeseriesGroupIPVersionParamsSPF
- type EmailRoutingTimeseriesGroupIPVersionResponse
- type EmailRoutingTimeseriesGroupIPVersionResponseEnvelope
- type EmailRoutingTimeseriesGroupIPVersionResponseMeta
- type EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval
- type EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfo
- type EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation
- type EmailRoutingTimeseriesGroupIPVersionResponseMetaDateRange
- type EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization
- type EmailRoutingTimeseriesGroupIPVersionResponseMetaUnit
- type EmailRoutingTimeseriesGroupIPVersionResponseSerie0
- type EmailRoutingTimeseriesGroupSPFParams
- type EmailRoutingTimeseriesGroupSPFParamsARC
- type EmailRoutingTimeseriesGroupSPFParamsAggInterval
- type EmailRoutingTimeseriesGroupSPFParamsDKIM
- type EmailRoutingTimeseriesGroupSPFParamsDMARC
- type EmailRoutingTimeseriesGroupSPFParamsEncrypted
- type EmailRoutingTimeseriesGroupSPFParamsFormat
- type EmailRoutingTimeseriesGroupSPFParamsIPVersion
- type EmailRoutingTimeseriesGroupSPFResponse
- type EmailRoutingTimeseriesGroupSPFResponseEnvelope
- type EmailRoutingTimeseriesGroupSPFResponseMeta
- type EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval
- type EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfo
- type EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation
- type EmailRoutingTimeseriesGroupSPFResponseMetaDateRange
- type EmailRoutingTimeseriesGroupSPFResponseMetaNormalization
- type EmailRoutingTimeseriesGroupSPFResponseMetaUnit
- type EmailRoutingTimeseriesGroupService
- func (r *EmailRoutingTimeseriesGroupService) ARC(ctx context.Context, query EmailRoutingTimeseriesGroupARCParams, ...) (res *EmailRoutingTimeseriesGroupARCResponse, err error)
- func (r *EmailRoutingTimeseriesGroupService) DKIM(ctx context.Context, query EmailRoutingTimeseriesGroupDKIMParams, ...) (res *EmailRoutingTimeseriesGroupDKIMResponse, err error)
- func (r *EmailRoutingTimeseriesGroupService) DMARC(ctx context.Context, query EmailRoutingTimeseriesGroupDMARCParams, ...) (res *EmailRoutingTimeseriesGroupDMARCResponse, err error)
- func (r *EmailRoutingTimeseriesGroupService) Encrypted(ctx context.Context, query EmailRoutingTimeseriesGroupEncryptedParams, ...) (res *EmailRoutingTimeseriesGroupEncryptedResponse, err error)
- func (r *EmailRoutingTimeseriesGroupService) IPVersion(ctx context.Context, query EmailRoutingTimeseriesGroupIPVersionParams, ...) (res *EmailRoutingTimeseriesGroupIPVersionResponse, err error)
- func (r *EmailRoutingTimeseriesGroupService) SPF(ctx context.Context, query EmailRoutingTimeseriesGroupSPFParams, ...) (res *EmailRoutingTimeseriesGroupSPFResponse, err error)
- type EmailSecurityService
- type EmailSecuritySummaryARCParams
- type EmailSecuritySummaryARCParamsDKIM
- type EmailSecuritySummaryARCParamsDMARC
- type EmailSecuritySummaryARCParamsFormat
- type EmailSecuritySummaryARCParamsSPF
- type EmailSecuritySummaryARCParamsTLSVersion
- type EmailSecuritySummaryARCResponse
- type EmailSecuritySummaryARCResponseEnvelope
- type EmailSecuritySummaryARCResponseMeta
- type EmailSecuritySummaryARCResponseMetaConfidenceInfo
- type EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummaryARCResponseMetaDateRange
- type EmailSecuritySummaryARCResponseMetaNormalization
- type EmailSecuritySummaryARCResponseMetaUnit
- type EmailSecuritySummaryDKIMParams
- type EmailSecuritySummaryDKIMParamsARC
- type EmailSecuritySummaryDKIMParamsDMARC
- type EmailSecuritySummaryDKIMParamsFormat
- type EmailSecuritySummaryDKIMParamsSPF
- type EmailSecuritySummaryDKIMParamsTLSVersion
- type EmailSecuritySummaryDKIMResponse
- type EmailSecuritySummaryDKIMResponseEnvelope
- type EmailSecuritySummaryDKIMResponseMeta
- type EmailSecuritySummaryDKIMResponseMetaConfidenceInfo
- type EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummaryDKIMResponseMetaDateRange
- type EmailSecuritySummaryDKIMResponseMetaNormalization
- type EmailSecuritySummaryDKIMResponseMetaUnit
- type EmailSecuritySummaryDMARCParams
- type EmailSecuritySummaryDMARCParamsARC
- type EmailSecuritySummaryDMARCParamsDKIM
- type EmailSecuritySummaryDMARCParamsFormat
- type EmailSecuritySummaryDMARCParamsSPF
- type EmailSecuritySummaryDMARCParamsTLSVersion
- type EmailSecuritySummaryDMARCResponse
- type EmailSecuritySummaryDMARCResponseEnvelope
- type EmailSecuritySummaryDMARCResponseMeta
- type EmailSecuritySummaryDMARCResponseMetaConfidenceInfo
- type EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummaryDMARCResponseMetaDateRange
- type EmailSecuritySummaryDMARCResponseMetaNormalization
- type EmailSecuritySummaryDMARCResponseMetaUnit
- type EmailSecuritySummaryMaliciousParams
- type EmailSecuritySummaryMaliciousParamsARC
- type EmailSecuritySummaryMaliciousParamsDKIM
- type EmailSecuritySummaryMaliciousParamsDMARC
- type EmailSecuritySummaryMaliciousParamsFormat
- type EmailSecuritySummaryMaliciousParamsSPF
- type EmailSecuritySummaryMaliciousParamsTLSVersion
- type EmailSecuritySummaryMaliciousResponse
- type EmailSecuritySummaryMaliciousResponseEnvelope
- type EmailSecuritySummaryMaliciousResponseMeta
- type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo
- type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummaryMaliciousResponseMetaDateRange
- type EmailSecuritySummaryMaliciousResponseMetaNormalization
- type EmailSecuritySummaryMaliciousResponseMetaUnit
- type EmailSecuritySummaryMaliciousResponseSummary0
- type EmailSecuritySummarySPFParams
- type EmailSecuritySummarySPFParamsARC
- type EmailSecuritySummarySPFParamsDKIM
- type EmailSecuritySummarySPFParamsDMARC
- type EmailSecuritySummarySPFParamsFormat
- type EmailSecuritySummarySPFParamsTLSVersion
- type EmailSecuritySummarySPFResponse
- type EmailSecuritySummarySPFResponseEnvelope
- type EmailSecuritySummarySPFResponseMeta
- type EmailSecuritySummarySPFResponseMetaConfidenceInfo
- type EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummarySPFResponseMetaDateRange
- type EmailSecuritySummarySPFResponseMetaNormalization
- type EmailSecuritySummarySPFResponseMetaUnit
- type EmailSecuritySummaryService
- func (r *EmailSecuritySummaryService) ARC(ctx context.Context, query EmailSecuritySummaryARCParams, ...) (res *EmailSecuritySummaryARCResponse, err error)
- func (r *EmailSecuritySummaryService) DKIM(ctx context.Context, query EmailSecuritySummaryDKIMParams, ...) (res *EmailSecuritySummaryDKIMResponse, err error)
- func (r *EmailSecuritySummaryService) DMARC(ctx context.Context, query EmailSecuritySummaryDMARCParams, ...) (res *EmailSecuritySummaryDMARCResponse, err error)
- func (r *EmailSecuritySummaryService) Malicious(ctx context.Context, query EmailSecuritySummaryMaliciousParams, ...) (res *EmailSecuritySummaryMaliciousResponse, err error)
- func (r *EmailSecuritySummaryService) SPF(ctx context.Context, query EmailSecuritySummarySPFParams, ...) (res *EmailSecuritySummarySPFResponse, err error)
- func (r *EmailSecuritySummaryService) Spam(ctx context.Context, query EmailSecuritySummarySpamParams, ...) (res *EmailSecuritySummarySpamResponse, err error)
- func (r *EmailSecuritySummaryService) Spoof(ctx context.Context, query EmailSecuritySummarySpoofParams, ...) (res *EmailSecuritySummarySpoofResponse, err error)
- func (r *EmailSecuritySummaryService) TLSVersion(ctx context.Context, query EmailSecuritySummaryTLSVersionParams, ...) (res *EmailSecuritySummaryTLSVersionResponse, err error)
- func (r *EmailSecuritySummaryService) ThreatCategory(ctx context.Context, query EmailSecuritySummaryThreatCategoryParams, ...) (res *EmailSecuritySummaryThreatCategoryResponse, err error)
- type EmailSecuritySummarySpamParams
- type EmailSecuritySummarySpamParamsARC
- type EmailSecuritySummarySpamParamsDKIM
- type EmailSecuritySummarySpamParamsDMARC
- type EmailSecuritySummarySpamParamsFormat
- type EmailSecuritySummarySpamParamsSPF
- type EmailSecuritySummarySpamParamsTLSVersion
- type EmailSecuritySummarySpamResponse
- type EmailSecuritySummarySpamResponseEnvelope
- type EmailSecuritySummarySpamResponseMeta
- type EmailSecuritySummarySpamResponseMetaConfidenceInfo
- type EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummarySpamResponseMetaDateRange
- type EmailSecuritySummarySpamResponseMetaNormalization
- type EmailSecuritySummarySpamResponseMetaUnit
- type EmailSecuritySummarySpamResponseSummary0
- type EmailSecuritySummarySpoofParams
- type EmailSecuritySummarySpoofParamsARC
- type EmailSecuritySummarySpoofParamsDKIM
- type EmailSecuritySummarySpoofParamsDMARC
- type EmailSecuritySummarySpoofParamsFormat
- type EmailSecuritySummarySpoofParamsSPF
- type EmailSecuritySummarySpoofParamsTLSVersion
- type EmailSecuritySummarySpoofResponse
- type EmailSecuritySummarySpoofResponseEnvelope
- type EmailSecuritySummarySpoofResponseMeta
- type EmailSecuritySummarySpoofResponseMetaConfidenceInfo
- type EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummarySpoofResponseMetaDateRange
- type EmailSecuritySummarySpoofResponseMetaNormalization
- type EmailSecuritySummarySpoofResponseMetaUnit
- type EmailSecuritySummarySpoofResponseSummary0
- type EmailSecuritySummaryTLSVersionParams
- type EmailSecuritySummaryTLSVersionParamsARC
- type EmailSecuritySummaryTLSVersionParamsDKIM
- type EmailSecuritySummaryTLSVersionParamsDMARC
- type EmailSecuritySummaryTLSVersionParamsFormat
- type EmailSecuritySummaryTLSVersionParamsSPF
- type EmailSecuritySummaryTLSVersionResponse
- type EmailSecuritySummaryTLSVersionResponseEnvelope
- type EmailSecuritySummaryTLSVersionResponseMeta
- type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo
- type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummaryTLSVersionResponseMetaDateRange
- type EmailSecuritySummaryTLSVersionResponseMetaNormalization
- type EmailSecuritySummaryTLSVersionResponseMetaUnit
- type EmailSecuritySummaryTLSVersionResponseSummary0
- type EmailSecuritySummaryThreatCategoryParams
- type EmailSecuritySummaryThreatCategoryParamsARC
- type EmailSecuritySummaryThreatCategoryParamsDKIM
- type EmailSecuritySummaryThreatCategoryParamsDMARC
- type EmailSecuritySummaryThreatCategoryParamsFormat
- type EmailSecuritySummaryThreatCategoryParamsSPF
- type EmailSecuritySummaryThreatCategoryParamsTLSVersion
- type EmailSecuritySummaryThreatCategoryResponse
- type EmailSecuritySummaryThreatCategoryResponseEnvelope
- type EmailSecuritySummaryThreatCategoryResponseMeta
- type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo
- type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation
- type EmailSecuritySummaryThreatCategoryResponseMetaDateRange
- type EmailSecuritySummaryThreatCategoryResponseMetaNormalization
- type EmailSecuritySummaryThreatCategoryResponseMetaUnit
- type EmailSecuritySummaryThreatCategoryResponseSummary0
- type EmailSecurityTimeseriesGroupARCParams
- type EmailSecurityTimeseriesGroupARCParamsAggInterval
- type EmailSecurityTimeseriesGroupARCParamsDKIM
- type EmailSecurityTimeseriesGroupARCParamsDMARC
- type EmailSecurityTimeseriesGroupARCParamsFormat
- type EmailSecurityTimeseriesGroupARCParamsSPF
- type EmailSecurityTimeseriesGroupARCParamsTLSVersion
- type EmailSecurityTimeseriesGroupARCResponse
- type EmailSecurityTimeseriesGroupARCResponseEnvelope
- type EmailSecurityTimeseriesGroupARCResponseMeta
- type EmailSecurityTimeseriesGroupARCResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupARCResponseMetaDateRange
- type EmailSecurityTimeseriesGroupARCResponseMetaNormalization
- type EmailSecurityTimeseriesGroupARCResponseMetaUnit
- type EmailSecurityTimeseriesGroupDKIMParams
- type EmailSecurityTimeseriesGroupDKIMParamsARC
- type EmailSecurityTimeseriesGroupDKIMParamsAggInterval
- type EmailSecurityTimeseriesGroupDKIMParamsDMARC
- type EmailSecurityTimeseriesGroupDKIMParamsFormat
- type EmailSecurityTimeseriesGroupDKIMParamsSPF
- type EmailSecurityTimeseriesGroupDKIMParamsTLSVersion
- type EmailSecurityTimeseriesGroupDKIMResponse
- type EmailSecurityTimeseriesGroupDKIMResponseEnvelope
- type EmailSecurityTimeseriesGroupDKIMResponseMeta
- type EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupDKIMResponseMetaDateRange
- type EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization
- type EmailSecurityTimeseriesGroupDKIMResponseMetaUnit
- type EmailSecurityTimeseriesGroupDMARCParams
- type EmailSecurityTimeseriesGroupDMARCParamsARC
- type EmailSecurityTimeseriesGroupDMARCParamsAggInterval
- type EmailSecurityTimeseriesGroupDMARCParamsDKIM
- type EmailSecurityTimeseriesGroupDMARCParamsFormat
- type EmailSecurityTimeseriesGroupDMARCParamsSPF
- type EmailSecurityTimeseriesGroupDMARCParamsTLSVersion
- type EmailSecurityTimeseriesGroupDMARCResponse
- type EmailSecurityTimeseriesGroupDMARCResponseEnvelope
- type EmailSecurityTimeseriesGroupDMARCResponseMeta
- type EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupDMARCResponseMetaDateRange
- type EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization
- type EmailSecurityTimeseriesGroupDMARCResponseMetaUnit
- type EmailSecurityTimeseriesGroupMaliciousParams
- type EmailSecurityTimeseriesGroupMaliciousParamsARC
- type EmailSecurityTimeseriesGroupMaliciousParamsAggInterval
- type EmailSecurityTimeseriesGroupMaliciousParamsDKIM
- type EmailSecurityTimeseriesGroupMaliciousParamsDMARC
- type EmailSecurityTimeseriesGroupMaliciousParamsFormat
- type EmailSecurityTimeseriesGroupMaliciousParamsSPF
- type EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion
- type EmailSecurityTimeseriesGroupMaliciousResponse
- type EmailSecurityTimeseriesGroupMaliciousResponseEnvelope
- type EmailSecurityTimeseriesGroupMaliciousResponseMeta
- type EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupMaliciousResponseMetaDateRange
- type EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization
- type EmailSecurityTimeseriesGroupMaliciousResponseMetaUnit
- type EmailSecurityTimeseriesGroupMaliciousResponseSerie0
- type EmailSecurityTimeseriesGroupSPFParams
- type EmailSecurityTimeseriesGroupSPFParamsARC
- type EmailSecurityTimeseriesGroupSPFParamsAggInterval
- type EmailSecurityTimeseriesGroupSPFParamsDKIM
- type EmailSecurityTimeseriesGroupSPFParamsDMARC
- type EmailSecurityTimeseriesGroupSPFParamsFormat
- type EmailSecurityTimeseriesGroupSPFParamsTLSVersion
- type EmailSecurityTimeseriesGroupSPFResponse
- type EmailSecurityTimeseriesGroupSPFResponseEnvelope
- type EmailSecurityTimeseriesGroupSPFResponseMeta
- type EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupSPFResponseMetaDateRange
- type EmailSecurityTimeseriesGroupSPFResponseMetaNormalization
- type EmailSecurityTimeseriesGroupSPFResponseMetaUnit
- type EmailSecurityTimeseriesGroupService
- func (r *EmailSecurityTimeseriesGroupService) ARC(ctx context.Context, query EmailSecurityTimeseriesGroupARCParams, ...) (res *EmailSecurityTimeseriesGroupARCResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) DKIM(ctx context.Context, query EmailSecurityTimeseriesGroupDKIMParams, ...) (res *EmailSecurityTimeseriesGroupDKIMResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) DMARC(ctx context.Context, query EmailSecurityTimeseriesGroupDMARCParams, ...) (res *EmailSecurityTimeseriesGroupDMARCResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) Malicious(ctx context.Context, query EmailSecurityTimeseriesGroupMaliciousParams, ...) (res *EmailSecurityTimeseriesGroupMaliciousResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) SPF(ctx context.Context, query EmailSecurityTimeseriesGroupSPFParams, ...) (res *EmailSecurityTimeseriesGroupSPFResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) Spam(ctx context.Context, query EmailSecurityTimeseriesGroupSpamParams, ...) (res *EmailSecurityTimeseriesGroupSpamResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) Spoof(ctx context.Context, query EmailSecurityTimeseriesGroupSpoofParams, ...) (res *EmailSecurityTimeseriesGroupSpoofResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) TLSVersion(ctx context.Context, query EmailSecurityTimeseriesGroupTLSVersionParams, ...) (res *EmailSecurityTimeseriesGroupTLSVersionResponse, err error)
- func (r *EmailSecurityTimeseriesGroupService) ThreatCategory(ctx context.Context, query EmailSecurityTimeseriesGroupThreatCategoryParams, ...) (res *EmailSecurityTimeseriesGroupThreatCategoryResponse, err error)
- type EmailSecurityTimeseriesGroupSpamParams
- type EmailSecurityTimeseriesGroupSpamParamsARC
- type EmailSecurityTimeseriesGroupSpamParamsAggInterval
- type EmailSecurityTimeseriesGroupSpamParamsDKIM
- type EmailSecurityTimeseriesGroupSpamParamsDMARC
- type EmailSecurityTimeseriesGroupSpamParamsFormat
- type EmailSecurityTimeseriesGroupSpamParamsSPF
- type EmailSecurityTimeseriesGroupSpamParamsTLSVersion
- type EmailSecurityTimeseriesGroupSpamResponse
- type EmailSecurityTimeseriesGroupSpamResponseEnvelope
- type EmailSecurityTimeseriesGroupSpamResponseMeta
- type EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupSpamResponseMetaDateRange
- type EmailSecurityTimeseriesGroupSpamResponseMetaNormalization
- type EmailSecurityTimeseriesGroupSpamResponseMetaUnit
- type EmailSecurityTimeseriesGroupSpamResponseSerie0
- type EmailSecurityTimeseriesGroupSpoofParams
- type EmailSecurityTimeseriesGroupSpoofParamsARC
- type EmailSecurityTimeseriesGroupSpoofParamsAggInterval
- type EmailSecurityTimeseriesGroupSpoofParamsDKIM
- type EmailSecurityTimeseriesGroupSpoofParamsDMARC
- type EmailSecurityTimeseriesGroupSpoofParamsFormat
- type EmailSecurityTimeseriesGroupSpoofParamsSPF
- type EmailSecurityTimeseriesGroupSpoofParamsTLSVersion
- type EmailSecurityTimeseriesGroupSpoofResponse
- type EmailSecurityTimeseriesGroupSpoofResponseEnvelope
- type EmailSecurityTimeseriesGroupSpoofResponseMeta
- type EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupSpoofResponseMetaDateRange
- type EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization
- type EmailSecurityTimeseriesGroupSpoofResponseMetaUnit
- type EmailSecurityTimeseriesGroupSpoofResponseSerie0
- type EmailSecurityTimeseriesGroupTLSVersionParams
- type EmailSecurityTimeseriesGroupTLSVersionParamsARC
- type EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval
- type EmailSecurityTimeseriesGroupTLSVersionParamsDKIM
- type EmailSecurityTimeseriesGroupTLSVersionParamsDMARC
- type EmailSecurityTimeseriesGroupTLSVersionParamsFormat
- type EmailSecurityTimeseriesGroupTLSVersionParamsSPF
- type EmailSecurityTimeseriesGroupTLSVersionResponse
- type EmailSecurityTimeseriesGroupTLSVersionResponseEnvelope
- type EmailSecurityTimeseriesGroupTLSVersionResponseMeta
- type EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupTLSVersionResponseMetaDateRange
- type EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization
- type EmailSecurityTimeseriesGroupTLSVersionResponseMetaUnit
- type EmailSecurityTimeseriesGroupTLSVersionResponseSerie0
- type EmailSecurityTimeseriesGroupThreatCategoryParams
- type EmailSecurityTimeseriesGroupThreatCategoryParamsARC
- type EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval
- type EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM
- type EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC
- type EmailSecurityTimeseriesGroupThreatCategoryParamsFormat
- type EmailSecurityTimeseriesGroupThreatCategoryParamsSPF
- type EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion
- type EmailSecurityTimeseriesGroupThreatCategoryResponse
- type EmailSecurityTimeseriesGroupThreatCategoryResponseEnvelope
- type EmailSecurityTimeseriesGroupThreatCategoryResponseMeta
- type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval
- type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfo
- type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaDateRange
- type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization
- type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaUnit
- type EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0
- type EmailSecurityTopService
- type EmailSecurityTopTldGetParams
- type EmailSecurityTopTldGetParamsARC
- type EmailSecurityTopTldGetParamsDKIM
- type EmailSecurityTopTldGetParamsDMARC
- type EmailSecurityTopTldGetParamsFormat
- type EmailSecurityTopTldGetParamsSPF
- type EmailSecurityTopTldGetParamsTLSVersion
- type EmailSecurityTopTldGetParamsTldCategory
- type EmailSecurityTopTldGetResponse
- type EmailSecurityTopTldGetResponseEnvelope
- type EmailSecurityTopTldGetResponseMeta
- type EmailSecurityTopTldGetResponseMetaConfidenceInfo
- type EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTopTldGetResponseMetaDateRange
- type EmailSecurityTopTldGetResponseMetaNormalization
- type EmailSecurityTopTldGetResponseMetaUnit
- type EmailSecurityTopTldGetResponseTop0
- type EmailSecurityTopTldMaliciousGetParams
- type EmailSecurityTopTldMaliciousGetParamsARC
- type EmailSecurityTopTldMaliciousGetParamsDKIM
- type EmailSecurityTopTldMaliciousGetParamsDMARC
- type EmailSecurityTopTldMaliciousGetParamsFormat
- type EmailSecurityTopTldMaliciousGetParamsMalicious
- type EmailSecurityTopTldMaliciousGetParamsSPF
- type EmailSecurityTopTldMaliciousGetParamsTLSVersion
- type EmailSecurityTopTldMaliciousGetParamsTldCategory
- type EmailSecurityTopTldMaliciousGetResponse
- type EmailSecurityTopTldMaliciousGetResponseEnvelope
- type EmailSecurityTopTldMaliciousGetResponseMeta
- type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo
- type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTopTldMaliciousGetResponseMetaDateRange
- type EmailSecurityTopTldMaliciousGetResponseMetaNormalization
- type EmailSecurityTopTldMaliciousGetResponseMetaUnit
- type EmailSecurityTopTldMaliciousGetResponseTop0
- type EmailSecurityTopTldMaliciousService
- type EmailSecurityTopTldService
- type EmailSecurityTopTldSpamGetParams
- type EmailSecurityTopTldSpamGetParamsARC
- type EmailSecurityTopTldSpamGetParamsDKIM
- type EmailSecurityTopTldSpamGetParamsDMARC
- type EmailSecurityTopTldSpamGetParamsFormat
- type EmailSecurityTopTldSpamGetParamsSPF
- type EmailSecurityTopTldSpamGetParamsSpam
- type EmailSecurityTopTldSpamGetParamsTLSVersion
- type EmailSecurityTopTldSpamGetParamsTldCategory
- type EmailSecurityTopTldSpamGetResponse
- type EmailSecurityTopTldSpamGetResponseEnvelope
- type EmailSecurityTopTldSpamGetResponseMeta
- type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo
- type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTopTldSpamGetResponseMetaDateRange
- type EmailSecurityTopTldSpamGetResponseMetaNormalization
- type EmailSecurityTopTldSpamGetResponseMetaUnit
- type EmailSecurityTopTldSpamGetResponseTop0
- type EmailSecurityTopTldSpamService
- type EmailSecurityTopTldSpoofGetParams
- type EmailSecurityTopTldSpoofGetParamsARC
- type EmailSecurityTopTldSpoofGetParamsDKIM
- type EmailSecurityTopTldSpoofGetParamsDMARC
- type EmailSecurityTopTldSpoofGetParamsFormat
- type EmailSecurityTopTldSpoofGetParamsSPF
- type EmailSecurityTopTldSpoofGetParamsSpoof
- type EmailSecurityTopTldSpoofGetParamsTLSVersion
- type EmailSecurityTopTldSpoofGetParamsTldCategory
- type EmailSecurityTopTldSpoofGetResponse
- type EmailSecurityTopTldSpoofGetResponseEnvelope
- type EmailSecurityTopTldSpoofGetResponseMeta
- type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo
- type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation
- type EmailSecurityTopTldSpoofGetResponseMetaDateRange
- type EmailSecurityTopTldSpoofGetResponseMetaNormalization
- type EmailSecurityTopTldSpoofGetResponseMetaUnit
- type EmailSecurityTopTldSpoofGetResponseTop0
- type EmailSecurityTopTldSpoofService
- type EmailService
- type EntityASNGetParams
- type EntityASNGetParamsFormat
- type EntityASNGetResponse
- type EntityASNGetResponseASN
- type EntityASNGetResponseASNEstimatedUsers
- type EntityASNGetResponseASNEstimatedUsersLocation
- type EntityASNGetResponseASNRelated
- type EntityASNGetResponseEnvelope
- type EntityASNIPParams
- type EntityASNListParams
- type EntityASNListParamsFormat
- type EntityASNListParamsOrderBy
- type EntityASNListResponse
- type EntityASNListResponseASN
- type EntityASNListResponseEnvelope
- type EntityASNRelParams
- type EntityASNRelParamsFormat
- type EntityASNRelResponse
- type EntityASNRelResponseEnvelope
- type EntityASNRelResponseMeta
- type EntityASNRelResponseRel
- type EntityASNService
- func (r *EntityASNService) Get(ctx context.Context, asn int64, query EntityASNGetParams, ...) (res *EntityASNGetResponse, err error)
- func (r *EntityASNService) IP(ctx context.Context, query EntityASNIPParams, opts ...option.RequestOption) (res *EntityAsnipResponse, err error)
- func (r *EntityASNService) List(ctx context.Context, query EntityASNListParams, opts ...option.RequestOption) (res *EntityASNListResponse, err error)
- func (r *EntityASNService) Rel(ctx context.Context, asn int64, query EntityASNRelParams, ...) (res *EntityASNRelResponse, err error)
- type EntityAsnipParamsFormat
- type EntityAsnipResponse
- type EntityAsnipResponseASN
- type EntityAsnipResponseASNEstimatedUsers
- type EntityAsnipResponseASNEstimatedUsersLocation
- type EntityAsnipResponseASNRelated
- type EntityAsnipResponseEnvelope
- type EntityGetParams
- type EntityGetParamsFormat
- type EntityGetResponse
- type EntityGetResponseEnvelope
- type EntityGetResponseIP
- type EntityLocationGetParams
- type EntityLocationGetParamsFormat
- type EntityLocationGetResponse
- type EntityLocationGetResponseEnvelope
- type EntityLocationGetResponseLocation
- type EntityLocationListParams
- type EntityLocationListParamsFormat
- type EntityLocationListResponse
- type EntityLocationListResponseEnvelope
- type EntityLocationListResponseLocation
- type EntityLocationService
- type EntityService
- type Error
- type ErrorData
- type ErrorDataSource
- type HTTPAseBotClassGetParams
- type HTTPAseBotClassGetParamsBotClass
- type HTTPAseBotClassGetParamsBrowserFamily
- type HTTPAseBotClassGetParamsDeviceType
- type HTTPAseBotClassGetParamsFormat
- type HTTPAseBotClassGetParamsHTTPProtocol
- type HTTPAseBotClassGetParamsHTTPVersion
- type HTTPAseBotClassGetParamsIPVersion
- type HTTPAseBotClassGetParamsOS
- type HTTPAseBotClassGetParamsTLSVersion
- type HTTPAseBotClassGetResponse
- type HTTPAseBotClassGetResponseEnvelope
- type HTTPAseBotClassGetResponseMeta
- type HTTPAseBotClassGetResponseMetaConfidenceInfo
- type HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseBotClassGetResponseMetaDateRange
- type HTTPAseBotClassGetResponseMetaNormalization
- type HTTPAseBotClassGetResponseMetaUnit
- type HTTPAseBotClassGetResponseTop0
- type HTTPAseBotClassService
- type HTTPAseBrowserFamilyGetParams
- type HTTPAseBrowserFamilyGetParamsBotClass
- type HTTPAseBrowserFamilyGetParamsBrowserFamily
- type HTTPAseBrowserFamilyGetParamsDeviceType
- type HTTPAseBrowserFamilyGetParamsFormat
- type HTTPAseBrowserFamilyGetParamsHTTPProtocol
- type HTTPAseBrowserFamilyGetParamsHTTPVersion
- type HTTPAseBrowserFamilyGetParamsIPVersion
- type HTTPAseBrowserFamilyGetParamsOS
- type HTTPAseBrowserFamilyGetParamsTLSVersion
- type HTTPAseBrowserFamilyGetResponse
- type HTTPAseBrowserFamilyGetResponseEnvelope
- type HTTPAseBrowserFamilyGetResponseMeta
- type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo
- type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseBrowserFamilyGetResponseMetaDateRange
- type HTTPAseBrowserFamilyGetResponseMetaNormalization
- type HTTPAseBrowserFamilyGetResponseMetaUnit
- type HTTPAseBrowserFamilyGetResponseTop0
- type HTTPAseBrowserFamilyService
- type HTTPAseDeviceTypeGetParams
- type HTTPAseDeviceTypeGetParamsBotClass
- type HTTPAseDeviceTypeGetParamsBrowserFamily
- type HTTPAseDeviceTypeGetParamsDeviceType
- type HTTPAseDeviceTypeGetParamsFormat
- type HTTPAseDeviceTypeGetParamsHTTPProtocol
- type HTTPAseDeviceTypeGetParamsHTTPVersion
- type HTTPAseDeviceTypeGetParamsIPVersion
- type HTTPAseDeviceTypeGetParamsOS
- type HTTPAseDeviceTypeGetParamsTLSVersion
- type HTTPAseDeviceTypeGetResponse
- type HTTPAseDeviceTypeGetResponseEnvelope
- type HTTPAseDeviceTypeGetResponseMeta
- type HTTPAseDeviceTypeGetResponseMetaConfidenceInfo
- type HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseDeviceTypeGetResponseMetaDateRange
- type HTTPAseDeviceTypeGetResponseMetaNormalization
- type HTTPAseDeviceTypeGetResponseMetaUnit
- type HTTPAseDeviceTypeGetResponseTop0
- type HTTPAseDeviceTypeService
- type HTTPAseGetParams
- type HTTPAseGetParamsBotClass
- type HTTPAseGetParamsBrowserFamily
- type HTTPAseGetParamsDeviceType
- type HTTPAseGetParamsFormat
- type HTTPAseGetParamsHTTPProtocol
- type HTTPAseGetParamsHTTPVersion
- type HTTPAseGetParamsIPVersion
- type HTTPAseGetParamsOS
- type HTTPAseGetParamsTLSVersion
- type HTTPAseGetResponse
- type HTTPAseGetResponseEnvelope
- type HTTPAseGetResponseMeta
- type HTTPAseGetResponseMetaConfidenceInfo
- type HTTPAseGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseGetResponseMetaDateRange
- type HTTPAseGetResponseMetaNormalization
- type HTTPAseGetResponseMetaUnit
- type HTTPAseGetResponseTop0
- type HTTPAseHTTPMethodGetParams
- type HTTPAseHTTPMethodGetParamsBotClass
- type HTTPAseHTTPMethodGetParamsBrowserFamily
- type HTTPAseHTTPMethodGetParamsDeviceType
- type HTTPAseHTTPMethodGetParamsFormat
- type HTTPAseHTTPMethodGetParamsHTTPProtocol
- type HTTPAseHTTPMethodGetParamsHTTPVersion
- type HTTPAseHTTPMethodGetParamsIPVersion
- type HTTPAseHTTPMethodGetParamsOS
- type HTTPAseHTTPMethodGetParamsTLSVersion
- type HTTPAseHTTPMethodGetResponse
- type HTTPAseHTTPMethodGetResponseEnvelope
- type HTTPAseHTTPMethodGetResponseMeta
- type HTTPAseHTTPMethodGetResponseMetaConfidenceInfo
- type HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseHTTPMethodGetResponseMetaDateRange
- type HTTPAseHTTPMethodGetResponseMetaNormalization
- type HTTPAseHTTPMethodGetResponseMetaUnit
- type HTTPAseHTTPMethodGetResponseTop0
- type HTTPAseHTTPMethodService
- type HTTPAseHTTPProtocolGetParams
- type HTTPAseHTTPProtocolGetParamsBotClass
- type HTTPAseHTTPProtocolGetParamsBrowserFamily
- type HTTPAseHTTPProtocolGetParamsDeviceType
- type HTTPAseHTTPProtocolGetParamsFormat
- type HTTPAseHTTPProtocolGetParamsHTTPProtocol
- type HTTPAseHTTPProtocolGetParamsHTTPVersion
- type HTTPAseHTTPProtocolGetParamsIPVersion
- type HTTPAseHTTPProtocolGetParamsOS
- type HTTPAseHTTPProtocolGetParamsTLSVersion
- type HTTPAseHTTPProtocolGetResponse
- type HTTPAseHTTPProtocolGetResponseEnvelope
- type HTTPAseHTTPProtocolGetResponseMeta
- type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo
- type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseHTTPProtocolGetResponseMetaDateRange
- type HTTPAseHTTPProtocolGetResponseMetaNormalization
- type HTTPAseHTTPProtocolGetResponseMetaUnit
- type HTTPAseHTTPProtocolGetResponseTop0
- type HTTPAseHTTPProtocolService
- type HTTPAseIPVersionGetParams
- type HTTPAseIPVersionGetParamsBotClass
- type HTTPAseIPVersionGetParamsBrowserFamily
- type HTTPAseIPVersionGetParamsDeviceType
- type HTTPAseIPVersionGetParamsFormat
- type HTTPAseIPVersionGetParamsHTTPProtocol
- type HTTPAseIPVersionGetParamsHTTPVersion
- type HTTPAseIPVersionGetParamsIPVersion
- type HTTPAseIPVersionGetParamsOS
- type HTTPAseIPVersionGetParamsTLSVersion
- type HTTPAseIPVersionGetResponse
- type HTTPAseIPVersionGetResponseEnvelope
- type HTTPAseIPVersionGetResponseMeta
- type HTTPAseIPVersionGetResponseMetaConfidenceInfo
- type HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseIPVersionGetResponseMetaDateRange
- type HTTPAseIPVersionGetResponseMetaNormalization
- type HTTPAseIPVersionGetResponseMetaUnit
- type HTTPAseIPVersionGetResponseTop0
- type HTTPAseIPVersionService
- type HTTPAseOSGetParams
- type HTTPAseOSGetParamsBotClass
- type HTTPAseOSGetParamsBrowserFamily
- type HTTPAseOSGetParamsDeviceType
- type HTTPAseOSGetParamsFormat
- type HTTPAseOSGetParamsHTTPProtocol
- type HTTPAseOSGetParamsHTTPVersion
- type HTTPAseOSGetParamsIPVersion
- type HTTPAseOSGetParamsOS
- type HTTPAseOSGetParamsTLSVersion
- type HTTPAseOSGetResponse
- type HTTPAseOSGetResponseEnvelope
- type HTTPAseOSGetResponseMeta
- type HTTPAseOSGetResponseMetaConfidenceInfo
- type HTTPAseOSGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseOSGetResponseMetaDateRange
- type HTTPAseOSGetResponseMetaNormalization
- type HTTPAseOSGetResponseMetaUnit
- type HTTPAseOSGetResponseTop0
- type HTTPAseOSService
- type HTTPAseService
- type HTTPAseTLSVersionGetParams
- type HTTPAseTLSVersionGetParamsBotClass
- type HTTPAseTLSVersionGetParamsBrowserFamily
- type HTTPAseTLSVersionGetParamsDeviceType
- type HTTPAseTLSVersionGetParamsFormat
- type HTTPAseTLSVersionGetParamsHTTPProtocol
- type HTTPAseTLSVersionGetParamsHTTPVersion
- type HTTPAseTLSVersionGetParamsIPVersion
- type HTTPAseTLSVersionGetParamsOS
- type HTTPAseTLSVersionGetParamsTLSVersion
- type HTTPAseTLSVersionGetResponse
- type HTTPAseTLSVersionGetResponseEnvelope
- type HTTPAseTLSVersionGetResponseMeta
- type HTTPAseTLSVersionGetResponseMetaConfidenceInfo
- type HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation
- type HTTPAseTLSVersionGetResponseMetaDateRange
- type HTTPAseTLSVersionGetResponseMetaNormalization
- type HTTPAseTLSVersionGetResponseMetaUnit
- type HTTPAseTLSVersionGetResponseTop0
- type HTTPAseTLSVersionService
- type HTTPLocationBotClassGetParams
- type HTTPLocationBotClassGetParamsBotClass
- type HTTPLocationBotClassGetParamsBrowserFamily
- type HTTPLocationBotClassGetParamsDeviceType
- type HTTPLocationBotClassGetParamsFormat
- type HTTPLocationBotClassGetParamsHTTPProtocol
- type HTTPLocationBotClassGetParamsHTTPVersion
- type HTTPLocationBotClassGetParamsIPVersion
- type HTTPLocationBotClassGetParamsOS
- type HTTPLocationBotClassGetParamsTLSVersion
- type HTTPLocationBotClassGetResponse
- type HTTPLocationBotClassGetResponseEnvelope
- type HTTPLocationBotClassGetResponseMeta
- type HTTPLocationBotClassGetResponseMetaConfidenceInfo
- type HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationBotClassGetResponseMetaDateRange
- type HTTPLocationBotClassGetResponseMetaNormalization
- type HTTPLocationBotClassGetResponseMetaUnit
- type HTTPLocationBotClassGetResponseTop0
- type HTTPLocationBotClassService
- type HTTPLocationBrowserFamilyGetParams
- type HTTPLocationBrowserFamilyGetParamsBotClass
- type HTTPLocationBrowserFamilyGetParamsBrowserFamily
- type HTTPLocationBrowserFamilyGetParamsDeviceType
- type HTTPLocationBrowserFamilyGetParamsFormat
- type HTTPLocationBrowserFamilyGetParamsHTTPProtocol
- type HTTPLocationBrowserFamilyGetParamsHTTPVersion
- type HTTPLocationBrowserFamilyGetParamsIPVersion
- type HTTPLocationBrowserFamilyGetParamsOS
- type HTTPLocationBrowserFamilyGetParamsTLSVersion
- type HTTPLocationBrowserFamilyGetResponse
- type HTTPLocationBrowserFamilyGetResponseEnvelope
- type HTTPLocationBrowserFamilyGetResponseMeta
- type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo
- type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationBrowserFamilyGetResponseMetaDateRange
- type HTTPLocationBrowserFamilyGetResponseMetaNormalization
- type HTTPLocationBrowserFamilyGetResponseMetaUnit
- type HTTPLocationBrowserFamilyGetResponseTop0
- type HTTPLocationBrowserFamilyService
- type HTTPLocationDeviceTypeGetParams
- type HTTPLocationDeviceTypeGetParamsBotClass
- type HTTPLocationDeviceTypeGetParamsBrowserFamily
- type HTTPLocationDeviceTypeGetParamsDeviceType
- type HTTPLocationDeviceTypeGetParamsFormat
- type HTTPLocationDeviceTypeGetParamsHTTPProtocol
- type HTTPLocationDeviceTypeGetParamsHTTPVersion
- type HTTPLocationDeviceTypeGetParamsIPVersion
- type HTTPLocationDeviceTypeGetParamsOS
- type HTTPLocationDeviceTypeGetParamsTLSVersion
- type HTTPLocationDeviceTypeGetResponse
- type HTTPLocationDeviceTypeGetResponseEnvelope
- type HTTPLocationDeviceTypeGetResponseMeta
- type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo
- type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationDeviceTypeGetResponseMetaDateRange
- type HTTPLocationDeviceTypeGetResponseMetaNormalization
- type HTTPLocationDeviceTypeGetResponseMetaUnit
- type HTTPLocationDeviceTypeGetResponseTop0
- type HTTPLocationDeviceTypeService
- type HTTPLocationGetParams
- type HTTPLocationGetParamsBotClass
- type HTTPLocationGetParamsBrowserFamily
- type HTTPLocationGetParamsDeviceType
- type HTTPLocationGetParamsFormat
- type HTTPLocationGetParamsHTTPProtocol
- type HTTPLocationGetParamsHTTPVersion
- type HTTPLocationGetParamsIPVersion
- type HTTPLocationGetParamsOS
- type HTTPLocationGetParamsTLSVersion
- type HTTPLocationGetResponse
- type HTTPLocationGetResponseEnvelope
- type HTTPLocationGetResponseMeta
- type HTTPLocationGetResponseMetaConfidenceInfo
- type HTTPLocationGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationGetResponseMetaDateRange
- type HTTPLocationGetResponseMetaNormalization
- type HTTPLocationGetResponseMetaUnit
- type HTTPLocationGetResponseTop0
- type HTTPLocationHTTPMethodGetParams
- type HTTPLocationHTTPMethodGetParamsBotClass
- type HTTPLocationHTTPMethodGetParamsBrowserFamily
- type HTTPLocationHTTPMethodGetParamsDeviceType
- type HTTPLocationHTTPMethodGetParamsFormat
- type HTTPLocationHTTPMethodGetParamsHTTPProtocol
- type HTTPLocationHTTPMethodGetParamsHTTPVersion
- type HTTPLocationHTTPMethodGetParamsIPVersion
- type HTTPLocationHTTPMethodGetParamsOS
- type HTTPLocationHTTPMethodGetParamsTLSVersion
- type HTTPLocationHTTPMethodGetResponse
- type HTTPLocationHTTPMethodGetResponseEnvelope
- type HTTPLocationHTTPMethodGetResponseMeta
- type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo
- type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationHTTPMethodGetResponseMetaDateRange
- type HTTPLocationHTTPMethodGetResponseMetaNormalization
- type HTTPLocationHTTPMethodGetResponseMetaUnit
- type HTTPLocationHTTPMethodGetResponseTop0
- type HTTPLocationHTTPMethodService
- type HTTPLocationHTTPProtocolGetParams
- type HTTPLocationHTTPProtocolGetParamsBotClass
- type HTTPLocationHTTPProtocolGetParamsBrowserFamily
- type HTTPLocationHTTPProtocolGetParamsDeviceType
- type HTTPLocationHTTPProtocolGetParamsFormat
- type HTTPLocationHTTPProtocolGetParamsHTTPProtocol
- type HTTPLocationHTTPProtocolGetParamsHTTPVersion
- type HTTPLocationHTTPProtocolGetParamsIPVersion
- type HTTPLocationHTTPProtocolGetParamsOS
- type HTTPLocationHTTPProtocolGetParamsTLSVersion
- type HTTPLocationHTTPProtocolGetResponse
- type HTTPLocationHTTPProtocolGetResponseEnvelope
- type HTTPLocationHTTPProtocolGetResponseMeta
- type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo
- type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationHTTPProtocolGetResponseMetaDateRange
- type HTTPLocationHTTPProtocolGetResponseMetaNormalization
- type HTTPLocationHTTPProtocolGetResponseMetaUnit
- type HTTPLocationHTTPProtocolGetResponseTop0
- type HTTPLocationHTTPProtocolService
- type HTTPLocationIPVersionGetParams
- type HTTPLocationIPVersionGetParamsBotClass
- type HTTPLocationIPVersionGetParamsBrowserFamily
- type HTTPLocationIPVersionGetParamsDeviceType
- type HTTPLocationIPVersionGetParamsFormat
- type HTTPLocationIPVersionGetParamsHTTPProtocol
- type HTTPLocationIPVersionGetParamsHTTPVersion
- type HTTPLocationIPVersionGetParamsIPVersion
- type HTTPLocationIPVersionGetParamsOS
- type HTTPLocationIPVersionGetParamsTLSVersion
- type HTTPLocationIPVersionGetResponse
- type HTTPLocationIPVersionGetResponseEnvelope
- type HTTPLocationIPVersionGetResponseMeta
- type HTTPLocationIPVersionGetResponseMetaConfidenceInfo
- type HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationIPVersionGetResponseMetaDateRange
- type HTTPLocationIPVersionGetResponseMetaNormalization
- type HTTPLocationIPVersionGetResponseMetaUnit
- type HTTPLocationIPVersionGetResponseTop0
- type HTTPLocationIPVersionService
- type HTTPLocationOSGetParams
- type HTTPLocationOSGetParamsBotClass
- type HTTPLocationOSGetParamsBrowserFamily
- type HTTPLocationOSGetParamsDeviceType
- type HTTPLocationOSGetParamsFormat
- type HTTPLocationOSGetParamsHTTPProtocol
- type HTTPLocationOSGetParamsHTTPVersion
- type HTTPLocationOSGetParamsIPVersion
- type HTTPLocationOSGetParamsOS
- type HTTPLocationOSGetParamsTLSVersion
- type HTTPLocationOSGetResponse
- type HTTPLocationOSGetResponseEnvelope
- type HTTPLocationOSGetResponseMeta
- type HTTPLocationOSGetResponseMetaConfidenceInfo
- type HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationOSGetResponseMetaDateRange
- type HTTPLocationOSGetResponseMetaNormalization
- type HTTPLocationOSGetResponseMetaUnit
- type HTTPLocationOSGetResponseTop0
- type HTTPLocationOSService
- type HTTPLocationService
- type HTTPLocationTLSVersionGetParams
- type HTTPLocationTLSVersionGetParamsBotClass
- type HTTPLocationTLSVersionGetParamsBrowserFamily
- type HTTPLocationTLSVersionGetParamsDeviceType
- type HTTPLocationTLSVersionGetParamsFormat
- type HTTPLocationTLSVersionGetParamsHTTPProtocol
- type HTTPLocationTLSVersionGetParamsHTTPVersion
- type HTTPLocationTLSVersionGetParamsIPVersion
- type HTTPLocationTLSVersionGetParamsOS
- type HTTPLocationTLSVersionGetParamsTLSVersion
- type HTTPLocationTLSVersionGetResponse
- type HTTPLocationTLSVersionGetResponseEnvelope
- type HTTPLocationTLSVersionGetResponseMeta
- type HTTPLocationTLSVersionGetResponseMetaConfidenceInfo
- type HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation
- type HTTPLocationTLSVersionGetResponseMetaDateRange
- type HTTPLocationTLSVersionGetResponseMetaNormalization
- type HTTPLocationTLSVersionGetResponseMetaUnit
- type HTTPLocationTLSVersionGetResponseTop0
- type HTTPLocationTLSVersionService
- type HTTPService
- type HTTPSummaryBotClassParams
- type HTTPSummaryBotClassParamsBrowserFamily
- type HTTPSummaryBotClassParamsDeviceType
- type HTTPSummaryBotClassParamsFormat
- type HTTPSummaryBotClassParamsHTTPProtocol
- type HTTPSummaryBotClassParamsHTTPVersion
- type HTTPSummaryBotClassParamsIPVersion
- type HTTPSummaryBotClassParamsOS
- type HTTPSummaryBotClassParamsTLSVersion
- type HTTPSummaryBotClassResponse
- type HTTPSummaryBotClassResponseEnvelope
- type HTTPSummaryBotClassResponseMeta
- type HTTPSummaryBotClassResponseMetaConfidenceInfo
- type HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryBotClassResponseMetaDateRange
- type HTTPSummaryBotClassResponseMetaNormalization
- type HTTPSummaryBotClassResponseMetaUnit
- type HTTPSummaryBotClassResponseSummary0
- type HTTPSummaryDeviceTypeParams
- type HTTPSummaryDeviceTypeParamsBotClass
- type HTTPSummaryDeviceTypeParamsBrowserFamily
- type HTTPSummaryDeviceTypeParamsFormat
- type HTTPSummaryDeviceTypeParamsHTTPProtocol
- type HTTPSummaryDeviceTypeParamsHTTPVersion
- type HTTPSummaryDeviceTypeParamsIPVersion
- type HTTPSummaryDeviceTypeParamsOS
- type HTTPSummaryDeviceTypeParamsTLSVersion
- type HTTPSummaryDeviceTypeResponse
- type HTTPSummaryDeviceTypeResponseEnvelope
- type HTTPSummaryDeviceTypeResponseMeta
- type HTTPSummaryDeviceTypeResponseMetaConfidenceInfo
- type HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryDeviceTypeResponseMetaDateRange
- type HTTPSummaryDeviceTypeResponseMetaNormalization
- type HTTPSummaryDeviceTypeResponseMetaUnit
- type HTTPSummaryDeviceTypeResponseSummary0
- type HTTPSummaryHTTPProtocolParams
- type HTTPSummaryHTTPProtocolParamsBotClass
- type HTTPSummaryHTTPProtocolParamsBrowserFamily
- type HTTPSummaryHTTPProtocolParamsDeviceType
- type HTTPSummaryHTTPProtocolParamsFormat
- type HTTPSummaryHTTPProtocolParamsHTTPVersion
- type HTTPSummaryHTTPProtocolParamsIPVersion
- type HTTPSummaryHTTPProtocolParamsOS
- type HTTPSummaryHTTPProtocolParamsTLSVersion
- type HTTPSummaryHTTPProtocolResponse
- type HTTPSummaryHTTPProtocolResponseEnvelope
- type HTTPSummaryHTTPProtocolResponseMeta
- type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo
- type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryHTTPProtocolResponseMetaDateRange
- type HTTPSummaryHTTPProtocolResponseMetaNormalization
- type HTTPSummaryHTTPProtocolResponseMetaUnit
- type HTTPSummaryHTTPProtocolResponseSummary0
- type HTTPSummaryHTTPVersionParams
- type HTTPSummaryHTTPVersionParamsBotClass
- type HTTPSummaryHTTPVersionParamsBrowserFamily
- type HTTPSummaryHTTPVersionParamsDeviceType
- type HTTPSummaryHTTPVersionParamsFormat
- type HTTPSummaryHTTPVersionParamsHTTPProtocol
- type HTTPSummaryHTTPVersionParamsIPVersion
- type HTTPSummaryHTTPVersionParamsOS
- type HTTPSummaryHTTPVersionParamsTLSVersion
- type HTTPSummaryHTTPVersionResponse
- type HTTPSummaryHTTPVersionResponseEnvelope
- type HTTPSummaryHTTPVersionResponseMeta
- type HTTPSummaryHTTPVersionResponseMetaConfidenceInfo
- type HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryHTTPVersionResponseMetaDateRange
- type HTTPSummaryHTTPVersionResponseMetaNormalization
- type HTTPSummaryHTTPVersionResponseMetaUnit
- type HTTPSummaryHTTPVersionResponseSummary0
- type HTTPSummaryIPVersionParams
- type HTTPSummaryIPVersionParamsBotClass
- type HTTPSummaryIPVersionParamsBrowserFamily
- type HTTPSummaryIPVersionParamsDeviceType
- type HTTPSummaryIPVersionParamsFormat
- type HTTPSummaryIPVersionParamsHTTPProtocol
- type HTTPSummaryIPVersionParamsHTTPVersion
- type HTTPSummaryIPVersionParamsOS
- type HTTPSummaryIPVersionParamsTLSVersion
- type HTTPSummaryIPVersionResponse
- type HTTPSummaryIPVersionResponseEnvelope
- type HTTPSummaryIPVersionResponseMeta
- type HTTPSummaryIPVersionResponseMetaConfidenceInfo
- type HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryIPVersionResponseMetaDateRange
- type HTTPSummaryIPVersionResponseMetaNormalization
- type HTTPSummaryIPVersionResponseMetaUnit
- type HTTPSummaryIPVersionResponseSummary0
- type HTTPSummaryOSParams
- type HTTPSummaryOSParamsBotClass
- type HTTPSummaryOSParamsBrowserFamily
- type HTTPSummaryOSParamsDeviceType
- type HTTPSummaryOSParamsFormat
- type HTTPSummaryOSParamsHTTPProtocol
- type HTTPSummaryOSParamsHTTPVersion
- type HTTPSummaryOSParamsIPVersion
- type HTTPSummaryOSParamsTLSVersion
- type HTTPSummaryOSResponse
- type HTTPSummaryOSResponseEnvelope
- type HTTPSummaryOSResponseMeta
- type HTTPSummaryOSResponseMetaConfidenceInfo
- type HTTPSummaryOSResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryOSResponseMetaDateRange
- type HTTPSummaryOSResponseMetaNormalization
- type HTTPSummaryOSResponseMetaUnit
- type HTTPSummaryOSResponseSummary0
- type HTTPSummaryPostQuantumParams
- type HTTPSummaryPostQuantumParamsBotClass
- type HTTPSummaryPostQuantumParamsBrowserFamily
- type HTTPSummaryPostQuantumParamsDeviceType
- type HTTPSummaryPostQuantumParamsFormat
- type HTTPSummaryPostQuantumParamsHTTPProtocol
- type HTTPSummaryPostQuantumParamsHTTPVersion
- type HTTPSummaryPostQuantumParamsIPVersion
- type HTTPSummaryPostQuantumParamsOS
- type HTTPSummaryPostQuantumParamsTLSVersion
- type HTTPSummaryPostQuantumResponse
- type HTTPSummaryPostQuantumResponseEnvelope
- type HTTPSummaryPostQuantumResponseMeta
- type HTTPSummaryPostQuantumResponseMetaConfidenceInfo
- type HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryPostQuantumResponseMetaDateRange
- type HTTPSummaryPostQuantumResponseMetaNormalization
- type HTTPSummaryPostQuantumResponseMetaUnit
- type HTTPSummaryPostQuantumResponseSummary0
- type HTTPSummaryService
- func (r *HTTPSummaryService) BotClass(ctx context.Context, query HTTPSummaryBotClassParams, ...) (res *HTTPSummaryBotClassResponse, err error)
- func (r *HTTPSummaryService) DeviceType(ctx context.Context, query HTTPSummaryDeviceTypeParams, ...) (res *HTTPSummaryDeviceTypeResponse, err error)
- func (r *HTTPSummaryService) HTTPProtocol(ctx context.Context, query HTTPSummaryHTTPProtocolParams, ...) (res *HTTPSummaryHTTPProtocolResponse, err error)
- func (r *HTTPSummaryService) HTTPVersion(ctx context.Context, query HTTPSummaryHTTPVersionParams, ...) (res *HTTPSummaryHTTPVersionResponse, err error)
- func (r *HTTPSummaryService) IPVersion(ctx context.Context, query HTTPSummaryIPVersionParams, ...) (res *HTTPSummaryIPVersionResponse, err error)
- func (r *HTTPSummaryService) OS(ctx context.Context, query HTTPSummaryOSParams, opts ...option.RequestOption) (res *HTTPSummaryOSResponse, err error)
- func (r *HTTPSummaryService) PostQuantum(ctx context.Context, query HTTPSummaryPostQuantumParams, ...) (res *HTTPSummaryPostQuantumResponse, err error)
- func (r *HTTPSummaryService) TLSVersion(ctx context.Context, query HTTPSummaryTLSVersionParams, ...) (res *HTTPSummaryTLSVersionResponse, err error)
- type HTTPSummaryTLSVersionParams
- type HTTPSummaryTLSVersionParamsBotClass
- type HTTPSummaryTLSVersionParamsBrowserFamily
- type HTTPSummaryTLSVersionParamsDeviceType
- type HTTPSummaryTLSVersionParamsFormat
- type HTTPSummaryTLSVersionParamsHTTPProtocol
- type HTTPSummaryTLSVersionParamsHTTPVersion
- type HTTPSummaryTLSVersionParamsIPVersion
- type HTTPSummaryTLSVersionParamsOS
- type HTTPSummaryTLSVersionResponse
- type HTTPSummaryTLSVersionResponseEnvelope
- type HTTPSummaryTLSVersionResponseMeta
- type HTTPSummaryTLSVersionResponseMetaConfidenceInfo
- type HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation
- type HTTPSummaryTLSVersionResponseMetaDateRange
- type HTTPSummaryTLSVersionResponseMetaNormalization
- type HTTPSummaryTLSVersionResponseMetaUnit
- type HTTPSummaryTLSVersionResponseSummary0
- type HTTPTimeseriesGroupBotClassParams
- type HTTPTimeseriesGroupBotClassParamsAggInterval
- type HTTPTimeseriesGroupBotClassParamsBrowserFamily
- type HTTPTimeseriesGroupBotClassParamsDeviceType
- type HTTPTimeseriesGroupBotClassParamsFormat
- type HTTPTimeseriesGroupBotClassParamsHTTPProtocol
- type HTTPTimeseriesGroupBotClassParamsHTTPVersion
- type HTTPTimeseriesGroupBotClassParamsIPVersion
- type HTTPTimeseriesGroupBotClassParamsOS
- type HTTPTimeseriesGroupBotClassParamsTLSVersion
- type HTTPTimeseriesGroupBotClassResponse
- type HTTPTimeseriesGroupBotClassResponseEnvelope
- type HTTPTimeseriesGroupBotClassResponseMeta
- type HTTPTimeseriesGroupBotClassResponseMetaAggInterval
- type HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupBotClassResponseMetaDateRange
- type HTTPTimeseriesGroupBotClassResponseMetaNormalization
- type HTTPTimeseriesGroupBotClassResponseMetaUnit
- type HTTPTimeseriesGroupBotClassResponseSerie0
- type HTTPTimeseriesGroupBrowserFamilyParams
- type HTTPTimeseriesGroupBrowserFamilyParamsAggInterval
- type HTTPTimeseriesGroupBrowserFamilyParamsBotClass
- type HTTPTimeseriesGroupBrowserFamilyParamsDeviceType
- type HTTPTimeseriesGroupBrowserFamilyParamsFormat
- type HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol
- type HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion
- type HTTPTimeseriesGroupBrowserFamilyParamsIPVersion
- type HTTPTimeseriesGroupBrowserFamilyParamsOS
- type HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion
- type HTTPTimeseriesGroupBrowserFamilyResponse
- type HTTPTimeseriesGroupBrowserFamilyResponseEnvelope
- type HTTPTimeseriesGroupBrowserFamilyResponseMeta
- type HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval
- type HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupBrowserFamilyResponseMetaDateRange
- type HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization
- type HTTPTimeseriesGroupBrowserFamilyResponseMetaUnit
- type HTTPTimeseriesGroupBrowserFamilyResponseSerie0
- type HTTPTimeseriesGroupBrowserParams
- type HTTPTimeseriesGroupBrowserParamsAggInterval
- type HTTPTimeseriesGroupBrowserParamsBotClass
- type HTTPTimeseriesGroupBrowserParamsBrowserFamily
- type HTTPTimeseriesGroupBrowserParamsDeviceType
- type HTTPTimeseriesGroupBrowserParamsFormat
- type HTTPTimeseriesGroupBrowserParamsHTTPProtocol
- type HTTPTimeseriesGroupBrowserParamsHTTPVersion
- type HTTPTimeseriesGroupBrowserParamsIPVersion
- type HTTPTimeseriesGroupBrowserParamsOS
- type HTTPTimeseriesGroupBrowserParamsTLSVersion
- type HTTPTimeseriesGroupBrowserResponse
- type HTTPTimeseriesGroupBrowserResponseEnvelope
- type HTTPTimeseriesGroupBrowserResponseMeta
- type HTTPTimeseriesGroupBrowserResponseMetaAggInterval
- type HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupBrowserResponseMetaDateRange
- type HTTPTimeseriesGroupBrowserResponseMetaNormalization
- type HTTPTimeseriesGroupBrowserResponseMetaUnit
- type HTTPTimeseriesGroupBrowserResponseSerie0
- type HTTPTimeseriesGroupDeviceTypeParams
- type HTTPTimeseriesGroupDeviceTypeParamsAggInterval
- type HTTPTimeseriesGroupDeviceTypeParamsBotClass
- type HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily
- type HTTPTimeseriesGroupDeviceTypeParamsFormat
- type HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol
- type HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion
- type HTTPTimeseriesGroupDeviceTypeParamsIPVersion
- type HTTPTimeseriesGroupDeviceTypeParamsOS
- type HTTPTimeseriesGroupDeviceTypeParamsTLSVersion
- type HTTPTimeseriesGroupDeviceTypeResponse
- type HTTPTimeseriesGroupDeviceTypeResponseEnvelope
- type HTTPTimeseriesGroupDeviceTypeResponseMeta
- type HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval
- type HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupDeviceTypeResponseMetaDateRange
- type HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization
- type HTTPTimeseriesGroupDeviceTypeResponseMetaUnit
- type HTTPTimeseriesGroupDeviceTypeResponseSerie0
- type HTTPTimeseriesGroupHTTPProtocolParams
- type HTTPTimeseriesGroupHTTPProtocolParamsAggInterval
- type HTTPTimeseriesGroupHTTPProtocolParamsBotClass
- type HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily
- type HTTPTimeseriesGroupHTTPProtocolParamsDeviceType
- type HTTPTimeseriesGroupHTTPProtocolParamsFormat
- type HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion
- type HTTPTimeseriesGroupHTTPProtocolParamsIPVersion
- type HTTPTimeseriesGroupHTTPProtocolParamsOS
- type HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion
- type HTTPTimeseriesGroupHTTPProtocolResponse
- type HTTPTimeseriesGroupHTTPProtocolResponseEnvelope
- type HTTPTimeseriesGroupHTTPProtocolResponseMeta
- type HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval
- type HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupHTTPProtocolResponseMetaDateRange
- type HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization
- type HTTPTimeseriesGroupHTTPProtocolResponseMetaUnit
- type HTTPTimeseriesGroupHTTPProtocolResponseSerie0
- type HTTPTimeseriesGroupHTTPVersionParams
- type HTTPTimeseriesGroupHTTPVersionParamsAggInterval
- type HTTPTimeseriesGroupHTTPVersionParamsBotClass
- type HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily
- type HTTPTimeseriesGroupHTTPVersionParamsDeviceType
- type HTTPTimeseriesGroupHTTPVersionParamsFormat
- type HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol
- type HTTPTimeseriesGroupHTTPVersionParamsIPVersion
- type HTTPTimeseriesGroupHTTPVersionParamsOS
- type HTTPTimeseriesGroupHTTPVersionParamsTLSVersion
- type HTTPTimeseriesGroupHTTPVersionResponse
- type HTTPTimeseriesGroupHTTPVersionResponseEnvelope
- type HTTPTimeseriesGroupHTTPVersionResponseMeta
- type HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval
- type HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupHTTPVersionResponseMetaDateRange
- type HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization
- type HTTPTimeseriesGroupHTTPVersionResponseMetaUnit
- type HTTPTimeseriesGroupHTTPVersionResponseSerie0
- type HTTPTimeseriesGroupIPVersionParams
- type HTTPTimeseriesGroupIPVersionParamsAggInterval
- type HTTPTimeseriesGroupIPVersionParamsBotClass
- type HTTPTimeseriesGroupIPVersionParamsBrowserFamily
- type HTTPTimeseriesGroupIPVersionParamsDeviceType
- type HTTPTimeseriesGroupIPVersionParamsFormat
- type HTTPTimeseriesGroupIPVersionParamsHTTPProtocol
- type HTTPTimeseriesGroupIPVersionParamsHTTPVersion
- type HTTPTimeseriesGroupIPVersionParamsOS
- type HTTPTimeseriesGroupIPVersionParamsTLSVersion
- type HTTPTimeseriesGroupIPVersionResponse
- type HTTPTimeseriesGroupIPVersionResponseEnvelope
- type HTTPTimeseriesGroupIPVersionResponseMeta
- type HTTPTimeseriesGroupIPVersionResponseMetaAggInterval
- type HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupIPVersionResponseMetaDateRange
- type HTTPTimeseriesGroupIPVersionResponseMetaNormalization
- type HTTPTimeseriesGroupIPVersionResponseMetaUnit
- type HTTPTimeseriesGroupIPVersionResponseSerie0
- type HTTPTimeseriesGroupOSParams
- type HTTPTimeseriesGroupOSParamsAggInterval
- type HTTPTimeseriesGroupOSParamsBotClass
- type HTTPTimeseriesGroupOSParamsBrowserFamily
- type HTTPTimeseriesGroupOSParamsDeviceType
- type HTTPTimeseriesGroupOSParamsFormat
- type HTTPTimeseriesGroupOSParamsHTTPProtocol
- type HTTPTimeseriesGroupOSParamsHTTPVersion
- type HTTPTimeseriesGroupOSParamsIPVersion
- type HTTPTimeseriesGroupOSParamsTLSVersion
- type HTTPTimeseriesGroupOSResponse
- type HTTPTimeseriesGroupOSResponseEnvelope
- type HTTPTimeseriesGroupOSResponseMeta
- type HTTPTimeseriesGroupOSResponseMetaAggInterval
- type HTTPTimeseriesGroupOSResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupOSResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupOSResponseMetaDateRange
- type HTTPTimeseriesGroupOSResponseMetaNormalization
- type HTTPTimeseriesGroupOSResponseMetaUnit
- type HTTPTimeseriesGroupOSResponseSerie0
- type HTTPTimeseriesGroupPostQuantumParams
- type HTTPTimeseriesGroupPostQuantumParamsAggInterval
- type HTTPTimeseriesGroupPostQuantumParamsBotClass
- type HTTPTimeseriesGroupPostQuantumParamsBrowserFamily
- type HTTPTimeseriesGroupPostQuantumParamsDeviceType
- type HTTPTimeseriesGroupPostQuantumParamsFormat
- type HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol
- type HTTPTimeseriesGroupPostQuantumParamsHTTPVersion
- type HTTPTimeseriesGroupPostQuantumParamsIPVersion
- type HTTPTimeseriesGroupPostQuantumParamsOS
- type HTTPTimeseriesGroupPostQuantumParamsTLSVersion
- type HTTPTimeseriesGroupPostQuantumResponse
- type HTTPTimeseriesGroupPostQuantumResponseEnvelope
- type HTTPTimeseriesGroupPostQuantumResponseMeta
- type HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval
- type HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupPostQuantumResponseMetaDateRange
- type HTTPTimeseriesGroupPostQuantumResponseMetaNormalization
- type HTTPTimeseriesGroupPostQuantumResponseMetaUnit
- type HTTPTimeseriesGroupPostQuantumResponseSerie0
- type HTTPTimeseriesGroupService
- func (r *HTTPTimeseriesGroupService) BotClass(ctx context.Context, query HTTPTimeseriesGroupBotClassParams, ...) (res *HTTPTimeseriesGroupBotClassResponse, err error)
- func (r *HTTPTimeseriesGroupService) Browser(ctx context.Context, query HTTPTimeseriesGroupBrowserParams, ...) (res *HTTPTimeseriesGroupBrowserResponse, err error)
- func (r *HTTPTimeseriesGroupService) BrowserFamily(ctx context.Context, query HTTPTimeseriesGroupBrowserFamilyParams, ...) (res *HTTPTimeseriesGroupBrowserFamilyResponse, err error)
- func (r *HTTPTimeseriesGroupService) DeviceType(ctx context.Context, query HTTPTimeseriesGroupDeviceTypeParams, ...) (res *HTTPTimeseriesGroupDeviceTypeResponse, err error)
- func (r *HTTPTimeseriesGroupService) HTTPProtocol(ctx context.Context, query HTTPTimeseriesGroupHTTPProtocolParams, ...) (res *HTTPTimeseriesGroupHTTPProtocolResponse, err error)
- func (r *HTTPTimeseriesGroupService) HTTPVersion(ctx context.Context, query HTTPTimeseriesGroupHTTPVersionParams, ...) (res *HTTPTimeseriesGroupHTTPVersionResponse, err error)
- func (r *HTTPTimeseriesGroupService) IPVersion(ctx context.Context, query HTTPTimeseriesGroupIPVersionParams, ...) (res *HTTPTimeseriesGroupIPVersionResponse, err error)
- func (r *HTTPTimeseriesGroupService) OS(ctx context.Context, query HTTPTimeseriesGroupOSParams, ...) (res *HTTPTimeseriesGroupOSResponse, err error)
- func (r *HTTPTimeseriesGroupService) PostQuantum(ctx context.Context, query HTTPTimeseriesGroupPostQuantumParams, ...) (res *HTTPTimeseriesGroupPostQuantumResponse, err error)
- func (r *HTTPTimeseriesGroupService) TLSVersion(ctx context.Context, query HTTPTimeseriesGroupTLSVersionParams, ...) (res *HTTPTimeseriesGroupTLSVersionResponse, err error)
- type HTTPTimeseriesGroupTLSVersionParams
- type HTTPTimeseriesGroupTLSVersionParamsAggInterval
- type HTTPTimeseriesGroupTLSVersionParamsBotClass
- type HTTPTimeseriesGroupTLSVersionParamsBrowserFamily
- type HTTPTimeseriesGroupTLSVersionParamsDeviceType
- type HTTPTimeseriesGroupTLSVersionParamsFormat
- type HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol
- type HTTPTimeseriesGroupTLSVersionParamsHTTPVersion
- type HTTPTimeseriesGroupTLSVersionParamsIPVersion
- type HTTPTimeseriesGroupTLSVersionParamsOS
- type HTTPTimeseriesGroupTLSVersionResponse
- type HTTPTimeseriesGroupTLSVersionResponseEnvelope
- type HTTPTimeseriesGroupTLSVersionResponseMeta
- type HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval
- type HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfo
- type HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesGroupTLSVersionResponseMetaDateRange
- type HTTPTimeseriesGroupTLSVersionResponseMetaNormalization
- type HTTPTimeseriesGroupTLSVersionResponseMetaUnit
- type HTTPTimeseriesGroupTLSVersionResponseSerie0
- type HTTPTimeseriesParams
- type HTTPTimeseriesParamsAggInterval
- type HTTPTimeseriesParamsBotClass
- type HTTPTimeseriesParamsBrowserFamily
- type HTTPTimeseriesParamsDeviceType
- type HTTPTimeseriesParamsFormat
- type HTTPTimeseriesParamsHTTPProtocol
- type HTTPTimeseriesParamsHTTPVersion
- type HTTPTimeseriesParamsIPVersion
- type HTTPTimeseriesParamsNormalization
- type HTTPTimeseriesParamsOS
- type HTTPTimeseriesParamsTLSVersion
- type HTTPTimeseriesResponse
- type HTTPTimeseriesResponseEnvelope
- type HTTPTimeseriesResponseMeta
- type HTTPTimeseriesResponseMetaAggInterval
- type HTTPTimeseriesResponseMetaConfidenceInfo
- type HTTPTimeseriesResponseMetaConfidenceInfoAnnotation
- type HTTPTimeseriesResponseMetaDateRange
- type HTTPTimeseriesResponseMetaNormalization
- type HTTPTimeseriesResponseMetaUnit
- type HTTPTopBrowserFamilyParams
- type HTTPTopBrowserFamilyParamsBotClass
- type HTTPTopBrowserFamilyParamsDeviceType
- type HTTPTopBrowserFamilyParamsFormat
- type HTTPTopBrowserFamilyParamsHTTPProtocol
- type HTTPTopBrowserFamilyParamsHTTPVersion
- type HTTPTopBrowserFamilyParamsIPVersion
- type HTTPTopBrowserFamilyParamsOS
- type HTTPTopBrowserFamilyParamsTLSVersion
- type HTTPTopBrowserFamilyResponse
- type HTTPTopBrowserFamilyResponseEnvelope
- type HTTPTopBrowserFamilyResponseMeta
- type HTTPTopBrowserFamilyResponseMetaConfidenceInfo
- type HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation
- type HTTPTopBrowserFamilyResponseMetaDateRange
- type HTTPTopBrowserFamilyResponseMetaNormalization
- type HTTPTopBrowserFamilyResponseMetaUnit
- type HTTPTopBrowserFamilyResponseTop0
- type HTTPTopBrowserParams
- type HTTPTopBrowserParamsBotClass
- type HTTPTopBrowserParamsBrowserFamily
- type HTTPTopBrowserParamsDeviceType
- type HTTPTopBrowserParamsFormat
- type HTTPTopBrowserParamsHTTPProtocol
- type HTTPTopBrowserParamsHTTPVersion
- type HTTPTopBrowserParamsIPVersion
- type HTTPTopBrowserParamsOS
- type HTTPTopBrowserParamsTLSVersion
- type HTTPTopBrowserResponse
- type HTTPTopBrowserResponseEnvelope
- type HTTPTopBrowserResponseMeta
- type HTTPTopBrowserResponseMetaConfidenceInfo
- type HTTPTopBrowserResponseMetaConfidenceInfoAnnotation
- type HTTPTopBrowserResponseMetaDateRange
- type HTTPTopBrowserResponseMetaNormalization
- type HTTPTopBrowserResponseMetaUnit
- type HTTPTopBrowserResponseTop0
- type HTTPTopService
- type LeakedCredentialService
- type LeakedCredentialSummaryBotClassParams
- type LeakedCredentialSummaryBotClassParamsCompromised
- type LeakedCredentialSummaryBotClassParamsFormat
- type LeakedCredentialSummaryBotClassResponse
- type LeakedCredentialSummaryBotClassResponseEnvelope
- type LeakedCredentialSummaryBotClassResponseMeta
- type LeakedCredentialSummaryBotClassResponseMetaConfidenceInfo
- type LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotation
- type LeakedCredentialSummaryBotClassResponseMetaDateRange
- type LeakedCredentialSummaryBotClassResponseMetaNormalization
- type LeakedCredentialSummaryBotClassResponseMetaUnit
- type LeakedCredentialSummaryBotClassResponseSummary0
- type LeakedCredentialSummaryCompromisedParams
- type LeakedCredentialSummaryCompromisedParamsBotClass
- type LeakedCredentialSummaryCompromisedParamsFormat
- type LeakedCredentialSummaryCompromisedResponse
- type LeakedCredentialSummaryCompromisedResponseEnvelope
- type LeakedCredentialSummaryCompromisedResponseMeta
- type LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfo
- type LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotation
- type LeakedCredentialSummaryCompromisedResponseMetaDateRange
- type LeakedCredentialSummaryCompromisedResponseMetaNormalization
- type LeakedCredentialSummaryCompromisedResponseMetaUnit
- type LeakedCredentialSummaryCompromisedResponseSummary0
- type LeakedCredentialSummaryService
- func (r *LeakedCredentialSummaryService) BotClass(ctx context.Context, query LeakedCredentialSummaryBotClassParams, ...) (res *LeakedCredentialSummaryBotClassResponse, err error)
- func (r *LeakedCredentialSummaryService) Compromised(ctx context.Context, query LeakedCredentialSummaryCompromisedParams, ...) (res *LeakedCredentialSummaryCompromisedResponse, err error)
- type LeakedCredentialTimeseriesGroupBotClassParams
- type LeakedCredentialTimeseriesGroupBotClassParamsAggInterval
- type LeakedCredentialTimeseriesGroupBotClassParamsCompromised
- type LeakedCredentialTimeseriesGroupBotClassParamsFormat
- type LeakedCredentialTimeseriesGroupBotClassResponse
- type LeakedCredentialTimeseriesGroupBotClassResponseEnvelope
- type LeakedCredentialTimeseriesGroupBotClassResponseMeta
- type LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval
- type LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfo
- type LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation
- type LeakedCredentialTimeseriesGroupBotClassResponseMetaDateRange
- type LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization
- type LeakedCredentialTimeseriesGroupBotClassResponseMetaUnit
- type LeakedCredentialTimeseriesGroupBotClassResponseSerie0
- type LeakedCredentialTimeseriesGroupCompromisedParams
- type LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval
- type LeakedCredentialTimeseriesGroupCompromisedParamsBotClass
- type LeakedCredentialTimeseriesGroupCompromisedParamsFormat
- type LeakedCredentialTimeseriesGroupCompromisedResponse
- type LeakedCredentialTimeseriesGroupCompromisedResponseEnvelope
- type LeakedCredentialTimeseriesGroupCompromisedResponseMeta
- type LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval
- type LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfo
- type LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotation
- type LeakedCredentialTimeseriesGroupCompromisedResponseMetaDateRange
- type LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization
- type LeakedCredentialTimeseriesGroupCompromisedResponseMetaUnit
- type LeakedCredentialTimeseriesGroupCompromisedResponseSerie0
- type LeakedCredentialTimeseriesGroupService
- func (r *LeakedCredentialTimeseriesGroupService) BotClass(ctx context.Context, query LeakedCredentialTimeseriesGroupBotClassParams, ...) (res *LeakedCredentialTimeseriesGroupBotClassResponse, err error)
- func (r *LeakedCredentialTimeseriesGroupService) Compromised(ctx context.Context, query LeakedCredentialTimeseriesGroupCompromisedParams, ...) (res *LeakedCredentialTimeseriesGroupCompromisedResponse, err error)
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type NetflowService
- type NetflowSummaryParams
- type NetflowSummaryParamsFormat
- type NetflowSummaryResponse
- type NetflowSummaryResponseEnvelope
- type NetflowSummaryResponseMeta
- type NetflowSummaryResponseMetaConfidenceInfo
- type NetflowSummaryResponseMetaConfidenceInfoAnnotation
- type NetflowSummaryResponseMetaDateRange
- type NetflowSummaryResponseMetaNormalization
- type NetflowSummaryResponseMetaUnit
- type NetflowSummaryResponseSummary0
- type NetflowTimeseriesParams
- type NetflowTimeseriesParamsAggInterval
- type NetflowTimeseriesParamsFormat
- type NetflowTimeseriesParamsNormalization
- type NetflowTimeseriesParamsProduct
- type NetflowTimeseriesResponse
- type NetflowTimeseriesResponseEnvelope
- type NetflowTimeseriesResponseMeta
- type NetflowTimeseriesResponseMetaAggInterval
- type NetflowTimeseriesResponseMetaConfidenceInfo
- type NetflowTimeseriesResponseMetaConfidenceInfoAnnotation
- type NetflowTimeseriesResponseMetaDateRange
- type NetflowTimeseriesResponseMetaNormalization
- type NetflowTimeseriesResponseMetaUnit
- type NetflowTimeseriesResponseSerie0
- type NetflowTopAsesParams
- type NetflowTopAsesParamsFormat
- type NetflowTopAsesResponse
- type NetflowTopAsesResponseEnvelope
- type NetflowTopAsesResponseMeta
- type NetflowTopAsesResponseMetaConfidenceInfo
- type NetflowTopAsesResponseMetaConfidenceInfoAnnotation
- type NetflowTopAsesResponseMetaDateRange
- type NetflowTopAsesResponseMetaNormalization
- type NetflowTopAsesResponseMetaUnit
- type NetflowTopAsesResponseTop0
- type NetflowTopLocationsParams
- type NetflowTopLocationsParamsFormat
- type NetflowTopLocationsResponse
- type NetflowTopLocationsResponseEnvelope
- type NetflowTopLocationsResponseMeta
- type NetflowTopLocationsResponseMetaConfidenceInfo
- type NetflowTopLocationsResponseMetaConfidenceInfoAnnotation
- type NetflowTopLocationsResponseMetaDateRange
- type NetflowTopLocationsResponseMetaNormalization
- type NetflowTopLocationsResponseMetaUnit
- type NetflowTopLocationsResponseTop0
- type NetflowTopService
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type QualityIQIService
- func (r *QualityIQIService) Summary(ctx context.Context, query QualityIQISummaryParams, ...) (res *QualityIQISummaryResponse, err error)
- func (r *QualityIQIService) TimeseriesGroups(ctx context.Context, query QualityIQITimeseriesGroupsParams, ...) (res *QualityIQITimeseriesGroupsResponse, err error)
- type QualityIQISummaryParams
- type QualityIQISummaryParamsFormat
- type QualityIQISummaryParamsMetric
- type QualityIQISummaryResponse
- type QualityIQISummaryResponseEnvelope
- type QualityIQISummaryResponseMeta
- type QualityIQISummaryResponseMetaConfidenceInfo
- type QualityIQISummaryResponseMetaConfidenceInfoAnnotation
- type QualityIQISummaryResponseMetaDateRange
- type QualityIQISummaryResponseMetaNormalization
- type QualityIQISummaryResponseMetaUnit
- type QualityIQISummaryResponseSummary0
- type QualityIQITimeseriesGroupsParams
- type QualityIQITimeseriesGroupsParamsAggInterval
- type QualityIQITimeseriesGroupsParamsFormat
- type QualityIQITimeseriesGroupsParamsMetric
- type QualityIQITimeseriesGroupsResponse
- type QualityIQITimeseriesGroupsResponseEnvelope
- type QualityIQITimeseriesGroupsResponseMeta
- type QualityIQITimeseriesGroupsResponseMetaAggInterval
- type QualityIQITimeseriesGroupsResponseMetaConfidenceInfo
- type QualityIQITimeseriesGroupsResponseMetaConfidenceInfoAnnotation
- type QualityIQITimeseriesGroupsResponseMetaDateRange
- type QualityIQITimeseriesGroupsResponseMetaNormalization
- type QualityIQITimeseriesGroupsResponseMetaUnit
- type QualityIQITimeseriesGroupsResponseSerie0
- type QualityService
- type QualitySpeedHistogramParams
- type QualitySpeedHistogramParamsFormat
- type QualitySpeedHistogramParamsMetricGroup
- type QualitySpeedHistogramResponse
- type QualitySpeedHistogramResponseEnvelope
- type QualitySpeedHistogramResponseHistogram0
- type QualitySpeedHistogramResponseMeta
- type QualitySpeedHistogramResponseMetaConfidenceInfo
- type QualitySpeedHistogramResponseMetaConfidenceInfoAnnotation
- type QualitySpeedHistogramResponseMetaDateRange
- type QualitySpeedHistogramResponseMetaNormalization
- type QualitySpeedHistogramResponseMetaUnit
- type QualitySpeedService
- type QualitySpeedSummaryParams
- type QualitySpeedSummaryParamsFormat
- type QualitySpeedSummaryResponse
- type QualitySpeedSummaryResponseEnvelope
- type QualitySpeedSummaryResponseMeta
- type QualitySpeedSummaryResponseMetaConfidenceInfo
- type QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation
- type QualitySpeedSummaryResponseMetaDateRange
- type QualitySpeedSummaryResponseMetaNormalization
- type QualitySpeedSummaryResponseMetaUnit
- type QualitySpeedSummaryResponseSummary0
- type QualitySpeedTopAsesParams
- type QualitySpeedTopAsesParamsFormat
- type QualitySpeedTopAsesParamsOrderBy
- type QualitySpeedTopAsesResponse
- type QualitySpeedTopAsesResponseEnvelope
- type QualitySpeedTopAsesResponseMeta
- type QualitySpeedTopAsesResponseMetaConfidenceInfo
- type QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation
- type QualitySpeedTopAsesResponseMetaDateRange
- type QualitySpeedTopAsesResponseMetaNormalization
- type QualitySpeedTopAsesResponseMetaUnit
- type QualitySpeedTopAsesResponseTop0
- type QualitySpeedTopLocationsParams
- type QualitySpeedTopLocationsParamsFormat
- type QualitySpeedTopLocationsParamsOrderBy
- type QualitySpeedTopLocationsResponse
- type QualitySpeedTopLocationsResponseEnvelope
- type QualitySpeedTopLocationsResponseMeta
- type QualitySpeedTopLocationsResponseMetaConfidenceInfo
- type QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation
- type QualitySpeedTopLocationsResponseMetaDateRange
- type QualitySpeedTopLocationsResponseMetaNormalization
- type QualitySpeedTopLocationsResponseMetaUnit
- type QualitySpeedTopLocationsResponseTop0
- type QualitySpeedTopService
- func (r *QualitySpeedTopService) Ases(ctx context.Context, query QualitySpeedTopAsesParams, ...) (res *QualitySpeedTopAsesResponse, err error)
- func (r *QualitySpeedTopService) Locations(ctx context.Context, query QualitySpeedTopLocationsParams, ...) (res *QualitySpeedTopLocationsResponse, err error)
- type RadarEmailSeries
- type RadarEmailSummary
- type RadarService
- type RankingDomainGetParams
- type RankingDomainGetParamsFormat
- type RankingDomainGetParamsRankingType
- type RankingDomainGetResponse
- type RankingDomainGetResponseDetails0
- type RankingDomainGetResponseDetails0Category
- type RankingDomainGetResponseDetails0TopLocation
- type RankingDomainGetResponseEnvelope
- type RankingDomainGetResponseMeta
- type RankingDomainGetResponseMetaDateRange
- type RankingDomainService
- type RankingInternetServiceCategoriesParams
- type RankingInternetServiceCategoriesParamsFormat
- type RankingInternetServiceCategoriesResponse
- type RankingInternetServiceCategoriesResponseCategories0
- type RankingInternetServiceCategoriesResponseEnvelope
- type RankingInternetServiceService
- func (r *RankingInternetServiceService) Categories(ctx context.Context, query RankingInternetServiceCategoriesParams, ...) (res *RankingInternetServiceCategoriesResponse, err error)
- func (r *RankingInternetServiceService) TimeseriesGroups(ctx context.Context, query RankingInternetServiceTimeseriesGroupsParams, ...) (res *RankingInternetServiceTimeseriesGroupsResponse, err error)
- func (r *RankingInternetServiceService) Top(ctx context.Context, query RankingInternetServiceTopParams, ...) (res *RankingInternetServiceTopResponse, err error)
- type RankingInternetServiceTimeseriesGroupsParams
- type RankingInternetServiceTimeseriesGroupsParamsFormat
- type RankingInternetServiceTimeseriesGroupsResponse
- type RankingInternetServiceTimeseriesGroupsResponseEnvelope
- type RankingInternetServiceTimeseriesGroupsResponseMeta
- type RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval
- type RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfo
- type RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoAnnotation
- type RankingInternetServiceTimeseriesGroupsResponseMetaDateRange
- type RankingInternetServiceTimeseriesGroupsResponseMetaNormalization
- type RankingInternetServiceTimeseriesGroupsResponseMetaUnit
- type RankingInternetServiceTimeseriesGroupsResponseSerie0
- type RankingInternetServiceTimeseriesGroupsResponseSerie0Union
- type RankingInternetServiceTopParams
- type RankingInternetServiceTopParamsFormat
- type RankingInternetServiceTopResponse
- type RankingInternetServiceTopResponseEnvelope
- type RankingInternetServiceTopResponseMeta
- type RankingInternetServiceTopResponseMetaConfidenceInfo
- type RankingInternetServiceTopResponseMetaConfidenceInfoAnnotation
- type RankingInternetServiceTopResponseMetaDateRange
- type RankingInternetServiceTopResponseMetaNormalization
- type RankingInternetServiceTopResponseMetaUnit
- type RankingInternetServiceTopResponseTop0
- type RankingService
- type RankingTimeseriesGroupsParams
- type RankingTimeseriesGroupsParamsFormat
- type RankingTimeseriesGroupsParamsRankingType
- type RankingTimeseriesGroupsResponse
- type RankingTimeseriesGroupsResponseEnvelope
- type RankingTimeseriesGroupsResponseMeta
- type RankingTimeseriesGroupsResponseMetaAggInterval
- type RankingTimeseriesGroupsResponseMetaConfidenceInfo
- type RankingTimeseriesGroupsResponseMetaConfidenceInfoAnnotation
- type RankingTimeseriesGroupsResponseMetaDateRange
- type RankingTimeseriesGroupsResponseMetaNormalization
- type RankingTimeseriesGroupsResponseMetaUnit
- type RankingTimeseriesGroupsResponseSerie0
- type RankingTimeseriesGroupsResponseSerie0Union
- type RankingTopParams
- type RankingTopParamsFormat
- type RankingTopParamsRankingType
- type RankingTopResponse
- type RankingTopResponseEnvelope
- type RankingTopResponseMeta
- type RankingTopResponseMetaConfidenceInfo
- type RankingTopResponseMetaConfidenceInfoAnnotation
- type RankingTopResponseMetaDateRange
- type RankingTopResponseMetaNormalization
- type RankingTopResponseMetaUnit
- type RankingTopResponseTop0
- type RankingTopResponseTop0Category
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type RobotsTXTService
- type RobotsTXTTopDomainCategoriesParams
- type RobotsTXTTopDomainCategoriesParamsFormat
- type RobotsTXTTopDomainCategoriesParamsUserAgentCategory
- type RobotsTXTTopDomainCategoriesResponse
- type RobotsTXTTopDomainCategoriesResponseEnvelope
- type RobotsTXTTopDomainCategoriesResponseMeta
- type RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfo
- type RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfoAnnotation
- type RobotsTXTTopDomainCategoriesResponseMetaDateRange
- type RobotsTXTTopDomainCategoriesResponseMetaNormalization
- type RobotsTXTTopDomainCategoriesResponseMetaUnit
- type RobotsTXTTopDomainCategoriesResponseTop0
- type RobotsTXTTopService
- type RobotsTXTTopUserAgentDirectiveParams
- type RobotsTXTTopUserAgentDirectiveParamsDirective
- type RobotsTXTTopUserAgentDirectiveParamsFormat
- type RobotsTXTTopUserAgentDirectiveParamsUserAgentCategory
- type RobotsTXTTopUserAgentDirectiveResponse
- type RobotsTXTTopUserAgentDirectiveResponseEnvelope
- type RobotsTXTTopUserAgentDirectiveResponseMeta
- type RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfo
- type RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoAnnotation
- type RobotsTXTTopUserAgentDirectiveResponseMetaDateRange
- type RobotsTXTTopUserAgentDirectiveResponseMetaNormalization
- type RobotsTXTTopUserAgentDirectiveResponseMetaUnit
- type RobotsTXTTopUserAgentDirectiveResponseTop0
- type RobotsTXTTopUserAgentService
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SearchGlobalParams
- type SearchGlobalParamsExclude
- type SearchGlobalParamsFormat
- type SearchGlobalParamsInclude
- type SearchGlobalResponse
- type SearchGlobalResponseEnvelope
- type SearchGlobalResponseSearch
- type SearchService
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type TCPResetsTimeoutService
- func (r *TCPResetsTimeoutService) Summary(ctx context.Context, query TCPResetsTimeoutSummaryParams, ...) (res *TCPResetsTimeoutSummaryResponse, err error)
- func (r *TCPResetsTimeoutService) TimeseriesGroups(ctx context.Context, query TCPResetsTimeoutTimeseriesGroupsParams, ...) (res *TCPResetsTimeoutTimeseriesGroupsResponse, err error)
- type TCPResetsTimeoutSummaryParams
- type TCPResetsTimeoutSummaryParamsFormat
- type TCPResetsTimeoutSummaryResponse
- type TCPResetsTimeoutSummaryResponseEnvelope
- type TCPResetsTimeoutSummaryResponseMeta
- type TCPResetsTimeoutSummaryResponseMetaConfidenceInfo
- type TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation
- type TCPResetsTimeoutSummaryResponseMetaDateRange
- type TCPResetsTimeoutSummaryResponseMetaNormalization
- type TCPResetsTimeoutSummaryResponseMetaUnit
- type TCPResetsTimeoutSummaryResponseSummary0
- type TCPResetsTimeoutTimeseriesGroupsParams
- type TCPResetsTimeoutTimeseriesGroupsParamsAggInterval
- type TCPResetsTimeoutTimeseriesGroupsParamsFormat
- type TCPResetsTimeoutTimeseriesGroupsResponse
- type TCPResetsTimeoutTimeseriesGroupsResponseEnvelope
- type TCPResetsTimeoutTimeseriesGroupsResponseMeta
- type TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval
- type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo
- type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation
- type TCPResetsTimeoutTimeseriesGroupsResponseMetaDateRange
- type TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization
- type TCPResetsTimeoutTimeseriesGroupsResponseMetaUnit
- type TCPResetsTimeoutTimeseriesGroupsResponseSerie0
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
- type TrafficAnomalyGetParams
- type TrafficAnomalyGetParamsFormat
- type TrafficAnomalyGetParamsStatus
- type TrafficAnomalyGetResponse
- type TrafficAnomalyGetResponseEnvelope
- type TrafficAnomalyGetResponseTrafficAnomaliesASNDetails
- type TrafficAnomalyGetResponseTrafficAnomaliesASNDetailsLocations
- type TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails
- type TrafficAnomalyGetResponseTrafficAnomaly
- type TrafficAnomalyLocationGetParams
- type TrafficAnomalyLocationGetParamsFormat
- type TrafficAnomalyLocationGetParamsStatus
- type TrafficAnomalyLocationGetResponse
- type TrafficAnomalyLocationGetResponseEnvelope
- type TrafficAnomalyLocationGetResponseTrafficAnomaly
- type TrafficAnomalyLocationService
- type TrafficAnomalyService
- type VerifiedBotService
- type VerifiedBotTopBotsParams
- type VerifiedBotTopBotsParamsFormat
- type VerifiedBotTopBotsResponse
- type VerifiedBotTopBotsResponseEnvelope
- type VerifiedBotTopBotsResponseMeta
- type VerifiedBotTopBotsResponseMetaConfidenceInfo
- type VerifiedBotTopBotsResponseMetaConfidenceInfoAnnotation
- type VerifiedBotTopBotsResponseMetaDateRange
- type VerifiedBotTopBotsResponseMetaNormalization
- type VerifiedBotTopBotsResponseMetaUnit
- type VerifiedBotTopBotsResponseTop0
- type VerifiedBotTopCategoriesParams
- type VerifiedBotTopCategoriesParamsFormat
- type VerifiedBotTopCategoriesResponse
- type VerifiedBotTopCategoriesResponseEnvelope
- type VerifiedBotTopCategoriesResponseMeta
- type VerifiedBotTopCategoriesResponseMetaConfidenceInfo
- type VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation
- type VerifiedBotTopCategoriesResponseMetaDateRange
- type VerifiedBotTopCategoriesResponseMetaNormalization
- type VerifiedBotTopCategoriesResponseMetaUnit
- type VerifiedBotTopCategoriesResponseTop0
- type VerifiedBotTopService
- func (r *VerifiedBotTopService) Bots(ctx context.Context, query VerifiedBotTopBotsParams, ...) (res *VerifiedBotTopBotsResponse, err error)deprecated
- func (r *VerifiedBotTopService) Categories(ctx context.Context, query VerifiedBotTopCategoriesParams, ...) (res *VerifiedBotTopCategoriesResponse, err error)deprecated
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AIBotService ¶
type AIBotService struct {
Options []option.RequestOption
Summary *AIBotSummaryService
}
AIBotService 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 NewAIBotService method instead.
func NewAIBotService ¶
func NewAIBotService(opts ...option.RequestOption) (r *AIBotService)
NewAIBotService 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 AIBotSummaryService ¶
type AIBotSummaryService struct {
Options []option.RequestOption
}
AIBotSummaryService 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 NewAIBotSummaryService method instead.
func NewAIBotSummaryService ¶
func NewAIBotSummaryService(opts ...option.RequestOption) (r *AIBotSummaryService)
NewAIBotSummaryService 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 (*AIBotSummaryService) UserAgent ¶
func (r *AIBotSummaryService) UserAgent(ctx context.Context, query AIBotSummaryUserAgentParams, opts ...option.RequestOption) (res *AIBotSummaryUserAgentResponse, err error)
Retrieves the distribution of traffic by AI user agent.
type AIBotSummaryUserAgentParams ¶
type AIBotSummaryUserAgentParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AIBotSummaryUserAgentParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AIBotSummaryUserAgentParams) URLQuery ¶
func (r AIBotSummaryUserAgentParams) URLQuery() (v url.Values)
URLQuery serializes AIBotSummaryUserAgentParams's query parameters as `url.Values`.
type AIBotSummaryUserAgentParamsFormat ¶
type AIBotSummaryUserAgentParamsFormat string
Format in which results will be returned.
const ( AIBotSummaryUserAgentParamsFormatJson AIBotSummaryUserAgentParamsFormat = "JSON" AIBotSummaryUserAgentParamsFormatCsv AIBotSummaryUserAgentParamsFormat = "CSV" )
func (AIBotSummaryUserAgentParamsFormat) IsKnown ¶
func (r AIBotSummaryUserAgentParamsFormat) IsKnown() bool
type AIBotSummaryUserAgentResponse ¶
type AIBotSummaryUserAgentResponse struct {
// Metadata for the results.
Meta AIBotSummaryUserAgentResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON aiBotSummaryUserAgentResponseJSON `json:"-"`
}
func (*AIBotSummaryUserAgentResponse) UnmarshalJSON ¶
func (r *AIBotSummaryUserAgentResponse) UnmarshalJSON(data []byte) (err error)
type AIBotSummaryUserAgentResponseEnvelope ¶
type AIBotSummaryUserAgentResponseEnvelope struct {
Result AIBotSummaryUserAgentResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON aiBotSummaryUserAgentResponseEnvelopeJSON `json:"-"`
}
func (*AIBotSummaryUserAgentResponseEnvelope) UnmarshalJSON ¶
func (r *AIBotSummaryUserAgentResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AIBotSummaryUserAgentResponseMeta ¶
type AIBotSummaryUserAgentResponseMeta struct {
ConfidenceInfo AIBotSummaryUserAgentResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AIBotSummaryUserAgentResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AIBotSummaryUserAgentResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AIBotSummaryUserAgentResponseMetaUnit `json:"units,required"`
JSON aiBotSummaryUserAgentResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AIBotSummaryUserAgentResponseMeta) UnmarshalJSON ¶
func (r *AIBotSummaryUserAgentResponseMeta) UnmarshalJSON(data []byte) (err error)
type AIBotSummaryUserAgentResponseMetaConfidenceInfo ¶
type AIBotSummaryUserAgentResponseMetaConfidenceInfo struct {
Annotations []AIBotSummaryUserAgentResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON aiBotSummaryUserAgentResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AIBotSummaryUserAgentResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AIBotSummaryUserAgentResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AIBotSummaryUserAgentResponseMetaConfidenceInfoAnnotation ¶
type AIBotSummaryUserAgentResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON aiBotSummaryUserAgentResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AIBotSummaryUserAgentResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AIBotSummaryUserAgentResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AIBotSummaryUserAgentResponseMetaDateRange ¶
type AIBotSummaryUserAgentResponseMetaDateRange 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 aiBotSummaryUserAgentResponseMetaDateRangeJSON `json:"-"`
}
func (*AIBotSummaryUserAgentResponseMetaDateRange) UnmarshalJSON ¶
func (r *AIBotSummaryUserAgentResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AIBotSummaryUserAgentResponseMetaNormalization ¶
type AIBotSummaryUserAgentResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AIBotSummaryUserAgentResponseMetaNormalizationPercentage AIBotSummaryUserAgentResponseMetaNormalization = "PERCENTAGE" AIBotSummaryUserAgentResponseMetaNormalizationMin0Max AIBotSummaryUserAgentResponseMetaNormalization = "MIN0_MAX" AIBotSummaryUserAgentResponseMetaNormalizationMinMax AIBotSummaryUserAgentResponseMetaNormalization = "MIN_MAX" AIBotSummaryUserAgentResponseMetaNormalizationRawValues AIBotSummaryUserAgentResponseMetaNormalization = "RAW_VALUES" AIBotSummaryUserAgentResponseMetaNormalizationPercentageChange AIBotSummaryUserAgentResponseMetaNormalization = "PERCENTAGE_CHANGE" AIBotSummaryUserAgentResponseMetaNormalizationRollingAverage AIBotSummaryUserAgentResponseMetaNormalization = "ROLLING_AVERAGE" AIBotSummaryUserAgentResponseMetaNormalizationOverlappedPercentage AIBotSummaryUserAgentResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AIBotSummaryUserAgentResponseMetaNormalizationRatio AIBotSummaryUserAgentResponseMetaNormalization = "RATIO" )
func (AIBotSummaryUserAgentResponseMetaNormalization) IsKnown ¶
func (r AIBotSummaryUserAgentResponseMetaNormalization) IsKnown() bool
type AIBotSummaryUserAgentResponseMetaUnit ¶
type AIBotSummaryUserAgentResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON aiBotSummaryUserAgentResponseMetaUnitJSON `json:"-"`
}
func (*AIBotSummaryUserAgentResponseMetaUnit) UnmarshalJSON ¶
func (r *AIBotSummaryUserAgentResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AIInferenceService ¶
type AIInferenceService struct {
Options []option.RequestOption
Summary *AIInferenceSummaryService
TimeseriesGroups *AIInferenceTimeseriesGroupService
}
AIInferenceService 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 NewAIInferenceService method instead.
func NewAIInferenceService ¶
func NewAIInferenceService(opts ...option.RequestOption) (r *AIInferenceService)
NewAIInferenceService 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 AIInferenceSummaryModelParams ¶
type AIInferenceSummaryModelParams struct {
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AIInferenceSummaryModelParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AIInferenceSummaryModelParams) URLQuery ¶
func (r AIInferenceSummaryModelParams) URLQuery() (v url.Values)
URLQuery serializes AIInferenceSummaryModelParams's query parameters as `url.Values`.
type AIInferenceSummaryModelParamsFormat ¶
type AIInferenceSummaryModelParamsFormat string
Format in which results will be returned.
const ( AIInferenceSummaryModelParamsFormatJson AIInferenceSummaryModelParamsFormat = "JSON" AIInferenceSummaryModelParamsFormatCsv AIInferenceSummaryModelParamsFormat = "CSV" )
func (AIInferenceSummaryModelParamsFormat) IsKnown ¶
func (r AIInferenceSummaryModelParamsFormat) IsKnown() bool
type AIInferenceSummaryModelResponse ¶
type AIInferenceSummaryModelResponse struct {
// Metadata for the results.
Meta AIInferenceSummaryModelResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON aiInferenceSummaryModelResponseJSON `json:"-"`
}
func (*AIInferenceSummaryModelResponse) UnmarshalJSON ¶
func (r *AIInferenceSummaryModelResponse) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryModelResponseEnvelope ¶
type AIInferenceSummaryModelResponseEnvelope struct {
Result AIInferenceSummaryModelResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON aiInferenceSummaryModelResponseEnvelopeJSON `json:"-"`
}
func (*AIInferenceSummaryModelResponseEnvelope) UnmarshalJSON ¶
func (r *AIInferenceSummaryModelResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryModelResponseMeta ¶
type AIInferenceSummaryModelResponseMeta struct {
ConfidenceInfo AIInferenceSummaryModelResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AIInferenceSummaryModelResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AIInferenceSummaryModelResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AIInferenceSummaryModelResponseMetaUnit `json:"units,required"`
JSON aiInferenceSummaryModelResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AIInferenceSummaryModelResponseMeta) UnmarshalJSON ¶
func (r *AIInferenceSummaryModelResponseMeta) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryModelResponseMetaConfidenceInfo ¶
type AIInferenceSummaryModelResponseMetaConfidenceInfo struct {
Annotations []AIInferenceSummaryModelResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON aiInferenceSummaryModelResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AIInferenceSummaryModelResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AIInferenceSummaryModelResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryModelResponseMetaConfidenceInfoAnnotation ¶
type AIInferenceSummaryModelResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON aiInferenceSummaryModelResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AIInferenceSummaryModelResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AIInferenceSummaryModelResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryModelResponseMetaDateRange ¶
type AIInferenceSummaryModelResponseMetaDateRange 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 aiInferenceSummaryModelResponseMetaDateRangeJSON `json:"-"`
}
func (*AIInferenceSummaryModelResponseMetaDateRange) UnmarshalJSON ¶
func (r *AIInferenceSummaryModelResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryModelResponseMetaNormalization ¶
type AIInferenceSummaryModelResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AIInferenceSummaryModelResponseMetaNormalizationPercentage AIInferenceSummaryModelResponseMetaNormalization = "PERCENTAGE" AIInferenceSummaryModelResponseMetaNormalizationMin0Max AIInferenceSummaryModelResponseMetaNormalization = "MIN0_MAX" AIInferenceSummaryModelResponseMetaNormalizationMinMax AIInferenceSummaryModelResponseMetaNormalization = "MIN_MAX" AIInferenceSummaryModelResponseMetaNormalizationRawValues AIInferenceSummaryModelResponseMetaNormalization = "RAW_VALUES" AIInferenceSummaryModelResponseMetaNormalizationPercentageChange AIInferenceSummaryModelResponseMetaNormalization = "PERCENTAGE_CHANGE" AIInferenceSummaryModelResponseMetaNormalizationRollingAverage AIInferenceSummaryModelResponseMetaNormalization = "ROLLING_AVERAGE" AIInferenceSummaryModelResponseMetaNormalizationOverlappedPercentage AIInferenceSummaryModelResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AIInferenceSummaryModelResponseMetaNormalizationRatio AIInferenceSummaryModelResponseMetaNormalization = "RATIO" )
func (AIInferenceSummaryModelResponseMetaNormalization) IsKnown ¶
func (r AIInferenceSummaryModelResponseMetaNormalization) IsKnown() bool
type AIInferenceSummaryModelResponseMetaUnit ¶
type AIInferenceSummaryModelResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON aiInferenceSummaryModelResponseMetaUnitJSON `json:"-"`
}
func (*AIInferenceSummaryModelResponseMetaUnit) UnmarshalJSON ¶
func (r *AIInferenceSummaryModelResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryService ¶
type AIInferenceSummaryService struct {
Options []option.RequestOption
}
AIInferenceSummaryService 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 NewAIInferenceSummaryService method instead.
func NewAIInferenceSummaryService ¶
func NewAIInferenceSummaryService(opts ...option.RequestOption) (r *AIInferenceSummaryService)
NewAIInferenceSummaryService 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 (*AIInferenceSummaryService) Model ¶
func (r *AIInferenceSummaryService) Model(ctx context.Context, query AIInferenceSummaryModelParams, opts ...option.RequestOption) (res *AIInferenceSummaryModelResponse, err error)
Retrieves the distribution of unique accounts by model.
func (*AIInferenceSummaryService) Task ¶
func (r *AIInferenceSummaryService) Task(ctx context.Context, query AIInferenceSummaryTaskParams, opts ...option.RequestOption) (res *AIInferenceSummaryTaskResponse, err error)
Retrieves the distribution of unique accounts by task.
type AIInferenceSummaryTaskParams ¶
type AIInferenceSummaryTaskParams struct {
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AIInferenceSummaryTaskParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AIInferenceSummaryTaskParams) URLQuery ¶
func (r AIInferenceSummaryTaskParams) URLQuery() (v url.Values)
URLQuery serializes AIInferenceSummaryTaskParams's query parameters as `url.Values`.
type AIInferenceSummaryTaskParamsFormat ¶
type AIInferenceSummaryTaskParamsFormat string
Format in which results will be returned.
const ( AIInferenceSummaryTaskParamsFormatJson AIInferenceSummaryTaskParamsFormat = "JSON" AIInferenceSummaryTaskParamsFormatCsv AIInferenceSummaryTaskParamsFormat = "CSV" )
func (AIInferenceSummaryTaskParamsFormat) IsKnown ¶
func (r AIInferenceSummaryTaskParamsFormat) IsKnown() bool
type AIInferenceSummaryTaskResponse ¶
type AIInferenceSummaryTaskResponse struct {
// Metadata for the results.
Meta AIInferenceSummaryTaskResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON aiInferenceSummaryTaskResponseJSON `json:"-"`
}
func (*AIInferenceSummaryTaskResponse) UnmarshalJSON ¶
func (r *AIInferenceSummaryTaskResponse) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryTaskResponseEnvelope ¶
type AIInferenceSummaryTaskResponseEnvelope struct {
Result AIInferenceSummaryTaskResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON aiInferenceSummaryTaskResponseEnvelopeJSON `json:"-"`
}
func (*AIInferenceSummaryTaskResponseEnvelope) UnmarshalJSON ¶
func (r *AIInferenceSummaryTaskResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryTaskResponseMeta ¶
type AIInferenceSummaryTaskResponseMeta struct {
ConfidenceInfo AIInferenceSummaryTaskResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AIInferenceSummaryTaskResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AIInferenceSummaryTaskResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AIInferenceSummaryTaskResponseMetaUnit `json:"units,required"`
JSON aiInferenceSummaryTaskResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AIInferenceSummaryTaskResponseMeta) UnmarshalJSON ¶
func (r *AIInferenceSummaryTaskResponseMeta) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryTaskResponseMetaConfidenceInfo ¶
type AIInferenceSummaryTaskResponseMetaConfidenceInfo struct {
Annotations []AIInferenceSummaryTaskResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON aiInferenceSummaryTaskResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AIInferenceSummaryTaskResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AIInferenceSummaryTaskResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryTaskResponseMetaConfidenceInfoAnnotation ¶
type AIInferenceSummaryTaskResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON aiInferenceSummaryTaskResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AIInferenceSummaryTaskResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AIInferenceSummaryTaskResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryTaskResponseMetaDateRange ¶
type AIInferenceSummaryTaskResponseMetaDateRange 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 aiInferenceSummaryTaskResponseMetaDateRangeJSON `json:"-"`
}
func (*AIInferenceSummaryTaskResponseMetaDateRange) UnmarshalJSON ¶
func (r *AIInferenceSummaryTaskResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AIInferenceSummaryTaskResponseMetaNormalization ¶
type AIInferenceSummaryTaskResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AIInferenceSummaryTaskResponseMetaNormalizationPercentage AIInferenceSummaryTaskResponseMetaNormalization = "PERCENTAGE" AIInferenceSummaryTaskResponseMetaNormalizationMin0Max AIInferenceSummaryTaskResponseMetaNormalization = "MIN0_MAX" AIInferenceSummaryTaskResponseMetaNormalizationMinMax AIInferenceSummaryTaskResponseMetaNormalization = "MIN_MAX" AIInferenceSummaryTaskResponseMetaNormalizationRawValues AIInferenceSummaryTaskResponseMetaNormalization = "RAW_VALUES" AIInferenceSummaryTaskResponseMetaNormalizationPercentageChange AIInferenceSummaryTaskResponseMetaNormalization = "PERCENTAGE_CHANGE" AIInferenceSummaryTaskResponseMetaNormalizationRollingAverage AIInferenceSummaryTaskResponseMetaNormalization = "ROLLING_AVERAGE" AIInferenceSummaryTaskResponseMetaNormalizationOverlappedPercentage AIInferenceSummaryTaskResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AIInferenceSummaryTaskResponseMetaNormalizationRatio AIInferenceSummaryTaskResponseMetaNormalization = "RATIO" )
func (AIInferenceSummaryTaskResponseMetaNormalization) IsKnown ¶
func (r AIInferenceSummaryTaskResponseMetaNormalization) IsKnown() bool
type AIInferenceSummaryTaskResponseMetaUnit ¶
type AIInferenceSummaryTaskResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON aiInferenceSummaryTaskResponseMetaUnitJSON `json:"-"`
}
func (*AIInferenceSummaryTaskResponseMetaUnit) UnmarshalJSON ¶
func (r *AIInferenceSummaryTaskResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupService ¶
type AIInferenceTimeseriesGroupService struct {
Options []option.RequestOption
Summary *AIInferenceTimeseriesGroupSummaryService
}
AIInferenceTimeseriesGroupService 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 NewAIInferenceTimeseriesGroupService method instead.
func NewAIInferenceTimeseriesGroupService ¶
func NewAIInferenceTimeseriesGroupService(opts ...option.RequestOption) (r *AIInferenceTimeseriesGroupService)
NewAIInferenceTimeseriesGroupService 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 AIInferenceTimeseriesGroupSummaryModelParams ¶
type AIInferenceTimeseriesGroupSummaryModelParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[AIInferenceTimeseriesGroupSummaryModelParamsAggInterval] `query:"aggInterval"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AIInferenceTimeseriesGroupSummaryModelParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AIInferenceTimeseriesGroupSummaryModelParams) URLQuery ¶
func (r AIInferenceTimeseriesGroupSummaryModelParams) URLQuery() (v url.Values)
URLQuery serializes AIInferenceTimeseriesGroupSummaryModelParams's query parameters as `url.Values`.
type AIInferenceTimeseriesGroupSummaryModelParamsAggInterval ¶
type AIInferenceTimeseriesGroupSummaryModelParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AIInferenceTimeseriesGroupSummaryModelParamsAggInterval15m AIInferenceTimeseriesGroupSummaryModelParamsAggInterval = "15m" AIInferenceTimeseriesGroupSummaryModelParamsAggInterval1h AIInferenceTimeseriesGroupSummaryModelParamsAggInterval = "1h" AIInferenceTimeseriesGroupSummaryModelParamsAggInterval1d AIInferenceTimeseriesGroupSummaryModelParamsAggInterval = "1d" AIInferenceTimeseriesGroupSummaryModelParamsAggInterval1w AIInferenceTimeseriesGroupSummaryModelParamsAggInterval = "1w" )
func (AIInferenceTimeseriesGroupSummaryModelParamsAggInterval) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryModelParamsAggInterval) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryModelParamsFormat ¶
type AIInferenceTimeseriesGroupSummaryModelParamsFormat string
Format in which results will be returned.
const ( AIInferenceTimeseriesGroupSummaryModelParamsFormatJson AIInferenceTimeseriesGroupSummaryModelParamsFormat = "JSON" AIInferenceTimeseriesGroupSummaryModelParamsFormatCsv AIInferenceTimeseriesGroupSummaryModelParamsFormat = "CSV" )
func (AIInferenceTimeseriesGroupSummaryModelParamsFormat) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryModelParamsFormat) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryModelResponse ¶
type AIInferenceTimeseriesGroupSummaryModelResponse struct {
// Metadata for the results.
Meta AIInferenceTimeseriesGroupSummaryModelResponseMeta `json:"meta,required"`
Serie0 AIInferenceTimeseriesGroupSummaryModelResponseSerie0 `json:"serie_0,required"`
JSON aiInferenceTimeseriesGroupSummaryModelResponseJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryModelResponse) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponse) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryModelResponseEnvelope ¶
type AIInferenceTimeseriesGroupSummaryModelResponseEnvelope struct {
Result AIInferenceTimeseriesGroupSummaryModelResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON aiInferenceTimeseriesGroupSummaryModelResponseEnvelopeJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryModelResponseEnvelope) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryModelResponseMeta ¶
type AIInferenceTimeseriesGroupSummaryModelResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AIInferenceTimeseriesGroupSummaryModelResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AIInferenceTimeseriesGroupSummaryModelResponseMetaUnit `json:"units,required"`
JSON aiInferenceTimeseriesGroupSummaryModelResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AIInferenceTimeseriesGroupSummaryModelResponseMeta) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponseMeta) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval ¶
type AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AIInferenceTimeseriesGroupSummaryModelResponseMetaAggIntervalFifteenMinutes AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval = "FIFTEEN_MINUTES" AIInferenceTimeseriesGroupSummaryModelResponseMetaAggIntervalOneHour AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval = "ONE_HOUR" AIInferenceTimeseriesGroupSummaryModelResponseMetaAggIntervalOneDay AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval = "ONE_DAY" AIInferenceTimeseriesGroupSummaryModelResponseMetaAggIntervalOneWeek AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval = "ONE_WEEK" AIInferenceTimeseriesGroupSummaryModelResponseMetaAggIntervalOneMonth AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval = "ONE_MONTH" )
func (AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryModelResponseMetaAggInterval) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfo ¶
type AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfo struct {
Annotations []AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON aiInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoAnnotation ¶
type AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON aiInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryModelResponseMetaDateRange ¶
type AIInferenceTimeseriesGroupSummaryModelResponseMetaDateRange 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 aiInferenceTimeseriesGroupSummaryModelResponseMetaDateRangeJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryModelResponseMetaDateRange) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization ¶
type AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationPercentage AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "PERCENTAGE" AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationMin0Max AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "MIN0_MAX" AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationMinMax AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "MIN_MAX" AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationRawValues AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "RAW_VALUES" AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationPercentageChange AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "PERCENTAGE_CHANGE" AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationRollingAverage AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "ROLLING_AVERAGE" AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationOverlappedPercentage AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalizationRatio AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization = "RATIO" )
func (AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryModelResponseMetaNormalization) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryModelResponseMetaUnit ¶
type AIInferenceTimeseriesGroupSummaryModelResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON aiInferenceTimeseriesGroupSummaryModelResponseMetaUnitJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryModelResponseMetaUnit) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryModelResponseSerie0 ¶
type AIInferenceTimeseriesGroupSummaryModelResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON aiInferenceTimeseriesGroupSummaryModelResponseSerie0JSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryModelResponseSerie0) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryModelResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryService ¶
type AIInferenceTimeseriesGroupSummaryService struct {
Options []option.RequestOption
}
AIInferenceTimeseriesGroupSummaryService 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 NewAIInferenceTimeseriesGroupSummaryService method instead.
func NewAIInferenceTimeseriesGroupSummaryService ¶
func NewAIInferenceTimeseriesGroupSummaryService(opts ...option.RequestOption) (r *AIInferenceTimeseriesGroupSummaryService)
NewAIInferenceTimeseriesGroupSummaryService 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 (*AIInferenceTimeseriesGroupSummaryService) Model ¶
func (r *AIInferenceTimeseriesGroupSummaryService) Model(ctx context.Context, query AIInferenceTimeseriesGroupSummaryModelParams, opts ...option.RequestOption) (res *AIInferenceTimeseriesGroupSummaryModelResponse, err error)
Retrieves the distribution of unique accounts by model over time.
func (*AIInferenceTimeseriesGroupSummaryService) Task ¶
func (r *AIInferenceTimeseriesGroupSummaryService) Task(ctx context.Context, query AIInferenceTimeseriesGroupSummaryTaskParams, opts ...option.RequestOption) (res *AIInferenceTimeseriesGroupSummaryTaskResponse, err error)
Retrieves the distribution of unique accounts by task over time.
type AIInferenceTimeseriesGroupSummaryTaskParams ¶
type AIInferenceTimeseriesGroupSummaryTaskParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval] `query:"aggInterval"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AIInferenceTimeseriesGroupSummaryTaskParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AIInferenceTimeseriesGroupSummaryTaskParams) URLQuery ¶
func (r AIInferenceTimeseriesGroupSummaryTaskParams) URLQuery() (v url.Values)
URLQuery serializes AIInferenceTimeseriesGroupSummaryTaskParams's query parameters as `url.Values`.
type AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval ¶
type AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval15m AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval = "15m" AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval1h AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval = "1h" AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval1d AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval = "1d" AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval1w AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval = "1w" )
func (AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryTaskParamsAggInterval) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryTaskParamsFormat ¶
type AIInferenceTimeseriesGroupSummaryTaskParamsFormat string
Format in which results will be returned.
const ( AIInferenceTimeseriesGroupSummaryTaskParamsFormatJson AIInferenceTimeseriesGroupSummaryTaskParamsFormat = "JSON" AIInferenceTimeseriesGroupSummaryTaskParamsFormatCsv AIInferenceTimeseriesGroupSummaryTaskParamsFormat = "CSV" )
func (AIInferenceTimeseriesGroupSummaryTaskParamsFormat) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryTaskParamsFormat) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryTaskResponse ¶
type AIInferenceTimeseriesGroupSummaryTaskResponse struct {
// Metadata for the results.
Meta AIInferenceTimeseriesGroupSummaryTaskResponseMeta `json:"meta,required"`
Serie0 AIInferenceTimeseriesGroupSummaryTaskResponseSerie0 `json:"serie_0,required"`
JSON aiInferenceTimeseriesGroupSummaryTaskResponseJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryTaskResponse) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponse) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryTaskResponseEnvelope ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseEnvelope struct {
Result AIInferenceTimeseriesGroupSummaryTaskResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON aiInferenceTimeseriesGroupSummaryTaskResponseEnvelopeJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryTaskResponseEnvelope) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryTaskResponseMeta ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AIInferenceTimeseriesGroupSummaryTaskResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AIInferenceTimeseriesGroupSummaryTaskResponseMetaUnit `json:"units,required"`
JSON aiInferenceTimeseriesGroupSummaryTaskResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AIInferenceTimeseriesGroupSummaryTaskResponseMeta) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponseMeta) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggIntervalFifteenMinutes AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval = "FIFTEEN_MINUTES" AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggIntervalOneHour AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval = "ONE_HOUR" AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggIntervalOneDay AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval = "ONE_DAY" AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggIntervalOneWeek AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval = "ONE_WEEK" AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggIntervalOneMonth AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval = "ONE_MONTH" )
func (AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryTaskResponseMetaAggInterval) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfo ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfo struct {
Annotations []AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON aiInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoAnnotation ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON aiInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaDateRange ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaDateRange 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 aiInferenceTimeseriesGroupSummaryTaskResponseMetaDateRangeJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryTaskResponseMetaDateRange) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationPercentage AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "PERCENTAGE" AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationMin0Max AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "MIN0_MAX" AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationMinMax AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "MIN_MAX" AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationRawValues AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "RAW_VALUES" AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationPercentageChange AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "PERCENTAGE_CHANGE" AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationRollingAverage AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "ROLLING_AVERAGE" AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationOverlappedPercentage AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalizationRatio AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization = "RATIO" )
func (AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization) IsKnown ¶
func (r AIInferenceTimeseriesGroupSummaryTaskResponseMetaNormalization) IsKnown() bool
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaUnit ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON aiInferenceTimeseriesGroupSummaryTaskResponseMetaUnitJSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryTaskResponseMetaUnit) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AIInferenceTimeseriesGroupSummaryTaskResponseSerie0 ¶
type AIInferenceTimeseriesGroupSummaryTaskResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON aiInferenceTimeseriesGroupSummaryTaskResponseSerie0JSON `json:"-"`
}
func (*AIInferenceTimeseriesGroupSummaryTaskResponseSerie0) UnmarshalJSON ¶
func (r *AIInferenceTimeseriesGroupSummaryTaskResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AIService ¶
type AIService struct {
Options []option.RequestOption
ToMarkdown *AIToMarkdownService
Inference *AIInferenceService
Bots *AIBotService
TimeseriesGroups *AITimeseriesGroupService
}
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 AITimeseriesGroupService ¶
type AITimeseriesGroupService struct {
Options []option.RequestOption
}
AITimeseriesGroupService 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 NewAITimeseriesGroupService method instead.
func NewAITimeseriesGroupService ¶
func NewAITimeseriesGroupService(opts ...option.RequestOption) (r *AITimeseriesGroupService)
NewAITimeseriesGroupService 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 (*AITimeseriesGroupService) UserAgent ¶
func (r *AITimeseriesGroupService) UserAgent(ctx context.Context, query AITimeseriesGroupUserAgentParams, opts ...option.RequestOption) (res *AITimeseriesGroupUserAgentResponse, err error)
Retrieves the distribution of traffic by AI user agent over time.
type AITimeseriesGroupUserAgentParams ¶
type AITimeseriesGroupUserAgentParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[AITimeseriesGroupUserAgentParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AITimeseriesGroupUserAgentParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AITimeseriesGroupUserAgentParams) URLQuery ¶
func (r AITimeseriesGroupUserAgentParams) URLQuery() (v url.Values)
URLQuery serializes AITimeseriesGroupUserAgentParams's query parameters as `url.Values`.
type AITimeseriesGroupUserAgentParamsAggInterval ¶
type AITimeseriesGroupUserAgentParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AITimeseriesGroupUserAgentParamsAggInterval15m AITimeseriesGroupUserAgentParamsAggInterval = "15m" AITimeseriesGroupUserAgentParamsAggInterval1h AITimeseriesGroupUserAgentParamsAggInterval = "1h" AITimeseriesGroupUserAgentParamsAggInterval1d AITimeseriesGroupUserAgentParamsAggInterval = "1d" AITimeseriesGroupUserAgentParamsAggInterval1w AITimeseriesGroupUserAgentParamsAggInterval = "1w" )
func (AITimeseriesGroupUserAgentParamsAggInterval) IsKnown ¶
func (r AITimeseriesGroupUserAgentParamsAggInterval) IsKnown() bool
type AITimeseriesGroupUserAgentParamsFormat ¶
type AITimeseriesGroupUserAgentParamsFormat string
Format in which results will be returned.
const ( AITimeseriesGroupUserAgentParamsFormatJson AITimeseriesGroupUserAgentParamsFormat = "JSON" AITimeseriesGroupUserAgentParamsFormatCsv AITimeseriesGroupUserAgentParamsFormat = "CSV" )
func (AITimeseriesGroupUserAgentParamsFormat) IsKnown ¶
func (r AITimeseriesGroupUserAgentParamsFormat) IsKnown() bool
type AITimeseriesGroupUserAgentResponse ¶
type AITimeseriesGroupUserAgentResponse struct {
// Metadata for the results.
Meta AITimeseriesGroupUserAgentResponseMeta `json:"meta,required"`
Serie0 AITimeseriesGroupUserAgentResponseSerie0 `json:"serie_0,required"`
JSON aiTimeseriesGroupUserAgentResponseJSON `json:"-"`
}
func (*AITimeseriesGroupUserAgentResponse) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponse) UnmarshalJSON(data []byte) (err error)
type AITimeseriesGroupUserAgentResponseEnvelope ¶
type AITimeseriesGroupUserAgentResponseEnvelope struct {
Result AITimeseriesGroupUserAgentResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON aiTimeseriesGroupUserAgentResponseEnvelopeJSON `json:"-"`
}
func (*AITimeseriesGroupUserAgentResponseEnvelope) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AITimeseriesGroupUserAgentResponseMeta ¶
type AITimeseriesGroupUserAgentResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AITimeseriesGroupUserAgentResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AITimeseriesGroupUserAgentResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AITimeseriesGroupUserAgentResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AITimeseriesGroupUserAgentResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AITimeseriesGroupUserAgentResponseMetaUnit `json:"units,required"`
JSON aiTimeseriesGroupUserAgentResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AITimeseriesGroupUserAgentResponseMeta) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponseMeta) UnmarshalJSON(data []byte) (err error)
type AITimeseriesGroupUserAgentResponseMetaAggInterval ¶
type AITimeseriesGroupUserAgentResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AITimeseriesGroupUserAgentResponseMetaAggIntervalFifteenMinutes AITimeseriesGroupUserAgentResponseMetaAggInterval = "FIFTEEN_MINUTES" AITimeseriesGroupUserAgentResponseMetaAggIntervalOneHour AITimeseriesGroupUserAgentResponseMetaAggInterval = "ONE_HOUR" AITimeseriesGroupUserAgentResponseMetaAggIntervalOneDay AITimeseriesGroupUserAgentResponseMetaAggInterval = "ONE_DAY" AITimeseriesGroupUserAgentResponseMetaAggIntervalOneWeek AITimeseriesGroupUserAgentResponseMetaAggInterval = "ONE_WEEK" AITimeseriesGroupUserAgentResponseMetaAggIntervalOneMonth AITimeseriesGroupUserAgentResponseMetaAggInterval = "ONE_MONTH" )
func (AITimeseriesGroupUserAgentResponseMetaAggInterval) IsKnown ¶
func (r AITimeseriesGroupUserAgentResponseMetaAggInterval) IsKnown() bool
type AITimeseriesGroupUserAgentResponseMetaConfidenceInfo ¶
type AITimeseriesGroupUserAgentResponseMetaConfidenceInfo struct {
Annotations []AITimeseriesGroupUserAgentResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON aiTimeseriesGroupUserAgentResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AITimeseriesGroupUserAgentResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AITimeseriesGroupUserAgentResponseMetaConfidenceInfoAnnotation ¶
type AITimeseriesGroupUserAgentResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON aiTimeseriesGroupUserAgentResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AITimeseriesGroupUserAgentResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AITimeseriesGroupUserAgentResponseMetaDateRange ¶
type AITimeseriesGroupUserAgentResponseMetaDateRange 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 aiTimeseriesGroupUserAgentResponseMetaDateRangeJSON `json:"-"`
}
func (*AITimeseriesGroupUserAgentResponseMetaDateRange) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AITimeseriesGroupUserAgentResponseMetaNormalization ¶
type AITimeseriesGroupUserAgentResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AITimeseriesGroupUserAgentResponseMetaNormalizationPercentage AITimeseriesGroupUserAgentResponseMetaNormalization = "PERCENTAGE" AITimeseriesGroupUserAgentResponseMetaNormalizationMin0Max AITimeseriesGroupUserAgentResponseMetaNormalization = "MIN0_MAX" AITimeseriesGroupUserAgentResponseMetaNormalizationMinMax AITimeseriesGroupUserAgentResponseMetaNormalization = "MIN_MAX" AITimeseriesGroupUserAgentResponseMetaNormalizationRawValues AITimeseriesGroupUserAgentResponseMetaNormalization = "RAW_VALUES" AITimeseriesGroupUserAgentResponseMetaNormalizationPercentageChange AITimeseriesGroupUserAgentResponseMetaNormalization = "PERCENTAGE_CHANGE" AITimeseriesGroupUserAgentResponseMetaNormalizationRollingAverage AITimeseriesGroupUserAgentResponseMetaNormalization = "ROLLING_AVERAGE" AITimeseriesGroupUserAgentResponseMetaNormalizationOverlappedPercentage AITimeseriesGroupUserAgentResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AITimeseriesGroupUserAgentResponseMetaNormalizationRatio AITimeseriesGroupUserAgentResponseMetaNormalization = "RATIO" )
func (AITimeseriesGroupUserAgentResponseMetaNormalization) IsKnown ¶
func (r AITimeseriesGroupUserAgentResponseMetaNormalization) IsKnown() bool
type AITimeseriesGroupUserAgentResponseMetaUnit ¶
type AITimeseriesGroupUserAgentResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON aiTimeseriesGroupUserAgentResponseMetaUnitJSON `json:"-"`
}
func (*AITimeseriesGroupUserAgentResponseMetaUnit) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AITimeseriesGroupUserAgentResponseSerie0 ¶
type AITimeseriesGroupUserAgentResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON aiTimeseriesGroupUserAgentResponseSerie0JSON `json:"-"`
}
func (*AITimeseriesGroupUserAgentResponseSerie0) UnmarshalJSON ¶
func (r *AITimeseriesGroupUserAgentResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AIToMarkdownNewParams ¶
type AIToMarkdownNewParams struct {
AccountID param.Field[string] `path:"account_id,required"`
Body io.Reader `json:"body" format:"binary"`
}
func (AIToMarkdownNewParams) MarshalMultipart ¶
func (r AIToMarkdownNewParams) MarshalMultipart() (data []byte, contentType string, err error)
type AIToMarkdownNewResponse ¶
type AIToMarkdownNewResponse struct {
Data string `json:"data,required"`
Format string `json:"format,required"`
MimeType string `json:"mimeType,required"`
Name string `json:"name,required"`
Tokens string `json:"tokens,required"`
JSON aiToMarkdownNewResponseJSON `json:"-"`
}
func (*AIToMarkdownNewResponse) UnmarshalJSON ¶
func (r *AIToMarkdownNewResponse) UnmarshalJSON(data []byte) (err error)
type AIToMarkdownService ¶
type AIToMarkdownService struct {
Options []option.RequestOption
}
AIToMarkdownService 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 NewAIToMarkdownService method instead.
func NewAIToMarkdownService ¶
func NewAIToMarkdownService(opts ...option.RequestOption) (r *AIToMarkdownService)
NewAIToMarkdownService 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 (*AIToMarkdownService) New ¶
func (r *AIToMarkdownService) New(ctx context.Context, Body io.Reader, body AIToMarkdownNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[AIToMarkdownNewResponse], err error)
Convert Files into Markdown
func (*AIToMarkdownService) NewAutoPaging ¶
func (r *AIToMarkdownService) NewAutoPaging(ctx context.Context, Body io.Reader, body AIToMarkdownNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AIToMarkdownNewResponse]
Convert Files into Markdown
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)
Retrieves the AS112 DNS queries over time.
type AS112SummaryDNSSECParams ¶
type AS112SummaryDNSSECParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112SummaryDNSSECParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112SummaryDNSSECParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112SummaryDNSSECParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112SummaryDNSSECParamsResponseCode] `query:"responseCode"`
}
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 in which results will be returned.
const ( AS112SummaryDNSSECParamsFormatJson AS112SummaryDNSSECParamsFormat = "JSON" AS112SummaryDNSSECParamsFormatCsv AS112SummaryDNSSECParamsFormat = "CSV" )
func (AS112SummaryDNSSECParamsFormat) IsKnown ¶
func (r AS112SummaryDNSSECParamsFormat) IsKnown() bool
type AS112SummaryDNSSECParamsProtocol ¶
type AS112SummaryDNSSECParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112SummaryDNSSECParamsProtocolUdp AS112SummaryDNSSECParamsProtocol = "UDP" AS112SummaryDNSSECParamsProtocolTCP AS112SummaryDNSSECParamsProtocol = "TCP" AS112SummaryDNSSECParamsProtocolHTTPS AS112SummaryDNSSECParamsProtocol = "HTTPS" AS112SummaryDNSSECParamsProtocolTLS AS112SummaryDNSSECParamsProtocol = "TLS" )
func (AS112SummaryDNSSECParamsProtocol) IsKnown ¶
func (r AS112SummaryDNSSECParamsProtocol) IsKnown() bool
type AS112SummaryDNSSECParamsQueryType ¶
type AS112SummaryDNSSECParamsQueryType string
Filters results by DNS query type.
const ( AS112SummaryDNSSECParamsQueryTypeA AS112SummaryDNSSECParamsQueryType = "A" AS112SummaryDNSSECParamsQueryTypeAAAA AS112SummaryDNSSECParamsQueryType = "AAAA" AS112SummaryDNSSECParamsQueryTypeA6 AS112SummaryDNSSECParamsQueryType = "A6" AS112SummaryDNSSECParamsQueryTypeAfsdb AS112SummaryDNSSECParamsQueryType = "AFSDB" AS112SummaryDNSSECParamsQueryTypeAny AS112SummaryDNSSECParamsQueryType = "ANY" AS112SummaryDNSSECParamsQueryTypeApl AS112SummaryDNSSECParamsQueryType = "APL" AS112SummaryDNSSECParamsQueryTypeAtma AS112SummaryDNSSECParamsQueryType = "ATMA" AS112SummaryDNSSECParamsQueryTypeAXFR AS112SummaryDNSSECParamsQueryType = "AXFR" AS112SummaryDNSSECParamsQueryTypeCAA AS112SummaryDNSSECParamsQueryType = "CAA" AS112SummaryDNSSECParamsQueryTypeCdnskey AS112SummaryDNSSECParamsQueryType = "CDNSKEY" AS112SummaryDNSSECParamsQueryTypeCds AS112SummaryDNSSECParamsQueryType = "CDS" AS112SummaryDNSSECParamsQueryTypeCERT AS112SummaryDNSSECParamsQueryType = "CERT" AS112SummaryDNSSECParamsQueryTypeCNAME AS112SummaryDNSSECParamsQueryType = "CNAME" AS112SummaryDNSSECParamsQueryTypeCsync AS112SummaryDNSSECParamsQueryType = "CSYNC" AS112SummaryDNSSECParamsQueryTypeDhcid AS112SummaryDNSSECParamsQueryType = "DHCID" AS112SummaryDNSSECParamsQueryTypeDlv AS112SummaryDNSSECParamsQueryType = "DLV" AS112SummaryDNSSECParamsQueryTypeDname AS112SummaryDNSSECParamsQueryType = "DNAME" AS112SummaryDNSSECParamsQueryTypeDNSKEY AS112SummaryDNSSECParamsQueryType = "DNSKEY" AS112SummaryDNSSECParamsQueryTypeDoa AS112SummaryDNSSECParamsQueryType = "DOA" AS112SummaryDNSSECParamsQueryTypeDS AS112SummaryDNSSECParamsQueryType = "DS" AS112SummaryDNSSECParamsQueryTypeEid AS112SummaryDNSSECParamsQueryType = "EID" AS112SummaryDNSSECParamsQueryTypeEui48 AS112SummaryDNSSECParamsQueryType = "EUI48" AS112SummaryDNSSECParamsQueryTypeEui64 AS112SummaryDNSSECParamsQueryType = "EUI64" AS112SummaryDNSSECParamsQueryTypeGpos AS112SummaryDNSSECParamsQueryType = "GPOS" AS112SummaryDNSSECParamsQueryTypeGid AS112SummaryDNSSECParamsQueryType = "GID" AS112SummaryDNSSECParamsQueryTypeHinfo AS112SummaryDNSSECParamsQueryType = "HINFO" AS112SummaryDNSSECParamsQueryTypeHip AS112SummaryDNSSECParamsQueryType = "HIP" AS112SummaryDNSSECParamsQueryTypeHTTPS AS112SummaryDNSSECParamsQueryType = "HTTPS" AS112SummaryDNSSECParamsQueryTypeIpseckey AS112SummaryDNSSECParamsQueryType = "IPSECKEY" AS112SummaryDNSSECParamsQueryTypeIsdn AS112SummaryDNSSECParamsQueryType = "ISDN" AS112SummaryDNSSECParamsQueryTypeIxfr AS112SummaryDNSSECParamsQueryType = "IXFR" AS112SummaryDNSSECParamsQueryTypeKey AS112SummaryDNSSECParamsQueryType = "KEY" AS112SummaryDNSSECParamsQueryTypeKx AS112SummaryDNSSECParamsQueryType = "KX" AS112SummaryDNSSECParamsQueryTypeL32 AS112SummaryDNSSECParamsQueryType = "L32" AS112SummaryDNSSECParamsQueryTypeL64 AS112SummaryDNSSECParamsQueryType = "L64" AS112SummaryDNSSECParamsQueryTypeLOC AS112SummaryDNSSECParamsQueryType = "LOC" AS112SummaryDNSSECParamsQueryTypeLp AS112SummaryDNSSECParamsQueryType = "LP" AS112SummaryDNSSECParamsQueryTypeMaila AS112SummaryDNSSECParamsQueryType = "MAILA" AS112SummaryDNSSECParamsQueryTypeMailb AS112SummaryDNSSECParamsQueryType = "MAILB" AS112SummaryDNSSECParamsQueryTypeMB AS112SummaryDNSSECParamsQueryType = "MB" AS112SummaryDNSSECParamsQueryTypeMd AS112SummaryDNSSECParamsQueryType = "MD" AS112SummaryDNSSECParamsQueryTypeMf AS112SummaryDNSSECParamsQueryType = "MF" AS112SummaryDNSSECParamsQueryTypeMg AS112SummaryDNSSECParamsQueryType = "MG" AS112SummaryDNSSECParamsQueryTypeMinfo AS112SummaryDNSSECParamsQueryType = "MINFO" AS112SummaryDNSSECParamsQueryTypeMr AS112SummaryDNSSECParamsQueryType = "MR" AS112SummaryDNSSECParamsQueryTypeMX AS112SummaryDNSSECParamsQueryType = "MX" AS112SummaryDNSSECParamsQueryTypeNAPTR AS112SummaryDNSSECParamsQueryType = "NAPTR" AS112SummaryDNSSECParamsQueryTypeNb AS112SummaryDNSSECParamsQueryType = "NB" AS112SummaryDNSSECParamsQueryTypeNbstat AS112SummaryDNSSECParamsQueryType = "NBSTAT" AS112SummaryDNSSECParamsQueryTypeNid AS112SummaryDNSSECParamsQueryType = "NID" AS112SummaryDNSSECParamsQueryTypeNimloc AS112SummaryDNSSECParamsQueryType = "NIMLOC" AS112SummaryDNSSECParamsQueryTypeNinfo AS112SummaryDNSSECParamsQueryType = "NINFO" AS112SummaryDNSSECParamsQueryTypeNS AS112SummaryDNSSECParamsQueryType = "NS" AS112SummaryDNSSECParamsQueryTypeNsap AS112SummaryDNSSECParamsQueryType = "NSAP" AS112SummaryDNSSECParamsQueryTypeNsec AS112SummaryDNSSECParamsQueryType = "NSEC" AS112SummaryDNSSECParamsQueryTypeNsec3 AS112SummaryDNSSECParamsQueryType = "NSEC3" AS112SummaryDNSSECParamsQueryTypeNsec3Param AS112SummaryDNSSECParamsQueryType = "NSEC3PARAM" AS112SummaryDNSSECParamsQueryTypeNull AS112SummaryDNSSECParamsQueryType = "NULL" AS112SummaryDNSSECParamsQueryTypeNxt AS112SummaryDNSSECParamsQueryType = "NXT" AS112SummaryDNSSECParamsQueryTypeOpenpgpkey AS112SummaryDNSSECParamsQueryType = "OPENPGPKEY" AS112SummaryDNSSECParamsQueryTypeOpt AS112SummaryDNSSECParamsQueryType = "OPT" AS112SummaryDNSSECParamsQueryTypePTR AS112SummaryDNSSECParamsQueryType = "PTR" AS112SummaryDNSSECParamsQueryTypePx AS112SummaryDNSSECParamsQueryType = "PX" AS112SummaryDNSSECParamsQueryTypeRkey AS112SummaryDNSSECParamsQueryType = "RKEY" AS112SummaryDNSSECParamsQueryTypeRp AS112SummaryDNSSECParamsQueryType = "RP" AS112SummaryDNSSECParamsQueryTypeRrsig AS112SummaryDNSSECParamsQueryType = "RRSIG" AS112SummaryDNSSECParamsQueryTypeRt AS112SummaryDNSSECParamsQueryType = "RT" AS112SummaryDNSSECParamsQueryTypeSig AS112SummaryDNSSECParamsQueryType = "SIG" AS112SummaryDNSSECParamsQueryTypeSink AS112SummaryDNSSECParamsQueryType = "SINK" AS112SummaryDNSSECParamsQueryTypeSMIMEA AS112SummaryDNSSECParamsQueryType = "SMIMEA" AS112SummaryDNSSECParamsQueryTypeSOA AS112SummaryDNSSECParamsQueryType = "SOA" AS112SummaryDNSSECParamsQueryTypeSPF AS112SummaryDNSSECParamsQueryType = "SPF" AS112SummaryDNSSECParamsQueryTypeSRV AS112SummaryDNSSECParamsQueryType = "SRV" AS112SummaryDNSSECParamsQueryTypeSSHFP AS112SummaryDNSSECParamsQueryType = "SSHFP" AS112SummaryDNSSECParamsQueryTypeSVCB AS112SummaryDNSSECParamsQueryType = "SVCB" AS112SummaryDNSSECParamsQueryTypeTa AS112SummaryDNSSECParamsQueryType = "TA" AS112SummaryDNSSECParamsQueryTypeTalink AS112SummaryDNSSECParamsQueryType = "TALINK" AS112SummaryDNSSECParamsQueryTypeTkey AS112SummaryDNSSECParamsQueryType = "TKEY" AS112SummaryDNSSECParamsQueryTypeTLSA AS112SummaryDNSSECParamsQueryType = "TLSA" AS112SummaryDNSSECParamsQueryTypeTSIG AS112SummaryDNSSECParamsQueryType = "TSIG" AS112SummaryDNSSECParamsQueryTypeTXT AS112SummaryDNSSECParamsQueryType = "TXT" AS112SummaryDNSSECParamsQueryTypeUinfo AS112SummaryDNSSECParamsQueryType = "UINFO" AS112SummaryDNSSECParamsQueryTypeUID AS112SummaryDNSSECParamsQueryType = "UID" AS112SummaryDNSSECParamsQueryTypeUnspec AS112SummaryDNSSECParamsQueryType = "UNSPEC" AS112SummaryDNSSECParamsQueryTypeURI AS112SummaryDNSSECParamsQueryType = "URI" AS112SummaryDNSSECParamsQueryTypeWks AS112SummaryDNSSECParamsQueryType = "WKS" AS112SummaryDNSSECParamsQueryTypeX25 AS112SummaryDNSSECParamsQueryType = "X25" AS112SummaryDNSSECParamsQueryTypeZonemd AS112SummaryDNSSECParamsQueryType = "ZONEMD" )
func (AS112SummaryDNSSECParamsQueryType) IsKnown ¶
func (r AS112SummaryDNSSECParamsQueryType) IsKnown() bool
type AS112SummaryDNSSECParamsResponseCode ¶
type AS112SummaryDNSSECParamsResponseCode string
Filters results by DNS response code.
const ( AS112SummaryDNSSECParamsResponseCodeNoerror AS112SummaryDNSSECParamsResponseCode = "NOERROR" AS112SummaryDNSSECParamsResponseCodeFormerr AS112SummaryDNSSECParamsResponseCode = "FORMERR" AS112SummaryDNSSECParamsResponseCodeServfail AS112SummaryDNSSECParamsResponseCode = "SERVFAIL" AS112SummaryDNSSECParamsResponseCodeNxdomain AS112SummaryDNSSECParamsResponseCode = "NXDOMAIN" AS112SummaryDNSSECParamsResponseCodeNotimp AS112SummaryDNSSECParamsResponseCode = "NOTIMP" AS112SummaryDNSSECParamsResponseCodeRefused AS112SummaryDNSSECParamsResponseCode = "REFUSED" AS112SummaryDNSSECParamsResponseCodeYxdomain AS112SummaryDNSSECParamsResponseCode = "YXDOMAIN" AS112SummaryDNSSECParamsResponseCodeYxrrset AS112SummaryDNSSECParamsResponseCode = "YXRRSET" AS112SummaryDNSSECParamsResponseCodeNxrrset AS112SummaryDNSSECParamsResponseCode = "NXRRSET" AS112SummaryDNSSECParamsResponseCodeNotauth AS112SummaryDNSSECParamsResponseCode = "NOTAUTH" AS112SummaryDNSSECParamsResponseCodeNotzone AS112SummaryDNSSECParamsResponseCode = "NOTZONE" AS112SummaryDNSSECParamsResponseCodeBadsig AS112SummaryDNSSECParamsResponseCode = "BADSIG" AS112SummaryDNSSECParamsResponseCodeBadkey AS112SummaryDNSSECParamsResponseCode = "BADKEY" AS112SummaryDNSSECParamsResponseCodeBadtime AS112SummaryDNSSECParamsResponseCode = "BADTIME" AS112SummaryDNSSECParamsResponseCodeBadmode AS112SummaryDNSSECParamsResponseCode = "BADMODE" AS112SummaryDNSSECParamsResponseCodeBadname AS112SummaryDNSSECParamsResponseCode = "BADNAME" AS112SummaryDNSSECParamsResponseCodeBadalg AS112SummaryDNSSECParamsResponseCode = "BADALG" AS112SummaryDNSSECParamsResponseCodeBadtrunc AS112SummaryDNSSECParamsResponseCode = "BADTRUNC" )
func (AS112SummaryDNSSECParamsResponseCode) IsKnown ¶
func (r AS112SummaryDNSSECParamsResponseCode) IsKnown() bool
type AS112SummaryDNSSECResponse ¶
type AS112SummaryDNSSECResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112SummaryDNSSECResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112SummaryDNSSECResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112SummaryDNSSECResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112SummaryDNSSECResponseMetaUnit `json:"units,required"`
JSON as112SummaryDNSSECResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112SummaryDNSSECResponseMeta) UnmarshalJSON ¶
func (r *AS112SummaryDNSSECResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112SummaryDNSSECResponseMetaConfidenceInfo ¶
type AS112SummaryDNSSECResponseMetaConfidenceInfo struct {
Annotations []AS112SummaryDNSSECResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112SummaryDNSSECResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 AS112SummaryDNSSECResponseMetaNormalization ¶
type AS112SummaryDNSSECResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112SummaryDNSSECResponseMetaNormalizationPercentage AS112SummaryDNSSECResponseMetaNormalization = "PERCENTAGE" AS112SummaryDNSSECResponseMetaNormalizationMin0Max AS112SummaryDNSSECResponseMetaNormalization = "MIN0_MAX" AS112SummaryDNSSECResponseMetaNormalizationMinMax AS112SummaryDNSSECResponseMetaNormalization = "MIN_MAX" AS112SummaryDNSSECResponseMetaNormalizationRawValues AS112SummaryDNSSECResponseMetaNormalization = "RAW_VALUES" AS112SummaryDNSSECResponseMetaNormalizationPercentageChange AS112SummaryDNSSECResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112SummaryDNSSECResponseMetaNormalizationRollingAverage AS112SummaryDNSSECResponseMetaNormalization = "ROLLING_AVERAGE" AS112SummaryDNSSECResponseMetaNormalizationOverlappedPercentage AS112SummaryDNSSECResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112SummaryDNSSECResponseMetaNormalizationRatio AS112SummaryDNSSECResponseMetaNormalization = "RATIO" )
func (AS112SummaryDNSSECResponseMetaNormalization) IsKnown ¶
func (r AS112SummaryDNSSECResponseMetaNormalization) IsKnown() bool
type AS112SummaryDNSSECResponseMetaUnit ¶
type AS112SummaryDNSSECResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112SummaryDNSSECResponseMetaUnitJSON `json:"-"`
}
func (*AS112SummaryDNSSECResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112SummaryDNSSECResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112SummaryDNSSECResponseSummary0 ¶
type AS112SummaryDNSSECResponseSummary0 struct {
// A numeric string.
NotSupported string `json:"NOT_SUPPORTED,required"`
// A numeric string.
Supported string `json:"SUPPORTED,required"`
JSON as112SummaryDNSSECResponseSummary0JSON `json:"-"`
}
func (*AS112SummaryDNSSECResponseSummary0) UnmarshalJSON ¶
func (r *AS112SummaryDNSSECResponseSummary0) UnmarshalJSON(data []byte) (err error)
type AS112SummaryEdnsParams ¶
type AS112SummaryEdnsParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112SummaryEdnsParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112SummaryEdnsParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112SummaryEdnsParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112SummaryEdnsParamsResponseCode] `query:"responseCode"`
}
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 in which results will be returned.
const ( AS112SummaryEdnsParamsFormatJson AS112SummaryEdnsParamsFormat = "JSON" AS112SummaryEdnsParamsFormatCsv AS112SummaryEdnsParamsFormat = "CSV" )
func (AS112SummaryEdnsParamsFormat) IsKnown ¶
func (r AS112SummaryEdnsParamsFormat) IsKnown() bool
type AS112SummaryEdnsParamsProtocol ¶
type AS112SummaryEdnsParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112SummaryEdnsParamsProtocolUdp AS112SummaryEdnsParamsProtocol = "UDP" AS112SummaryEdnsParamsProtocolTCP AS112SummaryEdnsParamsProtocol = "TCP" AS112SummaryEdnsParamsProtocolHTTPS AS112SummaryEdnsParamsProtocol = "HTTPS" AS112SummaryEdnsParamsProtocolTLS AS112SummaryEdnsParamsProtocol = "TLS" )
func (AS112SummaryEdnsParamsProtocol) IsKnown ¶
func (r AS112SummaryEdnsParamsProtocol) IsKnown() bool
type AS112SummaryEdnsParamsQueryType ¶
type AS112SummaryEdnsParamsQueryType string
Filters results by DNS query type.
const ( AS112SummaryEdnsParamsQueryTypeA AS112SummaryEdnsParamsQueryType = "A" AS112SummaryEdnsParamsQueryTypeAAAA AS112SummaryEdnsParamsQueryType = "AAAA" AS112SummaryEdnsParamsQueryTypeA6 AS112SummaryEdnsParamsQueryType = "A6" AS112SummaryEdnsParamsQueryTypeAfsdb AS112SummaryEdnsParamsQueryType = "AFSDB" AS112SummaryEdnsParamsQueryTypeAny AS112SummaryEdnsParamsQueryType = "ANY" AS112SummaryEdnsParamsQueryTypeApl AS112SummaryEdnsParamsQueryType = "APL" AS112SummaryEdnsParamsQueryTypeAtma AS112SummaryEdnsParamsQueryType = "ATMA" AS112SummaryEdnsParamsQueryTypeAXFR AS112SummaryEdnsParamsQueryType = "AXFR" AS112SummaryEdnsParamsQueryTypeCAA AS112SummaryEdnsParamsQueryType = "CAA" AS112SummaryEdnsParamsQueryTypeCdnskey AS112SummaryEdnsParamsQueryType = "CDNSKEY" AS112SummaryEdnsParamsQueryTypeCds AS112SummaryEdnsParamsQueryType = "CDS" AS112SummaryEdnsParamsQueryTypeCERT AS112SummaryEdnsParamsQueryType = "CERT" AS112SummaryEdnsParamsQueryTypeCNAME AS112SummaryEdnsParamsQueryType = "CNAME" AS112SummaryEdnsParamsQueryTypeCsync AS112SummaryEdnsParamsQueryType = "CSYNC" AS112SummaryEdnsParamsQueryTypeDhcid AS112SummaryEdnsParamsQueryType = "DHCID" AS112SummaryEdnsParamsQueryTypeDlv AS112SummaryEdnsParamsQueryType = "DLV" AS112SummaryEdnsParamsQueryTypeDname AS112SummaryEdnsParamsQueryType = "DNAME" AS112SummaryEdnsParamsQueryTypeDNSKEY AS112SummaryEdnsParamsQueryType = "DNSKEY" AS112SummaryEdnsParamsQueryTypeDoa AS112SummaryEdnsParamsQueryType = "DOA" AS112SummaryEdnsParamsQueryTypeDS AS112SummaryEdnsParamsQueryType = "DS" AS112SummaryEdnsParamsQueryTypeEid AS112SummaryEdnsParamsQueryType = "EID" AS112SummaryEdnsParamsQueryTypeEui48 AS112SummaryEdnsParamsQueryType = "EUI48" AS112SummaryEdnsParamsQueryTypeEui64 AS112SummaryEdnsParamsQueryType = "EUI64" AS112SummaryEdnsParamsQueryTypeGpos AS112SummaryEdnsParamsQueryType = "GPOS" AS112SummaryEdnsParamsQueryTypeGid AS112SummaryEdnsParamsQueryType = "GID" AS112SummaryEdnsParamsQueryTypeHinfo AS112SummaryEdnsParamsQueryType = "HINFO" AS112SummaryEdnsParamsQueryTypeHip AS112SummaryEdnsParamsQueryType = "HIP" AS112SummaryEdnsParamsQueryTypeHTTPS AS112SummaryEdnsParamsQueryType = "HTTPS" AS112SummaryEdnsParamsQueryTypeIpseckey AS112SummaryEdnsParamsQueryType = "IPSECKEY" AS112SummaryEdnsParamsQueryTypeIsdn AS112SummaryEdnsParamsQueryType = "ISDN" AS112SummaryEdnsParamsQueryTypeIxfr AS112SummaryEdnsParamsQueryType = "IXFR" AS112SummaryEdnsParamsQueryTypeKey AS112SummaryEdnsParamsQueryType = "KEY" AS112SummaryEdnsParamsQueryTypeKx AS112SummaryEdnsParamsQueryType = "KX" AS112SummaryEdnsParamsQueryTypeL32 AS112SummaryEdnsParamsQueryType = "L32" AS112SummaryEdnsParamsQueryTypeL64 AS112SummaryEdnsParamsQueryType = "L64" AS112SummaryEdnsParamsQueryTypeLOC AS112SummaryEdnsParamsQueryType = "LOC" AS112SummaryEdnsParamsQueryTypeLp AS112SummaryEdnsParamsQueryType = "LP" AS112SummaryEdnsParamsQueryTypeMaila AS112SummaryEdnsParamsQueryType = "MAILA" AS112SummaryEdnsParamsQueryTypeMailb AS112SummaryEdnsParamsQueryType = "MAILB" AS112SummaryEdnsParamsQueryTypeMB AS112SummaryEdnsParamsQueryType = "MB" AS112SummaryEdnsParamsQueryTypeMd AS112SummaryEdnsParamsQueryType = "MD" AS112SummaryEdnsParamsQueryTypeMf AS112SummaryEdnsParamsQueryType = "MF" AS112SummaryEdnsParamsQueryTypeMg AS112SummaryEdnsParamsQueryType = "MG" AS112SummaryEdnsParamsQueryTypeMinfo AS112SummaryEdnsParamsQueryType = "MINFO" AS112SummaryEdnsParamsQueryTypeMr AS112SummaryEdnsParamsQueryType = "MR" AS112SummaryEdnsParamsQueryTypeMX AS112SummaryEdnsParamsQueryType = "MX" AS112SummaryEdnsParamsQueryTypeNAPTR AS112SummaryEdnsParamsQueryType = "NAPTR" AS112SummaryEdnsParamsQueryTypeNb AS112SummaryEdnsParamsQueryType = "NB" AS112SummaryEdnsParamsQueryTypeNbstat AS112SummaryEdnsParamsQueryType = "NBSTAT" AS112SummaryEdnsParamsQueryTypeNid AS112SummaryEdnsParamsQueryType = "NID" AS112SummaryEdnsParamsQueryTypeNimloc AS112SummaryEdnsParamsQueryType = "NIMLOC" AS112SummaryEdnsParamsQueryTypeNinfo AS112SummaryEdnsParamsQueryType = "NINFO" AS112SummaryEdnsParamsQueryTypeNS AS112SummaryEdnsParamsQueryType = "NS" AS112SummaryEdnsParamsQueryTypeNsap AS112SummaryEdnsParamsQueryType = "NSAP" AS112SummaryEdnsParamsQueryTypeNsec AS112SummaryEdnsParamsQueryType = "NSEC" AS112SummaryEdnsParamsQueryTypeNsec3 AS112SummaryEdnsParamsQueryType = "NSEC3" AS112SummaryEdnsParamsQueryTypeNsec3Param AS112SummaryEdnsParamsQueryType = "NSEC3PARAM" AS112SummaryEdnsParamsQueryTypeNull AS112SummaryEdnsParamsQueryType = "NULL" AS112SummaryEdnsParamsQueryTypeNxt AS112SummaryEdnsParamsQueryType = "NXT" AS112SummaryEdnsParamsQueryTypeOpenpgpkey AS112SummaryEdnsParamsQueryType = "OPENPGPKEY" AS112SummaryEdnsParamsQueryTypeOpt AS112SummaryEdnsParamsQueryType = "OPT" AS112SummaryEdnsParamsQueryTypePTR AS112SummaryEdnsParamsQueryType = "PTR" AS112SummaryEdnsParamsQueryTypePx AS112SummaryEdnsParamsQueryType = "PX" AS112SummaryEdnsParamsQueryTypeRkey AS112SummaryEdnsParamsQueryType = "RKEY" AS112SummaryEdnsParamsQueryTypeRp AS112SummaryEdnsParamsQueryType = "RP" AS112SummaryEdnsParamsQueryTypeRrsig AS112SummaryEdnsParamsQueryType = "RRSIG" AS112SummaryEdnsParamsQueryTypeRt AS112SummaryEdnsParamsQueryType = "RT" AS112SummaryEdnsParamsQueryTypeSig AS112SummaryEdnsParamsQueryType = "SIG" AS112SummaryEdnsParamsQueryTypeSink AS112SummaryEdnsParamsQueryType = "SINK" AS112SummaryEdnsParamsQueryTypeSMIMEA AS112SummaryEdnsParamsQueryType = "SMIMEA" AS112SummaryEdnsParamsQueryTypeSOA AS112SummaryEdnsParamsQueryType = "SOA" AS112SummaryEdnsParamsQueryTypeSPF AS112SummaryEdnsParamsQueryType = "SPF" AS112SummaryEdnsParamsQueryTypeSRV AS112SummaryEdnsParamsQueryType = "SRV" AS112SummaryEdnsParamsQueryTypeSSHFP AS112SummaryEdnsParamsQueryType = "SSHFP" AS112SummaryEdnsParamsQueryTypeSVCB AS112SummaryEdnsParamsQueryType = "SVCB" AS112SummaryEdnsParamsQueryTypeTa AS112SummaryEdnsParamsQueryType = "TA" AS112SummaryEdnsParamsQueryTypeTalink AS112SummaryEdnsParamsQueryType = "TALINK" AS112SummaryEdnsParamsQueryTypeTkey AS112SummaryEdnsParamsQueryType = "TKEY" AS112SummaryEdnsParamsQueryTypeTLSA AS112SummaryEdnsParamsQueryType = "TLSA" AS112SummaryEdnsParamsQueryTypeTSIG AS112SummaryEdnsParamsQueryType = "TSIG" AS112SummaryEdnsParamsQueryTypeTXT AS112SummaryEdnsParamsQueryType = "TXT" AS112SummaryEdnsParamsQueryTypeUinfo AS112SummaryEdnsParamsQueryType = "UINFO" AS112SummaryEdnsParamsQueryTypeUID AS112SummaryEdnsParamsQueryType = "UID" AS112SummaryEdnsParamsQueryTypeUnspec AS112SummaryEdnsParamsQueryType = "UNSPEC" AS112SummaryEdnsParamsQueryTypeURI AS112SummaryEdnsParamsQueryType = "URI" AS112SummaryEdnsParamsQueryTypeWks AS112SummaryEdnsParamsQueryType = "WKS" AS112SummaryEdnsParamsQueryTypeX25 AS112SummaryEdnsParamsQueryType = "X25" AS112SummaryEdnsParamsQueryTypeZonemd AS112SummaryEdnsParamsQueryType = "ZONEMD" )
func (AS112SummaryEdnsParamsQueryType) IsKnown ¶
func (r AS112SummaryEdnsParamsQueryType) IsKnown() bool
type AS112SummaryEdnsParamsResponseCode ¶
type AS112SummaryEdnsParamsResponseCode string
Filters results by DNS response code.
const ( AS112SummaryEdnsParamsResponseCodeNoerror AS112SummaryEdnsParamsResponseCode = "NOERROR" AS112SummaryEdnsParamsResponseCodeFormerr AS112SummaryEdnsParamsResponseCode = "FORMERR" AS112SummaryEdnsParamsResponseCodeServfail AS112SummaryEdnsParamsResponseCode = "SERVFAIL" AS112SummaryEdnsParamsResponseCodeNxdomain AS112SummaryEdnsParamsResponseCode = "NXDOMAIN" AS112SummaryEdnsParamsResponseCodeNotimp AS112SummaryEdnsParamsResponseCode = "NOTIMP" AS112SummaryEdnsParamsResponseCodeRefused AS112SummaryEdnsParamsResponseCode = "REFUSED" AS112SummaryEdnsParamsResponseCodeYxdomain AS112SummaryEdnsParamsResponseCode = "YXDOMAIN" AS112SummaryEdnsParamsResponseCodeYxrrset AS112SummaryEdnsParamsResponseCode = "YXRRSET" AS112SummaryEdnsParamsResponseCodeNxrrset AS112SummaryEdnsParamsResponseCode = "NXRRSET" AS112SummaryEdnsParamsResponseCodeNotauth AS112SummaryEdnsParamsResponseCode = "NOTAUTH" AS112SummaryEdnsParamsResponseCodeNotzone AS112SummaryEdnsParamsResponseCode = "NOTZONE" AS112SummaryEdnsParamsResponseCodeBadsig AS112SummaryEdnsParamsResponseCode = "BADSIG" AS112SummaryEdnsParamsResponseCodeBadkey AS112SummaryEdnsParamsResponseCode = "BADKEY" AS112SummaryEdnsParamsResponseCodeBadtime AS112SummaryEdnsParamsResponseCode = "BADTIME" AS112SummaryEdnsParamsResponseCodeBadmode AS112SummaryEdnsParamsResponseCode = "BADMODE" AS112SummaryEdnsParamsResponseCodeBadname AS112SummaryEdnsParamsResponseCode = "BADNAME" AS112SummaryEdnsParamsResponseCodeBadalg AS112SummaryEdnsParamsResponseCode = "BADALG" AS112SummaryEdnsParamsResponseCodeBadtrunc AS112SummaryEdnsParamsResponseCode = "BADTRUNC" )
func (AS112SummaryEdnsParamsResponseCode) IsKnown ¶
func (r AS112SummaryEdnsParamsResponseCode) IsKnown() bool
type AS112SummaryEdnsResponse ¶
type AS112SummaryEdnsResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112SummaryEdnsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112SummaryEdnsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112SummaryEdnsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112SummaryEdnsResponseMetaUnit `json:"units,required"`
JSON as112SummaryEdnsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112SummaryEdnsResponseMeta) UnmarshalJSON ¶
func (r *AS112SummaryEdnsResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112SummaryEdnsResponseMetaConfidenceInfo ¶
type AS112SummaryEdnsResponseMetaConfidenceInfo struct {
Annotations []AS112SummaryEdnsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112SummaryEdnsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 AS112SummaryEdnsResponseMetaNormalization ¶
type AS112SummaryEdnsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112SummaryEdnsResponseMetaNormalizationPercentage AS112SummaryEdnsResponseMetaNormalization = "PERCENTAGE" AS112SummaryEdnsResponseMetaNormalizationMin0Max AS112SummaryEdnsResponseMetaNormalization = "MIN0_MAX" AS112SummaryEdnsResponseMetaNormalizationMinMax AS112SummaryEdnsResponseMetaNormalization = "MIN_MAX" AS112SummaryEdnsResponseMetaNormalizationRawValues AS112SummaryEdnsResponseMetaNormalization = "RAW_VALUES" AS112SummaryEdnsResponseMetaNormalizationPercentageChange AS112SummaryEdnsResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112SummaryEdnsResponseMetaNormalizationRollingAverage AS112SummaryEdnsResponseMetaNormalization = "ROLLING_AVERAGE" AS112SummaryEdnsResponseMetaNormalizationOverlappedPercentage AS112SummaryEdnsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112SummaryEdnsResponseMetaNormalizationRatio AS112SummaryEdnsResponseMetaNormalization = "RATIO" )
func (AS112SummaryEdnsResponseMetaNormalization) IsKnown ¶
func (r AS112SummaryEdnsResponseMetaNormalization) IsKnown() bool
type AS112SummaryEdnsResponseMetaUnit ¶
type AS112SummaryEdnsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112SummaryEdnsResponseMetaUnitJSON `json:"-"`
}
func (*AS112SummaryEdnsResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112SummaryEdnsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112SummaryEdnsResponseSummary0 ¶
type AS112SummaryEdnsResponseSummary0 struct {
// A numeric string.
NotSupported string `json:"NOT_SUPPORTED,required"`
// A numeric string.
Supported string `json:"SUPPORTED,required"`
JSON as112SummaryEdnsResponseSummary0JSON `json:"-"`
}
func (*AS112SummaryEdnsResponseSummary0) UnmarshalJSON ¶
func (r *AS112SummaryEdnsResponseSummary0) UnmarshalJSON(data []byte) (err error)
type AS112SummaryIPVersionParams ¶
type AS112SummaryIPVersionParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112SummaryIPVersionParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112SummaryIPVersionParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112SummaryIPVersionParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112SummaryIPVersionParamsResponseCode] `query:"responseCode"`
}
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 in which results will be returned.
const ( AS112SummaryIPVersionParamsFormatJson AS112SummaryIPVersionParamsFormat = "JSON" AS112SummaryIPVersionParamsFormatCsv AS112SummaryIPVersionParamsFormat = "CSV" )
func (AS112SummaryIPVersionParamsFormat) IsKnown ¶
func (r AS112SummaryIPVersionParamsFormat) IsKnown() bool
type AS112SummaryIPVersionParamsProtocol ¶
type AS112SummaryIPVersionParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112SummaryIPVersionParamsProtocolUdp AS112SummaryIPVersionParamsProtocol = "UDP" AS112SummaryIPVersionParamsProtocolTCP AS112SummaryIPVersionParamsProtocol = "TCP" AS112SummaryIPVersionParamsProtocolHTTPS AS112SummaryIPVersionParamsProtocol = "HTTPS" AS112SummaryIPVersionParamsProtocolTLS AS112SummaryIPVersionParamsProtocol = "TLS" )
func (AS112SummaryIPVersionParamsProtocol) IsKnown ¶
func (r AS112SummaryIPVersionParamsProtocol) IsKnown() bool
type AS112SummaryIPVersionParamsQueryType ¶
type AS112SummaryIPVersionParamsQueryType string
Filters results by DNS query type.
const ( AS112SummaryIPVersionParamsQueryTypeA AS112SummaryIPVersionParamsQueryType = "A" AS112SummaryIPVersionParamsQueryTypeAAAA AS112SummaryIPVersionParamsQueryType = "AAAA" AS112SummaryIPVersionParamsQueryTypeA6 AS112SummaryIPVersionParamsQueryType = "A6" AS112SummaryIPVersionParamsQueryTypeAfsdb AS112SummaryIPVersionParamsQueryType = "AFSDB" AS112SummaryIPVersionParamsQueryTypeAny AS112SummaryIPVersionParamsQueryType = "ANY" AS112SummaryIPVersionParamsQueryTypeApl AS112SummaryIPVersionParamsQueryType = "APL" AS112SummaryIPVersionParamsQueryTypeAtma AS112SummaryIPVersionParamsQueryType = "ATMA" AS112SummaryIPVersionParamsQueryTypeAXFR AS112SummaryIPVersionParamsQueryType = "AXFR" AS112SummaryIPVersionParamsQueryTypeCAA AS112SummaryIPVersionParamsQueryType = "CAA" AS112SummaryIPVersionParamsQueryTypeCdnskey AS112SummaryIPVersionParamsQueryType = "CDNSKEY" AS112SummaryIPVersionParamsQueryTypeCds AS112SummaryIPVersionParamsQueryType = "CDS" AS112SummaryIPVersionParamsQueryTypeCERT AS112SummaryIPVersionParamsQueryType = "CERT" AS112SummaryIPVersionParamsQueryTypeCNAME AS112SummaryIPVersionParamsQueryType = "CNAME" AS112SummaryIPVersionParamsQueryTypeCsync AS112SummaryIPVersionParamsQueryType = "CSYNC" AS112SummaryIPVersionParamsQueryTypeDhcid AS112SummaryIPVersionParamsQueryType = "DHCID" AS112SummaryIPVersionParamsQueryTypeDlv AS112SummaryIPVersionParamsQueryType = "DLV" AS112SummaryIPVersionParamsQueryTypeDname AS112SummaryIPVersionParamsQueryType = "DNAME" AS112SummaryIPVersionParamsQueryTypeDNSKEY AS112SummaryIPVersionParamsQueryType = "DNSKEY" AS112SummaryIPVersionParamsQueryTypeDoa AS112SummaryIPVersionParamsQueryType = "DOA" AS112SummaryIPVersionParamsQueryTypeDS AS112SummaryIPVersionParamsQueryType = "DS" AS112SummaryIPVersionParamsQueryTypeEid AS112SummaryIPVersionParamsQueryType = "EID" AS112SummaryIPVersionParamsQueryTypeEui48 AS112SummaryIPVersionParamsQueryType = "EUI48" AS112SummaryIPVersionParamsQueryTypeEui64 AS112SummaryIPVersionParamsQueryType = "EUI64" AS112SummaryIPVersionParamsQueryTypeGpos AS112SummaryIPVersionParamsQueryType = "GPOS" AS112SummaryIPVersionParamsQueryTypeGid AS112SummaryIPVersionParamsQueryType = "GID" AS112SummaryIPVersionParamsQueryTypeHinfo AS112SummaryIPVersionParamsQueryType = "HINFO" AS112SummaryIPVersionParamsQueryTypeHip AS112SummaryIPVersionParamsQueryType = "HIP" AS112SummaryIPVersionParamsQueryTypeHTTPS AS112SummaryIPVersionParamsQueryType = "HTTPS" AS112SummaryIPVersionParamsQueryTypeIpseckey AS112SummaryIPVersionParamsQueryType = "IPSECKEY" AS112SummaryIPVersionParamsQueryTypeIsdn AS112SummaryIPVersionParamsQueryType = "ISDN" AS112SummaryIPVersionParamsQueryTypeIxfr AS112SummaryIPVersionParamsQueryType = "IXFR" AS112SummaryIPVersionParamsQueryTypeKey AS112SummaryIPVersionParamsQueryType = "KEY" AS112SummaryIPVersionParamsQueryTypeKx AS112SummaryIPVersionParamsQueryType = "KX" AS112SummaryIPVersionParamsQueryTypeL32 AS112SummaryIPVersionParamsQueryType = "L32" AS112SummaryIPVersionParamsQueryTypeL64 AS112SummaryIPVersionParamsQueryType = "L64" AS112SummaryIPVersionParamsQueryTypeLOC AS112SummaryIPVersionParamsQueryType = "LOC" AS112SummaryIPVersionParamsQueryTypeLp AS112SummaryIPVersionParamsQueryType = "LP" AS112SummaryIPVersionParamsQueryTypeMaila AS112SummaryIPVersionParamsQueryType = "MAILA" AS112SummaryIPVersionParamsQueryTypeMailb AS112SummaryIPVersionParamsQueryType = "MAILB" AS112SummaryIPVersionParamsQueryTypeMB AS112SummaryIPVersionParamsQueryType = "MB" AS112SummaryIPVersionParamsQueryTypeMd AS112SummaryIPVersionParamsQueryType = "MD" AS112SummaryIPVersionParamsQueryTypeMf AS112SummaryIPVersionParamsQueryType = "MF" AS112SummaryIPVersionParamsQueryTypeMg AS112SummaryIPVersionParamsQueryType = "MG" AS112SummaryIPVersionParamsQueryTypeMinfo AS112SummaryIPVersionParamsQueryType = "MINFO" AS112SummaryIPVersionParamsQueryTypeMr AS112SummaryIPVersionParamsQueryType = "MR" AS112SummaryIPVersionParamsQueryTypeMX AS112SummaryIPVersionParamsQueryType = "MX" AS112SummaryIPVersionParamsQueryTypeNAPTR AS112SummaryIPVersionParamsQueryType = "NAPTR" AS112SummaryIPVersionParamsQueryTypeNb AS112SummaryIPVersionParamsQueryType = "NB" AS112SummaryIPVersionParamsQueryTypeNbstat AS112SummaryIPVersionParamsQueryType = "NBSTAT" AS112SummaryIPVersionParamsQueryTypeNid AS112SummaryIPVersionParamsQueryType = "NID" AS112SummaryIPVersionParamsQueryTypeNimloc AS112SummaryIPVersionParamsQueryType = "NIMLOC" AS112SummaryIPVersionParamsQueryTypeNinfo AS112SummaryIPVersionParamsQueryType = "NINFO" AS112SummaryIPVersionParamsQueryTypeNS AS112SummaryIPVersionParamsQueryType = "NS" AS112SummaryIPVersionParamsQueryTypeNsap AS112SummaryIPVersionParamsQueryType = "NSAP" AS112SummaryIPVersionParamsQueryTypeNsec AS112SummaryIPVersionParamsQueryType = "NSEC" AS112SummaryIPVersionParamsQueryTypeNsec3 AS112SummaryIPVersionParamsQueryType = "NSEC3" AS112SummaryIPVersionParamsQueryTypeNsec3Param AS112SummaryIPVersionParamsQueryType = "NSEC3PARAM" AS112SummaryIPVersionParamsQueryTypeNull AS112SummaryIPVersionParamsQueryType = "NULL" AS112SummaryIPVersionParamsQueryTypeNxt AS112SummaryIPVersionParamsQueryType = "NXT" AS112SummaryIPVersionParamsQueryTypeOpenpgpkey AS112SummaryIPVersionParamsQueryType = "OPENPGPKEY" AS112SummaryIPVersionParamsQueryTypeOpt AS112SummaryIPVersionParamsQueryType = "OPT" AS112SummaryIPVersionParamsQueryTypePTR AS112SummaryIPVersionParamsQueryType = "PTR" AS112SummaryIPVersionParamsQueryTypePx AS112SummaryIPVersionParamsQueryType = "PX" AS112SummaryIPVersionParamsQueryTypeRkey AS112SummaryIPVersionParamsQueryType = "RKEY" AS112SummaryIPVersionParamsQueryTypeRp AS112SummaryIPVersionParamsQueryType = "RP" AS112SummaryIPVersionParamsQueryTypeRrsig AS112SummaryIPVersionParamsQueryType = "RRSIG" AS112SummaryIPVersionParamsQueryTypeRt AS112SummaryIPVersionParamsQueryType = "RT" AS112SummaryIPVersionParamsQueryTypeSig AS112SummaryIPVersionParamsQueryType = "SIG" AS112SummaryIPVersionParamsQueryTypeSink AS112SummaryIPVersionParamsQueryType = "SINK" AS112SummaryIPVersionParamsQueryTypeSMIMEA AS112SummaryIPVersionParamsQueryType = "SMIMEA" AS112SummaryIPVersionParamsQueryTypeSOA AS112SummaryIPVersionParamsQueryType = "SOA" AS112SummaryIPVersionParamsQueryTypeSPF AS112SummaryIPVersionParamsQueryType = "SPF" AS112SummaryIPVersionParamsQueryTypeSRV AS112SummaryIPVersionParamsQueryType = "SRV" AS112SummaryIPVersionParamsQueryTypeSSHFP AS112SummaryIPVersionParamsQueryType = "SSHFP" AS112SummaryIPVersionParamsQueryTypeSVCB AS112SummaryIPVersionParamsQueryType = "SVCB" AS112SummaryIPVersionParamsQueryTypeTa AS112SummaryIPVersionParamsQueryType = "TA" AS112SummaryIPVersionParamsQueryTypeTalink AS112SummaryIPVersionParamsQueryType = "TALINK" AS112SummaryIPVersionParamsQueryTypeTkey AS112SummaryIPVersionParamsQueryType = "TKEY" AS112SummaryIPVersionParamsQueryTypeTLSA AS112SummaryIPVersionParamsQueryType = "TLSA" AS112SummaryIPVersionParamsQueryTypeTSIG AS112SummaryIPVersionParamsQueryType = "TSIG" AS112SummaryIPVersionParamsQueryTypeTXT AS112SummaryIPVersionParamsQueryType = "TXT" AS112SummaryIPVersionParamsQueryTypeUinfo AS112SummaryIPVersionParamsQueryType = "UINFO" AS112SummaryIPVersionParamsQueryTypeUID AS112SummaryIPVersionParamsQueryType = "UID" AS112SummaryIPVersionParamsQueryTypeUnspec AS112SummaryIPVersionParamsQueryType = "UNSPEC" AS112SummaryIPVersionParamsQueryTypeURI AS112SummaryIPVersionParamsQueryType = "URI" AS112SummaryIPVersionParamsQueryTypeWks AS112SummaryIPVersionParamsQueryType = "WKS" AS112SummaryIPVersionParamsQueryTypeX25 AS112SummaryIPVersionParamsQueryType = "X25" AS112SummaryIPVersionParamsQueryTypeZonemd AS112SummaryIPVersionParamsQueryType = "ZONEMD" )
func (AS112SummaryIPVersionParamsQueryType) IsKnown ¶
func (r AS112SummaryIPVersionParamsQueryType) IsKnown() bool
type AS112SummaryIPVersionParamsResponseCode ¶
type AS112SummaryIPVersionParamsResponseCode string
Filters results by DNS response code.
const ( AS112SummaryIPVersionParamsResponseCodeNoerror AS112SummaryIPVersionParamsResponseCode = "NOERROR" AS112SummaryIPVersionParamsResponseCodeFormerr AS112SummaryIPVersionParamsResponseCode = "FORMERR" AS112SummaryIPVersionParamsResponseCodeServfail AS112SummaryIPVersionParamsResponseCode = "SERVFAIL" AS112SummaryIPVersionParamsResponseCodeNxdomain AS112SummaryIPVersionParamsResponseCode = "NXDOMAIN" AS112SummaryIPVersionParamsResponseCodeNotimp AS112SummaryIPVersionParamsResponseCode = "NOTIMP" AS112SummaryIPVersionParamsResponseCodeRefused AS112SummaryIPVersionParamsResponseCode = "REFUSED" AS112SummaryIPVersionParamsResponseCodeYxdomain AS112SummaryIPVersionParamsResponseCode = "YXDOMAIN" AS112SummaryIPVersionParamsResponseCodeYxrrset AS112SummaryIPVersionParamsResponseCode = "YXRRSET" AS112SummaryIPVersionParamsResponseCodeNxrrset AS112SummaryIPVersionParamsResponseCode = "NXRRSET" AS112SummaryIPVersionParamsResponseCodeNotauth AS112SummaryIPVersionParamsResponseCode = "NOTAUTH" AS112SummaryIPVersionParamsResponseCodeNotzone AS112SummaryIPVersionParamsResponseCode = "NOTZONE" AS112SummaryIPVersionParamsResponseCodeBadsig AS112SummaryIPVersionParamsResponseCode = "BADSIG" AS112SummaryIPVersionParamsResponseCodeBadkey AS112SummaryIPVersionParamsResponseCode = "BADKEY" AS112SummaryIPVersionParamsResponseCodeBadtime AS112SummaryIPVersionParamsResponseCode = "BADTIME" AS112SummaryIPVersionParamsResponseCodeBadmode AS112SummaryIPVersionParamsResponseCode = "BADMODE" AS112SummaryIPVersionParamsResponseCodeBadname AS112SummaryIPVersionParamsResponseCode = "BADNAME" AS112SummaryIPVersionParamsResponseCodeBadalg AS112SummaryIPVersionParamsResponseCode = "BADALG" AS112SummaryIPVersionParamsResponseCodeBadtrunc AS112SummaryIPVersionParamsResponseCode = "BADTRUNC" )
func (AS112SummaryIPVersionParamsResponseCode) IsKnown ¶
func (r AS112SummaryIPVersionParamsResponseCode) IsKnown() bool
type AS112SummaryIPVersionResponse ¶
type AS112SummaryIPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112SummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112SummaryIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112SummaryIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112SummaryIPVersionResponseMetaUnit `json:"units,required"`
JSON as112SummaryIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112SummaryIPVersionResponseMeta) UnmarshalJSON ¶
func (r *AS112SummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112SummaryIPVersionResponseMetaConfidenceInfo ¶
type AS112SummaryIPVersionResponseMetaConfidenceInfo struct {
Annotations []AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112SummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AS112SummaryIPVersionResponseMetaNormalization ¶
type AS112SummaryIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112SummaryIPVersionResponseMetaNormalizationPercentage AS112SummaryIPVersionResponseMetaNormalization = "PERCENTAGE" AS112SummaryIPVersionResponseMetaNormalizationMin0Max AS112SummaryIPVersionResponseMetaNormalization = "MIN0_MAX" AS112SummaryIPVersionResponseMetaNormalizationMinMax AS112SummaryIPVersionResponseMetaNormalization = "MIN_MAX" AS112SummaryIPVersionResponseMetaNormalizationRawValues AS112SummaryIPVersionResponseMetaNormalization = "RAW_VALUES" AS112SummaryIPVersionResponseMetaNormalizationPercentageChange AS112SummaryIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112SummaryIPVersionResponseMetaNormalizationRollingAverage AS112SummaryIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AS112SummaryIPVersionResponseMetaNormalizationOverlappedPercentage AS112SummaryIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112SummaryIPVersionResponseMetaNormalizationRatio AS112SummaryIPVersionResponseMetaNormalization = "RATIO" )
func (AS112SummaryIPVersionResponseMetaNormalization) IsKnown ¶
func (r AS112SummaryIPVersionResponseMetaNormalization) IsKnown() bool
type AS112SummaryIPVersionResponseMetaUnit ¶
type AS112SummaryIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112SummaryIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AS112SummaryIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112SummaryIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112SummaryIPVersionResponseSummary0 ¶
type AS112SummaryIPVersionResponseSummary0 struct {
// A numeric string.
IPv4 string `json:"IPv4,required"`
// A numeric string.
IPv6 string `json:"IPv6,required"`
JSON as112SummaryIPVersionResponseSummary0JSON `json:"-"`
}
func (*AS112SummaryIPVersionResponseSummary0) UnmarshalJSON ¶
func (r *AS112SummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)
type AS112SummaryProtocolParams ¶
type AS112SummaryProtocolParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112SummaryProtocolParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS query type.
QueryType param.Field[AS112SummaryProtocolParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112SummaryProtocolParamsResponseCode] `query:"responseCode"`
}
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 in which results will be returned.
const ( AS112SummaryProtocolParamsFormatJson AS112SummaryProtocolParamsFormat = "JSON" AS112SummaryProtocolParamsFormatCsv AS112SummaryProtocolParamsFormat = "CSV" )
func (AS112SummaryProtocolParamsFormat) IsKnown ¶
func (r AS112SummaryProtocolParamsFormat) IsKnown() bool
type AS112SummaryProtocolParamsQueryType ¶
type AS112SummaryProtocolParamsQueryType string
Filters results by DNS query type.
const ( AS112SummaryProtocolParamsQueryTypeA AS112SummaryProtocolParamsQueryType = "A" AS112SummaryProtocolParamsQueryTypeAAAA AS112SummaryProtocolParamsQueryType = "AAAA" AS112SummaryProtocolParamsQueryTypeA6 AS112SummaryProtocolParamsQueryType = "A6" AS112SummaryProtocolParamsQueryTypeAfsdb AS112SummaryProtocolParamsQueryType = "AFSDB" AS112SummaryProtocolParamsQueryTypeAny AS112SummaryProtocolParamsQueryType = "ANY" AS112SummaryProtocolParamsQueryTypeApl AS112SummaryProtocolParamsQueryType = "APL" AS112SummaryProtocolParamsQueryTypeAtma AS112SummaryProtocolParamsQueryType = "ATMA" AS112SummaryProtocolParamsQueryTypeAXFR AS112SummaryProtocolParamsQueryType = "AXFR" AS112SummaryProtocolParamsQueryTypeCAA AS112SummaryProtocolParamsQueryType = "CAA" AS112SummaryProtocolParamsQueryTypeCdnskey AS112SummaryProtocolParamsQueryType = "CDNSKEY" AS112SummaryProtocolParamsQueryTypeCds AS112SummaryProtocolParamsQueryType = "CDS" AS112SummaryProtocolParamsQueryTypeCERT AS112SummaryProtocolParamsQueryType = "CERT" AS112SummaryProtocolParamsQueryTypeCNAME AS112SummaryProtocolParamsQueryType = "CNAME" AS112SummaryProtocolParamsQueryTypeCsync AS112SummaryProtocolParamsQueryType = "CSYNC" AS112SummaryProtocolParamsQueryTypeDhcid AS112SummaryProtocolParamsQueryType = "DHCID" AS112SummaryProtocolParamsQueryTypeDlv AS112SummaryProtocolParamsQueryType = "DLV" AS112SummaryProtocolParamsQueryTypeDname AS112SummaryProtocolParamsQueryType = "DNAME" AS112SummaryProtocolParamsQueryTypeDNSKEY AS112SummaryProtocolParamsQueryType = "DNSKEY" AS112SummaryProtocolParamsQueryTypeDoa AS112SummaryProtocolParamsQueryType = "DOA" AS112SummaryProtocolParamsQueryTypeDS AS112SummaryProtocolParamsQueryType = "DS" AS112SummaryProtocolParamsQueryTypeEid AS112SummaryProtocolParamsQueryType = "EID" AS112SummaryProtocolParamsQueryTypeEui48 AS112SummaryProtocolParamsQueryType = "EUI48" AS112SummaryProtocolParamsQueryTypeEui64 AS112SummaryProtocolParamsQueryType = "EUI64" AS112SummaryProtocolParamsQueryTypeGpos AS112SummaryProtocolParamsQueryType = "GPOS" AS112SummaryProtocolParamsQueryTypeGid AS112SummaryProtocolParamsQueryType = "GID" AS112SummaryProtocolParamsQueryTypeHinfo AS112SummaryProtocolParamsQueryType = "HINFO" AS112SummaryProtocolParamsQueryTypeHip AS112SummaryProtocolParamsQueryType = "HIP" AS112SummaryProtocolParamsQueryTypeHTTPS AS112SummaryProtocolParamsQueryType = "HTTPS" AS112SummaryProtocolParamsQueryTypeIpseckey AS112SummaryProtocolParamsQueryType = "IPSECKEY" AS112SummaryProtocolParamsQueryTypeIsdn AS112SummaryProtocolParamsQueryType = "ISDN" AS112SummaryProtocolParamsQueryTypeIxfr AS112SummaryProtocolParamsQueryType = "IXFR" AS112SummaryProtocolParamsQueryTypeKey AS112SummaryProtocolParamsQueryType = "KEY" AS112SummaryProtocolParamsQueryTypeKx AS112SummaryProtocolParamsQueryType = "KX" AS112SummaryProtocolParamsQueryTypeL32 AS112SummaryProtocolParamsQueryType = "L32" AS112SummaryProtocolParamsQueryTypeL64 AS112SummaryProtocolParamsQueryType = "L64" AS112SummaryProtocolParamsQueryTypeLOC AS112SummaryProtocolParamsQueryType = "LOC" AS112SummaryProtocolParamsQueryTypeLp AS112SummaryProtocolParamsQueryType = "LP" AS112SummaryProtocolParamsQueryTypeMaila AS112SummaryProtocolParamsQueryType = "MAILA" AS112SummaryProtocolParamsQueryTypeMailb AS112SummaryProtocolParamsQueryType = "MAILB" AS112SummaryProtocolParamsQueryTypeMB AS112SummaryProtocolParamsQueryType = "MB" AS112SummaryProtocolParamsQueryTypeMd AS112SummaryProtocolParamsQueryType = "MD" AS112SummaryProtocolParamsQueryTypeMf AS112SummaryProtocolParamsQueryType = "MF" AS112SummaryProtocolParamsQueryTypeMg AS112SummaryProtocolParamsQueryType = "MG" AS112SummaryProtocolParamsQueryTypeMinfo AS112SummaryProtocolParamsQueryType = "MINFO" AS112SummaryProtocolParamsQueryTypeMr AS112SummaryProtocolParamsQueryType = "MR" AS112SummaryProtocolParamsQueryTypeMX AS112SummaryProtocolParamsQueryType = "MX" AS112SummaryProtocolParamsQueryTypeNAPTR AS112SummaryProtocolParamsQueryType = "NAPTR" AS112SummaryProtocolParamsQueryTypeNb AS112SummaryProtocolParamsQueryType = "NB" AS112SummaryProtocolParamsQueryTypeNbstat AS112SummaryProtocolParamsQueryType = "NBSTAT" AS112SummaryProtocolParamsQueryTypeNid AS112SummaryProtocolParamsQueryType = "NID" AS112SummaryProtocolParamsQueryTypeNimloc AS112SummaryProtocolParamsQueryType = "NIMLOC" AS112SummaryProtocolParamsQueryTypeNinfo AS112SummaryProtocolParamsQueryType = "NINFO" AS112SummaryProtocolParamsQueryTypeNS AS112SummaryProtocolParamsQueryType = "NS" AS112SummaryProtocolParamsQueryTypeNsap AS112SummaryProtocolParamsQueryType = "NSAP" AS112SummaryProtocolParamsQueryTypeNsec AS112SummaryProtocolParamsQueryType = "NSEC" AS112SummaryProtocolParamsQueryTypeNsec3 AS112SummaryProtocolParamsQueryType = "NSEC3" AS112SummaryProtocolParamsQueryTypeNsec3Param AS112SummaryProtocolParamsQueryType = "NSEC3PARAM" AS112SummaryProtocolParamsQueryTypeNull AS112SummaryProtocolParamsQueryType = "NULL" AS112SummaryProtocolParamsQueryTypeNxt AS112SummaryProtocolParamsQueryType = "NXT" AS112SummaryProtocolParamsQueryTypeOpenpgpkey AS112SummaryProtocolParamsQueryType = "OPENPGPKEY" AS112SummaryProtocolParamsQueryTypeOpt AS112SummaryProtocolParamsQueryType = "OPT" AS112SummaryProtocolParamsQueryTypePTR AS112SummaryProtocolParamsQueryType = "PTR" AS112SummaryProtocolParamsQueryTypePx AS112SummaryProtocolParamsQueryType = "PX" AS112SummaryProtocolParamsQueryTypeRkey AS112SummaryProtocolParamsQueryType = "RKEY" AS112SummaryProtocolParamsQueryTypeRp AS112SummaryProtocolParamsQueryType = "RP" AS112SummaryProtocolParamsQueryTypeRrsig AS112SummaryProtocolParamsQueryType = "RRSIG" AS112SummaryProtocolParamsQueryTypeRt AS112SummaryProtocolParamsQueryType = "RT" AS112SummaryProtocolParamsQueryTypeSig AS112SummaryProtocolParamsQueryType = "SIG" AS112SummaryProtocolParamsQueryTypeSink AS112SummaryProtocolParamsQueryType = "SINK" AS112SummaryProtocolParamsQueryTypeSMIMEA AS112SummaryProtocolParamsQueryType = "SMIMEA" AS112SummaryProtocolParamsQueryTypeSOA AS112SummaryProtocolParamsQueryType = "SOA" AS112SummaryProtocolParamsQueryTypeSPF AS112SummaryProtocolParamsQueryType = "SPF" AS112SummaryProtocolParamsQueryTypeSRV AS112SummaryProtocolParamsQueryType = "SRV" AS112SummaryProtocolParamsQueryTypeSSHFP AS112SummaryProtocolParamsQueryType = "SSHFP" AS112SummaryProtocolParamsQueryTypeSVCB AS112SummaryProtocolParamsQueryType = "SVCB" AS112SummaryProtocolParamsQueryTypeTa AS112SummaryProtocolParamsQueryType = "TA" AS112SummaryProtocolParamsQueryTypeTalink AS112SummaryProtocolParamsQueryType = "TALINK" AS112SummaryProtocolParamsQueryTypeTkey AS112SummaryProtocolParamsQueryType = "TKEY" AS112SummaryProtocolParamsQueryTypeTLSA AS112SummaryProtocolParamsQueryType = "TLSA" AS112SummaryProtocolParamsQueryTypeTSIG AS112SummaryProtocolParamsQueryType = "TSIG" AS112SummaryProtocolParamsQueryTypeTXT AS112SummaryProtocolParamsQueryType = "TXT" AS112SummaryProtocolParamsQueryTypeUinfo AS112SummaryProtocolParamsQueryType = "UINFO" AS112SummaryProtocolParamsQueryTypeUID AS112SummaryProtocolParamsQueryType = "UID" AS112SummaryProtocolParamsQueryTypeUnspec AS112SummaryProtocolParamsQueryType = "UNSPEC" AS112SummaryProtocolParamsQueryTypeURI AS112SummaryProtocolParamsQueryType = "URI" AS112SummaryProtocolParamsQueryTypeWks AS112SummaryProtocolParamsQueryType = "WKS" AS112SummaryProtocolParamsQueryTypeX25 AS112SummaryProtocolParamsQueryType = "X25" AS112SummaryProtocolParamsQueryTypeZonemd AS112SummaryProtocolParamsQueryType = "ZONEMD" )
func (AS112SummaryProtocolParamsQueryType) IsKnown ¶
func (r AS112SummaryProtocolParamsQueryType) IsKnown() bool
type AS112SummaryProtocolParamsResponseCode ¶
type AS112SummaryProtocolParamsResponseCode string
Filters results by DNS response code.
const ( AS112SummaryProtocolParamsResponseCodeNoerror AS112SummaryProtocolParamsResponseCode = "NOERROR" AS112SummaryProtocolParamsResponseCodeFormerr AS112SummaryProtocolParamsResponseCode = "FORMERR" AS112SummaryProtocolParamsResponseCodeServfail AS112SummaryProtocolParamsResponseCode = "SERVFAIL" AS112SummaryProtocolParamsResponseCodeNxdomain AS112SummaryProtocolParamsResponseCode = "NXDOMAIN" AS112SummaryProtocolParamsResponseCodeNotimp AS112SummaryProtocolParamsResponseCode = "NOTIMP" AS112SummaryProtocolParamsResponseCodeRefused AS112SummaryProtocolParamsResponseCode = "REFUSED" AS112SummaryProtocolParamsResponseCodeYxdomain AS112SummaryProtocolParamsResponseCode = "YXDOMAIN" AS112SummaryProtocolParamsResponseCodeYxrrset AS112SummaryProtocolParamsResponseCode = "YXRRSET" AS112SummaryProtocolParamsResponseCodeNxrrset AS112SummaryProtocolParamsResponseCode = "NXRRSET" AS112SummaryProtocolParamsResponseCodeNotauth AS112SummaryProtocolParamsResponseCode = "NOTAUTH" AS112SummaryProtocolParamsResponseCodeNotzone AS112SummaryProtocolParamsResponseCode = "NOTZONE" AS112SummaryProtocolParamsResponseCodeBadsig AS112SummaryProtocolParamsResponseCode = "BADSIG" AS112SummaryProtocolParamsResponseCodeBadkey AS112SummaryProtocolParamsResponseCode = "BADKEY" AS112SummaryProtocolParamsResponseCodeBadtime AS112SummaryProtocolParamsResponseCode = "BADTIME" AS112SummaryProtocolParamsResponseCodeBadmode AS112SummaryProtocolParamsResponseCode = "BADMODE" AS112SummaryProtocolParamsResponseCodeBadname AS112SummaryProtocolParamsResponseCode = "BADNAME" AS112SummaryProtocolParamsResponseCodeBadalg AS112SummaryProtocolParamsResponseCode = "BADALG" AS112SummaryProtocolParamsResponseCodeBadtrunc AS112SummaryProtocolParamsResponseCode = "BADTRUNC" )
func (AS112SummaryProtocolParamsResponseCode) IsKnown ¶
func (r AS112SummaryProtocolParamsResponseCode) IsKnown() bool
type AS112SummaryProtocolResponse ¶
type AS112SummaryProtocolResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112SummaryProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112SummaryProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112SummaryProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112SummaryProtocolResponseMetaUnit `json:"units,required"`
JSON as112SummaryProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112SummaryProtocolResponseMeta) UnmarshalJSON ¶
func (r *AS112SummaryProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112SummaryProtocolResponseMetaConfidenceInfo ¶
type AS112SummaryProtocolResponseMetaConfidenceInfo struct {
Annotations []AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112SummaryProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112SummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AS112SummaryProtocolResponseMetaNormalization ¶
type AS112SummaryProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112SummaryProtocolResponseMetaNormalizationPercentage AS112SummaryProtocolResponseMetaNormalization = "PERCENTAGE" AS112SummaryProtocolResponseMetaNormalizationMin0Max AS112SummaryProtocolResponseMetaNormalization = "MIN0_MAX" AS112SummaryProtocolResponseMetaNormalizationMinMax AS112SummaryProtocolResponseMetaNormalization = "MIN_MAX" AS112SummaryProtocolResponseMetaNormalizationRawValues AS112SummaryProtocolResponseMetaNormalization = "RAW_VALUES" AS112SummaryProtocolResponseMetaNormalizationPercentageChange AS112SummaryProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112SummaryProtocolResponseMetaNormalizationRollingAverage AS112SummaryProtocolResponseMetaNormalization = "ROLLING_AVERAGE" AS112SummaryProtocolResponseMetaNormalizationOverlappedPercentage AS112SummaryProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112SummaryProtocolResponseMetaNormalizationRatio AS112SummaryProtocolResponseMetaNormalization = "RATIO" )
func (AS112SummaryProtocolResponseMetaNormalization) IsKnown ¶
func (r AS112SummaryProtocolResponseMetaNormalization) IsKnown() bool
type AS112SummaryProtocolResponseMetaUnit ¶
type AS112SummaryProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112SummaryProtocolResponseMetaUnitJSON `json:"-"`
}
func (*AS112SummaryProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112SummaryProtocolResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112SummaryProtocolResponseSummary0 ¶
type AS112SummaryProtocolResponseSummary0 struct {
// A numeric string.
HTTPS string `json:"HTTPS,required"`
// A numeric string.
TCP string `json:"TCP,required"`
// A numeric string.
TLS string `json:"TLS,required"`
// A numeric string.
Udp string `json:"UDP,required"`
JSON as112SummaryProtocolResponseSummary0JSON `json:"-"`
}
func (*AS112SummaryProtocolResponseSummary0) UnmarshalJSON ¶
func (r *AS112SummaryProtocolResponseSummary0) UnmarshalJSON(data []byte) (err error)
type AS112SummaryQueryTypeParams ¶
type AS112SummaryQueryTypeParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112SummaryQueryTypeParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112SummaryQueryTypeParamsProtocol] `query:"protocol"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112SummaryQueryTypeParamsResponseCode] `query:"responseCode"`
}
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 in which results will be returned.
const ( AS112SummaryQueryTypeParamsFormatJson AS112SummaryQueryTypeParamsFormat = "JSON" AS112SummaryQueryTypeParamsFormatCsv AS112SummaryQueryTypeParamsFormat = "CSV" )
func (AS112SummaryQueryTypeParamsFormat) IsKnown ¶
func (r AS112SummaryQueryTypeParamsFormat) IsKnown() bool
type AS112SummaryQueryTypeParamsProtocol ¶
type AS112SummaryQueryTypeParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112SummaryQueryTypeParamsProtocolUdp AS112SummaryQueryTypeParamsProtocol = "UDP" AS112SummaryQueryTypeParamsProtocolTCP AS112SummaryQueryTypeParamsProtocol = "TCP" AS112SummaryQueryTypeParamsProtocolHTTPS AS112SummaryQueryTypeParamsProtocol = "HTTPS" AS112SummaryQueryTypeParamsProtocolTLS AS112SummaryQueryTypeParamsProtocol = "TLS" )
func (AS112SummaryQueryTypeParamsProtocol) IsKnown ¶
func (r AS112SummaryQueryTypeParamsProtocol) IsKnown() bool
type AS112SummaryQueryTypeParamsResponseCode ¶
type AS112SummaryQueryTypeParamsResponseCode string
Filters results by DNS response code.
const ( AS112SummaryQueryTypeParamsResponseCodeNoerror AS112SummaryQueryTypeParamsResponseCode = "NOERROR" AS112SummaryQueryTypeParamsResponseCodeFormerr AS112SummaryQueryTypeParamsResponseCode = "FORMERR" AS112SummaryQueryTypeParamsResponseCodeServfail AS112SummaryQueryTypeParamsResponseCode = "SERVFAIL" AS112SummaryQueryTypeParamsResponseCodeNxdomain AS112SummaryQueryTypeParamsResponseCode = "NXDOMAIN" AS112SummaryQueryTypeParamsResponseCodeNotimp AS112SummaryQueryTypeParamsResponseCode = "NOTIMP" AS112SummaryQueryTypeParamsResponseCodeRefused AS112SummaryQueryTypeParamsResponseCode = "REFUSED" AS112SummaryQueryTypeParamsResponseCodeYxdomain AS112SummaryQueryTypeParamsResponseCode = "YXDOMAIN" AS112SummaryQueryTypeParamsResponseCodeYxrrset AS112SummaryQueryTypeParamsResponseCode = "YXRRSET" AS112SummaryQueryTypeParamsResponseCodeNxrrset AS112SummaryQueryTypeParamsResponseCode = "NXRRSET" AS112SummaryQueryTypeParamsResponseCodeNotauth AS112SummaryQueryTypeParamsResponseCode = "NOTAUTH" AS112SummaryQueryTypeParamsResponseCodeNotzone AS112SummaryQueryTypeParamsResponseCode = "NOTZONE" AS112SummaryQueryTypeParamsResponseCodeBadsig AS112SummaryQueryTypeParamsResponseCode = "BADSIG" AS112SummaryQueryTypeParamsResponseCodeBadkey AS112SummaryQueryTypeParamsResponseCode = "BADKEY" AS112SummaryQueryTypeParamsResponseCodeBadtime AS112SummaryQueryTypeParamsResponseCode = "BADTIME" AS112SummaryQueryTypeParamsResponseCodeBadmode AS112SummaryQueryTypeParamsResponseCode = "BADMODE" AS112SummaryQueryTypeParamsResponseCodeBadname AS112SummaryQueryTypeParamsResponseCode = "BADNAME" AS112SummaryQueryTypeParamsResponseCodeBadalg AS112SummaryQueryTypeParamsResponseCode = "BADALG" AS112SummaryQueryTypeParamsResponseCodeBadtrunc AS112SummaryQueryTypeParamsResponseCode = "BADTRUNC" )
func (AS112SummaryQueryTypeParamsResponseCode) IsKnown ¶
func (r AS112SummaryQueryTypeParamsResponseCode) IsKnown() bool
type AS112SummaryQueryTypeResponse ¶
type AS112SummaryQueryTypeResponse struct {
// Metadata for the results.
Meta AS112SummaryQueryTypeResponseMeta `json:"meta,required"`
Summary0 map[string]string `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 {
ConfidenceInfo AS112SummaryQueryTypeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112SummaryQueryTypeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112SummaryQueryTypeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112SummaryQueryTypeResponseMetaUnit `json:"units,required"`
JSON as112SummaryQueryTypeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112SummaryQueryTypeResponseMeta) UnmarshalJSON ¶
func (r *AS112SummaryQueryTypeResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112SummaryQueryTypeResponseMetaConfidenceInfo ¶
type AS112SummaryQueryTypeResponseMetaConfidenceInfo struct {
Annotations []AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112SummaryQueryTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112SummaryQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AS112SummaryQueryTypeResponseMetaNormalization ¶
type AS112SummaryQueryTypeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112SummaryQueryTypeResponseMetaNormalizationPercentage AS112SummaryQueryTypeResponseMetaNormalization = "PERCENTAGE" AS112SummaryQueryTypeResponseMetaNormalizationMin0Max AS112SummaryQueryTypeResponseMetaNormalization = "MIN0_MAX" AS112SummaryQueryTypeResponseMetaNormalizationMinMax AS112SummaryQueryTypeResponseMetaNormalization = "MIN_MAX" AS112SummaryQueryTypeResponseMetaNormalizationRawValues AS112SummaryQueryTypeResponseMetaNormalization = "RAW_VALUES" AS112SummaryQueryTypeResponseMetaNormalizationPercentageChange AS112SummaryQueryTypeResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112SummaryQueryTypeResponseMetaNormalizationRollingAverage AS112SummaryQueryTypeResponseMetaNormalization = "ROLLING_AVERAGE" AS112SummaryQueryTypeResponseMetaNormalizationOverlappedPercentage AS112SummaryQueryTypeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112SummaryQueryTypeResponseMetaNormalizationRatio AS112SummaryQueryTypeResponseMetaNormalization = "RATIO" )
func (AS112SummaryQueryTypeResponseMetaNormalization) IsKnown ¶
func (r AS112SummaryQueryTypeResponseMetaNormalization) IsKnown() bool
type AS112SummaryQueryTypeResponseMetaUnit ¶
type AS112SummaryQueryTypeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112SummaryQueryTypeResponseMetaUnitJSON `json:"-"`
}
func (*AS112SummaryQueryTypeResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112SummaryQueryTypeResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112SummaryResponseCodesParams ¶
type AS112SummaryResponseCodesParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112SummaryResponseCodesParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112SummaryResponseCodesParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112SummaryResponseCodesParamsQueryType] `query:"queryType"`
}
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 in which results will be returned.
const ( AS112SummaryResponseCodesParamsFormatJson AS112SummaryResponseCodesParamsFormat = "JSON" AS112SummaryResponseCodesParamsFormatCsv AS112SummaryResponseCodesParamsFormat = "CSV" )
func (AS112SummaryResponseCodesParamsFormat) IsKnown ¶
func (r AS112SummaryResponseCodesParamsFormat) IsKnown() bool
type AS112SummaryResponseCodesParamsProtocol ¶
type AS112SummaryResponseCodesParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112SummaryResponseCodesParamsProtocolUdp AS112SummaryResponseCodesParamsProtocol = "UDP" AS112SummaryResponseCodesParamsProtocolTCP AS112SummaryResponseCodesParamsProtocol = "TCP" AS112SummaryResponseCodesParamsProtocolHTTPS AS112SummaryResponseCodesParamsProtocol = "HTTPS" AS112SummaryResponseCodesParamsProtocolTLS AS112SummaryResponseCodesParamsProtocol = "TLS" )
func (AS112SummaryResponseCodesParamsProtocol) IsKnown ¶
func (r AS112SummaryResponseCodesParamsProtocol) IsKnown() bool
type AS112SummaryResponseCodesParamsQueryType ¶
type AS112SummaryResponseCodesParamsQueryType string
Filters results by DNS query type.
const ( AS112SummaryResponseCodesParamsQueryTypeA AS112SummaryResponseCodesParamsQueryType = "A" AS112SummaryResponseCodesParamsQueryTypeAAAA AS112SummaryResponseCodesParamsQueryType = "AAAA" AS112SummaryResponseCodesParamsQueryTypeA6 AS112SummaryResponseCodesParamsQueryType = "A6" AS112SummaryResponseCodesParamsQueryTypeAfsdb AS112SummaryResponseCodesParamsQueryType = "AFSDB" AS112SummaryResponseCodesParamsQueryTypeAny AS112SummaryResponseCodesParamsQueryType = "ANY" AS112SummaryResponseCodesParamsQueryTypeApl AS112SummaryResponseCodesParamsQueryType = "APL" AS112SummaryResponseCodesParamsQueryTypeAtma AS112SummaryResponseCodesParamsQueryType = "ATMA" AS112SummaryResponseCodesParamsQueryTypeAXFR AS112SummaryResponseCodesParamsQueryType = "AXFR" AS112SummaryResponseCodesParamsQueryTypeCAA AS112SummaryResponseCodesParamsQueryType = "CAA" AS112SummaryResponseCodesParamsQueryTypeCdnskey AS112SummaryResponseCodesParamsQueryType = "CDNSKEY" AS112SummaryResponseCodesParamsQueryTypeCds AS112SummaryResponseCodesParamsQueryType = "CDS" AS112SummaryResponseCodesParamsQueryTypeCERT AS112SummaryResponseCodesParamsQueryType = "CERT" AS112SummaryResponseCodesParamsQueryTypeCNAME AS112SummaryResponseCodesParamsQueryType = "CNAME" AS112SummaryResponseCodesParamsQueryTypeCsync AS112SummaryResponseCodesParamsQueryType = "CSYNC" AS112SummaryResponseCodesParamsQueryTypeDhcid AS112SummaryResponseCodesParamsQueryType = "DHCID" AS112SummaryResponseCodesParamsQueryTypeDlv AS112SummaryResponseCodesParamsQueryType = "DLV" AS112SummaryResponseCodesParamsQueryTypeDname AS112SummaryResponseCodesParamsQueryType = "DNAME" AS112SummaryResponseCodesParamsQueryTypeDNSKEY AS112SummaryResponseCodesParamsQueryType = "DNSKEY" AS112SummaryResponseCodesParamsQueryTypeDoa AS112SummaryResponseCodesParamsQueryType = "DOA" AS112SummaryResponseCodesParamsQueryTypeDS AS112SummaryResponseCodesParamsQueryType = "DS" AS112SummaryResponseCodesParamsQueryTypeEid AS112SummaryResponseCodesParamsQueryType = "EID" AS112SummaryResponseCodesParamsQueryTypeEui48 AS112SummaryResponseCodesParamsQueryType = "EUI48" AS112SummaryResponseCodesParamsQueryTypeEui64 AS112SummaryResponseCodesParamsQueryType = "EUI64" AS112SummaryResponseCodesParamsQueryTypeGpos AS112SummaryResponseCodesParamsQueryType = "GPOS" AS112SummaryResponseCodesParamsQueryTypeGid AS112SummaryResponseCodesParamsQueryType = "GID" AS112SummaryResponseCodesParamsQueryTypeHinfo AS112SummaryResponseCodesParamsQueryType = "HINFO" AS112SummaryResponseCodesParamsQueryTypeHip AS112SummaryResponseCodesParamsQueryType = "HIP" AS112SummaryResponseCodesParamsQueryTypeHTTPS AS112SummaryResponseCodesParamsQueryType = "HTTPS" AS112SummaryResponseCodesParamsQueryTypeIpseckey AS112SummaryResponseCodesParamsQueryType = "IPSECKEY" AS112SummaryResponseCodesParamsQueryTypeIsdn AS112SummaryResponseCodesParamsQueryType = "ISDN" AS112SummaryResponseCodesParamsQueryTypeIxfr AS112SummaryResponseCodesParamsQueryType = "IXFR" AS112SummaryResponseCodesParamsQueryTypeKey AS112SummaryResponseCodesParamsQueryType = "KEY" AS112SummaryResponseCodesParamsQueryTypeKx AS112SummaryResponseCodesParamsQueryType = "KX" AS112SummaryResponseCodesParamsQueryTypeL32 AS112SummaryResponseCodesParamsQueryType = "L32" AS112SummaryResponseCodesParamsQueryTypeL64 AS112SummaryResponseCodesParamsQueryType = "L64" AS112SummaryResponseCodesParamsQueryTypeLOC AS112SummaryResponseCodesParamsQueryType = "LOC" AS112SummaryResponseCodesParamsQueryTypeLp AS112SummaryResponseCodesParamsQueryType = "LP" AS112SummaryResponseCodesParamsQueryTypeMaila AS112SummaryResponseCodesParamsQueryType = "MAILA" AS112SummaryResponseCodesParamsQueryTypeMailb AS112SummaryResponseCodesParamsQueryType = "MAILB" AS112SummaryResponseCodesParamsQueryTypeMB AS112SummaryResponseCodesParamsQueryType = "MB" AS112SummaryResponseCodesParamsQueryTypeMd AS112SummaryResponseCodesParamsQueryType = "MD" AS112SummaryResponseCodesParamsQueryTypeMf AS112SummaryResponseCodesParamsQueryType = "MF" AS112SummaryResponseCodesParamsQueryTypeMg AS112SummaryResponseCodesParamsQueryType = "MG" AS112SummaryResponseCodesParamsQueryTypeMinfo AS112SummaryResponseCodesParamsQueryType = "MINFO" AS112SummaryResponseCodesParamsQueryTypeMr AS112SummaryResponseCodesParamsQueryType = "MR" AS112SummaryResponseCodesParamsQueryTypeMX AS112SummaryResponseCodesParamsQueryType = "MX" AS112SummaryResponseCodesParamsQueryTypeNAPTR AS112SummaryResponseCodesParamsQueryType = "NAPTR" AS112SummaryResponseCodesParamsQueryTypeNb AS112SummaryResponseCodesParamsQueryType = "NB" AS112SummaryResponseCodesParamsQueryTypeNbstat AS112SummaryResponseCodesParamsQueryType = "NBSTAT" AS112SummaryResponseCodesParamsQueryTypeNid AS112SummaryResponseCodesParamsQueryType = "NID" AS112SummaryResponseCodesParamsQueryTypeNimloc AS112SummaryResponseCodesParamsQueryType = "NIMLOC" AS112SummaryResponseCodesParamsQueryTypeNinfo AS112SummaryResponseCodesParamsQueryType = "NINFO" AS112SummaryResponseCodesParamsQueryTypeNS AS112SummaryResponseCodesParamsQueryType = "NS" AS112SummaryResponseCodesParamsQueryTypeNsap AS112SummaryResponseCodesParamsQueryType = "NSAP" AS112SummaryResponseCodesParamsQueryTypeNsec AS112SummaryResponseCodesParamsQueryType = "NSEC" AS112SummaryResponseCodesParamsQueryTypeNsec3 AS112SummaryResponseCodesParamsQueryType = "NSEC3" AS112SummaryResponseCodesParamsQueryTypeNsec3Param AS112SummaryResponseCodesParamsQueryType = "NSEC3PARAM" AS112SummaryResponseCodesParamsQueryTypeNull AS112SummaryResponseCodesParamsQueryType = "NULL" AS112SummaryResponseCodesParamsQueryTypeNxt AS112SummaryResponseCodesParamsQueryType = "NXT" AS112SummaryResponseCodesParamsQueryTypeOpenpgpkey AS112SummaryResponseCodesParamsQueryType = "OPENPGPKEY" AS112SummaryResponseCodesParamsQueryTypeOpt AS112SummaryResponseCodesParamsQueryType = "OPT" AS112SummaryResponseCodesParamsQueryTypePTR AS112SummaryResponseCodesParamsQueryType = "PTR" AS112SummaryResponseCodesParamsQueryTypePx AS112SummaryResponseCodesParamsQueryType = "PX" AS112SummaryResponseCodesParamsQueryTypeRkey AS112SummaryResponseCodesParamsQueryType = "RKEY" AS112SummaryResponseCodesParamsQueryTypeRp AS112SummaryResponseCodesParamsQueryType = "RP" AS112SummaryResponseCodesParamsQueryTypeRrsig AS112SummaryResponseCodesParamsQueryType = "RRSIG" AS112SummaryResponseCodesParamsQueryTypeRt AS112SummaryResponseCodesParamsQueryType = "RT" AS112SummaryResponseCodesParamsQueryTypeSig AS112SummaryResponseCodesParamsQueryType = "SIG" AS112SummaryResponseCodesParamsQueryTypeSink AS112SummaryResponseCodesParamsQueryType = "SINK" AS112SummaryResponseCodesParamsQueryTypeSMIMEA AS112SummaryResponseCodesParamsQueryType = "SMIMEA" AS112SummaryResponseCodesParamsQueryTypeSOA AS112SummaryResponseCodesParamsQueryType = "SOA" AS112SummaryResponseCodesParamsQueryTypeSPF AS112SummaryResponseCodesParamsQueryType = "SPF" AS112SummaryResponseCodesParamsQueryTypeSRV AS112SummaryResponseCodesParamsQueryType = "SRV" AS112SummaryResponseCodesParamsQueryTypeSSHFP AS112SummaryResponseCodesParamsQueryType = "SSHFP" AS112SummaryResponseCodesParamsQueryTypeSVCB AS112SummaryResponseCodesParamsQueryType = "SVCB" AS112SummaryResponseCodesParamsQueryTypeTa AS112SummaryResponseCodesParamsQueryType = "TA" AS112SummaryResponseCodesParamsQueryTypeTalink AS112SummaryResponseCodesParamsQueryType = "TALINK" AS112SummaryResponseCodesParamsQueryTypeTkey AS112SummaryResponseCodesParamsQueryType = "TKEY" AS112SummaryResponseCodesParamsQueryTypeTLSA AS112SummaryResponseCodesParamsQueryType = "TLSA" AS112SummaryResponseCodesParamsQueryTypeTSIG AS112SummaryResponseCodesParamsQueryType = "TSIG" AS112SummaryResponseCodesParamsQueryTypeTXT AS112SummaryResponseCodesParamsQueryType = "TXT" AS112SummaryResponseCodesParamsQueryTypeUinfo AS112SummaryResponseCodesParamsQueryType = "UINFO" AS112SummaryResponseCodesParamsQueryTypeUID AS112SummaryResponseCodesParamsQueryType = "UID" AS112SummaryResponseCodesParamsQueryTypeUnspec AS112SummaryResponseCodesParamsQueryType = "UNSPEC" AS112SummaryResponseCodesParamsQueryTypeURI AS112SummaryResponseCodesParamsQueryType = "URI" AS112SummaryResponseCodesParamsQueryTypeWks AS112SummaryResponseCodesParamsQueryType = "WKS" AS112SummaryResponseCodesParamsQueryTypeX25 AS112SummaryResponseCodesParamsQueryType = "X25" AS112SummaryResponseCodesParamsQueryTypeZonemd AS112SummaryResponseCodesParamsQueryType = "ZONEMD" )
func (AS112SummaryResponseCodesParamsQueryType) IsKnown ¶
func (r AS112SummaryResponseCodesParamsQueryType) IsKnown() bool
type AS112SummaryResponseCodesResponse ¶
type AS112SummaryResponseCodesResponse struct {
// Metadata for the results.
Meta AS112SummaryResponseCodesResponseMeta `json:"meta,required"`
Summary0 map[string]string `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 {
ConfidenceInfo AS112SummaryResponseCodesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112SummaryResponseCodesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112SummaryResponseCodesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112SummaryResponseCodesResponseMetaUnit `json:"units,required"`
JSON as112SummaryResponseCodesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112SummaryResponseCodesResponseMeta) UnmarshalJSON ¶
func (r *AS112SummaryResponseCodesResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112SummaryResponseCodesResponseMetaConfidenceInfo ¶
type AS112SummaryResponseCodesResponseMetaConfidenceInfo struct {
Annotations []AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112SummaryResponseCodesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112SummaryResponseCodesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AS112SummaryResponseCodesResponseMetaNormalization ¶
type AS112SummaryResponseCodesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112SummaryResponseCodesResponseMetaNormalizationPercentage AS112SummaryResponseCodesResponseMetaNormalization = "PERCENTAGE" AS112SummaryResponseCodesResponseMetaNormalizationMin0Max AS112SummaryResponseCodesResponseMetaNormalization = "MIN0_MAX" AS112SummaryResponseCodesResponseMetaNormalizationMinMax AS112SummaryResponseCodesResponseMetaNormalization = "MIN_MAX" AS112SummaryResponseCodesResponseMetaNormalizationRawValues AS112SummaryResponseCodesResponseMetaNormalization = "RAW_VALUES" AS112SummaryResponseCodesResponseMetaNormalizationPercentageChange AS112SummaryResponseCodesResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112SummaryResponseCodesResponseMetaNormalizationRollingAverage AS112SummaryResponseCodesResponseMetaNormalization = "ROLLING_AVERAGE" AS112SummaryResponseCodesResponseMetaNormalizationOverlappedPercentage AS112SummaryResponseCodesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112SummaryResponseCodesResponseMetaNormalizationRatio AS112SummaryResponseCodesResponseMetaNormalization = "RATIO" )
func (AS112SummaryResponseCodesResponseMetaNormalization) IsKnown ¶
func (r AS112SummaryResponseCodesResponseMetaNormalization) IsKnown() bool
type AS112SummaryResponseCodesResponseMetaUnit ¶
type AS112SummaryResponseCodesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112SummaryResponseCodesResponseMetaUnitJSON `json:"-"`
}
func (*AS112SummaryResponseCodesResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112SummaryResponseCodesResponseMetaUnit) 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 ¶
func (r *AS112SummaryService) DNSSEC(ctx context.Context, query AS112SummaryDNSSECParams, opts ...option.RequestOption) (res *AS112SummaryDNSSECResponse, err error)
Retrieves the distribution of DNS queries to AS112 by DNSSEC (DNS Security Extensions) support.
func (*AS112SummaryService) Edns ¶
func (r *AS112SummaryService) Edns(ctx context.Context, query AS112SummaryEdnsParams, opts ...option.RequestOption) (res *AS112SummaryEdnsResponse, err error)
Retrieves the distribution of DNS queries to AS112 by EDNS (Extension Mechanisms for DNS) support.
func (*AS112SummaryService) IPVersion ¶
func (r *AS112SummaryService) IPVersion(ctx context.Context, query AS112SummaryIPVersionParams, opts ...option.RequestOption) (res *AS112SummaryIPVersionResponse, err error)
Retrieves the distribution of DNS queries to AS112 by IP version.
func (*AS112SummaryService) Protocol ¶
func (r *AS112SummaryService) Protocol(ctx context.Context, query AS112SummaryProtocolParams, opts ...option.RequestOption) (res *AS112SummaryProtocolResponse, err error)
Retrieves the distribution of DNS queries to AS112 by protocol.
func (*AS112SummaryService) QueryType ¶
func (r *AS112SummaryService) QueryType(ctx context.Context, query AS112SummaryQueryTypeParams, opts ...option.RequestOption) (res *AS112SummaryQueryTypeResponse, err error)
Retrieves the distribution of DNS queries to AS112 by type.
func (*AS112SummaryService) ResponseCodes ¶
func (r *AS112SummaryService) ResponseCodes(ctx context.Context, query AS112SummaryResponseCodesParams, opts ...option.RequestOption) (res *AS112SummaryResponseCodesResponse, err error)
Retrieves the distribution of AS112 DNS requests classified by response code.
type AS112TimeseriesGroupDNSSECParams ¶
type AS112TimeseriesGroupDNSSECParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TimeseriesGroupDNSSECParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112TimeseriesGroupDNSSECParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112TimeseriesGroupDNSSECParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112TimeseriesGroupDNSSECParamsResponseCode] `query:"responseCode"`
}
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 of the results (e.g., 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 ¶
func (r AS112TimeseriesGroupDNSSECParamsAggInterval) IsKnown() bool
type AS112TimeseriesGroupDNSSECParamsFormat ¶
type AS112TimeseriesGroupDNSSECParamsFormat string
Format in which results will be returned.
const ( AS112TimeseriesGroupDNSSECParamsFormatJson AS112TimeseriesGroupDNSSECParamsFormat = "JSON" AS112TimeseriesGroupDNSSECParamsFormatCsv AS112TimeseriesGroupDNSSECParamsFormat = "CSV" )
func (AS112TimeseriesGroupDNSSECParamsFormat) IsKnown ¶
func (r AS112TimeseriesGroupDNSSECParamsFormat) IsKnown() bool
type AS112TimeseriesGroupDNSSECParamsProtocol ¶
type AS112TimeseriesGroupDNSSECParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112TimeseriesGroupDNSSECParamsProtocolUdp AS112TimeseriesGroupDNSSECParamsProtocol = "UDP" AS112TimeseriesGroupDNSSECParamsProtocolTCP AS112TimeseriesGroupDNSSECParamsProtocol = "TCP" AS112TimeseriesGroupDNSSECParamsProtocolHTTPS AS112TimeseriesGroupDNSSECParamsProtocol = "HTTPS" AS112TimeseriesGroupDNSSECParamsProtocolTLS AS112TimeseriesGroupDNSSECParamsProtocol = "TLS" )
func (AS112TimeseriesGroupDNSSECParamsProtocol) IsKnown ¶
func (r AS112TimeseriesGroupDNSSECParamsProtocol) IsKnown() bool
type AS112TimeseriesGroupDNSSECParamsQueryType ¶
type AS112TimeseriesGroupDNSSECParamsQueryType string
Filters results by DNS query type.
const ( AS112TimeseriesGroupDNSSECParamsQueryTypeA AS112TimeseriesGroupDNSSECParamsQueryType = "A" AS112TimeseriesGroupDNSSECParamsQueryTypeAAAA AS112TimeseriesGroupDNSSECParamsQueryType = "AAAA" AS112TimeseriesGroupDNSSECParamsQueryTypeA6 AS112TimeseriesGroupDNSSECParamsQueryType = "A6" AS112TimeseriesGroupDNSSECParamsQueryTypeAfsdb AS112TimeseriesGroupDNSSECParamsQueryType = "AFSDB" AS112TimeseriesGroupDNSSECParamsQueryTypeAny AS112TimeseriesGroupDNSSECParamsQueryType = "ANY" AS112TimeseriesGroupDNSSECParamsQueryTypeApl AS112TimeseriesGroupDNSSECParamsQueryType = "APL" AS112TimeseriesGroupDNSSECParamsQueryTypeAtma AS112TimeseriesGroupDNSSECParamsQueryType = "ATMA" AS112TimeseriesGroupDNSSECParamsQueryTypeAXFR AS112TimeseriesGroupDNSSECParamsQueryType = "AXFR" AS112TimeseriesGroupDNSSECParamsQueryTypeCAA AS112TimeseriesGroupDNSSECParamsQueryType = "CAA" AS112TimeseriesGroupDNSSECParamsQueryTypeCdnskey AS112TimeseriesGroupDNSSECParamsQueryType = "CDNSKEY" AS112TimeseriesGroupDNSSECParamsQueryTypeCds AS112TimeseriesGroupDNSSECParamsQueryType = "CDS" AS112TimeseriesGroupDNSSECParamsQueryTypeCERT AS112TimeseriesGroupDNSSECParamsQueryType = "CERT" AS112TimeseriesGroupDNSSECParamsQueryTypeCNAME AS112TimeseriesGroupDNSSECParamsQueryType = "CNAME" AS112TimeseriesGroupDNSSECParamsQueryTypeCsync AS112TimeseriesGroupDNSSECParamsQueryType = "CSYNC" AS112TimeseriesGroupDNSSECParamsQueryTypeDhcid AS112TimeseriesGroupDNSSECParamsQueryType = "DHCID" AS112TimeseriesGroupDNSSECParamsQueryTypeDlv AS112TimeseriesGroupDNSSECParamsQueryType = "DLV" AS112TimeseriesGroupDNSSECParamsQueryTypeDname AS112TimeseriesGroupDNSSECParamsQueryType = "DNAME" AS112TimeseriesGroupDNSSECParamsQueryTypeDNSKEY AS112TimeseriesGroupDNSSECParamsQueryType = "DNSKEY" AS112TimeseriesGroupDNSSECParamsQueryTypeDoa AS112TimeseriesGroupDNSSECParamsQueryType = "DOA" AS112TimeseriesGroupDNSSECParamsQueryTypeDS AS112TimeseriesGroupDNSSECParamsQueryType = "DS" AS112TimeseriesGroupDNSSECParamsQueryTypeEid AS112TimeseriesGroupDNSSECParamsQueryType = "EID" AS112TimeseriesGroupDNSSECParamsQueryTypeEui48 AS112TimeseriesGroupDNSSECParamsQueryType = "EUI48" AS112TimeseriesGroupDNSSECParamsQueryTypeEui64 AS112TimeseriesGroupDNSSECParamsQueryType = "EUI64" AS112TimeseriesGroupDNSSECParamsQueryTypeGpos AS112TimeseriesGroupDNSSECParamsQueryType = "GPOS" AS112TimeseriesGroupDNSSECParamsQueryTypeGid AS112TimeseriesGroupDNSSECParamsQueryType = "GID" AS112TimeseriesGroupDNSSECParamsQueryTypeHinfo AS112TimeseriesGroupDNSSECParamsQueryType = "HINFO" AS112TimeseriesGroupDNSSECParamsQueryTypeHip AS112TimeseriesGroupDNSSECParamsQueryType = "HIP" AS112TimeseriesGroupDNSSECParamsQueryTypeHTTPS AS112TimeseriesGroupDNSSECParamsQueryType = "HTTPS" AS112TimeseriesGroupDNSSECParamsQueryTypeIpseckey AS112TimeseriesGroupDNSSECParamsQueryType = "IPSECKEY" AS112TimeseriesGroupDNSSECParamsQueryTypeIsdn AS112TimeseriesGroupDNSSECParamsQueryType = "ISDN" AS112TimeseriesGroupDNSSECParamsQueryTypeIxfr AS112TimeseriesGroupDNSSECParamsQueryType = "IXFR" AS112TimeseriesGroupDNSSECParamsQueryTypeKey AS112TimeseriesGroupDNSSECParamsQueryType = "KEY" AS112TimeseriesGroupDNSSECParamsQueryTypeKx AS112TimeseriesGroupDNSSECParamsQueryType = "KX" AS112TimeseriesGroupDNSSECParamsQueryTypeL32 AS112TimeseriesGroupDNSSECParamsQueryType = "L32" AS112TimeseriesGroupDNSSECParamsQueryTypeL64 AS112TimeseriesGroupDNSSECParamsQueryType = "L64" AS112TimeseriesGroupDNSSECParamsQueryTypeLOC AS112TimeseriesGroupDNSSECParamsQueryType = "LOC" AS112TimeseriesGroupDNSSECParamsQueryTypeLp AS112TimeseriesGroupDNSSECParamsQueryType = "LP" AS112TimeseriesGroupDNSSECParamsQueryTypeMaila AS112TimeseriesGroupDNSSECParamsQueryType = "MAILA" AS112TimeseriesGroupDNSSECParamsQueryTypeMailb AS112TimeseriesGroupDNSSECParamsQueryType = "MAILB" AS112TimeseriesGroupDNSSECParamsQueryTypeMB AS112TimeseriesGroupDNSSECParamsQueryType = "MB" AS112TimeseriesGroupDNSSECParamsQueryTypeMd AS112TimeseriesGroupDNSSECParamsQueryType = "MD" AS112TimeseriesGroupDNSSECParamsQueryTypeMf AS112TimeseriesGroupDNSSECParamsQueryType = "MF" AS112TimeseriesGroupDNSSECParamsQueryTypeMg AS112TimeseriesGroupDNSSECParamsQueryType = "MG" AS112TimeseriesGroupDNSSECParamsQueryTypeMinfo AS112TimeseriesGroupDNSSECParamsQueryType = "MINFO" AS112TimeseriesGroupDNSSECParamsQueryTypeMr AS112TimeseriesGroupDNSSECParamsQueryType = "MR" AS112TimeseriesGroupDNSSECParamsQueryTypeMX AS112TimeseriesGroupDNSSECParamsQueryType = "MX" AS112TimeseriesGroupDNSSECParamsQueryTypeNAPTR AS112TimeseriesGroupDNSSECParamsQueryType = "NAPTR" AS112TimeseriesGroupDNSSECParamsQueryTypeNb AS112TimeseriesGroupDNSSECParamsQueryType = "NB" AS112TimeseriesGroupDNSSECParamsQueryTypeNbstat AS112TimeseriesGroupDNSSECParamsQueryType = "NBSTAT" AS112TimeseriesGroupDNSSECParamsQueryTypeNid AS112TimeseriesGroupDNSSECParamsQueryType = "NID" AS112TimeseriesGroupDNSSECParamsQueryTypeNimloc AS112TimeseriesGroupDNSSECParamsQueryType = "NIMLOC" AS112TimeseriesGroupDNSSECParamsQueryTypeNinfo AS112TimeseriesGroupDNSSECParamsQueryType = "NINFO" AS112TimeseriesGroupDNSSECParamsQueryTypeNS AS112TimeseriesGroupDNSSECParamsQueryType = "NS" AS112TimeseriesGroupDNSSECParamsQueryTypeNsap AS112TimeseriesGroupDNSSECParamsQueryType = "NSAP" AS112TimeseriesGroupDNSSECParamsQueryTypeNsec AS112TimeseriesGroupDNSSECParamsQueryType = "NSEC" AS112TimeseriesGroupDNSSECParamsQueryTypeNsec3 AS112TimeseriesGroupDNSSECParamsQueryType = "NSEC3" AS112TimeseriesGroupDNSSECParamsQueryTypeNsec3Param AS112TimeseriesGroupDNSSECParamsQueryType = "NSEC3PARAM" AS112TimeseriesGroupDNSSECParamsQueryTypeNull AS112TimeseriesGroupDNSSECParamsQueryType = "NULL" AS112TimeseriesGroupDNSSECParamsQueryTypeNxt AS112TimeseriesGroupDNSSECParamsQueryType = "NXT" AS112TimeseriesGroupDNSSECParamsQueryTypeOpenpgpkey AS112TimeseriesGroupDNSSECParamsQueryType = "OPENPGPKEY" AS112TimeseriesGroupDNSSECParamsQueryTypeOpt AS112TimeseriesGroupDNSSECParamsQueryType = "OPT" AS112TimeseriesGroupDNSSECParamsQueryTypePTR AS112TimeseriesGroupDNSSECParamsQueryType = "PTR" AS112TimeseriesGroupDNSSECParamsQueryTypePx AS112TimeseriesGroupDNSSECParamsQueryType = "PX" AS112TimeseriesGroupDNSSECParamsQueryTypeRkey AS112TimeseriesGroupDNSSECParamsQueryType = "RKEY" AS112TimeseriesGroupDNSSECParamsQueryTypeRp AS112TimeseriesGroupDNSSECParamsQueryType = "RP" AS112TimeseriesGroupDNSSECParamsQueryTypeRrsig AS112TimeseriesGroupDNSSECParamsQueryType = "RRSIG" AS112TimeseriesGroupDNSSECParamsQueryTypeRt AS112TimeseriesGroupDNSSECParamsQueryType = "RT" AS112TimeseriesGroupDNSSECParamsQueryTypeSig AS112TimeseriesGroupDNSSECParamsQueryType = "SIG" AS112TimeseriesGroupDNSSECParamsQueryTypeSink AS112TimeseriesGroupDNSSECParamsQueryType = "SINK" AS112TimeseriesGroupDNSSECParamsQueryTypeSMIMEA AS112TimeseriesGroupDNSSECParamsQueryType = "SMIMEA" AS112TimeseriesGroupDNSSECParamsQueryTypeSOA AS112TimeseriesGroupDNSSECParamsQueryType = "SOA" AS112TimeseriesGroupDNSSECParamsQueryTypeSPF AS112TimeseriesGroupDNSSECParamsQueryType = "SPF" AS112TimeseriesGroupDNSSECParamsQueryTypeSRV AS112TimeseriesGroupDNSSECParamsQueryType = "SRV" AS112TimeseriesGroupDNSSECParamsQueryTypeSSHFP AS112TimeseriesGroupDNSSECParamsQueryType = "SSHFP" AS112TimeseriesGroupDNSSECParamsQueryTypeSVCB AS112TimeseriesGroupDNSSECParamsQueryType = "SVCB" AS112TimeseriesGroupDNSSECParamsQueryTypeTa AS112TimeseriesGroupDNSSECParamsQueryType = "TA" AS112TimeseriesGroupDNSSECParamsQueryTypeTalink AS112TimeseriesGroupDNSSECParamsQueryType = "TALINK" AS112TimeseriesGroupDNSSECParamsQueryTypeTkey AS112TimeseriesGroupDNSSECParamsQueryType = "TKEY" AS112TimeseriesGroupDNSSECParamsQueryTypeTLSA AS112TimeseriesGroupDNSSECParamsQueryType = "TLSA" AS112TimeseriesGroupDNSSECParamsQueryTypeTSIG AS112TimeseriesGroupDNSSECParamsQueryType = "TSIG" AS112TimeseriesGroupDNSSECParamsQueryTypeTXT AS112TimeseriesGroupDNSSECParamsQueryType = "TXT" AS112TimeseriesGroupDNSSECParamsQueryTypeUinfo AS112TimeseriesGroupDNSSECParamsQueryType = "UINFO" AS112TimeseriesGroupDNSSECParamsQueryTypeUID AS112TimeseriesGroupDNSSECParamsQueryType = "UID" AS112TimeseriesGroupDNSSECParamsQueryTypeUnspec AS112TimeseriesGroupDNSSECParamsQueryType = "UNSPEC" AS112TimeseriesGroupDNSSECParamsQueryTypeURI AS112TimeseriesGroupDNSSECParamsQueryType = "URI" AS112TimeseriesGroupDNSSECParamsQueryTypeWks AS112TimeseriesGroupDNSSECParamsQueryType = "WKS" AS112TimeseriesGroupDNSSECParamsQueryTypeX25 AS112TimeseriesGroupDNSSECParamsQueryType = "X25" AS112TimeseriesGroupDNSSECParamsQueryTypeZonemd AS112TimeseriesGroupDNSSECParamsQueryType = "ZONEMD" )
func (AS112TimeseriesGroupDNSSECParamsQueryType) IsKnown ¶
func (r AS112TimeseriesGroupDNSSECParamsQueryType) IsKnown() bool
type AS112TimeseriesGroupDNSSECParamsResponseCode ¶
type AS112TimeseriesGroupDNSSECParamsResponseCode string
Filters results by DNS response code.
const ( AS112TimeseriesGroupDNSSECParamsResponseCodeNoerror AS112TimeseriesGroupDNSSECParamsResponseCode = "NOERROR" AS112TimeseriesGroupDNSSECParamsResponseCodeFormerr AS112TimeseriesGroupDNSSECParamsResponseCode = "FORMERR" AS112TimeseriesGroupDNSSECParamsResponseCodeServfail AS112TimeseriesGroupDNSSECParamsResponseCode = "SERVFAIL" AS112TimeseriesGroupDNSSECParamsResponseCodeNxdomain AS112TimeseriesGroupDNSSECParamsResponseCode = "NXDOMAIN" AS112TimeseriesGroupDNSSECParamsResponseCodeNotimp AS112TimeseriesGroupDNSSECParamsResponseCode = "NOTIMP" AS112TimeseriesGroupDNSSECParamsResponseCodeRefused AS112TimeseriesGroupDNSSECParamsResponseCode = "REFUSED" AS112TimeseriesGroupDNSSECParamsResponseCodeYxdomain AS112TimeseriesGroupDNSSECParamsResponseCode = "YXDOMAIN" AS112TimeseriesGroupDNSSECParamsResponseCodeYxrrset AS112TimeseriesGroupDNSSECParamsResponseCode = "YXRRSET" AS112TimeseriesGroupDNSSECParamsResponseCodeNxrrset AS112TimeseriesGroupDNSSECParamsResponseCode = "NXRRSET" AS112TimeseriesGroupDNSSECParamsResponseCodeNotauth AS112TimeseriesGroupDNSSECParamsResponseCode = "NOTAUTH" AS112TimeseriesGroupDNSSECParamsResponseCodeNotzone AS112TimeseriesGroupDNSSECParamsResponseCode = "NOTZONE" AS112TimeseriesGroupDNSSECParamsResponseCodeBadsig AS112TimeseriesGroupDNSSECParamsResponseCode = "BADSIG" AS112TimeseriesGroupDNSSECParamsResponseCodeBadkey AS112TimeseriesGroupDNSSECParamsResponseCode = "BADKEY" AS112TimeseriesGroupDNSSECParamsResponseCodeBadtime AS112TimeseriesGroupDNSSECParamsResponseCode = "BADTIME" AS112TimeseriesGroupDNSSECParamsResponseCodeBadmode AS112TimeseriesGroupDNSSECParamsResponseCode = "BADMODE" AS112TimeseriesGroupDNSSECParamsResponseCodeBadname AS112TimeseriesGroupDNSSECParamsResponseCode = "BADNAME" AS112TimeseriesGroupDNSSECParamsResponseCodeBadalg AS112TimeseriesGroupDNSSECParamsResponseCode = "BADALG" AS112TimeseriesGroupDNSSECParamsResponseCodeBadtrunc AS112TimeseriesGroupDNSSECParamsResponseCode = "BADTRUNC" )
func (AS112TimeseriesGroupDNSSECParamsResponseCode) IsKnown ¶
func (r AS112TimeseriesGroupDNSSECParamsResponseCode) IsKnown() bool
type AS112TimeseriesGroupDNSSECResponse ¶
type AS112TimeseriesGroupDNSSECResponse struct {
// Metadata for the results.
Meta AS112TimeseriesGroupDNSSECResponseMeta `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 AS112TimeseriesGroupDNSSECResponseMeta ¶
type AS112TimeseriesGroupDNSSECResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AS112TimeseriesGroupDNSSECResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112TimeseriesGroupDNSSECResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TimeseriesGroupDNSSECResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TimeseriesGroupDNSSECResponseMetaUnit `json:"units,required"`
JSON as112TimeseriesGroupDNSSECResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TimeseriesGroupDNSSECResponseMeta) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupDNSSECResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupDNSSECResponseMetaAggInterval ¶
type AS112TimeseriesGroupDNSSECResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AS112TimeseriesGroupDNSSECResponseMetaAggIntervalFifteenMinutes AS112TimeseriesGroupDNSSECResponseMetaAggInterval = "FIFTEEN_MINUTES" AS112TimeseriesGroupDNSSECResponseMetaAggIntervalOneHour AS112TimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_HOUR" AS112TimeseriesGroupDNSSECResponseMetaAggIntervalOneDay AS112TimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_DAY" AS112TimeseriesGroupDNSSECResponseMetaAggIntervalOneWeek AS112TimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_WEEK" AS112TimeseriesGroupDNSSECResponseMetaAggIntervalOneMonth AS112TimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_MONTH" )
func (AS112TimeseriesGroupDNSSECResponseMetaAggInterval) IsKnown ¶
func (r AS112TimeseriesGroupDNSSECResponseMetaAggInterval) IsKnown() bool
type AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfo ¶
type AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfo struct {
Annotations []AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON as112TimeseriesGroupDNSSECResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation ¶
type AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupDNSSECResponseMetaDateRange ¶
type AS112TimeseriesGroupDNSSECResponseMetaDateRange 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 as112TimeseriesGroupDNSSECResponseMetaDateRangeJSON `json:"-"`
}
func (*AS112TimeseriesGroupDNSSECResponseMetaDateRange) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupDNSSECResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupDNSSECResponseMetaNormalization ¶
type AS112TimeseriesGroupDNSSECResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TimeseriesGroupDNSSECResponseMetaNormalizationPercentage AS112TimeseriesGroupDNSSECResponseMetaNormalization = "PERCENTAGE" AS112TimeseriesGroupDNSSECResponseMetaNormalizationMin0Max AS112TimeseriesGroupDNSSECResponseMetaNormalization = "MIN0_MAX" AS112TimeseriesGroupDNSSECResponseMetaNormalizationMinMax AS112TimeseriesGroupDNSSECResponseMetaNormalization = "MIN_MAX" AS112TimeseriesGroupDNSSECResponseMetaNormalizationRawValues AS112TimeseriesGroupDNSSECResponseMetaNormalization = "RAW_VALUES" AS112TimeseriesGroupDNSSECResponseMetaNormalizationPercentageChange AS112TimeseriesGroupDNSSECResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TimeseriesGroupDNSSECResponseMetaNormalizationRollingAverage AS112TimeseriesGroupDNSSECResponseMetaNormalization = "ROLLING_AVERAGE" AS112TimeseriesGroupDNSSECResponseMetaNormalizationOverlappedPercentage AS112TimeseriesGroupDNSSECResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TimeseriesGroupDNSSECResponseMetaNormalizationRatio AS112TimeseriesGroupDNSSECResponseMetaNormalization = "RATIO" )
func (AS112TimeseriesGroupDNSSECResponseMetaNormalization) IsKnown ¶
func (r AS112TimeseriesGroupDNSSECResponseMetaNormalization) IsKnown() bool
type AS112TimeseriesGroupDNSSECResponseMetaUnit ¶
type AS112TimeseriesGroupDNSSECResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TimeseriesGroupDNSSECResponseMetaUnitJSON `json:"-"`
}
func (*AS112TimeseriesGroupDNSSECResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupDNSSECResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TimeseriesGroupEdnsParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112TimeseriesGroupEdnsParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112TimeseriesGroupEdnsParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112TimeseriesGroupEdnsParamsResponseCode] `query:"responseCode"`
}
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 of the results (e.g., 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 ¶
func (r AS112TimeseriesGroupEdnsParamsAggInterval) IsKnown() bool
type AS112TimeseriesGroupEdnsParamsFormat ¶
type AS112TimeseriesGroupEdnsParamsFormat string
Format in which results will be returned.
const ( AS112TimeseriesGroupEdnsParamsFormatJson AS112TimeseriesGroupEdnsParamsFormat = "JSON" AS112TimeseriesGroupEdnsParamsFormatCsv AS112TimeseriesGroupEdnsParamsFormat = "CSV" )
func (AS112TimeseriesGroupEdnsParamsFormat) IsKnown ¶
func (r AS112TimeseriesGroupEdnsParamsFormat) IsKnown() bool
type AS112TimeseriesGroupEdnsParamsProtocol ¶
type AS112TimeseriesGroupEdnsParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112TimeseriesGroupEdnsParamsProtocolUdp AS112TimeseriesGroupEdnsParamsProtocol = "UDP" AS112TimeseriesGroupEdnsParamsProtocolTCP AS112TimeseriesGroupEdnsParamsProtocol = "TCP" AS112TimeseriesGroupEdnsParamsProtocolHTTPS AS112TimeseriesGroupEdnsParamsProtocol = "HTTPS" AS112TimeseriesGroupEdnsParamsProtocolTLS AS112TimeseriesGroupEdnsParamsProtocol = "TLS" )
func (AS112TimeseriesGroupEdnsParamsProtocol) IsKnown ¶
func (r AS112TimeseriesGroupEdnsParamsProtocol) IsKnown() bool
type AS112TimeseriesGroupEdnsParamsQueryType ¶
type AS112TimeseriesGroupEdnsParamsQueryType string
Filters results by DNS query type.
const ( AS112TimeseriesGroupEdnsParamsQueryTypeA AS112TimeseriesGroupEdnsParamsQueryType = "A" AS112TimeseriesGroupEdnsParamsQueryTypeAAAA AS112TimeseriesGroupEdnsParamsQueryType = "AAAA" AS112TimeseriesGroupEdnsParamsQueryTypeA6 AS112TimeseriesGroupEdnsParamsQueryType = "A6" AS112TimeseriesGroupEdnsParamsQueryTypeAfsdb AS112TimeseriesGroupEdnsParamsQueryType = "AFSDB" AS112TimeseriesGroupEdnsParamsQueryTypeAny AS112TimeseriesGroupEdnsParamsQueryType = "ANY" AS112TimeseriesGroupEdnsParamsQueryTypeApl AS112TimeseriesGroupEdnsParamsQueryType = "APL" AS112TimeseriesGroupEdnsParamsQueryTypeAtma AS112TimeseriesGroupEdnsParamsQueryType = "ATMA" AS112TimeseriesGroupEdnsParamsQueryTypeAXFR AS112TimeseriesGroupEdnsParamsQueryType = "AXFR" AS112TimeseriesGroupEdnsParamsQueryTypeCAA AS112TimeseriesGroupEdnsParamsQueryType = "CAA" AS112TimeseriesGroupEdnsParamsQueryTypeCdnskey AS112TimeseriesGroupEdnsParamsQueryType = "CDNSKEY" AS112TimeseriesGroupEdnsParamsQueryTypeCds AS112TimeseriesGroupEdnsParamsQueryType = "CDS" AS112TimeseriesGroupEdnsParamsQueryTypeCERT AS112TimeseriesGroupEdnsParamsQueryType = "CERT" AS112TimeseriesGroupEdnsParamsQueryTypeCNAME AS112TimeseriesGroupEdnsParamsQueryType = "CNAME" AS112TimeseriesGroupEdnsParamsQueryTypeCsync AS112TimeseriesGroupEdnsParamsQueryType = "CSYNC" AS112TimeseriesGroupEdnsParamsQueryTypeDhcid AS112TimeseriesGroupEdnsParamsQueryType = "DHCID" AS112TimeseriesGroupEdnsParamsQueryTypeDlv AS112TimeseriesGroupEdnsParamsQueryType = "DLV" AS112TimeseriesGroupEdnsParamsQueryTypeDname AS112TimeseriesGroupEdnsParamsQueryType = "DNAME" AS112TimeseriesGroupEdnsParamsQueryTypeDNSKEY AS112TimeseriesGroupEdnsParamsQueryType = "DNSKEY" AS112TimeseriesGroupEdnsParamsQueryTypeDoa AS112TimeseriesGroupEdnsParamsQueryType = "DOA" AS112TimeseriesGroupEdnsParamsQueryTypeDS AS112TimeseriesGroupEdnsParamsQueryType = "DS" AS112TimeseriesGroupEdnsParamsQueryTypeEid AS112TimeseriesGroupEdnsParamsQueryType = "EID" AS112TimeseriesGroupEdnsParamsQueryTypeEui48 AS112TimeseriesGroupEdnsParamsQueryType = "EUI48" AS112TimeseriesGroupEdnsParamsQueryTypeEui64 AS112TimeseriesGroupEdnsParamsQueryType = "EUI64" AS112TimeseriesGroupEdnsParamsQueryTypeGpos AS112TimeseriesGroupEdnsParamsQueryType = "GPOS" AS112TimeseriesGroupEdnsParamsQueryTypeGid AS112TimeseriesGroupEdnsParamsQueryType = "GID" AS112TimeseriesGroupEdnsParamsQueryTypeHinfo AS112TimeseriesGroupEdnsParamsQueryType = "HINFO" AS112TimeseriesGroupEdnsParamsQueryTypeHip AS112TimeseriesGroupEdnsParamsQueryType = "HIP" AS112TimeseriesGroupEdnsParamsQueryTypeHTTPS AS112TimeseriesGroupEdnsParamsQueryType = "HTTPS" AS112TimeseriesGroupEdnsParamsQueryTypeIpseckey AS112TimeseriesGroupEdnsParamsQueryType = "IPSECKEY" AS112TimeseriesGroupEdnsParamsQueryTypeIsdn AS112TimeseriesGroupEdnsParamsQueryType = "ISDN" AS112TimeseriesGroupEdnsParamsQueryTypeIxfr AS112TimeseriesGroupEdnsParamsQueryType = "IXFR" AS112TimeseriesGroupEdnsParamsQueryTypeKey AS112TimeseriesGroupEdnsParamsQueryType = "KEY" AS112TimeseriesGroupEdnsParamsQueryTypeKx AS112TimeseriesGroupEdnsParamsQueryType = "KX" AS112TimeseriesGroupEdnsParamsQueryTypeL32 AS112TimeseriesGroupEdnsParamsQueryType = "L32" AS112TimeseriesGroupEdnsParamsQueryTypeL64 AS112TimeseriesGroupEdnsParamsQueryType = "L64" AS112TimeseriesGroupEdnsParamsQueryTypeLOC AS112TimeseriesGroupEdnsParamsQueryType = "LOC" AS112TimeseriesGroupEdnsParamsQueryTypeLp AS112TimeseriesGroupEdnsParamsQueryType = "LP" AS112TimeseriesGroupEdnsParamsQueryTypeMaila AS112TimeseriesGroupEdnsParamsQueryType = "MAILA" AS112TimeseriesGroupEdnsParamsQueryTypeMailb AS112TimeseriesGroupEdnsParamsQueryType = "MAILB" AS112TimeseriesGroupEdnsParamsQueryTypeMB AS112TimeseriesGroupEdnsParamsQueryType = "MB" AS112TimeseriesGroupEdnsParamsQueryTypeMd AS112TimeseriesGroupEdnsParamsQueryType = "MD" AS112TimeseriesGroupEdnsParamsQueryTypeMf AS112TimeseriesGroupEdnsParamsQueryType = "MF" AS112TimeseriesGroupEdnsParamsQueryTypeMg AS112TimeseriesGroupEdnsParamsQueryType = "MG" AS112TimeseriesGroupEdnsParamsQueryTypeMinfo AS112TimeseriesGroupEdnsParamsQueryType = "MINFO" AS112TimeseriesGroupEdnsParamsQueryTypeMr AS112TimeseriesGroupEdnsParamsQueryType = "MR" AS112TimeseriesGroupEdnsParamsQueryTypeMX AS112TimeseriesGroupEdnsParamsQueryType = "MX" AS112TimeseriesGroupEdnsParamsQueryTypeNAPTR AS112TimeseriesGroupEdnsParamsQueryType = "NAPTR" AS112TimeseriesGroupEdnsParamsQueryTypeNb AS112TimeseriesGroupEdnsParamsQueryType = "NB" AS112TimeseriesGroupEdnsParamsQueryTypeNbstat AS112TimeseriesGroupEdnsParamsQueryType = "NBSTAT" AS112TimeseriesGroupEdnsParamsQueryTypeNid AS112TimeseriesGroupEdnsParamsQueryType = "NID" AS112TimeseriesGroupEdnsParamsQueryTypeNimloc AS112TimeseriesGroupEdnsParamsQueryType = "NIMLOC" AS112TimeseriesGroupEdnsParamsQueryTypeNinfo AS112TimeseriesGroupEdnsParamsQueryType = "NINFO" AS112TimeseriesGroupEdnsParamsQueryTypeNS AS112TimeseriesGroupEdnsParamsQueryType = "NS" AS112TimeseriesGroupEdnsParamsQueryTypeNsap AS112TimeseriesGroupEdnsParamsQueryType = "NSAP" AS112TimeseriesGroupEdnsParamsQueryTypeNsec AS112TimeseriesGroupEdnsParamsQueryType = "NSEC" AS112TimeseriesGroupEdnsParamsQueryTypeNsec3 AS112TimeseriesGroupEdnsParamsQueryType = "NSEC3" AS112TimeseriesGroupEdnsParamsQueryTypeNsec3Param AS112TimeseriesGroupEdnsParamsQueryType = "NSEC3PARAM" AS112TimeseriesGroupEdnsParamsQueryTypeNull AS112TimeseriesGroupEdnsParamsQueryType = "NULL" AS112TimeseriesGroupEdnsParamsQueryTypeNxt AS112TimeseriesGroupEdnsParamsQueryType = "NXT" AS112TimeseriesGroupEdnsParamsQueryTypeOpenpgpkey AS112TimeseriesGroupEdnsParamsQueryType = "OPENPGPKEY" AS112TimeseriesGroupEdnsParamsQueryTypeOpt AS112TimeseriesGroupEdnsParamsQueryType = "OPT" AS112TimeseriesGroupEdnsParamsQueryTypePTR AS112TimeseriesGroupEdnsParamsQueryType = "PTR" AS112TimeseriesGroupEdnsParamsQueryTypePx AS112TimeseriesGroupEdnsParamsQueryType = "PX" AS112TimeseriesGroupEdnsParamsQueryTypeRkey AS112TimeseriesGroupEdnsParamsQueryType = "RKEY" AS112TimeseriesGroupEdnsParamsQueryTypeRp AS112TimeseriesGroupEdnsParamsQueryType = "RP" AS112TimeseriesGroupEdnsParamsQueryTypeRrsig AS112TimeseriesGroupEdnsParamsQueryType = "RRSIG" AS112TimeseriesGroupEdnsParamsQueryTypeRt AS112TimeseriesGroupEdnsParamsQueryType = "RT" AS112TimeseriesGroupEdnsParamsQueryTypeSig AS112TimeseriesGroupEdnsParamsQueryType = "SIG" AS112TimeseriesGroupEdnsParamsQueryTypeSink AS112TimeseriesGroupEdnsParamsQueryType = "SINK" AS112TimeseriesGroupEdnsParamsQueryTypeSMIMEA AS112TimeseriesGroupEdnsParamsQueryType = "SMIMEA" AS112TimeseriesGroupEdnsParamsQueryTypeSOA AS112TimeseriesGroupEdnsParamsQueryType = "SOA" AS112TimeseriesGroupEdnsParamsQueryTypeSPF AS112TimeseriesGroupEdnsParamsQueryType = "SPF" AS112TimeseriesGroupEdnsParamsQueryTypeSRV AS112TimeseriesGroupEdnsParamsQueryType = "SRV" AS112TimeseriesGroupEdnsParamsQueryTypeSSHFP AS112TimeseriesGroupEdnsParamsQueryType = "SSHFP" AS112TimeseriesGroupEdnsParamsQueryTypeSVCB AS112TimeseriesGroupEdnsParamsQueryType = "SVCB" AS112TimeseriesGroupEdnsParamsQueryTypeTa AS112TimeseriesGroupEdnsParamsQueryType = "TA" AS112TimeseriesGroupEdnsParamsQueryTypeTalink AS112TimeseriesGroupEdnsParamsQueryType = "TALINK" AS112TimeseriesGroupEdnsParamsQueryTypeTkey AS112TimeseriesGroupEdnsParamsQueryType = "TKEY" AS112TimeseriesGroupEdnsParamsQueryTypeTLSA AS112TimeseriesGroupEdnsParamsQueryType = "TLSA" AS112TimeseriesGroupEdnsParamsQueryTypeTSIG AS112TimeseriesGroupEdnsParamsQueryType = "TSIG" AS112TimeseriesGroupEdnsParamsQueryTypeTXT AS112TimeseriesGroupEdnsParamsQueryType = "TXT" AS112TimeseriesGroupEdnsParamsQueryTypeUinfo AS112TimeseriesGroupEdnsParamsQueryType = "UINFO" AS112TimeseriesGroupEdnsParamsQueryTypeUID AS112TimeseriesGroupEdnsParamsQueryType = "UID" AS112TimeseriesGroupEdnsParamsQueryTypeUnspec AS112TimeseriesGroupEdnsParamsQueryType = "UNSPEC" AS112TimeseriesGroupEdnsParamsQueryTypeURI AS112TimeseriesGroupEdnsParamsQueryType = "URI" AS112TimeseriesGroupEdnsParamsQueryTypeWks AS112TimeseriesGroupEdnsParamsQueryType = "WKS" AS112TimeseriesGroupEdnsParamsQueryTypeX25 AS112TimeseriesGroupEdnsParamsQueryType = "X25" AS112TimeseriesGroupEdnsParamsQueryTypeZonemd AS112TimeseriesGroupEdnsParamsQueryType = "ZONEMD" )
func (AS112TimeseriesGroupEdnsParamsQueryType) IsKnown ¶
func (r AS112TimeseriesGroupEdnsParamsQueryType) IsKnown() bool
type AS112TimeseriesGroupEdnsParamsResponseCode ¶
type AS112TimeseriesGroupEdnsParamsResponseCode string
Filters results by DNS response code.
const ( AS112TimeseriesGroupEdnsParamsResponseCodeNoerror AS112TimeseriesGroupEdnsParamsResponseCode = "NOERROR" AS112TimeseriesGroupEdnsParamsResponseCodeFormerr AS112TimeseriesGroupEdnsParamsResponseCode = "FORMERR" AS112TimeseriesGroupEdnsParamsResponseCodeServfail AS112TimeseriesGroupEdnsParamsResponseCode = "SERVFAIL" AS112TimeseriesGroupEdnsParamsResponseCodeNxdomain AS112TimeseriesGroupEdnsParamsResponseCode = "NXDOMAIN" AS112TimeseriesGroupEdnsParamsResponseCodeNotimp AS112TimeseriesGroupEdnsParamsResponseCode = "NOTIMP" AS112TimeseriesGroupEdnsParamsResponseCodeRefused AS112TimeseriesGroupEdnsParamsResponseCode = "REFUSED" AS112TimeseriesGroupEdnsParamsResponseCodeYxdomain AS112TimeseriesGroupEdnsParamsResponseCode = "YXDOMAIN" AS112TimeseriesGroupEdnsParamsResponseCodeYxrrset AS112TimeseriesGroupEdnsParamsResponseCode = "YXRRSET" AS112TimeseriesGroupEdnsParamsResponseCodeNxrrset AS112TimeseriesGroupEdnsParamsResponseCode = "NXRRSET" AS112TimeseriesGroupEdnsParamsResponseCodeNotauth AS112TimeseriesGroupEdnsParamsResponseCode = "NOTAUTH" AS112TimeseriesGroupEdnsParamsResponseCodeNotzone AS112TimeseriesGroupEdnsParamsResponseCode = "NOTZONE" AS112TimeseriesGroupEdnsParamsResponseCodeBadsig AS112TimeseriesGroupEdnsParamsResponseCode = "BADSIG" AS112TimeseriesGroupEdnsParamsResponseCodeBadkey AS112TimeseriesGroupEdnsParamsResponseCode = "BADKEY" AS112TimeseriesGroupEdnsParamsResponseCodeBadtime AS112TimeseriesGroupEdnsParamsResponseCode = "BADTIME" AS112TimeseriesGroupEdnsParamsResponseCodeBadmode AS112TimeseriesGroupEdnsParamsResponseCode = "BADMODE" AS112TimeseriesGroupEdnsParamsResponseCodeBadname AS112TimeseriesGroupEdnsParamsResponseCode = "BADNAME" AS112TimeseriesGroupEdnsParamsResponseCodeBadalg AS112TimeseriesGroupEdnsParamsResponseCode = "BADALG" AS112TimeseriesGroupEdnsParamsResponseCodeBadtrunc AS112TimeseriesGroupEdnsParamsResponseCode = "BADTRUNC" )
func (AS112TimeseriesGroupEdnsParamsResponseCode) IsKnown ¶
func (r AS112TimeseriesGroupEdnsParamsResponseCode) IsKnown() bool
type AS112TimeseriesGroupEdnsResponse ¶
type AS112TimeseriesGroupEdnsResponse struct {
// Metadata for the results.
Meta AS112TimeseriesGroupEdnsResponseMeta `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 AS112TimeseriesGroupEdnsResponseMeta ¶
type AS112TimeseriesGroupEdnsResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AS112TimeseriesGroupEdnsResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AS112TimeseriesGroupEdnsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112TimeseriesGroupEdnsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TimeseriesGroupEdnsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TimeseriesGroupEdnsResponseMetaUnit `json:"units,required"`
JSON as112TimeseriesGroupEdnsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TimeseriesGroupEdnsResponseMeta) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupEdnsResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupEdnsResponseMetaAggInterval ¶
type AS112TimeseriesGroupEdnsResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AS112TimeseriesGroupEdnsResponseMetaAggIntervalFifteenMinutes AS112TimeseriesGroupEdnsResponseMetaAggInterval = "FIFTEEN_MINUTES" AS112TimeseriesGroupEdnsResponseMetaAggIntervalOneHour AS112TimeseriesGroupEdnsResponseMetaAggInterval = "ONE_HOUR" AS112TimeseriesGroupEdnsResponseMetaAggIntervalOneDay AS112TimeseriesGroupEdnsResponseMetaAggInterval = "ONE_DAY" AS112TimeseriesGroupEdnsResponseMetaAggIntervalOneWeek AS112TimeseriesGroupEdnsResponseMetaAggInterval = "ONE_WEEK" AS112TimeseriesGroupEdnsResponseMetaAggIntervalOneMonth AS112TimeseriesGroupEdnsResponseMetaAggInterval = "ONE_MONTH" )
func (AS112TimeseriesGroupEdnsResponseMetaAggInterval) IsKnown ¶
func (r AS112TimeseriesGroupEdnsResponseMetaAggInterval) IsKnown() bool
type AS112TimeseriesGroupEdnsResponseMetaConfidenceInfo ¶
type AS112TimeseriesGroupEdnsResponseMetaConfidenceInfo struct {
Annotations []AS112TimeseriesGroupEdnsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON as112TimeseriesGroupEdnsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AS112TimeseriesGroupEdnsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupEdnsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupEdnsResponseMetaConfidenceInfoAnnotation ¶
type AS112TimeseriesGroupEdnsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TimeseriesGroupEdnsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112TimeseriesGroupEdnsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupEdnsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupEdnsResponseMetaDateRange ¶
type AS112TimeseriesGroupEdnsResponseMetaDateRange 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 as112TimeseriesGroupEdnsResponseMetaDateRangeJSON `json:"-"`
}
func (*AS112TimeseriesGroupEdnsResponseMetaDateRange) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupEdnsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupEdnsResponseMetaNormalization ¶
type AS112TimeseriesGroupEdnsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TimeseriesGroupEdnsResponseMetaNormalizationPercentage AS112TimeseriesGroupEdnsResponseMetaNormalization = "PERCENTAGE" AS112TimeseriesGroupEdnsResponseMetaNormalizationMin0Max AS112TimeseriesGroupEdnsResponseMetaNormalization = "MIN0_MAX" AS112TimeseriesGroupEdnsResponseMetaNormalizationMinMax AS112TimeseriesGroupEdnsResponseMetaNormalization = "MIN_MAX" AS112TimeseriesGroupEdnsResponseMetaNormalizationRawValues AS112TimeseriesGroupEdnsResponseMetaNormalization = "RAW_VALUES" AS112TimeseriesGroupEdnsResponseMetaNormalizationPercentageChange AS112TimeseriesGroupEdnsResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TimeseriesGroupEdnsResponseMetaNormalizationRollingAverage AS112TimeseriesGroupEdnsResponseMetaNormalization = "ROLLING_AVERAGE" AS112TimeseriesGroupEdnsResponseMetaNormalizationOverlappedPercentage AS112TimeseriesGroupEdnsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TimeseriesGroupEdnsResponseMetaNormalizationRatio AS112TimeseriesGroupEdnsResponseMetaNormalization = "RATIO" )
func (AS112TimeseriesGroupEdnsResponseMetaNormalization) IsKnown ¶
func (r AS112TimeseriesGroupEdnsResponseMetaNormalization) IsKnown() bool
type AS112TimeseriesGroupEdnsResponseMetaUnit ¶
type AS112TimeseriesGroupEdnsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TimeseriesGroupEdnsResponseMetaUnitJSON `json:"-"`
}
func (*AS112TimeseriesGroupEdnsResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupEdnsResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TimeseriesGroupIPVersionParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112TimeseriesGroupIPVersionParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112TimeseriesGroupIPVersionParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112TimeseriesGroupIPVersionParamsResponseCode] `query:"responseCode"`
}
func (AS112TimeseriesGroupIPVersionParams) URLQuery ¶
func (r AS112TimeseriesGroupIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes AS112TimeseriesGroupIPVersionParams's query parameters as `url.Values`.
type AS112TimeseriesGroupIPVersionParamsAggInterval ¶
type AS112TimeseriesGroupIPVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AS112TimeseriesGroupIPVersionParamsAggInterval) IsKnown() bool
type AS112TimeseriesGroupIPVersionParamsFormat ¶
type AS112TimeseriesGroupIPVersionParamsFormat string
Format in which results will be returned.
const ( AS112TimeseriesGroupIPVersionParamsFormatJson AS112TimeseriesGroupIPVersionParamsFormat = "JSON" AS112TimeseriesGroupIPVersionParamsFormatCsv AS112TimeseriesGroupIPVersionParamsFormat = "CSV" )
func (AS112TimeseriesGroupIPVersionParamsFormat) IsKnown ¶
func (r AS112TimeseriesGroupIPVersionParamsFormat) IsKnown() bool
type AS112TimeseriesGroupIPVersionParamsProtocol ¶
type AS112TimeseriesGroupIPVersionParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112TimeseriesGroupIPVersionParamsProtocolUdp AS112TimeseriesGroupIPVersionParamsProtocol = "UDP" AS112TimeseriesGroupIPVersionParamsProtocolTCP AS112TimeseriesGroupIPVersionParamsProtocol = "TCP" AS112TimeseriesGroupIPVersionParamsProtocolHTTPS AS112TimeseriesGroupIPVersionParamsProtocol = "HTTPS" AS112TimeseriesGroupIPVersionParamsProtocolTLS AS112TimeseriesGroupIPVersionParamsProtocol = "TLS" )
func (AS112TimeseriesGroupIPVersionParamsProtocol) IsKnown ¶
func (r AS112TimeseriesGroupIPVersionParamsProtocol) IsKnown() bool
type AS112TimeseriesGroupIPVersionParamsQueryType ¶
type AS112TimeseriesGroupIPVersionParamsQueryType string
Filters results by DNS query type.
const ( AS112TimeseriesGroupIPVersionParamsQueryTypeA AS112TimeseriesGroupIPVersionParamsQueryType = "A" AS112TimeseriesGroupIPVersionParamsQueryTypeAAAA AS112TimeseriesGroupIPVersionParamsQueryType = "AAAA" AS112TimeseriesGroupIPVersionParamsQueryTypeA6 AS112TimeseriesGroupIPVersionParamsQueryType = "A6" AS112TimeseriesGroupIPVersionParamsQueryTypeAfsdb AS112TimeseriesGroupIPVersionParamsQueryType = "AFSDB" AS112TimeseriesGroupIPVersionParamsQueryTypeAny AS112TimeseriesGroupIPVersionParamsQueryType = "ANY" AS112TimeseriesGroupIPVersionParamsQueryTypeApl AS112TimeseriesGroupIPVersionParamsQueryType = "APL" AS112TimeseriesGroupIPVersionParamsQueryTypeAtma AS112TimeseriesGroupIPVersionParamsQueryType = "ATMA" AS112TimeseriesGroupIPVersionParamsQueryTypeAXFR AS112TimeseriesGroupIPVersionParamsQueryType = "AXFR" AS112TimeseriesGroupIPVersionParamsQueryTypeCAA AS112TimeseriesGroupIPVersionParamsQueryType = "CAA" AS112TimeseriesGroupIPVersionParamsQueryTypeCdnskey AS112TimeseriesGroupIPVersionParamsQueryType = "CDNSKEY" AS112TimeseriesGroupIPVersionParamsQueryTypeCds AS112TimeseriesGroupIPVersionParamsQueryType = "CDS" AS112TimeseriesGroupIPVersionParamsQueryTypeCERT AS112TimeseriesGroupIPVersionParamsQueryType = "CERT" AS112TimeseriesGroupIPVersionParamsQueryTypeCNAME AS112TimeseriesGroupIPVersionParamsQueryType = "CNAME" AS112TimeseriesGroupIPVersionParamsQueryTypeCsync AS112TimeseriesGroupIPVersionParamsQueryType = "CSYNC" AS112TimeseriesGroupIPVersionParamsQueryTypeDhcid AS112TimeseriesGroupIPVersionParamsQueryType = "DHCID" AS112TimeseriesGroupIPVersionParamsQueryTypeDlv AS112TimeseriesGroupIPVersionParamsQueryType = "DLV" AS112TimeseriesGroupIPVersionParamsQueryTypeDname AS112TimeseriesGroupIPVersionParamsQueryType = "DNAME" AS112TimeseriesGroupIPVersionParamsQueryTypeDNSKEY AS112TimeseriesGroupIPVersionParamsQueryType = "DNSKEY" AS112TimeseriesGroupIPVersionParamsQueryTypeDoa AS112TimeseriesGroupIPVersionParamsQueryType = "DOA" AS112TimeseriesGroupIPVersionParamsQueryTypeDS AS112TimeseriesGroupIPVersionParamsQueryType = "DS" AS112TimeseriesGroupIPVersionParamsQueryTypeEid AS112TimeseriesGroupIPVersionParamsQueryType = "EID" AS112TimeseriesGroupIPVersionParamsQueryTypeEui48 AS112TimeseriesGroupIPVersionParamsQueryType = "EUI48" AS112TimeseriesGroupIPVersionParamsQueryTypeEui64 AS112TimeseriesGroupIPVersionParamsQueryType = "EUI64" AS112TimeseriesGroupIPVersionParamsQueryTypeGpos AS112TimeseriesGroupIPVersionParamsQueryType = "GPOS" AS112TimeseriesGroupIPVersionParamsQueryTypeGid AS112TimeseriesGroupIPVersionParamsQueryType = "GID" AS112TimeseriesGroupIPVersionParamsQueryTypeHinfo AS112TimeseriesGroupIPVersionParamsQueryType = "HINFO" AS112TimeseriesGroupIPVersionParamsQueryTypeHip AS112TimeseriesGroupIPVersionParamsQueryType = "HIP" AS112TimeseriesGroupIPVersionParamsQueryTypeHTTPS AS112TimeseriesGroupIPVersionParamsQueryType = "HTTPS" AS112TimeseriesGroupIPVersionParamsQueryTypeIpseckey AS112TimeseriesGroupIPVersionParamsQueryType = "IPSECKEY" AS112TimeseriesGroupIPVersionParamsQueryTypeIsdn AS112TimeseriesGroupIPVersionParamsQueryType = "ISDN" AS112TimeseriesGroupIPVersionParamsQueryTypeIxfr AS112TimeseriesGroupIPVersionParamsQueryType = "IXFR" AS112TimeseriesGroupIPVersionParamsQueryTypeKey AS112TimeseriesGroupIPVersionParamsQueryType = "KEY" AS112TimeseriesGroupIPVersionParamsQueryTypeKx AS112TimeseriesGroupIPVersionParamsQueryType = "KX" AS112TimeseriesGroupIPVersionParamsQueryTypeL32 AS112TimeseriesGroupIPVersionParamsQueryType = "L32" AS112TimeseriesGroupIPVersionParamsQueryTypeL64 AS112TimeseriesGroupIPVersionParamsQueryType = "L64" AS112TimeseriesGroupIPVersionParamsQueryTypeLOC AS112TimeseriesGroupIPVersionParamsQueryType = "LOC" AS112TimeseriesGroupIPVersionParamsQueryTypeLp AS112TimeseriesGroupIPVersionParamsQueryType = "LP" AS112TimeseriesGroupIPVersionParamsQueryTypeMaila AS112TimeseriesGroupIPVersionParamsQueryType = "MAILA" AS112TimeseriesGroupIPVersionParamsQueryTypeMailb AS112TimeseriesGroupIPVersionParamsQueryType = "MAILB" AS112TimeseriesGroupIPVersionParamsQueryTypeMB AS112TimeseriesGroupIPVersionParamsQueryType = "MB" AS112TimeseriesGroupIPVersionParamsQueryTypeMd AS112TimeseriesGroupIPVersionParamsQueryType = "MD" AS112TimeseriesGroupIPVersionParamsQueryTypeMf AS112TimeseriesGroupIPVersionParamsQueryType = "MF" AS112TimeseriesGroupIPVersionParamsQueryTypeMg AS112TimeseriesGroupIPVersionParamsQueryType = "MG" AS112TimeseriesGroupIPVersionParamsQueryTypeMinfo AS112TimeseriesGroupIPVersionParamsQueryType = "MINFO" AS112TimeseriesGroupIPVersionParamsQueryTypeMr AS112TimeseriesGroupIPVersionParamsQueryType = "MR" AS112TimeseriesGroupIPVersionParamsQueryTypeMX AS112TimeseriesGroupIPVersionParamsQueryType = "MX" AS112TimeseriesGroupIPVersionParamsQueryTypeNAPTR AS112TimeseriesGroupIPVersionParamsQueryType = "NAPTR" AS112TimeseriesGroupIPVersionParamsQueryTypeNb AS112TimeseriesGroupIPVersionParamsQueryType = "NB" AS112TimeseriesGroupIPVersionParamsQueryTypeNbstat AS112TimeseriesGroupIPVersionParamsQueryType = "NBSTAT" AS112TimeseriesGroupIPVersionParamsQueryTypeNid AS112TimeseriesGroupIPVersionParamsQueryType = "NID" AS112TimeseriesGroupIPVersionParamsQueryTypeNimloc AS112TimeseriesGroupIPVersionParamsQueryType = "NIMLOC" AS112TimeseriesGroupIPVersionParamsQueryTypeNinfo AS112TimeseriesGroupIPVersionParamsQueryType = "NINFO" AS112TimeseriesGroupIPVersionParamsQueryTypeNS AS112TimeseriesGroupIPVersionParamsQueryType = "NS" AS112TimeseriesGroupIPVersionParamsQueryTypeNsap AS112TimeseriesGroupIPVersionParamsQueryType = "NSAP" AS112TimeseriesGroupIPVersionParamsQueryTypeNsec AS112TimeseriesGroupIPVersionParamsQueryType = "NSEC" AS112TimeseriesGroupIPVersionParamsQueryTypeNsec3 AS112TimeseriesGroupIPVersionParamsQueryType = "NSEC3" AS112TimeseriesGroupIPVersionParamsQueryTypeNsec3Param AS112TimeseriesGroupIPVersionParamsQueryType = "NSEC3PARAM" AS112TimeseriesGroupIPVersionParamsQueryTypeNull AS112TimeseriesGroupIPVersionParamsQueryType = "NULL" AS112TimeseriesGroupIPVersionParamsQueryTypeNxt AS112TimeseriesGroupIPVersionParamsQueryType = "NXT" AS112TimeseriesGroupIPVersionParamsQueryTypeOpenpgpkey AS112TimeseriesGroupIPVersionParamsQueryType = "OPENPGPKEY" AS112TimeseriesGroupIPVersionParamsQueryTypeOpt AS112TimeseriesGroupIPVersionParamsQueryType = "OPT" AS112TimeseriesGroupIPVersionParamsQueryTypePTR AS112TimeseriesGroupIPVersionParamsQueryType = "PTR" AS112TimeseriesGroupIPVersionParamsQueryTypePx AS112TimeseriesGroupIPVersionParamsQueryType = "PX" AS112TimeseriesGroupIPVersionParamsQueryTypeRkey AS112TimeseriesGroupIPVersionParamsQueryType = "RKEY" AS112TimeseriesGroupIPVersionParamsQueryTypeRp AS112TimeseriesGroupIPVersionParamsQueryType = "RP" AS112TimeseriesGroupIPVersionParamsQueryTypeRrsig AS112TimeseriesGroupIPVersionParamsQueryType = "RRSIG" AS112TimeseriesGroupIPVersionParamsQueryTypeRt AS112TimeseriesGroupIPVersionParamsQueryType = "RT" AS112TimeseriesGroupIPVersionParamsQueryTypeSig AS112TimeseriesGroupIPVersionParamsQueryType = "SIG" AS112TimeseriesGroupIPVersionParamsQueryTypeSink AS112TimeseriesGroupIPVersionParamsQueryType = "SINK" AS112TimeseriesGroupIPVersionParamsQueryTypeSMIMEA AS112TimeseriesGroupIPVersionParamsQueryType = "SMIMEA" AS112TimeseriesGroupIPVersionParamsQueryTypeSOA AS112TimeseriesGroupIPVersionParamsQueryType = "SOA" AS112TimeseriesGroupIPVersionParamsQueryTypeSPF AS112TimeseriesGroupIPVersionParamsQueryType = "SPF" AS112TimeseriesGroupIPVersionParamsQueryTypeSRV AS112TimeseriesGroupIPVersionParamsQueryType = "SRV" AS112TimeseriesGroupIPVersionParamsQueryTypeSSHFP AS112TimeseriesGroupIPVersionParamsQueryType = "SSHFP" AS112TimeseriesGroupIPVersionParamsQueryTypeSVCB AS112TimeseriesGroupIPVersionParamsQueryType = "SVCB" AS112TimeseriesGroupIPVersionParamsQueryTypeTa AS112TimeseriesGroupIPVersionParamsQueryType = "TA" AS112TimeseriesGroupIPVersionParamsQueryTypeTalink AS112TimeseriesGroupIPVersionParamsQueryType = "TALINK" AS112TimeseriesGroupIPVersionParamsQueryTypeTkey AS112TimeseriesGroupIPVersionParamsQueryType = "TKEY" AS112TimeseriesGroupIPVersionParamsQueryTypeTLSA AS112TimeseriesGroupIPVersionParamsQueryType = "TLSA" AS112TimeseriesGroupIPVersionParamsQueryTypeTSIG AS112TimeseriesGroupIPVersionParamsQueryType = "TSIG" AS112TimeseriesGroupIPVersionParamsQueryTypeTXT AS112TimeseriesGroupIPVersionParamsQueryType = "TXT" AS112TimeseriesGroupIPVersionParamsQueryTypeUinfo AS112TimeseriesGroupIPVersionParamsQueryType = "UINFO" AS112TimeseriesGroupIPVersionParamsQueryTypeUID AS112TimeseriesGroupIPVersionParamsQueryType = "UID" AS112TimeseriesGroupIPVersionParamsQueryTypeUnspec AS112TimeseriesGroupIPVersionParamsQueryType = "UNSPEC" AS112TimeseriesGroupIPVersionParamsQueryTypeURI AS112TimeseriesGroupIPVersionParamsQueryType = "URI" AS112TimeseriesGroupIPVersionParamsQueryTypeWks AS112TimeseriesGroupIPVersionParamsQueryType = "WKS" AS112TimeseriesGroupIPVersionParamsQueryTypeX25 AS112TimeseriesGroupIPVersionParamsQueryType = "X25" AS112TimeseriesGroupIPVersionParamsQueryTypeZonemd AS112TimeseriesGroupIPVersionParamsQueryType = "ZONEMD" )
func (AS112TimeseriesGroupIPVersionParamsQueryType) IsKnown ¶
func (r AS112TimeseriesGroupIPVersionParamsQueryType) IsKnown() bool
type AS112TimeseriesGroupIPVersionParamsResponseCode ¶
type AS112TimeseriesGroupIPVersionParamsResponseCode string
Filters results by DNS response code.
const ( AS112TimeseriesGroupIPVersionParamsResponseCodeNoerror AS112TimeseriesGroupIPVersionParamsResponseCode = "NOERROR" AS112TimeseriesGroupIPVersionParamsResponseCodeFormerr AS112TimeseriesGroupIPVersionParamsResponseCode = "FORMERR" AS112TimeseriesGroupIPVersionParamsResponseCodeServfail AS112TimeseriesGroupIPVersionParamsResponseCode = "SERVFAIL" AS112TimeseriesGroupIPVersionParamsResponseCodeNxdomain AS112TimeseriesGroupIPVersionParamsResponseCode = "NXDOMAIN" AS112TimeseriesGroupIPVersionParamsResponseCodeNotimp AS112TimeseriesGroupIPVersionParamsResponseCode = "NOTIMP" AS112TimeseriesGroupIPVersionParamsResponseCodeRefused AS112TimeseriesGroupIPVersionParamsResponseCode = "REFUSED" AS112TimeseriesGroupIPVersionParamsResponseCodeYxdomain AS112TimeseriesGroupIPVersionParamsResponseCode = "YXDOMAIN" AS112TimeseriesGroupIPVersionParamsResponseCodeYxrrset AS112TimeseriesGroupIPVersionParamsResponseCode = "YXRRSET" AS112TimeseriesGroupIPVersionParamsResponseCodeNxrrset AS112TimeseriesGroupIPVersionParamsResponseCode = "NXRRSET" AS112TimeseriesGroupIPVersionParamsResponseCodeNotauth AS112TimeseriesGroupIPVersionParamsResponseCode = "NOTAUTH" AS112TimeseriesGroupIPVersionParamsResponseCodeNotzone AS112TimeseriesGroupIPVersionParamsResponseCode = "NOTZONE" AS112TimeseriesGroupIPVersionParamsResponseCodeBadsig AS112TimeseriesGroupIPVersionParamsResponseCode = "BADSIG" AS112TimeseriesGroupIPVersionParamsResponseCodeBadkey AS112TimeseriesGroupIPVersionParamsResponseCode = "BADKEY" AS112TimeseriesGroupIPVersionParamsResponseCodeBadtime AS112TimeseriesGroupIPVersionParamsResponseCode = "BADTIME" AS112TimeseriesGroupIPVersionParamsResponseCodeBadmode AS112TimeseriesGroupIPVersionParamsResponseCode = "BADMODE" AS112TimeseriesGroupIPVersionParamsResponseCodeBadname AS112TimeseriesGroupIPVersionParamsResponseCode = "BADNAME" AS112TimeseriesGroupIPVersionParamsResponseCodeBadalg AS112TimeseriesGroupIPVersionParamsResponseCode = "BADALG" AS112TimeseriesGroupIPVersionParamsResponseCodeBadtrunc AS112TimeseriesGroupIPVersionParamsResponseCode = "BADTRUNC" )
func (AS112TimeseriesGroupIPVersionParamsResponseCode) IsKnown ¶
func (r AS112TimeseriesGroupIPVersionParamsResponseCode) IsKnown() bool
type AS112TimeseriesGroupIPVersionResponse ¶
type AS112TimeseriesGroupIPVersionResponse struct {
// Metadata for the results.
Meta AS112TimeseriesGroupIPVersionResponseMeta `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 AS112TimeseriesGroupIPVersionResponseMeta ¶
type AS112TimeseriesGroupIPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AS112TimeseriesGroupIPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112TimeseriesGroupIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TimeseriesGroupIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TimeseriesGroupIPVersionResponseMetaUnit `json:"units,required"`
JSON as112TimeseriesGroupIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TimeseriesGroupIPVersionResponseMeta) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupIPVersionResponseMetaAggInterval ¶
type AS112TimeseriesGroupIPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AS112TimeseriesGroupIPVersionResponseMetaAggIntervalFifteenMinutes AS112TimeseriesGroupIPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" AS112TimeseriesGroupIPVersionResponseMetaAggIntervalOneHour AS112TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_HOUR" AS112TimeseriesGroupIPVersionResponseMetaAggIntervalOneDay AS112TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_DAY" AS112TimeseriesGroupIPVersionResponseMetaAggIntervalOneWeek AS112TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_WEEK" AS112TimeseriesGroupIPVersionResponseMetaAggIntervalOneMonth AS112TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (AS112TimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown ¶
func (r AS112TimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown() bool
type AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfo ¶
type AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfo struct {
Annotations []AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON as112TimeseriesGroupIPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation ¶
type AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupIPVersionResponseMetaDateRange ¶
type AS112TimeseriesGroupIPVersionResponseMetaDateRange 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 as112TimeseriesGroupIPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*AS112TimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupIPVersionResponseMetaNormalization ¶
type AS112TimeseriesGroupIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TimeseriesGroupIPVersionResponseMetaNormalizationPercentage AS112TimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE" AS112TimeseriesGroupIPVersionResponseMetaNormalizationMin0Max AS112TimeseriesGroupIPVersionResponseMetaNormalization = "MIN0_MAX" AS112TimeseriesGroupIPVersionResponseMetaNormalizationMinMax AS112TimeseriesGroupIPVersionResponseMetaNormalization = "MIN_MAX" AS112TimeseriesGroupIPVersionResponseMetaNormalizationRawValues AS112TimeseriesGroupIPVersionResponseMetaNormalization = "RAW_VALUES" AS112TimeseriesGroupIPVersionResponseMetaNormalizationPercentageChange AS112TimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TimeseriesGroupIPVersionResponseMetaNormalizationRollingAverage AS112TimeseriesGroupIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AS112TimeseriesGroupIPVersionResponseMetaNormalizationOverlappedPercentage AS112TimeseriesGroupIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TimeseriesGroupIPVersionResponseMetaNormalizationRatio AS112TimeseriesGroupIPVersionResponseMetaNormalization = "RATIO" )
func (AS112TimeseriesGroupIPVersionResponseMetaNormalization) IsKnown ¶
func (r AS112TimeseriesGroupIPVersionResponseMetaNormalization) IsKnown() bool
type AS112TimeseriesGroupIPVersionResponseMetaUnit ¶
type AS112TimeseriesGroupIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TimeseriesGroupIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AS112TimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupIPVersionResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TimeseriesGroupProtocolParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS query type.
QueryType param.Field[AS112TimeseriesGroupProtocolParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112TimeseriesGroupProtocolParamsResponseCode] `query:"responseCode"`
}
func (AS112TimeseriesGroupProtocolParams) URLQuery ¶
func (r AS112TimeseriesGroupProtocolParams) URLQuery() (v url.Values)
URLQuery serializes AS112TimeseriesGroupProtocolParams's query parameters as `url.Values`.
type AS112TimeseriesGroupProtocolParamsAggInterval ¶
type AS112TimeseriesGroupProtocolParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AS112TimeseriesGroupProtocolParamsAggInterval) IsKnown() bool
type AS112TimeseriesGroupProtocolParamsFormat ¶
type AS112TimeseriesGroupProtocolParamsFormat string
Format in which results will be returned.
const ( AS112TimeseriesGroupProtocolParamsFormatJson AS112TimeseriesGroupProtocolParamsFormat = "JSON" AS112TimeseriesGroupProtocolParamsFormatCsv AS112TimeseriesGroupProtocolParamsFormat = "CSV" )
func (AS112TimeseriesGroupProtocolParamsFormat) IsKnown ¶
func (r AS112TimeseriesGroupProtocolParamsFormat) IsKnown() bool
type AS112TimeseriesGroupProtocolParamsQueryType ¶
type AS112TimeseriesGroupProtocolParamsQueryType string
Filters results by DNS query type.
const ( AS112TimeseriesGroupProtocolParamsQueryTypeA AS112TimeseriesGroupProtocolParamsQueryType = "A" AS112TimeseriesGroupProtocolParamsQueryTypeAAAA AS112TimeseriesGroupProtocolParamsQueryType = "AAAA" AS112TimeseriesGroupProtocolParamsQueryTypeA6 AS112TimeseriesGroupProtocolParamsQueryType = "A6" AS112TimeseriesGroupProtocolParamsQueryTypeAfsdb AS112TimeseriesGroupProtocolParamsQueryType = "AFSDB" AS112TimeseriesGroupProtocolParamsQueryTypeAny AS112TimeseriesGroupProtocolParamsQueryType = "ANY" AS112TimeseriesGroupProtocolParamsQueryTypeApl AS112TimeseriesGroupProtocolParamsQueryType = "APL" AS112TimeseriesGroupProtocolParamsQueryTypeAtma AS112TimeseriesGroupProtocolParamsQueryType = "ATMA" AS112TimeseriesGroupProtocolParamsQueryTypeAXFR AS112TimeseriesGroupProtocolParamsQueryType = "AXFR" AS112TimeseriesGroupProtocolParamsQueryTypeCAA AS112TimeseriesGroupProtocolParamsQueryType = "CAA" AS112TimeseriesGroupProtocolParamsQueryTypeCdnskey AS112TimeseriesGroupProtocolParamsQueryType = "CDNSKEY" AS112TimeseriesGroupProtocolParamsQueryTypeCds AS112TimeseriesGroupProtocolParamsQueryType = "CDS" AS112TimeseriesGroupProtocolParamsQueryTypeCERT AS112TimeseriesGroupProtocolParamsQueryType = "CERT" AS112TimeseriesGroupProtocolParamsQueryTypeCNAME AS112TimeseriesGroupProtocolParamsQueryType = "CNAME" AS112TimeseriesGroupProtocolParamsQueryTypeCsync AS112TimeseriesGroupProtocolParamsQueryType = "CSYNC" AS112TimeseriesGroupProtocolParamsQueryTypeDhcid AS112TimeseriesGroupProtocolParamsQueryType = "DHCID" AS112TimeseriesGroupProtocolParamsQueryTypeDlv AS112TimeseriesGroupProtocolParamsQueryType = "DLV" AS112TimeseriesGroupProtocolParamsQueryTypeDname AS112TimeseriesGroupProtocolParamsQueryType = "DNAME" AS112TimeseriesGroupProtocolParamsQueryTypeDNSKEY AS112TimeseriesGroupProtocolParamsQueryType = "DNSKEY" AS112TimeseriesGroupProtocolParamsQueryTypeDoa AS112TimeseriesGroupProtocolParamsQueryType = "DOA" AS112TimeseriesGroupProtocolParamsQueryTypeDS AS112TimeseriesGroupProtocolParamsQueryType = "DS" AS112TimeseriesGroupProtocolParamsQueryTypeEid AS112TimeseriesGroupProtocolParamsQueryType = "EID" AS112TimeseriesGroupProtocolParamsQueryTypeEui48 AS112TimeseriesGroupProtocolParamsQueryType = "EUI48" AS112TimeseriesGroupProtocolParamsQueryTypeEui64 AS112TimeseriesGroupProtocolParamsQueryType = "EUI64" AS112TimeseriesGroupProtocolParamsQueryTypeGpos AS112TimeseriesGroupProtocolParamsQueryType = "GPOS" AS112TimeseriesGroupProtocolParamsQueryTypeGid AS112TimeseriesGroupProtocolParamsQueryType = "GID" AS112TimeseriesGroupProtocolParamsQueryTypeHinfo AS112TimeseriesGroupProtocolParamsQueryType = "HINFO" AS112TimeseriesGroupProtocolParamsQueryTypeHip AS112TimeseriesGroupProtocolParamsQueryType = "HIP" AS112TimeseriesGroupProtocolParamsQueryTypeHTTPS AS112TimeseriesGroupProtocolParamsQueryType = "HTTPS" AS112TimeseriesGroupProtocolParamsQueryTypeIpseckey AS112TimeseriesGroupProtocolParamsQueryType = "IPSECKEY" AS112TimeseriesGroupProtocolParamsQueryTypeIsdn AS112TimeseriesGroupProtocolParamsQueryType = "ISDN" AS112TimeseriesGroupProtocolParamsQueryTypeIxfr AS112TimeseriesGroupProtocolParamsQueryType = "IXFR" AS112TimeseriesGroupProtocolParamsQueryTypeKey AS112TimeseriesGroupProtocolParamsQueryType = "KEY" AS112TimeseriesGroupProtocolParamsQueryTypeKx AS112TimeseriesGroupProtocolParamsQueryType = "KX" AS112TimeseriesGroupProtocolParamsQueryTypeL32 AS112TimeseriesGroupProtocolParamsQueryType = "L32" AS112TimeseriesGroupProtocolParamsQueryTypeL64 AS112TimeseriesGroupProtocolParamsQueryType = "L64" AS112TimeseriesGroupProtocolParamsQueryTypeLOC AS112TimeseriesGroupProtocolParamsQueryType = "LOC" AS112TimeseriesGroupProtocolParamsQueryTypeLp AS112TimeseriesGroupProtocolParamsQueryType = "LP" AS112TimeseriesGroupProtocolParamsQueryTypeMaila AS112TimeseriesGroupProtocolParamsQueryType = "MAILA" AS112TimeseriesGroupProtocolParamsQueryTypeMailb AS112TimeseriesGroupProtocolParamsQueryType = "MAILB" AS112TimeseriesGroupProtocolParamsQueryTypeMB AS112TimeseriesGroupProtocolParamsQueryType = "MB" AS112TimeseriesGroupProtocolParamsQueryTypeMd AS112TimeseriesGroupProtocolParamsQueryType = "MD" AS112TimeseriesGroupProtocolParamsQueryTypeMf AS112TimeseriesGroupProtocolParamsQueryType = "MF" AS112TimeseriesGroupProtocolParamsQueryTypeMg AS112TimeseriesGroupProtocolParamsQueryType = "MG" AS112TimeseriesGroupProtocolParamsQueryTypeMinfo AS112TimeseriesGroupProtocolParamsQueryType = "MINFO" AS112TimeseriesGroupProtocolParamsQueryTypeMr AS112TimeseriesGroupProtocolParamsQueryType = "MR" AS112TimeseriesGroupProtocolParamsQueryTypeMX AS112TimeseriesGroupProtocolParamsQueryType = "MX" AS112TimeseriesGroupProtocolParamsQueryTypeNAPTR AS112TimeseriesGroupProtocolParamsQueryType = "NAPTR" AS112TimeseriesGroupProtocolParamsQueryTypeNb AS112TimeseriesGroupProtocolParamsQueryType = "NB" AS112TimeseriesGroupProtocolParamsQueryTypeNbstat AS112TimeseriesGroupProtocolParamsQueryType = "NBSTAT" AS112TimeseriesGroupProtocolParamsQueryTypeNid AS112TimeseriesGroupProtocolParamsQueryType = "NID" AS112TimeseriesGroupProtocolParamsQueryTypeNimloc AS112TimeseriesGroupProtocolParamsQueryType = "NIMLOC" AS112TimeseriesGroupProtocolParamsQueryTypeNinfo AS112TimeseriesGroupProtocolParamsQueryType = "NINFO" AS112TimeseriesGroupProtocolParamsQueryTypeNS AS112TimeseriesGroupProtocolParamsQueryType = "NS" AS112TimeseriesGroupProtocolParamsQueryTypeNsap AS112TimeseriesGroupProtocolParamsQueryType = "NSAP" AS112TimeseriesGroupProtocolParamsQueryTypeNsec AS112TimeseriesGroupProtocolParamsQueryType = "NSEC" AS112TimeseriesGroupProtocolParamsQueryTypeNsec3 AS112TimeseriesGroupProtocolParamsQueryType = "NSEC3" AS112TimeseriesGroupProtocolParamsQueryTypeNsec3Param AS112TimeseriesGroupProtocolParamsQueryType = "NSEC3PARAM" AS112TimeseriesGroupProtocolParamsQueryTypeNull AS112TimeseriesGroupProtocolParamsQueryType = "NULL" AS112TimeseriesGroupProtocolParamsQueryTypeNxt AS112TimeseriesGroupProtocolParamsQueryType = "NXT" AS112TimeseriesGroupProtocolParamsQueryTypeOpenpgpkey AS112TimeseriesGroupProtocolParamsQueryType = "OPENPGPKEY" AS112TimeseriesGroupProtocolParamsQueryTypeOpt AS112TimeseriesGroupProtocolParamsQueryType = "OPT" AS112TimeseriesGroupProtocolParamsQueryTypePTR AS112TimeseriesGroupProtocolParamsQueryType = "PTR" AS112TimeseriesGroupProtocolParamsQueryTypePx AS112TimeseriesGroupProtocolParamsQueryType = "PX" AS112TimeseriesGroupProtocolParamsQueryTypeRkey AS112TimeseriesGroupProtocolParamsQueryType = "RKEY" AS112TimeseriesGroupProtocolParamsQueryTypeRp AS112TimeseriesGroupProtocolParamsQueryType = "RP" AS112TimeseriesGroupProtocolParamsQueryTypeRrsig AS112TimeseriesGroupProtocolParamsQueryType = "RRSIG" AS112TimeseriesGroupProtocolParamsQueryTypeRt AS112TimeseriesGroupProtocolParamsQueryType = "RT" AS112TimeseriesGroupProtocolParamsQueryTypeSig AS112TimeseriesGroupProtocolParamsQueryType = "SIG" AS112TimeseriesGroupProtocolParamsQueryTypeSink AS112TimeseriesGroupProtocolParamsQueryType = "SINK" AS112TimeseriesGroupProtocolParamsQueryTypeSMIMEA AS112TimeseriesGroupProtocolParamsQueryType = "SMIMEA" AS112TimeseriesGroupProtocolParamsQueryTypeSOA AS112TimeseriesGroupProtocolParamsQueryType = "SOA" AS112TimeseriesGroupProtocolParamsQueryTypeSPF AS112TimeseriesGroupProtocolParamsQueryType = "SPF" AS112TimeseriesGroupProtocolParamsQueryTypeSRV AS112TimeseriesGroupProtocolParamsQueryType = "SRV" AS112TimeseriesGroupProtocolParamsQueryTypeSSHFP AS112TimeseriesGroupProtocolParamsQueryType = "SSHFP" AS112TimeseriesGroupProtocolParamsQueryTypeSVCB AS112TimeseriesGroupProtocolParamsQueryType = "SVCB" AS112TimeseriesGroupProtocolParamsQueryTypeTa AS112TimeseriesGroupProtocolParamsQueryType = "TA" AS112TimeseriesGroupProtocolParamsQueryTypeTalink AS112TimeseriesGroupProtocolParamsQueryType = "TALINK" AS112TimeseriesGroupProtocolParamsQueryTypeTkey AS112TimeseriesGroupProtocolParamsQueryType = "TKEY" AS112TimeseriesGroupProtocolParamsQueryTypeTLSA AS112TimeseriesGroupProtocolParamsQueryType = "TLSA" AS112TimeseriesGroupProtocolParamsQueryTypeTSIG AS112TimeseriesGroupProtocolParamsQueryType = "TSIG" AS112TimeseriesGroupProtocolParamsQueryTypeTXT AS112TimeseriesGroupProtocolParamsQueryType = "TXT" AS112TimeseriesGroupProtocolParamsQueryTypeUinfo AS112TimeseriesGroupProtocolParamsQueryType = "UINFO" AS112TimeseriesGroupProtocolParamsQueryTypeUID AS112TimeseriesGroupProtocolParamsQueryType = "UID" AS112TimeseriesGroupProtocolParamsQueryTypeUnspec AS112TimeseriesGroupProtocolParamsQueryType = "UNSPEC" AS112TimeseriesGroupProtocolParamsQueryTypeURI AS112TimeseriesGroupProtocolParamsQueryType = "URI" AS112TimeseriesGroupProtocolParamsQueryTypeWks AS112TimeseriesGroupProtocolParamsQueryType = "WKS" AS112TimeseriesGroupProtocolParamsQueryTypeX25 AS112TimeseriesGroupProtocolParamsQueryType = "X25" AS112TimeseriesGroupProtocolParamsQueryTypeZonemd AS112TimeseriesGroupProtocolParamsQueryType = "ZONEMD" )
func (AS112TimeseriesGroupProtocolParamsQueryType) IsKnown ¶
func (r AS112TimeseriesGroupProtocolParamsQueryType) IsKnown() bool
type AS112TimeseriesGroupProtocolParamsResponseCode ¶
type AS112TimeseriesGroupProtocolParamsResponseCode string
Filters results by DNS response code.
const ( AS112TimeseriesGroupProtocolParamsResponseCodeNoerror AS112TimeseriesGroupProtocolParamsResponseCode = "NOERROR" AS112TimeseriesGroupProtocolParamsResponseCodeFormerr AS112TimeseriesGroupProtocolParamsResponseCode = "FORMERR" AS112TimeseriesGroupProtocolParamsResponseCodeServfail AS112TimeseriesGroupProtocolParamsResponseCode = "SERVFAIL" AS112TimeseriesGroupProtocolParamsResponseCodeNxdomain AS112TimeseriesGroupProtocolParamsResponseCode = "NXDOMAIN" AS112TimeseriesGroupProtocolParamsResponseCodeNotimp AS112TimeseriesGroupProtocolParamsResponseCode = "NOTIMP" AS112TimeseriesGroupProtocolParamsResponseCodeRefused AS112TimeseriesGroupProtocolParamsResponseCode = "REFUSED" AS112TimeseriesGroupProtocolParamsResponseCodeYxdomain AS112TimeseriesGroupProtocolParamsResponseCode = "YXDOMAIN" AS112TimeseriesGroupProtocolParamsResponseCodeYxrrset AS112TimeseriesGroupProtocolParamsResponseCode = "YXRRSET" AS112TimeseriesGroupProtocolParamsResponseCodeNxrrset AS112TimeseriesGroupProtocolParamsResponseCode = "NXRRSET" AS112TimeseriesGroupProtocolParamsResponseCodeNotauth AS112TimeseriesGroupProtocolParamsResponseCode = "NOTAUTH" AS112TimeseriesGroupProtocolParamsResponseCodeNotzone AS112TimeseriesGroupProtocolParamsResponseCode = "NOTZONE" AS112TimeseriesGroupProtocolParamsResponseCodeBadsig AS112TimeseriesGroupProtocolParamsResponseCode = "BADSIG" AS112TimeseriesGroupProtocolParamsResponseCodeBadkey AS112TimeseriesGroupProtocolParamsResponseCode = "BADKEY" AS112TimeseriesGroupProtocolParamsResponseCodeBadtime AS112TimeseriesGroupProtocolParamsResponseCode = "BADTIME" AS112TimeseriesGroupProtocolParamsResponseCodeBadmode AS112TimeseriesGroupProtocolParamsResponseCode = "BADMODE" AS112TimeseriesGroupProtocolParamsResponseCodeBadname AS112TimeseriesGroupProtocolParamsResponseCode = "BADNAME" AS112TimeseriesGroupProtocolParamsResponseCodeBadalg AS112TimeseriesGroupProtocolParamsResponseCode = "BADALG" AS112TimeseriesGroupProtocolParamsResponseCodeBadtrunc AS112TimeseriesGroupProtocolParamsResponseCode = "BADTRUNC" )
func (AS112TimeseriesGroupProtocolParamsResponseCode) IsKnown ¶
func (r AS112TimeseriesGroupProtocolParamsResponseCode) IsKnown() bool
type AS112TimeseriesGroupProtocolResponse ¶
type AS112TimeseriesGroupProtocolResponse struct {
// Metadata for the results.
Meta AS112TimeseriesGroupProtocolResponseMeta `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 AS112TimeseriesGroupProtocolResponseMeta ¶
type AS112TimeseriesGroupProtocolResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AS112TimeseriesGroupProtocolResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AS112TimeseriesGroupProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112TimeseriesGroupProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TimeseriesGroupProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TimeseriesGroupProtocolResponseMetaUnit `json:"units,required"`
JSON as112TimeseriesGroupProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TimeseriesGroupProtocolResponseMeta) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupProtocolResponseMetaAggInterval ¶
type AS112TimeseriesGroupProtocolResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AS112TimeseriesGroupProtocolResponseMetaAggIntervalFifteenMinutes AS112TimeseriesGroupProtocolResponseMetaAggInterval = "FIFTEEN_MINUTES" AS112TimeseriesGroupProtocolResponseMetaAggIntervalOneHour AS112TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_HOUR" AS112TimeseriesGroupProtocolResponseMetaAggIntervalOneDay AS112TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_DAY" AS112TimeseriesGroupProtocolResponseMetaAggIntervalOneWeek AS112TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_WEEK" AS112TimeseriesGroupProtocolResponseMetaAggIntervalOneMonth AS112TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_MONTH" )
func (AS112TimeseriesGroupProtocolResponseMetaAggInterval) IsKnown ¶
func (r AS112TimeseriesGroupProtocolResponseMetaAggInterval) IsKnown() bool
type AS112TimeseriesGroupProtocolResponseMetaConfidenceInfo ¶
type AS112TimeseriesGroupProtocolResponseMetaConfidenceInfo struct {
Annotations []AS112TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON as112TimeseriesGroupProtocolResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AS112TimeseriesGroupProtocolResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation ¶
type AS112TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupProtocolResponseMetaDateRange ¶
type AS112TimeseriesGroupProtocolResponseMetaDateRange 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 as112TimeseriesGroupProtocolResponseMetaDateRangeJSON `json:"-"`
}
func (*AS112TimeseriesGroupProtocolResponseMetaDateRange) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupProtocolResponseMetaNormalization ¶
type AS112TimeseriesGroupProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TimeseriesGroupProtocolResponseMetaNormalizationPercentage AS112TimeseriesGroupProtocolResponseMetaNormalization = "PERCENTAGE" AS112TimeseriesGroupProtocolResponseMetaNormalizationMin0Max AS112TimeseriesGroupProtocolResponseMetaNormalization = "MIN0_MAX" AS112TimeseriesGroupProtocolResponseMetaNormalizationMinMax AS112TimeseriesGroupProtocolResponseMetaNormalization = "MIN_MAX" AS112TimeseriesGroupProtocolResponseMetaNormalizationRawValues AS112TimeseriesGroupProtocolResponseMetaNormalization = "RAW_VALUES" AS112TimeseriesGroupProtocolResponseMetaNormalizationPercentageChange AS112TimeseriesGroupProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TimeseriesGroupProtocolResponseMetaNormalizationRollingAverage AS112TimeseriesGroupProtocolResponseMetaNormalization = "ROLLING_AVERAGE" AS112TimeseriesGroupProtocolResponseMetaNormalizationOverlappedPercentage AS112TimeseriesGroupProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TimeseriesGroupProtocolResponseMetaNormalizationRatio AS112TimeseriesGroupProtocolResponseMetaNormalization = "RATIO" )
func (AS112TimeseriesGroupProtocolResponseMetaNormalization) IsKnown ¶
func (r AS112TimeseriesGroupProtocolResponseMetaNormalization) IsKnown() bool
type AS112TimeseriesGroupProtocolResponseMetaUnit ¶
type AS112TimeseriesGroupProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TimeseriesGroupProtocolResponseMetaUnitJSON `json:"-"`
}
func (*AS112TimeseriesGroupProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupProtocolResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupProtocolResponseSerie0 ¶
type AS112TimeseriesGroupProtocolResponseSerie0 struct {
HTTPS []string `json:"HTTPS,required"`
TCP []string `json:"TCP,required"`
TLS []string `json:"TLS,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 of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TimeseriesGroupQueryTypeParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112TimeseriesGroupQueryTypeParamsProtocol] `query:"protocol"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112TimeseriesGroupQueryTypeParamsResponseCode] `query:"responseCode"`
}
func (AS112TimeseriesGroupQueryTypeParams) URLQuery ¶
func (r AS112TimeseriesGroupQueryTypeParams) URLQuery() (v url.Values)
URLQuery serializes AS112TimeseriesGroupQueryTypeParams's query parameters as `url.Values`.
type AS112TimeseriesGroupQueryTypeParamsAggInterval ¶
type AS112TimeseriesGroupQueryTypeParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AS112TimeseriesGroupQueryTypeParamsAggInterval) IsKnown() bool
type AS112TimeseriesGroupQueryTypeParamsFormat ¶
type AS112TimeseriesGroupQueryTypeParamsFormat string
Format in which results will be returned.
const ( AS112TimeseriesGroupQueryTypeParamsFormatJson AS112TimeseriesGroupQueryTypeParamsFormat = "JSON" AS112TimeseriesGroupQueryTypeParamsFormatCsv AS112TimeseriesGroupQueryTypeParamsFormat = "CSV" )
func (AS112TimeseriesGroupQueryTypeParamsFormat) IsKnown ¶
func (r AS112TimeseriesGroupQueryTypeParamsFormat) IsKnown() bool
type AS112TimeseriesGroupQueryTypeParamsProtocol ¶
type AS112TimeseriesGroupQueryTypeParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112TimeseriesGroupQueryTypeParamsProtocolUdp AS112TimeseriesGroupQueryTypeParamsProtocol = "UDP" AS112TimeseriesGroupQueryTypeParamsProtocolTCP AS112TimeseriesGroupQueryTypeParamsProtocol = "TCP" AS112TimeseriesGroupQueryTypeParamsProtocolHTTPS AS112TimeseriesGroupQueryTypeParamsProtocol = "HTTPS" AS112TimeseriesGroupQueryTypeParamsProtocolTLS AS112TimeseriesGroupQueryTypeParamsProtocol = "TLS" )
func (AS112TimeseriesGroupQueryTypeParamsProtocol) IsKnown ¶
func (r AS112TimeseriesGroupQueryTypeParamsProtocol) IsKnown() bool
type AS112TimeseriesGroupQueryTypeParamsResponseCode ¶
type AS112TimeseriesGroupQueryTypeParamsResponseCode string
Filters results by DNS response code.
const ( AS112TimeseriesGroupQueryTypeParamsResponseCodeNoerror AS112TimeseriesGroupQueryTypeParamsResponseCode = "NOERROR" AS112TimeseriesGroupQueryTypeParamsResponseCodeFormerr AS112TimeseriesGroupQueryTypeParamsResponseCode = "FORMERR" AS112TimeseriesGroupQueryTypeParamsResponseCodeServfail AS112TimeseriesGroupQueryTypeParamsResponseCode = "SERVFAIL" AS112TimeseriesGroupQueryTypeParamsResponseCodeNxdomain AS112TimeseriesGroupQueryTypeParamsResponseCode = "NXDOMAIN" AS112TimeseriesGroupQueryTypeParamsResponseCodeNotimp AS112TimeseriesGroupQueryTypeParamsResponseCode = "NOTIMP" AS112TimeseriesGroupQueryTypeParamsResponseCodeRefused AS112TimeseriesGroupQueryTypeParamsResponseCode = "REFUSED" AS112TimeseriesGroupQueryTypeParamsResponseCodeYxdomain AS112TimeseriesGroupQueryTypeParamsResponseCode = "YXDOMAIN" AS112TimeseriesGroupQueryTypeParamsResponseCodeYxrrset AS112TimeseriesGroupQueryTypeParamsResponseCode = "YXRRSET" AS112TimeseriesGroupQueryTypeParamsResponseCodeNxrrset AS112TimeseriesGroupQueryTypeParamsResponseCode = "NXRRSET" AS112TimeseriesGroupQueryTypeParamsResponseCodeNotauth AS112TimeseriesGroupQueryTypeParamsResponseCode = "NOTAUTH" AS112TimeseriesGroupQueryTypeParamsResponseCodeNotzone AS112TimeseriesGroupQueryTypeParamsResponseCode = "NOTZONE" AS112TimeseriesGroupQueryTypeParamsResponseCodeBadsig AS112TimeseriesGroupQueryTypeParamsResponseCode = "BADSIG" AS112TimeseriesGroupQueryTypeParamsResponseCodeBadkey AS112TimeseriesGroupQueryTypeParamsResponseCode = "BADKEY" AS112TimeseriesGroupQueryTypeParamsResponseCodeBadtime AS112TimeseriesGroupQueryTypeParamsResponseCode = "BADTIME" AS112TimeseriesGroupQueryTypeParamsResponseCodeBadmode AS112TimeseriesGroupQueryTypeParamsResponseCode = "BADMODE" AS112TimeseriesGroupQueryTypeParamsResponseCodeBadname AS112TimeseriesGroupQueryTypeParamsResponseCode = "BADNAME" AS112TimeseriesGroupQueryTypeParamsResponseCodeBadalg AS112TimeseriesGroupQueryTypeParamsResponseCode = "BADALG" AS112TimeseriesGroupQueryTypeParamsResponseCodeBadtrunc AS112TimeseriesGroupQueryTypeParamsResponseCode = "BADTRUNC" )
func (AS112TimeseriesGroupQueryTypeParamsResponseCode) IsKnown ¶
func (r AS112TimeseriesGroupQueryTypeParamsResponseCode) IsKnown() bool
type AS112TimeseriesGroupQueryTypeResponse ¶
type AS112TimeseriesGroupQueryTypeResponse struct {
// Metadata for the results.
Meta AS112TimeseriesGroupQueryTypeResponseMeta `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 AS112TimeseriesGroupQueryTypeResponseMeta ¶
type AS112TimeseriesGroupQueryTypeResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AS112TimeseriesGroupQueryTypeResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112TimeseriesGroupQueryTypeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TimeseriesGroupQueryTypeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TimeseriesGroupQueryTypeResponseMetaUnit `json:"units,required"`
JSON as112TimeseriesGroupQueryTypeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TimeseriesGroupQueryTypeResponseMeta) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupQueryTypeResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupQueryTypeResponseMetaAggInterval ¶
type AS112TimeseriesGroupQueryTypeResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AS112TimeseriesGroupQueryTypeResponseMetaAggIntervalFifteenMinutes AS112TimeseriesGroupQueryTypeResponseMetaAggInterval = "FIFTEEN_MINUTES" AS112TimeseriesGroupQueryTypeResponseMetaAggIntervalOneHour AS112TimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_HOUR" AS112TimeseriesGroupQueryTypeResponseMetaAggIntervalOneDay AS112TimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_DAY" AS112TimeseriesGroupQueryTypeResponseMetaAggIntervalOneWeek AS112TimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_WEEK" AS112TimeseriesGroupQueryTypeResponseMetaAggIntervalOneMonth AS112TimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_MONTH" )
func (AS112TimeseriesGroupQueryTypeResponseMetaAggInterval) IsKnown ¶
func (r AS112TimeseriesGroupQueryTypeResponseMetaAggInterval) IsKnown() bool
type AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfo ¶
type AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfo struct {
Annotations []AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON as112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation ¶
type AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupQueryTypeResponseMetaDateRange ¶
type AS112TimeseriesGroupQueryTypeResponseMetaDateRange 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 as112TimeseriesGroupQueryTypeResponseMetaDateRangeJSON `json:"-"`
}
func (*AS112TimeseriesGroupQueryTypeResponseMetaDateRange) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupQueryTypeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupQueryTypeResponseMetaNormalization ¶
type AS112TimeseriesGroupQueryTypeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TimeseriesGroupQueryTypeResponseMetaNormalizationPercentage AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "PERCENTAGE" AS112TimeseriesGroupQueryTypeResponseMetaNormalizationMin0Max AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "MIN0_MAX" AS112TimeseriesGroupQueryTypeResponseMetaNormalizationMinMax AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "MIN_MAX" AS112TimeseriesGroupQueryTypeResponseMetaNormalizationRawValues AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "RAW_VALUES" AS112TimeseriesGroupQueryTypeResponseMetaNormalizationPercentageChange AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TimeseriesGroupQueryTypeResponseMetaNormalizationRollingAverage AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "ROLLING_AVERAGE" AS112TimeseriesGroupQueryTypeResponseMetaNormalizationOverlappedPercentage AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TimeseriesGroupQueryTypeResponseMetaNormalizationRatio AS112TimeseriesGroupQueryTypeResponseMetaNormalization = "RATIO" )
func (AS112TimeseriesGroupQueryTypeResponseMetaNormalization) IsKnown ¶
func (r AS112TimeseriesGroupQueryTypeResponseMetaNormalization) IsKnown() bool
type AS112TimeseriesGroupQueryTypeResponseMetaUnit ¶
type AS112TimeseriesGroupQueryTypeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TimeseriesGroupQueryTypeResponseMetaUnitJSON `json:"-"`
}
func (*AS112TimeseriesGroupQueryTypeResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupQueryTypeResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupQueryTypeResponseSerie0 ¶
type AS112TimeseriesGroupQueryTypeResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON as112TimeseriesGroupQueryTypeResponseSerie0JSON `json:"-"`
}
func (*AS112TimeseriesGroupQueryTypeResponseSerie0) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupQueryTypeResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupResponseCodesParams ¶
type AS112TimeseriesGroupResponseCodesParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TimeseriesGroupResponseCodesParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112TimeseriesGroupResponseCodesParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112TimeseriesGroupResponseCodesParamsQueryType] `query:"queryType"`
}
func (AS112TimeseriesGroupResponseCodesParams) URLQuery ¶
func (r AS112TimeseriesGroupResponseCodesParams) URLQuery() (v url.Values)
URLQuery serializes AS112TimeseriesGroupResponseCodesParams's query parameters as `url.Values`.
type AS112TimeseriesGroupResponseCodesParamsAggInterval ¶
type AS112TimeseriesGroupResponseCodesParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AS112TimeseriesGroupResponseCodesParamsAggInterval) IsKnown() bool
type AS112TimeseriesGroupResponseCodesParamsFormat ¶
type AS112TimeseriesGroupResponseCodesParamsFormat string
Format in which results will be returned.
const ( AS112TimeseriesGroupResponseCodesParamsFormatJson AS112TimeseriesGroupResponseCodesParamsFormat = "JSON" AS112TimeseriesGroupResponseCodesParamsFormatCsv AS112TimeseriesGroupResponseCodesParamsFormat = "CSV" )
func (AS112TimeseriesGroupResponseCodesParamsFormat) IsKnown ¶
func (r AS112TimeseriesGroupResponseCodesParamsFormat) IsKnown() bool
type AS112TimeseriesGroupResponseCodesParamsProtocol ¶
type AS112TimeseriesGroupResponseCodesParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112TimeseriesGroupResponseCodesParamsProtocolUdp AS112TimeseriesGroupResponseCodesParamsProtocol = "UDP" AS112TimeseriesGroupResponseCodesParamsProtocolTCP AS112TimeseriesGroupResponseCodesParamsProtocol = "TCP" AS112TimeseriesGroupResponseCodesParamsProtocolHTTPS AS112TimeseriesGroupResponseCodesParamsProtocol = "HTTPS" AS112TimeseriesGroupResponseCodesParamsProtocolTLS AS112TimeseriesGroupResponseCodesParamsProtocol = "TLS" )
func (AS112TimeseriesGroupResponseCodesParamsProtocol) IsKnown ¶
func (r AS112TimeseriesGroupResponseCodesParamsProtocol) IsKnown() bool
type AS112TimeseriesGroupResponseCodesParamsQueryType ¶
type AS112TimeseriesGroupResponseCodesParamsQueryType string
Filters results by DNS query type.
const ( AS112TimeseriesGroupResponseCodesParamsQueryTypeA AS112TimeseriesGroupResponseCodesParamsQueryType = "A" AS112TimeseriesGroupResponseCodesParamsQueryTypeAAAA AS112TimeseriesGroupResponseCodesParamsQueryType = "AAAA" AS112TimeseriesGroupResponseCodesParamsQueryTypeA6 AS112TimeseriesGroupResponseCodesParamsQueryType = "A6" AS112TimeseriesGroupResponseCodesParamsQueryTypeAfsdb AS112TimeseriesGroupResponseCodesParamsQueryType = "AFSDB" AS112TimeseriesGroupResponseCodesParamsQueryTypeAny AS112TimeseriesGroupResponseCodesParamsQueryType = "ANY" AS112TimeseriesGroupResponseCodesParamsQueryTypeApl AS112TimeseriesGroupResponseCodesParamsQueryType = "APL" AS112TimeseriesGroupResponseCodesParamsQueryTypeAtma AS112TimeseriesGroupResponseCodesParamsQueryType = "ATMA" AS112TimeseriesGroupResponseCodesParamsQueryTypeAXFR AS112TimeseriesGroupResponseCodesParamsQueryType = "AXFR" AS112TimeseriesGroupResponseCodesParamsQueryTypeCAA AS112TimeseriesGroupResponseCodesParamsQueryType = "CAA" AS112TimeseriesGroupResponseCodesParamsQueryTypeCdnskey AS112TimeseriesGroupResponseCodesParamsQueryType = "CDNSKEY" AS112TimeseriesGroupResponseCodesParamsQueryTypeCds AS112TimeseriesGroupResponseCodesParamsQueryType = "CDS" AS112TimeseriesGroupResponseCodesParamsQueryTypeCERT AS112TimeseriesGroupResponseCodesParamsQueryType = "CERT" AS112TimeseriesGroupResponseCodesParamsQueryTypeCNAME AS112TimeseriesGroupResponseCodesParamsQueryType = "CNAME" AS112TimeseriesGroupResponseCodesParamsQueryTypeCsync AS112TimeseriesGroupResponseCodesParamsQueryType = "CSYNC" AS112TimeseriesGroupResponseCodesParamsQueryTypeDhcid AS112TimeseriesGroupResponseCodesParamsQueryType = "DHCID" AS112TimeseriesGroupResponseCodesParamsQueryTypeDlv AS112TimeseriesGroupResponseCodesParamsQueryType = "DLV" AS112TimeseriesGroupResponseCodesParamsQueryTypeDname AS112TimeseriesGroupResponseCodesParamsQueryType = "DNAME" AS112TimeseriesGroupResponseCodesParamsQueryTypeDNSKEY AS112TimeseriesGroupResponseCodesParamsQueryType = "DNSKEY" AS112TimeseriesGroupResponseCodesParamsQueryTypeDoa AS112TimeseriesGroupResponseCodesParamsQueryType = "DOA" AS112TimeseriesGroupResponseCodesParamsQueryTypeDS AS112TimeseriesGroupResponseCodesParamsQueryType = "DS" AS112TimeseriesGroupResponseCodesParamsQueryTypeEid AS112TimeseriesGroupResponseCodesParamsQueryType = "EID" AS112TimeseriesGroupResponseCodesParamsQueryTypeEui48 AS112TimeseriesGroupResponseCodesParamsQueryType = "EUI48" AS112TimeseriesGroupResponseCodesParamsQueryTypeEui64 AS112TimeseriesGroupResponseCodesParamsQueryType = "EUI64" AS112TimeseriesGroupResponseCodesParamsQueryTypeGpos AS112TimeseriesGroupResponseCodesParamsQueryType = "GPOS" AS112TimeseriesGroupResponseCodesParamsQueryTypeGid AS112TimeseriesGroupResponseCodesParamsQueryType = "GID" AS112TimeseriesGroupResponseCodesParamsQueryTypeHinfo AS112TimeseriesGroupResponseCodesParamsQueryType = "HINFO" AS112TimeseriesGroupResponseCodesParamsQueryTypeHip AS112TimeseriesGroupResponseCodesParamsQueryType = "HIP" AS112TimeseriesGroupResponseCodesParamsQueryTypeHTTPS AS112TimeseriesGroupResponseCodesParamsQueryType = "HTTPS" AS112TimeseriesGroupResponseCodesParamsQueryTypeIpseckey AS112TimeseriesGroupResponseCodesParamsQueryType = "IPSECKEY" AS112TimeseriesGroupResponseCodesParamsQueryTypeIsdn AS112TimeseriesGroupResponseCodesParamsQueryType = "ISDN" AS112TimeseriesGroupResponseCodesParamsQueryTypeIxfr AS112TimeseriesGroupResponseCodesParamsQueryType = "IXFR" AS112TimeseriesGroupResponseCodesParamsQueryTypeKey AS112TimeseriesGroupResponseCodesParamsQueryType = "KEY" AS112TimeseriesGroupResponseCodesParamsQueryTypeKx AS112TimeseriesGroupResponseCodesParamsQueryType = "KX" AS112TimeseriesGroupResponseCodesParamsQueryTypeL32 AS112TimeseriesGroupResponseCodesParamsQueryType = "L32" AS112TimeseriesGroupResponseCodesParamsQueryTypeL64 AS112TimeseriesGroupResponseCodesParamsQueryType = "L64" AS112TimeseriesGroupResponseCodesParamsQueryTypeLOC AS112TimeseriesGroupResponseCodesParamsQueryType = "LOC" AS112TimeseriesGroupResponseCodesParamsQueryTypeLp AS112TimeseriesGroupResponseCodesParamsQueryType = "LP" AS112TimeseriesGroupResponseCodesParamsQueryTypeMaila AS112TimeseriesGroupResponseCodesParamsQueryType = "MAILA" AS112TimeseriesGroupResponseCodesParamsQueryTypeMailb AS112TimeseriesGroupResponseCodesParamsQueryType = "MAILB" AS112TimeseriesGroupResponseCodesParamsQueryTypeMB AS112TimeseriesGroupResponseCodesParamsQueryType = "MB" AS112TimeseriesGroupResponseCodesParamsQueryTypeMd AS112TimeseriesGroupResponseCodesParamsQueryType = "MD" AS112TimeseriesGroupResponseCodesParamsQueryTypeMf AS112TimeseriesGroupResponseCodesParamsQueryType = "MF" AS112TimeseriesGroupResponseCodesParamsQueryTypeMg AS112TimeseriesGroupResponseCodesParamsQueryType = "MG" AS112TimeseriesGroupResponseCodesParamsQueryTypeMinfo AS112TimeseriesGroupResponseCodesParamsQueryType = "MINFO" AS112TimeseriesGroupResponseCodesParamsQueryTypeMr AS112TimeseriesGroupResponseCodesParamsQueryType = "MR" AS112TimeseriesGroupResponseCodesParamsQueryTypeMX AS112TimeseriesGroupResponseCodesParamsQueryType = "MX" AS112TimeseriesGroupResponseCodesParamsQueryTypeNAPTR AS112TimeseriesGroupResponseCodesParamsQueryType = "NAPTR" AS112TimeseriesGroupResponseCodesParamsQueryTypeNb AS112TimeseriesGroupResponseCodesParamsQueryType = "NB" AS112TimeseriesGroupResponseCodesParamsQueryTypeNbstat AS112TimeseriesGroupResponseCodesParamsQueryType = "NBSTAT" AS112TimeseriesGroupResponseCodesParamsQueryTypeNid AS112TimeseriesGroupResponseCodesParamsQueryType = "NID" AS112TimeseriesGroupResponseCodesParamsQueryTypeNimloc AS112TimeseriesGroupResponseCodesParamsQueryType = "NIMLOC" AS112TimeseriesGroupResponseCodesParamsQueryTypeNinfo AS112TimeseriesGroupResponseCodesParamsQueryType = "NINFO" AS112TimeseriesGroupResponseCodesParamsQueryTypeNS AS112TimeseriesGroupResponseCodesParamsQueryType = "NS" AS112TimeseriesGroupResponseCodesParamsQueryTypeNsap AS112TimeseriesGroupResponseCodesParamsQueryType = "NSAP" AS112TimeseriesGroupResponseCodesParamsQueryTypeNsec AS112TimeseriesGroupResponseCodesParamsQueryType = "NSEC" AS112TimeseriesGroupResponseCodesParamsQueryTypeNsec3 AS112TimeseriesGroupResponseCodesParamsQueryType = "NSEC3" AS112TimeseriesGroupResponseCodesParamsQueryTypeNsec3Param AS112TimeseriesGroupResponseCodesParamsQueryType = "NSEC3PARAM" AS112TimeseriesGroupResponseCodesParamsQueryTypeNull AS112TimeseriesGroupResponseCodesParamsQueryType = "NULL" AS112TimeseriesGroupResponseCodesParamsQueryTypeNxt AS112TimeseriesGroupResponseCodesParamsQueryType = "NXT" AS112TimeseriesGroupResponseCodesParamsQueryTypeOpenpgpkey AS112TimeseriesGroupResponseCodesParamsQueryType = "OPENPGPKEY" AS112TimeseriesGroupResponseCodesParamsQueryTypeOpt AS112TimeseriesGroupResponseCodesParamsQueryType = "OPT" AS112TimeseriesGroupResponseCodesParamsQueryTypePTR AS112TimeseriesGroupResponseCodesParamsQueryType = "PTR" AS112TimeseriesGroupResponseCodesParamsQueryTypePx AS112TimeseriesGroupResponseCodesParamsQueryType = "PX" AS112TimeseriesGroupResponseCodesParamsQueryTypeRkey AS112TimeseriesGroupResponseCodesParamsQueryType = "RKEY" AS112TimeseriesGroupResponseCodesParamsQueryTypeRp AS112TimeseriesGroupResponseCodesParamsQueryType = "RP" AS112TimeseriesGroupResponseCodesParamsQueryTypeRrsig AS112TimeseriesGroupResponseCodesParamsQueryType = "RRSIG" AS112TimeseriesGroupResponseCodesParamsQueryTypeRt AS112TimeseriesGroupResponseCodesParamsQueryType = "RT" AS112TimeseriesGroupResponseCodesParamsQueryTypeSig AS112TimeseriesGroupResponseCodesParamsQueryType = "SIG" AS112TimeseriesGroupResponseCodesParamsQueryTypeSink AS112TimeseriesGroupResponseCodesParamsQueryType = "SINK" AS112TimeseriesGroupResponseCodesParamsQueryTypeSMIMEA AS112TimeseriesGroupResponseCodesParamsQueryType = "SMIMEA" AS112TimeseriesGroupResponseCodesParamsQueryTypeSOA AS112TimeseriesGroupResponseCodesParamsQueryType = "SOA" AS112TimeseriesGroupResponseCodesParamsQueryTypeSPF AS112TimeseriesGroupResponseCodesParamsQueryType = "SPF" AS112TimeseriesGroupResponseCodesParamsQueryTypeSRV AS112TimeseriesGroupResponseCodesParamsQueryType = "SRV" AS112TimeseriesGroupResponseCodesParamsQueryTypeSSHFP AS112TimeseriesGroupResponseCodesParamsQueryType = "SSHFP" AS112TimeseriesGroupResponseCodesParamsQueryTypeSVCB AS112TimeseriesGroupResponseCodesParamsQueryType = "SVCB" AS112TimeseriesGroupResponseCodesParamsQueryTypeTa AS112TimeseriesGroupResponseCodesParamsQueryType = "TA" AS112TimeseriesGroupResponseCodesParamsQueryTypeTalink AS112TimeseriesGroupResponseCodesParamsQueryType = "TALINK" AS112TimeseriesGroupResponseCodesParamsQueryTypeTkey AS112TimeseriesGroupResponseCodesParamsQueryType = "TKEY" AS112TimeseriesGroupResponseCodesParamsQueryTypeTLSA AS112TimeseriesGroupResponseCodesParamsQueryType = "TLSA" AS112TimeseriesGroupResponseCodesParamsQueryTypeTSIG AS112TimeseriesGroupResponseCodesParamsQueryType = "TSIG" AS112TimeseriesGroupResponseCodesParamsQueryTypeTXT AS112TimeseriesGroupResponseCodesParamsQueryType = "TXT" AS112TimeseriesGroupResponseCodesParamsQueryTypeUinfo AS112TimeseriesGroupResponseCodesParamsQueryType = "UINFO" AS112TimeseriesGroupResponseCodesParamsQueryTypeUID AS112TimeseriesGroupResponseCodesParamsQueryType = "UID" AS112TimeseriesGroupResponseCodesParamsQueryTypeUnspec AS112TimeseriesGroupResponseCodesParamsQueryType = "UNSPEC" AS112TimeseriesGroupResponseCodesParamsQueryTypeURI AS112TimeseriesGroupResponseCodesParamsQueryType = "URI" AS112TimeseriesGroupResponseCodesParamsQueryTypeWks AS112TimeseriesGroupResponseCodesParamsQueryType = "WKS" AS112TimeseriesGroupResponseCodesParamsQueryTypeX25 AS112TimeseriesGroupResponseCodesParamsQueryType = "X25" AS112TimeseriesGroupResponseCodesParamsQueryTypeZonemd AS112TimeseriesGroupResponseCodesParamsQueryType = "ZONEMD" )
func (AS112TimeseriesGroupResponseCodesParamsQueryType) IsKnown ¶
func (r AS112TimeseriesGroupResponseCodesParamsQueryType) IsKnown() bool
type AS112TimeseriesGroupResponseCodesResponse ¶
type AS112TimeseriesGroupResponseCodesResponse struct {
// Metadata for the results.
Meta AS112TimeseriesGroupResponseCodesResponseMeta `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 AS112TimeseriesGroupResponseCodesResponseMeta ¶
type AS112TimeseriesGroupResponseCodesResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AS112TimeseriesGroupResponseCodesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112TimeseriesGroupResponseCodesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TimeseriesGroupResponseCodesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TimeseriesGroupResponseCodesResponseMetaUnit `json:"units,required"`
JSON as112TimeseriesGroupResponseCodesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TimeseriesGroupResponseCodesResponseMeta) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupResponseCodesResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupResponseCodesResponseMetaAggInterval ¶
type AS112TimeseriesGroupResponseCodesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AS112TimeseriesGroupResponseCodesResponseMetaAggIntervalFifteenMinutes AS112TimeseriesGroupResponseCodesResponseMetaAggInterval = "FIFTEEN_MINUTES" AS112TimeseriesGroupResponseCodesResponseMetaAggIntervalOneHour AS112TimeseriesGroupResponseCodesResponseMetaAggInterval = "ONE_HOUR" AS112TimeseriesGroupResponseCodesResponseMetaAggIntervalOneDay AS112TimeseriesGroupResponseCodesResponseMetaAggInterval = "ONE_DAY" AS112TimeseriesGroupResponseCodesResponseMetaAggIntervalOneWeek AS112TimeseriesGroupResponseCodesResponseMetaAggInterval = "ONE_WEEK" AS112TimeseriesGroupResponseCodesResponseMetaAggIntervalOneMonth AS112TimeseriesGroupResponseCodesResponseMetaAggInterval = "ONE_MONTH" )
func (AS112TimeseriesGroupResponseCodesResponseMetaAggInterval) IsKnown ¶
func (r AS112TimeseriesGroupResponseCodesResponseMetaAggInterval) IsKnown() bool
type AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfo ¶
type AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfo struct {
Annotations []AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON as112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoAnnotation ¶
type AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupResponseCodesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupResponseCodesResponseMetaDateRange ¶
type AS112TimeseriesGroupResponseCodesResponseMetaDateRange 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 as112TimeseriesGroupResponseCodesResponseMetaDateRangeJSON `json:"-"`
}
func (*AS112TimeseriesGroupResponseCodesResponseMetaDateRange) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupResponseCodesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupResponseCodesResponseMetaNormalization ¶
type AS112TimeseriesGroupResponseCodesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TimeseriesGroupResponseCodesResponseMetaNormalizationPercentage AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "PERCENTAGE" AS112TimeseriesGroupResponseCodesResponseMetaNormalizationMin0Max AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "MIN0_MAX" AS112TimeseriesGroupResponseCodesResponseMetaNormalizationMinMax AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "MIN_MAX" AS112TimeseriesGroupResponseCodesResponseMetaNormalizationRawValues AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "RAW_VALUES" AS112TimeseriesGroupResponseCodesResponseMetaNormalizationPercentageChange AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TimeseriesGroupResponseCodesResponseMetaNormalizationRollingAverage AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "ROLLING_AVERAGE" AS112TimeseriesGroupResponseCodesResponseMetaNormalizationOverlappedPercentage AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TimeseriesGroupResponseCodesResponseMetaNormalizationRatio AS112TimeseriesGroupResponseCodesResponseMetaNormalization = "RATIO" )
func (AS112TimeseriesGroupResponseCodesResponseMetaNormalization) IsKnown ¶
func (r AS112TimeseriesGroupResponseCodesResponseMetaNormalization) IsKnown() bool
type AS112TimeseriesGroupResponseCodesResponseMetaUnit ¶
type AS112TimeseriesGroupResponseCodesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TimeseriesGroupResponseCodesResponseMetaUnitJSON `json:"-"`
}
func (*AS112TimeseriesGroupResponseCodesResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TimeseriesGroupResponseCodesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesGroupResponseCodesResponseSerie0 ¶
type AS112TimeseriesGroupResponseCodesResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
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 ¶
func (r *AS112TimeseriesGroupService) DNSSEC(ctx context.Context, query AS112TimeseriesGroupDNSSECParams, opts ...option.RequestOption) (res *AS112TimeseriesGroupDNSSECResponse, err error)
Retrieves the distribution of AS112 DNS queries by DNSSEC (DNS Security Extensions) support over time.
func (*AS112TimeseriesGroupService) Edns ¶
func (r *AS112TimeseriesGroupService) Edns(ctx context.Context, query AS112TimeseriesGroupEdnsParams, opts ...option.RequestOption) (res *AS112TimeseriesGroupEdnsResponse, err error)
Retrieves the distribution of AS112 DNS queries by EDNS (Extension Mechanisms for DNS) support over time.
func (*AS112TimeseriesGroupService) IPVersion ¶
func (r *AS112TimeseriesGroupService) IPVersion(ctx context.Context, query AS112TimeseriesGroupIPVersionParams, opts ...option.RequestOption) (res *AS112TimeseriesGroupIPVersionResponse, err error)
Retrieves the distribution of AS112 DNS queries by IP version over time.
func (*AS112TimeseriesGroupService) Protocol ¶
func (r *AS112TimeseriesGroupService) Protocol(ctx context.Context, query AS112TimeseriesGroupProtocolParams, opts ...option.RequestOption) (res *AS112TimeseriesGroupProtocolResponse, err error)
Retrieves the distribution of AS112 DNS requests classified by protocol over time.
func (*AS112TimeseriesGroupService) QueryType ¶
func (r *AS112TimeseriesGroupService) QueryType(ctx context.Context, query AS112TimeseriesGroupQueryTypeParams, opts ...option.RequestOption) (res *AS112TimeseriesGroupQueryTypeResponse, err error)
Retrieves the distribution of AS112 DNS queries by type over time.
func (*AS112TimeseriesGroupService) ResponseCodes ¶
func (r *AS112TimeseriesGroupService) ResponseCodes(ctx context.Context, query AS112TimeseriesGroupResponseCodesParams, opts ...option.RequestOption) (res *AS112TimeseriesGroupResponseCodesResponse, err error)
Retrieves the distribution of AS112 DNS requests classified by response code over time.
type AS112TimeseriesParams ¶
type AS112TimeseriesParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TimeseriesParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by DNS transport protocol.
Protocol param.Field[AS112TimeseriesParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[AS112TimeseriesParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[AS112TimeseriesParamsResponseCode] `query:"responseCode"`
}
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 of the results (e.g., 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 ¶
func (r AS112TimeseriesParamsAggInterval) IsKnown() bool
type AS112TimeseriesParamsFormat ¶
type AS112TimeseriesParamsFormat string
Format in which results will be returned.
const ( AS112TimeseriesParamsFormatJson AS112TimeseriesParamsFormat = "JSON" AS112TimeseriesParamsFormatCsv AS112TimeseriesParamsFormat = "CSV" )
func (AS112TimeseriesParamsFormat) IsKnown ¶
func (r AS112TimeseriesParamsFormat) IsKnown() bool
type AS112TimeseriesParamsProtocol ¶
type AS112TimeseriesParamsProtocol string
Filters results by DNS transport protocol.
const ( AS112TimeseriesParamsProtocolUdp AS112TimeseriesParamsProtocol = "UDP" AS112TimeseriesParamsProtocolTCP AS112TimeseriesParamsProtocol = "TCP" AS112TimeseriesParamsProtocolHTTPS AS112TimeseriesParamsProtocol = "HTTPS" AS112TimeseriesParamsProtocolTLS AS112TimeseriesParamsProtocol = "TLS" )
func (AS112TimeseriesParamsProtocol) IsKnown ¶
func (r AS112TimeseriesParamsProtocol) IsKnown() bool
type AS112TimeseriesParamsQueryType ¶
type AS112TimeseriesParamsQueryType string
Filters results by DNS query type.
const ( AS112TimeseriesParamsQueryTypeA AS112TimeseriesParamsQueryType = "A" AS112TimeseriesParamsQueryTypeAAAA AS112TimeseriesParamsQueryType = "AAAA" AS112TimeseriesParamsQueryTypeA6 AS112TimeseriesParamsQueryType = "A6" AS112TimeseriesParamsQueryTypeAfsdb AS112TimeseriesParamsQueryType = "AFSDB" AS112TimeseriesParamsQueryTypeAny AS112TimeseriesParamsQueryType = "ANY" AS112TimeseriesParamsQueryTypeApl AS112TimeseriesParamsQueryType = "APL" AS112TimeseriesParamsQueryTypeAtma AS112TimeseriesParamsQueryType = "ATMA" AS112TimeseriesParamsQueryTypeAXFR AS112TimeseriesParamsQueryType = "AXFR" AS112TimeseriesParamsQueryTypeCAA AS112TimeseriesParamsQueryType = "CAA" AS112TimeseriesParamsQueryTypeCdnskey AS112TimeseriesParamsQueryType = "CDNSKEY" AS112TimeseriesParamsQueryTypeCds AS112TimeseriesParamsQueryType = "CDS" AS112TimeseriesParamsQueryTypeCERT AS112TimeseriesParamsQueryType = "CERT" AS112TimeseriesParamsQueryTypeCNAME AS112TimeseriesParamsQueryType = "CNAME" AS112TimeseriesParamsQueryTypeCsync AS112TimeseriesParamsQueryType = "CSYNC" AS112TimeseriesParamsQueryTypeDhcid AS112TimeseriesParamsQueryType = "DHCID" AS112TimeseriesParamsQueryTypeDlv AS112TimeseriesParamsQueryType = "DLV" AS112TimeseriesParamsQueryTypeDname AS112TimeseriesParamsQueryType = "DNAME" AS112TimeseriesParamsQueryTypeDNSKEY AS112TimeseriesParamsQueryType = "DNSKEY" AS112TimeseriesParamsQueryTypeDoa AS112TimeseriesParamsQueryType = "DOA" AS112TimeseriesParamsQueryTypeDS AS112TimeseriesParamsQueryType = "DS" AS112TimeseriesParamsQueryTypeEid AS112TimeseriesParamsQueryType = "EID" AS112TimeseriesParamsQueryTypeEui48 AS112TimeseriesParamsQueryType = "EUI48" AS112TimeseriesParamsQueryTypeEui64 AS112TimeseriesParamsQueryType = "EUI64" AS112TimeseriesParamsQueryTypeGpos AS112TimeseriesParamsQueryType = "GPOS" AS112TimeseriesParamsQueryTypeGid AS112TimeseriesParamsQueryType = "GID" AS112TimeseriesParamsQueryTypeHinfo AS112TimeseriesParamsQueryType = "HINFO" AS112TimeseriesParamsQueryTypeHip AS112TimeseriesParamsQueryType = "HIP" AS112TimeseriesParamsQueryTypeHTTPS AS112TimeseriesParamsQueryType = "HTTPS" AS112TimeseriesParamsQueryTypeIpseckey AS112TimeseriesParamsQueryType = "IPSECKEY" AS112TimeseriesParamsQueryTypeIsdn AS112TimeseriesParamsQueryType = "ISDN" AS112TimeseriesParamsQueryTypeIxfr AS112TimeseriesParamsQueryType = "IXFR" AS112TimeseriesParamsQueryTypeKey AS112TimeseriesParamsQueryType = "KEY" AS112TimeseriesParamsQueryTypeKx AS112TimeseriesParamsQueryType = "KX" AS112TimeseriesParamsQueryTypeL32 AS112TimeseriesParamsQueryType = "L32" AS112TimeseriesParamsQueryTypeL64 AS112TimeseriesParamsQueryType = "L64" AS112TimeseriesParamsQueryTypeLOC AS112TimeseriesParamsQueryType = "LOC" AS112TimeseriesParamsQueryTypeLp AS112TimeseriesParamsQueryType = "LP" AS112TimeseriesParamsQueryTypeMaila AS112TimeseriesParamsQueryType = "MAILA" AS112TimeseriesParamsQueryTypeMailb AS112TimeseriesParamsQueryType = "MAILB" AS112TimeseriesParamsQueryTypeMB AS112TimeseriesParamsQueryType = "MB" AS112TimeseriesParamsQueryTypeMd AS112TimeseriesParamsQueryType = "MD" AS112TimeseriesParamsQueryTypeMf AS112TimeseriesParamsQueryType = "MF" AS112TimeseriesParamsQueryTypeMg AS112TimeseriesParamsQueryType = "MG" AS112TimeseriesParamsQueryTypeMinfo AS112TimeseriesParamsQueryType = "MINFO" AS112TimeseriesParamsQueryTypeMr AS112TimeseriesParamsQueryType = "MR" AS112TimeseriesParamsQueryTypeMX AS112TimeseriesParamsQueryType = "MX" AS112TimeseriesParamsQueryTypeNAPTR AS112TimeseriesParamsQueryType = "NAPTR" AS112TimeseriesParamsQueryTypeNb AS112TimeseriesParamsQueryType = "NB" AS112TimeseriesParamsQueryTypeNbstat AS112TimeseriesParamsQueryType = "NBSTAT" AS112TimeseriesParamsQueryTypeNid AS112TimeseriesParamsQueryType = "NID" AS112TimeseriesParamsQueryTypeNimloc AS112TimeseriesParamsQueryType = "NIMLOC" AS112TimeseriesParamsQueryTypeNinfo AS112TimeseriesParamsQueryType = "NINFO" AS112TimeseriesParamsQueryTypeNS AS112TimeseriesParamsQueryType = "NS" AS112TimeseriesParamsQueryTypeNsap AS112TimeseriesParamsQueryType = "NSAP" AS112TimeseriesParamsQueryTypeNsec AS112TimeseriesParamsQueryType = "NSEC" AS112TimeseriesParamsQueryTypeNsec3 AS112TimeseriesParamsQueryType = "NSEC3" AS112TimeseriesParamsQueryTypeNsec3Param AS112TimeseriesParamsQueryType = "NSEC3PARAM" AS112TimeseriesParamsQueryTypeNull AS112TimeseriesParamsQueryType = "NULL" AS112TimeseriesParamsQueryTypeNxt AS112TimeseriesParamsQueryType = "NXT" AS112TimeseriesParamsQueryTypeOpenpgpkey AS112TimeseriesParamsQueryType = "OPENPGPKEY" AS112TimeseriesParamsQueryTypeOpt AS112TimeseriesParamsQueryType = "OPT" AS112TimeseriesParamsQueryTypePTR AS112TimeseriesParamsQueryType = "PTR" AS112TimeseriesParamsQueryTypePx AS112TimeseriesParamsQueryType = "PX" AS112TimeseriesParamsQueryTypeRkey AS112TimeseriesParamsQueryType = "RKEY" AS112TimeseriesParamsQueryTypeRp AS112TimeseriesParamsQueryType = "RP" AS112TimeseriesParamsQueryTypeRrsig AS112TimeseriesParamsQueryType = "RRSIG" AS112TimeseriesParamsQueryTypeRt AS112TimeseriesParamsQueryType = "RT" AS112TimeseriesParamsQueryTypeSig AS112TimeseriesParamsQueryType = "SIG" AS112TimeseriesParamsQueryTypeSink AS112TimeseriesParamsQueryType = "SINK" AS112TimeseriesParamsQueryTypeSMIMEA AS112TimeseriesParamsQueryType = "SMIMEA" AS112TimeseriesParamsQueryTypeSOA AS112TimeseriesParamsQueryType = "SOA" AS112TimeseriesParamsQueryTypeSPF AS112TimeseriesParamsQueryType = "SPF" AS112TimeseriesParamsQueryTypeSRV AS112TimeseriesParamsQueryType = "SRV" AS112TimeseriesParamsQueryTypeSSHFP AS112TimeseriesParamsQueryType = "SSHFP" AS112TimeseriesParamsQueryTypeSVCB AS112TimeseriesParamsQueryType = "SVCB" AS112TimeseriesParamsQueryTypeTa AS112TimeseriesParamsQueryType = "TA" AS112TimeseriesParamsQueryTypeTalink AS112TimeseriesParamsQueryType = "TALINK" AS112TimeseriesParamsQueryTypeTkey AS112TimeseriesParamsQueryType = "TKEY" AS112TimeseriesParamsQueryTypeTLSA AS112TimeseriesParamsQueryType = "TLSA" AS112TimeseriesParamsQueryTypeTSIG AS112TimeseriesParamsQueryType = "TSIG" AS112TimeseriesParamsQueryTypeTXT AS112TimeseriesParamsQueryType = "TXT" AS112TimeseriesParamsQueryTypeUinfo AS112TimeseriesParamsQueryType = "UINFO" AS112TimeseriesParamsQueryTypeUID AS112TimeseriesParamsQueryType = "UID" AS112TimeseriesParamsQueryTypeUnspec AS112TimeseriesParamsQueryType = "UNSPEC" AS112TimeseriesParamsQueryTypeURI AS112TimeseriesParamsQueryType = "URI" AS112TimeseriesParamsQueryTypeWks AS112TimeseriesParamsQueryType = "WKS" AS112TimeseriesParamsQueryTypeX25 AS112TimeseriesParamsQueryType = "X25" AS112TimeseriesParamsQueryTypeZonemd AS112TimeseriesParamsQueryType = "ZONEMD" )
func (AS112TimeseriesParamsQueryType) IsKnown ¶
func (r AS112TimeseriesParamsQueryType) IsKnown() bool
type AS112TimeseriesParamsResponseCode ¶
type AS112TimeseriesParamsResponseCode string
Filters results by DNS response code.
const ( AS112TimeseriesParamsResponseCodeNoerror AS112TimeseriesParamsResponseCode = "NOERROR" AS112TimeseriesParamsResponseCodeFormerr AS112TimeseriesParamsResponseCode = "FORMERR" AS112TimeseriesParamsResponseCodeServfail AS112TimeseriesParamsResponseCode = "SERVFAIL" AS112TimeseriesParamsResponseCodeNxdomain AS112TimeseriesParamsResponseCode = "NXDOMAIN" AS112TimeseriesParamsResponseCodeNotimp AS112TimeseriesParamsResponseCode = "NOTIMP" AS112TimeseriesParamsResponseCodeRefused AS112TimeseriesParamsResponseCode = "REFUSED" AS112TimeseriesParamsResponseCodeYxdomain AS112TimeseriesParamsResponseCode = "YXDOMAIN" AS112TimeseriesParamsResponseCodeYxrrset AS112TimeseriesParamsResponseCode = "YXRRSET" AS112TimeseriesParamsResponseCodeNxrrset AS112TimeseriesParamsResponseCode = "NXRRSET" AS112TimeseriesParamsResponseCodeNotauth AS112TimeseriesParamsResponseCode = "NOTAUTH" AS112TimeseriesParamsResponseCodeNotzone AS112TimeseriesParamsResponseCode = "NOTZONE" AS112TimeseriesParamsResponseCodeBadsig AS112TimeseriesParamsResponseCode = "BADSIG" AS112TimeseriesParamsResponseCodeBadkey AS112TimeseriesParamsResponseCode = "BADKEY" AS112TimeseriesParamsResponseCodeBadtime AS112TimeseriesParamsResponseCode = "BADTIME" AS112TimeseriesParamsResponseCodeBadmode AS112TimeseriesParamsResponseCode = "BADMODE" AS112TimeseriesParamsResponseCodeBadname AS112TimeseriesParamsResponseCode = "BADNAME" AS112TimeseriesParamsResponseCodeBadalg AS112TimeseriesParamsResponseCode = "BADALG" AS112TimeseriesParamsResponseCodeBadtrunc AS112TimeseriesParamsResponseCode = "BADTRUNC" )
func (AS112TimeseriesParamsResponseCode) IsKnown ¶
func (r AS112TimeseriesParamsResponseCode) IsKnown() bool
type AS112TimeseriesResponse ¶
type AS112TimeseriesResponse struct {
// Metadata for the results.
Meta AS112TimeseriesResponseMeta `json:"meta,required"`
ExtraFields map[string]AS112TimeseriesResponse `json:"-,extras"`
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 {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AS112TimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AS112TimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AS112TimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TimeseriesResponseMetaUnit `json:"units,required"`
JSON as112TimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TimeseriesResponseMeta) UnmarshalJSON ¶
func (r *AS112TimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TimeseriesResponseMetaAggInterval ¶
type AS112TimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AS112TimeseriesResponseMetaAggIntervalFifteenMinutes AS112TimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" AS112TimeseriesResponseMetaAggIntervalOneHour AS112TimeseriesResponseMetaAggInterval = "ONE_HOUR" AS112TimeseriesResponseMetaAggIntervalOneDay AS112TimeseriesResponseMetaAggInterval = "ONE_DAY" AS112TimeseriesResponseMetaAggIntervalOneWeek AS112TimeseriesResponseMetaAggInterval = "ONE_WEEK" AS112TimeseriesResponseMetaAggIntervalOneMonth AS112TimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (AS112TimeseriesResponseMetaAggInterval) IsKnown ¶
func (r AS112TimeseriesResponseMetaAggInterval) IsKnown() bool
type AS112TimeseriesResponseMetaConfidenceInfo ¶
type AS112TimeseriesResponseMetaConfidenceInfo struct {
Annotations []AS112TimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 AS112TimeseriesResponseMetaNormalization ¶
type AS112TimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TimeseriesResponseMetaNormalizationPercentage AS112TimeseriesResponseMetaNormalization = "PERCENTAGE" AS112TimeseriesResponseMetaNormalizationMin0Max AS112TimeseriesResponseMetaNormalization = "MIN0_MAX" AS112TimeseriesResponseMetaNormalizationMinMax AS112TimeseriesResponseMetaNormalization = "MIN_MAX" AS112TimeseriesResponseMetaNormalizationRawValues AS112TimeseriesResponseMetaNormalization = "RAW_VALUES" AS112TimeseriesResponseMetaNormalizationPercentageChange AS112TimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TimeseriesResponseMetaNormalizationRollingAverage AS112TimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" AS112TimeseriesResponseMetaNormalizationOverlappedPercentage AS112TimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TimeseriesResponseMetaNormalizationRatio AS112TimeseriesResponseMetaNormalization = "RATIO" )
func (AS112TimeseriesResponseMetaNormalization) IsKnown ¶
func (r AS112TimeseriesResponseMetaNormalization) IsKnown() bool
type AS112TimeseriesResponseMetaUnit ¶
type AS112TimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*AS112TimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TimeseriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TopDNSSECParams ¶
type AS112TopDNSSECParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TopDNSSECParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 (DNS Security Extensions) status.
const ( AS112TopDNSSECParamsDNSSECSupported AS112TopDNSSECParamsDNSSEC = "SUPPORTED" AS112TopDNSSECParamsDNSSECNotSupported AS112TopDNSSECParamsDNSSEC = "NOT_SUPPORTED" )
func (AS112TopDNSSECParamsDNSSEC) IsKnown ¶
func (r AS112TopDNSSECParamsDNSSEC) IsKnown() bool
type AS112TopDNSSECParamsFormat ¶
type AS112TopDNSSECParamsFormat string
Format in which results will be returned.
const ( AS112TopDNSSECParamsFormatJson AS112TopDNSSECParamsFormat = "JSON" AS112TopDNSSECParamsFormatCsv AS112TopDNSSECParamsFormat = "CSV" )
func (AS112TopDNSSECParamsFormat) IsKnown ¶
func (r AS112TopDNSSECParamsFormat) IsKnown() bool
type AS112TopDNSSECResponse ¶
type AS112TopDNSSECResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112TopDNSSECResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AS112TopDNSSECResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TopDNSSECResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TopDNSSECResponseMetaUnit `json:"units,required"`
JSON as112TopDNSSECResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TopDNSSECResponseMeta) UnmarshalJSON ¶
func (r *AS112TopDNSSECResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TopDNSSECResponseMetaConfidenceInfo ¶
type AS112TopDNSSECResponseMetaConfidenceInfo struct {
Annotations []AS112TopDNSSECResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TopDNSSECResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 AS112TopDNSSECResponseMetaNormalization ¶
type AS112TopDNSSECResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TopDNSSECResponseMetaNormalizationPercentage AS112TopDNSSECResponseMetaNormalization = "PERCENTAGE" AS112TopDNSSECResponseMetaNormalizationMin0Max AS112TopDNSSECResponseMetaNormalization = "MIN0_MAX" AS112TopDNSSECResponseMetaNormalizationMinMax AS112TopDNSSECResponseMetaNormalization = "MIN_MAX" AS112TopDNSSECResponseMetaNormalizationRawValues AS112TopDNSSECResponseMetaNormalization = "RAW_VALUES" AS112TopDNSSECResponseMetaNormalizationPercentageChange AS112TopDNSSECResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TopDNSSECResponseMetaNormalizationRollingAverage AS112TopDNSSECResponseMetaNormalization = "ROLLING_AVERAGE" AS112TopDNSSECResponseMetaNormalizationOverlappedPercentage AS112TopDNSSECResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TopDNSSECResponseMetaNormalizationRatio AS112TopDNSSECResponseMetaNormalization = "RATIO" )
func (AS112TopDNSSECResponseMetaNormalization) IsKnown ¶
func (r AS112TopDNSSECResponseMetaNormalization) IsKnown() bool
type AS112TopDNSSECResponseMetaUnit ¶
type AS112TopDNSSECResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TopDNSSECResponseMetaUnitJSON `json:"-"`
}
func (*AS112TopDNSSECResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TopDNSSECResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TopDNSSECResponseTop0 ¶
type AS112TopDNSSECResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
Value string `json:"value,required"`
JSON as112TopDNSSECResponseTop0JSON `json:"-"`
}
func (*AS112TopDNSSECResponseTop0) UnmarshalJSON ¶
func (r *AS112TopDNSSECResponseTop0) UnmarshalJSON(data []byte) (err error)
type AS112TopEdnsParams ¶
type AS112TopEdnsParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TopEdnsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 (Extension Mechanisms for DNS) status.
const ( AS112TopEdnsParamsEdnsSupported AS112TopEdnsParamsEdns = "SUPPORTED" AS112TopEdnsParamsEdnsNotSupported AS112TopEdnsParamsEdns = "NOT_SUPPORTED" )
func (AS112TopEdnsParamsEdns) IsKnown ¶
func (r AS112TopEdnsParamsEdns) IsKnown() bool
type AS112TopEdnsParamsFormat ¶
type AS112TopEdnsParamsFormat string
Format in which results will be returned.
const ( AS112TopEdnsParamsFormatJson AS112TopEdnsParamsFormat = "JSON" AS112TopEdnsParamsFormatCsv AS112TopEdnsParamsFormat = "CSV" )
func (AS112TopEdnsParamsFormat) IsKnown ¶
func (r AS112TopEdnsParamsFormat) IsKnown() bool
type AS112TopEdnsResponse ¶
type AS112TopEdnsResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112TopEdnsResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AS112TopEdnsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TopEdnsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TopEdnsResponseMetaUnit `json:"units,required"`
JSON as112TopEdnsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TopEdnsResponseMeta) UnmarshalJSON ¶
func (r *AS112TopEdnsResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TopEdnsResponseMetaConfidenceInfo ¶
type AS112TopEdnsResponseMetaConfidenceInfo struct {
Annotations []AS112TopEdnsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TopEdnsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 AS112TopEdnsResponseMetaNormalization ¶
type AS112TopEdnsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TopEdnsResponseMetaNormalizationPercentage AS112TopEdnsResponseMetaNormalization = "PERCENTAGE" AS112TopEdnsResponseMetaNormalizationMin0Max AS112TopEdnsResponseMetaNormalization = "MIN0_MAX" AS112TopEdnsResponseMetaNormalizationMinMax AS112TopEdnsResponseMetaNormalization = "MIN_MAX" AS112TopEdnsResponseMetaNormalizationRawValues AS112TopEdnsResponseMetaNormalization = "RAW_VALUES" AS112TopEdnsResponseMetaNormalizationPercentageChange AS112TopEdnsResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TopEdnsResponseMetaNormalizationRollingAverage AS112TopEdnsResponseMetaNormalization = "ROLLING_AVERAGE" AS112TopEdnsResponseMetaNormalizationOverlappedPercentage AS112TopEdnsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TopEdnsResponseMetaNormalizationRatio AS112TopEdnsResponseMetaNormalization = "RATIO" )
func (AS112TopEdnsResponseMetaNormalization) IsKnown ¶
func (r AS112TopEdnsResponseMetaNormalization) IsKnown() bool
type AS112TopEdnsResponseMetaUnit ¶
type AS112TopEdnsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TopEdnsResponseMetaUnitJSON `json:"-"`
}
func (*AS112TopEdnsResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TopEdnsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TopEdnsResponseTop0 ¶
type AS112TopEdnsResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
Value string `json:"value,required"`
JSON as112TopEdnsResponseTop0JSON `json:"-"`
}
func (*AS112TopEdnsResponseTop0) UnmarshalJSON ¶
func (r *AS112TopEdnsResponseTop0) UnmarshalJSON(data []byte) (err error)
type AS112TopIPVersionParams ¶
type AS112TopIPVersionParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TopIPVersionParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
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 ¶
func (r AS112TopIPVersionParamsIPVersion) IsKnown() bool
type AS112TopIPVersionResponse ¶
type AS112TopIPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112TopIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AS112TopIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TopIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TopIPVersionResponseMetaUnit `json:"units,required"`
JSON as112TopIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TopIPVersionResponseMeta) UnmarshalJSON ¶
func (r *AS112TopIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TopIPVersionResponseMetaConfidenceInfo ¶
type AS112TopIPVersionResponseMetaConfidenceInfo struct {
Annotations []AS112TopIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TopIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 AS112TopIPVersionResponseMetaNormalization ¶
type AS112TopIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TopIPVersionResponseMetaNormalizationPercentage AS112TopIPVersionResponseMetaNormalization = "PERCENTAGE" AS112TopIPVersionResponseMetaNormalizationMin0Max AS112TopIPVersionResponseMetaNormalization = "MIN0_MAX" AS112TopIPVersionResponseMetaNormalizationMinMax AS112TopIPVersionResponseMetaNormalization = "MIN_MAX" AS112TopIPVersionResponseMetaNormalizationRawValues AS112TopIPVersionResponseMetaNormalization = "RAW_VALUES" AS112TopIPVersionResponseMetaNormalizationPercentageChange AS112TopIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TopIPVersionResponseMetaNormalizationRollingAverage AS112TopIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AS112TopIPVersionResponseMetaNormalizationOverlappedPercentage AS112TopIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TopIPVersionResponseMetaNormalizationRatio AS112TopIPVersionResponseMetaNormalization = "RATIO" )
func (AS112TopIPVersionResponseMetaNormalization) IsKnown ¶
func (r AS112TopIPVersionResponseMetaNormalization) IsKnown() bool
type AS112TopIPVersionResponseMetaUnit ¶
type AS112TopIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TopIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AS112TopIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TopIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TopIPVersionResponseTop0 ¶
type AS112TopIPVersionResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
Value string `json:"value,required"`
JSON as112TopIPVersionResponseTop0JSON `json:"-"`
}
func (*AS112TopIPVersionResponseTop0) UnmarshalJSON ¶
func (r *AS112TopIPVersionResponseTop0) UnmarshalJSON(data []byte) (err error)
type AS112TopLocationsParams ¶
type AS112TopLocationsParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AS112TopLocationsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( AS112TopLocationsParamsFormatJson AS112TopLocationsParamsFormat = "JSON" AS112TopLocationsParamsFormatCsv AS112TopLocationsParamsFormat = "CSV" )
func (AS112TopLocationsParamsFormat) IsKnown ¶
func (r AS112TopLocationsParamsFormat) IsKnown() bool
type AS112TopLocationsResponse ¶
type AS112TopLocationsResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AS112TopLocationsResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AS112TopLocationsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AS112TopLocationsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AS112TopLocationsResponseMetaUnit `json:"units,required"`
JSON as112TopLocationsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AS112TopLocationsResponseMeta) UnmarshalJSON ¶
func (r *AS112TopLocationsResponseMeta) UnmarshalJSON(data []byte) (err error)
type AS112TopLocationsResponseMetaConfidenceInfo ¶
type AS112TopLocationsResponseMetaConfidenceInfo struct {
Annotations []AS112TopLocationsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON as112TopLocationsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 AS112TopLocationsResponseMetaNormalization ¶
type AS112TopLocationsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AS112TopLocationsResponseMetaNormalizationPercentage AS112TopLocationsResponseMetaNormalization = "PERCENTAGE" AS112TopLocationsResponseMetaNormalizationMin0Max AS112TopLocationsResponseMetaNormalization = "MIN0_MAX" AS112TopLocationsResponseMetaNormalizationMinMax AS112TopLocationsResponseMetaNormalization = "MIN_MAX" AS112TopLocationsResponseMetaNormalizationRawValues AS112TopLocationsResponseMetaNormalization = "RAW_VALUES" AS112TopLocationsResponseMetaNormalizationPercentageChange AS112TopLocationsResponseMetaNormalization = "PERCENTAGE_CHANGE" AS112TopLocationsResponseMetaNormalizationRollingAverage AS112TopLocationsResponseMetaNormalization = "ROLLING_AVERAGE" AS112TopLocationsResponseMetaNormalizationOverlappedPercentage AS112TopLocationsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AS112TopLocationsResponseMetaNormalizationRatio AS112TopLocationsResponseMetaNormalization = "RATIO" )
func (AS112TopLocationsResponseMetaNormalization) IsKnown ¶
func (r AS112TopLocationsResponseMetaNormalization) IsKnown() bool
type AS112TopLocationsResponseMetaUnit ¶
type AS112TopLocationsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON as112TopLocationsResponseMetaUnitJSON `json:"-"`
}
func (*AS112TopLocationsResponseMetaUnit) UnmarshalJSON ¶
func (r *AS112TopLocationsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AS112TopLocationsResponseTop0 ¶
type AS112TopLocationsResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *AS112TopService) DNSSEC(ctx context.Context, dnssec AS112TopDNSSECParamsDNSSEC, query AS112TopDNSSECParams, opts ...option.RequestOption) (res *AS112TopDNSSECResponse, err error)
Retrieves the top locations of DNS queries to AS112 with DNSSEC (DNS Security Extensions) support.
func (*AS112TopService) Edns ¶
func (r *AS112TopService) Edns(ctx context.Context, edns AS112TopEdnsParamsEdns, query AS112TopEdnsParams, opts ...option.RequestOption) (res *AS112TopEdnsResponse, err error)
Retrieves the top locations of DNS queries to AS112 with EDNS (Extension Mechanisms for DNS) support.
func (*AS112TopService) IPVersion ¶
func (r *AS112TopService) IPVersion(ctx context.Context, ipVersion AS112TopIPVersionParamsIPVersion, query AS112TopIPVersionParams, opts ...option.RequestOption) (res *AS112TopIPVersionResponse, err error)
Retrieves the top locations of DNS queries to AS112 for an IP version.
func (*AS112TopService) Locations ¶
func (r *AS112TopService) Locations(ctx context.Context, query AS112TopLocationsParams, opts ...option.RequestOption) (res *AS112TopLocationsResponse, err error)
Retrieves the top locations by AS112 DNS queries.
type AnnotationListParams ¶
type AnnotationListParams struct {
// Filters results by Autonomous System. Specify a single Autonomous System Number
// (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"`
// Filters results by date range.
DateRange param.Field[string] `query:"dateRange"`
// Start of the date range (inclusive).
DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AnnotationListParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify an alpha-2 location code.
Location param.Field[string] `query:"location"`
// Skips the specified number of objects before fetching the 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 in which results will be returned.
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 {
// Filters results by Autonomous System. Specify a single Autonomous System Number
// (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"`
// Filters results by date range.
DateRange param.Field[string] `query:"dateRange"`
// Start of the date range (inclusive).
DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AnnotationOutageGetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify an alpha-2 location code.
Location param.Field[string] `query:"location"`
// Skips the specified number of objects before fetching the 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 in which results will be returned.
const ( AnnotationOutageGetParamsFormatJson AnnotationOutageGetParamsFormat = "JSON" AnnotationOutageGetParamsFormatCsv AnnotationOutageGetParamsFormat = "CSV" )
func (AnnotationOutageGetParamsFormat) IsKnown ¶
func (r AnnotationOutageGetParamsFormat) IsKnown() bool
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 time.Time `json:"startDate,required" format:"date-time"`
Description string `json:"description"`
EndDate time.Time `json:"endDate" format:"date-time"`
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 ¶
func (r *AnnotationOutageGetResponseAnnotationsASNsDetailsLocations) UnmarshalJSON(data []byte) (err error)
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"`
// Filters results by date range.
DateRange param.Field[string] `query:"dateRange"`
// Start of the date range (inclusive).
DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AnnotationOutageLocationsParamsFormat] `query:"format"`
// Limits the number of objects returned 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 in which results will be returned.
const ( AnnotationOutageLocationsParamsFormatJson AnnotationOutageLocationsParamsFormat = "JSON" AnnotationOutageLocationsParamsFormatCsv AnnotationOutageLocationsParamsFormat = "CSV" )
func (AnnotationOutageLocationsParamsFormat) IsKnown ¶
func (r AnnotationOutageLocationsParamsFormat) IsKnown() bool
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"`
// A numeric string.
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 ¶
func (r *AnnotationOutageService) Get(ctx context.Context, query AnnotationOutageGetParams, opts ...option.RequestOption) (res *AnnotationOutageGetResponse, err error)
Retrieves the latest Internet outages and anomalies.
func (*AnnotationOutageService) Locations ¶
func (r *AnnotationOutageService) Locations(ctx context.Context, query AnnotationOutageLocationsParams, opts ...option.RequestOption) (res *AnnotationOutageLocationsResponse, err error)
Retrieves 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 ¶
func (r *AnnotationService) List(ctx context.Context, query AnnotationListParams, opts ...option.RequestOption) (res *AnnotationListResponse, err error)
Retrieves 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 ¶
func (r *AttackLayer3Service) Timeseries(ctx context.Context, query AttackLayer3TimeseriesParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesResponse, err error)
Retrieves layer 3 attacks over time.
type AttackLayer3SummaryBitrateParams ¶
type AttackLayer3SummaryBitrateParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3SummaryBitrateParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3SummaryBitrateParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3SummaryBitrateParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
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
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3SummaryBitrateParamsDirectionOrigin AttackLayer3SummaryBitrateParamsDirection = "ORIGIN" AttackLayer3SummaryBitrateParamsDirectionTarget AttackLayer3SummaryBitrateParamsDirection = "TARGET" )
func (AttackLayer3SummaryBitrateParamsDirection) IsKnown ¶
func (r AttackLayer3SummaryBitrateParamsDirection) IsKnown() bool
type AttackLayer3SummaryBitrateParamsFormat ¶
type AttackLayer3SummaryBitrateParamsFormat string
Format in which results will be returned.
const ( AttackLayer3SummaryBitrateParamsFormatJson AttackLayer3SummaryBitrateParamsFormat = "JSON" AttackLayer3SummaryBitrateParamsFormatCsv AttackLayer3SummaryBitrateParamsFormat = "CSV" )
func (AttackLayer3SummaryBitrateParamsFormat) IsKnown ¶
func (r AttackLayer3SummaryBitrateParamsFormat) IsKnown() bool
type AttackLayer3SummaryBitrateParamsIPVersion ¶
type AttackLayer3SummaryBitrateParamsIPVersion string
const ( AttackLayer3SummaryBitrateParamsIPVersionIPv4 AttackLayer3SummaryBitrateParamsIPVersion = "IPv4" AttackLayer3SummaryBitrateParamsIPVersionIPv6 AttackLayer3SummaryBitrateParamsIPVersion = "IPv6" )
func (AttackLayer3SummaryBitrateParamsIPVersion) IsKnown ¶
func (r AttackLayer3SummaryBitrateParamsIPVersion) IsKnown() bool
type AttackLayer3SummaryBitrateParamsProtocol ¶
type AttackLayer3SummaryBitrateParamsProtocol string
const ( AttackLayer3SummaryBitrateParamsProtocolUdp AttackLayer3SummaryBitrateParamsProtocol = "UDP" AttackLayer3SummaryBitrateParamsProtocolTCP AttackLayer3SummaryBitrateParamsProtocol = "TCP" AttackLayer3SummaryBitrateParamsProtocolIcmp AttackLayer3SummaryBitrateParamsProtocol = "ICMP" AttackLayer3SummaryBitrateParamsProtocolGRE AttackLayer3SummaryBitrateParamsProtocol = "GRE" )
func (AttackLayer3SummaryBitrateParamsProtocol) IsKnown ¶
func (r AttackLayer3SummaryBitrateParamsProtocol) IsKnown() bool
type AttackLayer3SummaryBitrateResponse ¶
type AttackLayer3SummaryBitrateResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3SummaryBitrateResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3SummaryBitrateResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3SummaryBitrateResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3SummaryBitrateResponseMetaUnit `json:"units,required"`
JSON attackLayer3SummaryBitrateResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3SummaryBitrateResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3SummaryBitrateResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryBitrateResponseMetaConfidenceInfo ¶
type AttackLayer3SummaryBitrateResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3SummaryBitrateResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3SummaryBitrateResponseMetaNormalization ¶
type AttackLayer3SummaryBitrateResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3SummaryBitrateResponseMetaNormalizationPercentage AttackLayer3SummaryBitrateResponseMetaNormalization = "PERCENTAGE" AttackLayer3SummaryBitrateResponseMetaNormalizationMin0Max AttackLayer3SummaryBitrateResponseMetaNormalization = "MIN0_MAX" AttackLayer3SummaryBitrateResponseMetaNormalizationMinMax AttackLayer3SummaryBitrateResponseMetaNormalization = "MIN_MAX" AttackLayer3SummaryBitrateResponseMetaNormalizationRawValues AttackLayer3SummaryBitrateResponseMetaNormalization = "RAW_VALUES" AttackLayer3SummaryBitrateResponseMetaNormalizationPercentageChange AttackLayer3SummaryBitrateResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3SummaryBitrateResponseMetaNormalizationRollingAverage AttackLayer3SummaryBitrateResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3SummaryBitrateResponseMetaNormalizationOverlappedPercentage AttackLayer3SummaryBitrateResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3SummaryBitrateResponseMetaNormalizationRatio AttackLayer3SummaryBitrateResponseMetaNormalization = "RATIO" )
func (AttackLayer3SummaryBitrateResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3SummaryBitrateResponseMetaNormalization) IsKnown() bool
type AttackLayer3SummaryBitrateResponseMetaUnit ¶
type AttackLayer3SummaryBitrateResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3SummaryBitrateResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3SummaryBitrateResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3SummaryBitrateResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryBitrateResponseSummary0 ¶
type AttackLayer3SummaryBitrateResponseSummary0 struct {
// A numeric string.
OneGBPSToTenGBPS string `json:"_1_GBPS_TO_10_GBPS,required"`
// A numeric string.
TenGBPSToOneHundredGBPS string `json:"_10_GBPS_TO_100_GBPS,required"`
// A numeric string.
FiveHundredMBPSToOneGBPS string `json:"_500_MBPS_TO_1_GBPS,required"`
// A numeric string.
Over100GBPS string `json:"OVER_100_GBPS,required"`
// A numeric string.
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 {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3SummaryDurationParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3SummaryDurationParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3SummaryDurationParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
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
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3SummaryDurationParamsDirectionOrigin AttackLayer3SummaryDurationParamsDirection = "ORIGIN" AttackLayer3SummaryDurationParamsDirectionTarget AttackLayer3SummaryDurationParamsDirection = "TARGET" )
func (AttackLayer3SummaryDurationParamsDirection) IsKnown ¶
func (r AttackLayer3SummaryDurationParamsDirection) IsKnown() bool
type AttackLayer3SummaryDurationParamsFormat ¶
type AttackLayer3SummaryDurationParamsFormat string
Format in which results will be returned.
const ( AttackLayer3SummaryDurationParamsFormatJson AttackLayer3SummaryDurationParamsFormat = "JSON" AttackLayer3SummaryDurationParamsFormatCsv AttackLayer3SummaryDurationParamsFormat = "CSV" )
func (AttackLayer3SummaryDurationParamsFormat) IsKnown ¶
func (r AttackLayer3SummaryDurationParamsFormat) IsKnown() bool
type AttackLayer3SummaryDurationParamsIPVersion ¶
type AttackLayer3SummaryDurationParamsIPVersion string
const ( AttackLayer3SummaryDurationParamsIPVersionIPv4 AttackLayer3SummaryDurationParamsIPVersion = "IPv4" AttackLayer3SummaryDurationParamsIPVersionIPv6 AttackLayer3SummaryDurationParamsIPVersion = "IPv6" )
func (AttackLayer3SummaryDurationParamsIPVersion) IsKnown ¶
func (r AttackLayer3SummaryDurationParamsIPVersion) IsKnown() bool
type AttackLayer3SummaryDurationParamsProtocol ¶
type AttackLayer3SummaryDurationParamsProtocol string
const ( AttackLayer3SummaryDurationParamsProtocolUdp AttackLayer3SummaryDurationParamsProtocol = "UDP" AttackLayer3SummaryDurationParamsProtocolTCP AttackLayer3SummaryDurationParamsProtocol = "TCP" AttackLayer3SummaryDurationParamsProtocolIcmp AttackLayer3SummaryDurationParamsProtocol = "ICMP" AttackLayer3SummaryDurationParamsProtocolGRE AttackLayer3SummaryDurationParamsProtocol = "GRE" )
func (AttackLayer3SummaryDurationParamsProtocol) IsKnown ¶
func (r AttackLayer3SummaryDurationParamsProtocol) IsKnown() bool
type AttackLayer3SummaryDurationResponse ¶
type AttackLayer3SummaryDurationResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3SummaryDurationResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3SummaryDurationResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3SummaryDurationResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3SummaryDurationResponseMetaUnit `json:"units,required"`
JSON attackLayer3SummaryDurationResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3SummaryDurationResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3SummaryDurationResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryDurationResponseMetaConfidenceInfo ¶
type AttackLayer3SummaryDurationResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3SummaryDurationResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3SummaryDurationResponseMetaNormalization ¶
type AttackLayer3SummaryDurationResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3SummaryDurationResponseMetaNormalizationPercentage AttackLayer3SummaryDurationResponseMetaNormalization = "PERCENTAGE" AttackLayer3SummaryDurationResponseMetaNormalizationMin0Max AttackLayer3SummaryDurationResponseMetaNormalization = "MIN0_MAX" AttackLayer3SummaryDurationResponseMetaNormalizationMinMax AttackLayer3SummaryDurationResponseMetaNormalization = "MIN_MAX" AttackLayer3SummaryDurationResponseMetaNormalizationRawValues AttackLayer3SummaryDurationResponseMetaNormalization = "RAW_VALUES" AttackLayer3SummaryDurationResponseMetaNormalizationPercentageChange AttackLayer3SummaryDurationResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3SummaryDurationResponseMetaNormalizationRollingAverage AttackLayer3SummaryDurationResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3SummaryDurationResponseMetaNormalizationOverlappedPercentage AttackLayer3SummaryDurationResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3SummaryDurationResponseMetaNormalizationRatio AttackLayer3SummaryDurationResponseMetaNormalization = "RATIO" )
func (AttackLayer3SummaryDurationResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3SummaryDurationResponseMetaNormalization) IsKnown() bool
type AttackLayer3SummaryDurationResponseMetaUnit ¶
type AttackLayer3SummaryDurationResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3SummaryDurationResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3SummaryDurationResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3SummaryDurationResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryDurationResponseSummary0 ¶
type AttackLayer3SummaryDurationResponseSummary0 struct {
// A numeric string.
OneHourToThreeHours string `json:"_1_HOUR_TO_3_HOURS,required"`
// A numeric string.
TenMinsToTwentyMins string `json:"_10_MINS_TO_20_MINS,required"`
// A numeric string.
TwentyMinsToFortyMins string `json:"_20_MINS_TO_40_MINS,required"`
// A numeric string.
FortyMinsToOneHour string `json:"_40_MINS_TO_1_HOUR,required"`
// A numeric string.
Over3Hours string `json:"OVER_3_HOURS,required"`
// A numeric string.
Under10Mins string `json:"UNDER_10_MINS,required"`
JSON attackLayer3SummaryDurationResponseSummary0JSON `json:"-"`
}
func (*AttackLayer3SummaryDurationResponseSummary0) UnmarshalJSON ¶
func (r *AttackLayer3SummaryDurationResponseSummary0) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIPVersionParams ¶
type AttackLayer3SummaryIPVersionParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3SummaryIPVersionParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3SummaryIPVersionParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3SummaryIPVersionParamsProtocol] `query:"protocol"`
}
func (AttackLayer3SummaryIPVersionParams) URLQuery ¶
func (r AttackLayer3SummaryIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3SummaryIPVersionParams's query parameters as `url.Values`.
type AttackLayer3SummaryIPVersionParamsDirection ¶
type AttackLayer3SummaryIPVersionParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3SummaryIPVersionParamsDirectionOrigin AttackLayer3SummaryIPVersionParamsDirection = "ORIGIN" AttackLayer3SummaryIPVersionParamsDirectionTarget AttackLayer3SummaryIPVersionParamsDirection = "TARGET" )
func (AttackLayer3SummaryIPVersionParamsDirection) IsKnown ¶
func (r AttackLayer3SummaryIPVersionParamsDirection) IsKnown() bool
type AttackLayer3SummaryIPVersionParamsFormat ¶
type AttackLayer3SummaryIPVersionParamsFormat string
Format in which results will be returned.
const ( AttackLayer3SummaryIPVersionParamsFormatJson AttackLayer3SummaryIPVersionParamsFormat = "JSON" AttackLayer3SummaryIPVersionParamsFormatCsv AttackLayer3SummaryIPVersionParamsFormat = "CSV" )
func (AttackLayer3SummaryIPVersionParamsFormat) IsKnown ¶
func (r AttackLayer3SummaryIPVersionParamsFormat) IsKnown() bool
type AttackLayer3SummaryIPVersionParamsProtocol ¶
type AttackLayer3SummaryIPVersionParamsProtocol string
const ( AttackLayer3SummaryIPVersionParamsProtocolUdp AttackLayer3SummaryIPVersionParamsProtocol = "UDP" AttackLayer3SummaryIPVersionParamsProtocolTCP AttackLayer3SummaryIPVersionParamsProtocol = "TCP" AttackLayer3SummaryIPVersionParamsProtocolIcmp AttackLayer3SummaryIPVersionParamsProtocol = "ICMP" AttackLayer3SummaryIPVersionParamsProtocolGRE AttackLayer3SummaryIPVersionParamsProtocol = "GRE" )
func (AttackLayer3SummaryIPVersionParamsProtocol) IsKnown ¶
func (r AttackLayer3SummaryIPVersionParamsProtocol) IsKnown() bool
type AttackLayer3SummaryIPVersionResponse ¶
type AttackLayer3SummaryIPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3SummaryIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3SummaryIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3SummaryIPVersionResponseMetaUnit `json:"units,required"`
JSON attackLayer3SummaryIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3SummaryIPVersionResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo ¶
type AttackLayer3SummaryIPVersionResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3SummaryIPVersionResponseMetaNormalization ¶
type AttackLayer3SummaryIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3SummaryIPVersionResponseMetaNormalizationPercentage AttackLayer3SummaryIPVersionResponseMetaNormalization = "PERCENTAGE" AttackLayer3SummaryIPVersionResponseMetaNormalizationMin0Max AttackLayer3SummaryIPVersionResponseMetaNormalization = "MIN0_MAX" AttackLayer3SummaryIPVersionResponseMetaNormalizationMinMax AttackLayer3SummaryIPVersionResponseMetaNormalization = "MIN_MAX" AttackLayer3SummaryIPVersionResponseMetaNormalizationRawValues AttackLayer3SummaryIPVersionResponseMetaNormalization = "RAW_VALUES" AttackLayer3SummaryIPVersionResponseMetaNormalizationPercentageChange AttackLayer3SummaryIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3SummaryIPVersionResponseMetaNormalizationRollingAverage AttackLayer3SummaryIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3SummaryIPVersionResponseMetaNormalizationOverlappedPercentage AttackLayer3SummaryIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3SummaryIPVersionResponseMetaNormalizationRatio AttackLayer3SummaryIPVersionResponseMetaNormalization = "RATIO" )
func (AttackLayer3SummaryIPVersionResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3SummaryIPVersionResponseMetaNormalization) IsKnown() bool
type AttackLayer3SummaryIPVersionResponseMetaUnit ¶
type AttackLayer3SummaryIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3SummaryIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3SummaryIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIPVersionResponseSummary0 ¶
type AttackLayer3SummaryIPVersionResponseSummary0 struct {
// A numeric string.
IPv4 string `json:"IPv4,required"`
// A numeric string.
IPv6 string `json:"IPv6,required"`
JSON attackLayer3SummaryIPVersionResponseSummary0JSON `json:"-"`
}
func (*AttackLayer3SummaryIPVersionResponseSummary0) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIndustryParams ¶
type AttackLayer3SummaryIndustryParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3SummaryIndustryParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3SummaryIndustryParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3SummaryIndustryParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3SummaryIndustryParamsProtocol] `query:"protocol"`
}
func (AttackLayer3SummaryIndustryParams) URLQuery ¶
func (r AttackLayer3SummaryIndustryParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3SummaryIndustryParams's query parameters as `url.Values`.
type AttackLayer3SummaryIndustryParamsDirection ¶
type AttackLayer3SummaryIndustryParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3SummaryIndustryParamsDirectionOrigin AttackLayer3SummaryIndustryParamsDirection = "ORIGIN" AttackLayer3SummaryIndustryParamsDirectionTarget AttackLayer3SummaryIndustryParamsDirection = "TARGET" )
func (AttackLayer3SummaryIndustryParamsDirection) IsKnown ¶
func (r AttackLayer3SummaryIndustryParamsDirection) IsKnown() bool
type AttackLayer3SummaryIndustryParamsFormat ¶
type AttackLayer3SummaryIndustryParamsFormat string
Format in which results will be returned.
const ( AttackLayer3SummaryIndustryParamsFormatJson AttackLayer3SummaryIndustryParamsFormat = "JSON" AttackLayer3SummaryIndustryParamsFormatCsv AttackLayer3SummaryIndustryParamsFormat = "CSV" )
func (AttackLayer3SummaryIndustryParamsFormat) IsKnown ¶
func (r AttackLayer3SummaryIndustryParamsFormat) IsKnown() bool
type AttackLayer3SummaryIndustryParamsIPVersion ¶
type AttackLayer3SummaryIndustryParamsIPVersion string
const ( AttackLayer3SummaryIndustryParamsIPVersionIPv4 AttackLayer3SummaryIndustryParamsIPVersion = "IPv4" AttackLayer3SummaryIndustryParamsIPVersionIPv6 AttackLayer3SummaryIndustryParamsIPVersion = "IPv6" )
func (AttackLayer3SummaryIndustryParamsIPVersion) IsKnown ¶
func (r AttackLayer3SummaryIndustryParamsIPVersion) IsKnown() bool
type AttackLayer3SummaryIndustryParamsProtocol ¶
type AttackLayer3SummaryIndustryParamsProtocol string
const ( AttackLayer3SummaryIndustryParamsProtocolUdp AttackLayer3SummaryIndustryParamsProtocol = "UDP" AttackLayer3SummaryIndustryParamsProtocolTCP AttackLayer3SummaryIndustryParamsProtocol = "TCP" AttackLayer3SummaryIndustryParamsProtocolIcmp AttackLayer3SummaryIndustryParamsProtocol = "ICMP" AttackLayer3SummaryIndustryParamsProtocolGRE AttackLayer3SummaryIndustryParamsProtocol = "GRE" )
func (AttackLayer3SummaryIndustryParamsProtocol) IsKnown ¶
func (r AttackLayer3SummaryIndustryParamsProtocol) IsKnown() bool
type AttackLayer3SummaryIndustryResponse ¶
type AttackLayer3SummaryIndustryResponse struct {
// Metadata for the results.
Meta AttackLayer3SummaryIndustryResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON attackLayer3SummaryIndustryResponseJSON `json:"-"`
}
func (*AttackLayer3SummaryIndustryResponse) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIndustryResponse) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIndustryResponseEnvelope ¶
type AttackLayer3SummaryIndustryResponseEnvelope struct {
Result AttackLayer3SummaryIndustryResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON attackLayer3SummaryIndustryResponseEnvelopeJSON `json:"-"`
}
func (*AttackLayer3SummaryIndustryResponseEnvelope) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIndustryResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIndustryResponseMeta ¶
type AttackLayer3SummaryIndustryResponseMeta struct {
ConfidenceInfo AttackLayer3SummaryIndustryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3SummaryIndustryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3SummaryIndustryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3SummaryIndustryResponseMetaUnit `json:"units,required"`
JSON attackLayer3SummaryIndustryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3SummaryIndustryResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIndustryResponseMetaConfidenceInfo ¶
type AttackLayer3SummaryIndustryResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3SummaryIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3SummaryIndustryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3SummaryIndustryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIndustryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIndustryResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3SummaryIndustryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3SummaryIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3SummaryIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIndustryResponseMetaDateRange ¶
type AttackLayer3SummaryIndustryResponseMetaDateRange 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 attackLayer3SummaryIndustryResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3SummaryIndustryResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIndustryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryIndustryResponseMetaNormalization ¶
type AttackLayer3SummaryIndustryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3SummaryIndustryResponseMetaNormalizationPercentage AttackLayer3SummaryIndustryResponseMetaNormalization = "PERCENTAGE" AttackLayer3SummaryIndustryResponseMetaNormalizationMin0Max AttackLayer3SummaryIndustryResponseMetaNormalization = "MIN0_MAX" AttackLayer3SummaryIndustryResponseMetaNormalizationMinMax AttackLayer3SummaryIndustryResponseMetaNormalization = "MIN_MAX" AttackLayer3SummaryIndustryResponseMetaNormalizationRawValues AttackLayer3SummaryIndustryResponseMetaNormalization = "RAW_VALUES" AttackLayer3SummaryIndustryResponseMetaNormalizationPercentageChange AttackLayer3SummaryIndustryResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3SummaryIndustryResponseMetaNormalizationRollingAverage AttackLayer3SummaryIndustryResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3SummaryIndustryResponseMetaNormalizationOverlappedPercentage AttackLayer3SummaryIndustryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3SummaryIndustryResponseMetaNormalizationRatio AttackLayer3SummaryIndustryResponseMetaNormalization = "RATIO" )
func (AttackLayer3SummaryIndustryResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3SummaryIndustryResponseMetaNormalization) IsKnown() bool
type AttackLayer3SummaryIndustryResponseMetaUnit ¶
type AttackLayer3SummaryIndustryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3SummaryIndustryResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3SummaryIndustryResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3SummaryIndustryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryProtocolParams ¶
type AttackLayer3SummaryProtocolParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3SummaryProtocolParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3SummaryProtocolParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3SummaryProtocolParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3SummaryProtocolParamsDirectionOrigin AttackLayer3SummaryProtocolParamsDirection = "ORIGIN" AttackLayer3SummaryProtocolParamsDirectionTarget AttackLayer3SummaryProtocolParamsDirection = "TARGET" )
func (AttackLayer3SummaryProtocolParamsDirection) IsKnown ¶
func (r AttackLayer3SummaryProtocolParamsDirection) IsKnown() bool
type AttackLayer3SummaryProtocolParamsFormat ¶
type AttackLayer3SummaryProtocolParamsFormat string
Format in which results will be returned.
const ( AttackLayer3SummaryProtocolParamsFormatJson AttackLayer3SummaryProtocolParamsFormat = "JSON" AttackLayer3SummaryProtocolParamsFormatCsv AttackLayer3SummaryProtocolParamsFormat = "CSV" )
func (AttackLayer3SummaryProtocolParamsFormat) IsKnown ¶
func (r AttackLayer3SummaryProtocolParamsFormat) IsKnown() bool
type AttackLayer3SummaryProtocolParamsIPVersion ¶
type AttackLayer3SummaryProtocolParamsIPVersion string
const ( AttackLayer3SummaryProtocolParamsIPVersionIPv4 AttackLayer3SummaryProtocolParamsIPVersion = "IPv4" AttackLayer3SummaryProtocolParamsIPVersionIPv6 AttackLayer3SummaryProtocolParamsIPVersion = "IPv6" )
func (AttackLayer3SummaryProtocolParamsIPVersion) IsKnown ¶
func (r AttackLayer3SummaryProtocolParamsIPVersion) IsKnown() bool
type AttackLayer3SummaryProtocolResponse ¶
type AttackLayer3SummaryProtocolResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3SummaryProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3SummaryProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3SummaryProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3SummaryProtocolResponseMetaUnit `json:"units,required"`
JSON attackLayer3SummaryProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3SummaryProtocolResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3SummaryProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryProtocolResponseMetaConfidenceInfo ¶
type AttackLayer3SummaryProtocolResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3SummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3SummaryProtocolResponseMetaNormalization ¶
type AttackLayer3SummaryProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3SummaryProtocolResponseMetaNormalizationPercentage AttackLayer3SummaryProtocolResponseMetaNormalization = "PERCENTAGE" AttackLayer3SummaryProtocolResponseMetaNormalizationMin0Max AttackLayer3SummaryProtocolResponseMetaNormalization = "MIN0_MAX" AttackLayer3SummaryProtocolResponseMetaNormalizationMinMax AttackLayer3SummaryProtocolResponseMetaNormalization = "MIN_MAX" AttackLayer3SummaryProtocolResponseMetaNormalizationRawValues AttackLayer3SummaryProtocolResponseMetaNormalization = "RAW_VALUES" AttackLayer3SummaryProtocolResponseMetaNormalizationPercentageChange AttackLayer3SummaryProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3SummaryProtocolResponseMetaNormalizationRollingAverage AttackLayer3SummaryProtocolResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3SummaryProtocolResponseMetaNormalizationOverlappedPercentage AttackLayer3SummaryProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3SummaryProtocolResponseMetaNormalizationRatio AttackLayer3SummaryProtocolResponseMetaNormalization = "RATIO" )
func (AttackLayer3SummaryProtocolResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3SummaryProtocolResponseMetaNormalization) IsKnown() bool
type AttackLayer3SummaryProtocolResponseMetaUnit ¶
type AttackLayer3SummaryProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3SummaryProtocolResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3SummaryProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3SummaryProtocolResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryProtocolResponseSummary0 ¶
type AttackLayer3SummaryProtocolResponseSummary0 struct {
// A numeric string.
GRE string `json:"GRE,required"`
// A numeric string.
Icmp string `json:"ICMP,required"`
// A numeric string.
TCP string `json:"TCP,required"`
// A numeric string.
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 ¶
func (r *AttackLayer3SummaryService) Bitrate(ctx context.Context, query AttackLayer3SummaryBitrateParams, opts ...option.RequestOption) (res *AttackLayer3SummaryBitrateResponse, err error)
Retrieves the distribution of layer 3 attacks by bitrate.
func (*AttackLayer3SummaryService) Duration ¶
func (r *AttackLayer3SummaryService) Duration(ctx context.Context, query AttackLayer3SummaryDurationParams, opts ...option.RequestOption) (res *AttackLayer3SummaryDurationResponse, err error)
Retrieves the distribution of layer 3 attacks by duration.
func (*AttackLayer3SummaryService) IPVersion ¶
func (r *AttackLayer3SummaryService) IPVersion(ctx context.Context, query AttackLayer3SummaryIPVersionParams, opts ...option.RequestOption) (res *AttackLayer3SummaryIPVersionResponse, err error)
Retrieves the distribution of layer 3 attacks by IP version.
func (*AttackLayer3SummaryService) Industry ¶
func (r *AttackLayer3SummaryService) Industry(ctx context.Context, query AttackLayer3SummaryIndustryParams, opts ...option.RequestOption) (res *AttackLayer3SummaryIndustryResponse, err error)
Retrieves the distribution of layer 3 attacks by targeted industry.
func (*AttackLayer3SummaryService) Protocol ¶
func (r *AttackLayer3SummaryService) Protocol(ctx context.Context, query AttackLayer3SummaryProtocolParams, opts ...option.RequestOption) (res *AttackLayer3SummaryProtocolResponse, err error)
Retrieves the distribution of layer 3 attacks by protocol.
func (*AttackLayer3SummaryService) Vector ¶
func (r *AttackLayer3SummaryService) Vector(ctx context.Context, query AttackLayer3SummaryVectorParams, opts ...option.RequestOption) (res *AttackLayer3SummaryVectorResponse, err error)
Retrieves the distribution of layer 3 attacks by vector.
func (*AttackLayer3SummaryService) Vertical ¶
func (r *AttackLayer3SummaryService) Vertical(ctx context.Context, query AttackLayer3SummaryVerticalParams, opts ...option.RequestOption) (res *AttackLayer3SummaryVerticalResponse, err error)
Retrieves the distribution of layer 3 attacks by targeted vertical.
type AttackLayer3SummaryVectorParams ¶
type AttackLayer3SummaryVectorParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3SummaryVectorParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3SummaryVectorParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3SummaryVectorParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
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
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3SummaryVectorParamsDirectionOrigin AttackLayer3SummaryVectorParamsDirection = "ORIGIN" AttackLayer3SummaryVectorParamsDirectionTarget AttackLayer3SummaryVectorParamsDirection = "TARGET" )
func (AttackLayer3SummaryVectorParamsDirection) IsKnown ¶
func (r AttackLayer3SummaryVectorParamsDirection) IsKnown() bool
type AttackLayer3SummaryVectorParamsFormat ¶
type AttackLayer3SummaryVectorParamsFormat string
Format in which results will be returned.
const ( AttackLayer3SummaryVectorParamsFormatJson AttackLayer3SummaryVectorParamsFormat = "JSON" AttackLayer3SummaryVectorParamsFormatCsv AttackLayer3SummaryVectorParamsFormat = "CSV" )
func (AttackLayer3SummaryVectorParamsFormat) IsKnown ¶
func (r AttackLayer3SummaryVectorParamsFormat) IsKnown() bool
type AttackLayer3SummaryVectorParamsIPVersion ¶
type AttackLayer3SummaryVectorParamsIPVersion string
const ( AttackLayer3SummaryVectorParamsIPVersionIPv4 AttackLayer3SummaryVectorParamsIPVersion = "IPv4" AttackLayer3SummaryVectorParamsIPVersionIPv6 AttackLayer3SummaryVectorParamsIPVersion = "IPv6" )
func (AttackLayer3SummaryVectorParamsIPVersion) IsKnown ¶
func (r AttackLayer3SummaryVectorParamsIPVersion) IsKnown() bool
type AttackLayer3SummaryVectorParamsProtocol ¶
type AttackLayer3SummaryVectorParamsProtocol string
const ( AttackLayer3SummaryVectorParamsProtocolUdp AttackLayer3SummaryVectorParamsProtocol = "UDP" AttackLayer3SummaryVectorParamsProtocolTCP AttackLayer3SummaryVectorParamsProtocol = "TCP" AttackLayer3SummaryVectorParamsProtocolIcmp AttackLayer3SummaryVectorParamsProtocol = "ICMP" AttackLayer3SummaryVectorParamsProtocolGRE AttackLayer3SummaryVectorParamsProtocol = "GRE" )
func (AttackLayer3SummaryVectorParamsProtocol) IsKnown ¶
func (r AttackLayer3SummaryVectorParamsProtocol) IsKnown() bool
type AttackLayer3SummaryVectorResponse ¶
type AttackLayer3SummaryVectorResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3SummaryVectorResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3SummaryVectorResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3SummaryVectorResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3SummaryVectorResponseMetaUnit `json:"units,required"`
JSON attackLayer3SummaryVectorResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3SummaryVectorResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVectorResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVectorResponseMetaConfidenceInfo ¶
type AttackLayer3SummaryVectorResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVectorResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3SummaryVectorResponseMetaNormalization ¶
type AttackLayer3SummaryVectorResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3SummaryVectorResponseMetaNormalizationPercentage AttackLayer3SummaryVectorResponseMetaNormalization = "PERCENTAGE" AttackLayer3SummaryVectorResponseMetaNormalizationMin0Max AttackLayer3SummaryVectorResponseMetaNormalization = "MIN0_MAX" AttackLayer3SummaryVectorResponseMetaNormalizationMinMax AttackLayer3SummaryVectorResponseMetaNormalization = "MIN_MAX" AttackLayer3SummaryVectorResponseMetaNormalizationRawValues AttackLayer3SummaryVectorResponseMetaNormalization = "RAW_VALUES" AttackLayer3SummaryVectorResponseMetaNormalizationPercentageChange AttackLayer3SummaryVectorResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3SummaryVectorResponseMetaNormalizationRollingAverage AttackLayer3SummaryVectorResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3SummaryVectorResponseMetaNormalizationOverlappedPercentage AttackLayer3SummaryVectorResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3SummaryVectorResponseMetaNormalizationRatio AttackLayer3SummaryVectorResponseMetaNormalization = "RATIO" )
func (AttackLayer3SummaryVectorResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3SummaryVectorResponseMetaNormalization) IsKnown() bool
type AttackLayer3SummaryVectorResponseMetaUnit ¶
type AttackLayer3SummaryVectorResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3SummaryVectorResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3SummaryVectorResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVectorResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVerticalParams ¶
type AttackLayer3SummaryVerticalParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3SummaryVerticalParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3SummaryVerticalParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3SummaryVerticalParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3SummaryVerticalParamsProtocol] `query:"protocol"`
}
func (AttackLayer3SummaryVerticalParams) URLQuery ¶
func (r AttackLayer3SummaryVerticalParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3SummaryVerticalParams's query parameters as `url.Values`.
type AttackLayer3SummaryVerticalParamsDirection ¶
type AttackLayer3SummaryVerticalParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3SummaryVerticalParamsDirectionOrigin AttackLayer3SummaryVerticalParamsDirection = "ORIGIN" AttackLayer3SummaryVerticalParamsDirectionTarget AttackLayer3SummaryVerticalParamsDirection = "TARGET" )
func (AttackLayer3SummaryVerticalParamsDirection) IsKnown ¶
func (r AttackLayer3SummaryVerticalParamsDirection) IsKnown() bool
type AttackLayer3SummaryVerticalParamsFormat ¶
type AttackLayer3SummaryVerticalParamsFormat string
Format in which results will be returned.
const ( AttackLayer3SummaryVerticalParamsFormatJson AttackLayer3SummaryVerticalParamsFormat = "JSON" AttackLayer3SummaryVerticalParamsFormatCsv AttackLayer3SummaryVerticalParamsFormat = "CSV" )
func (AttackLayer3SummaryVerticalParamsFormat) IsKnown ¶
func (r AttackLayer3SummaryVerticalParamsFormat) IsKnown() bool
type AttackLayer3SummaryVerticalParamsIPVersion ¶
type AttackLayer3SummaryVerticalParamsIPVersion string
const ( AttackLayer3SummaryVerticalParamsIPVersionIPv4 AttackLayer3SummaryVerticalParamsIPVersion = "IPv4" AttackLayer3SummaryVerticalParamsIPVersionIPv6 AttackLayer3SummaryVerticalParamsIPVersion = "IPv6" )
func (AttackLayer3SummaryVerticalParamsIPVersion) IsKnown ¶
func (r AttackLayer3SummaryVerticalParamsIPVersion) IsKnown() bool
type AttackLayer3SummaryVerticalParamsProtocol ¶
type AttackLayer3SummaryVerticalParamsProtocol string
const ( AttackLayer3SummaryVerticalParamsProtocolUdp AttackLayer3SummaryVerticalParamsProtocol = "UDP" AttackLayer3SummaryVerticalParamsProtocolTCP AttackLayer3SummaryVerticalParamsProtocol = "TCP" AttackLayer3SummaryVerticalParamsProtocolIcmp AttackLayer3SummaryVerticalParamsProtocol = "ICMP" AttackLayer3SummaryVerticalParamsProtocolGRE AttackLayer3SummaryVerticalParamsProtocol = "GRE" )
func (AttackLayer3SummaryVerticalParamsProtocol) IsKnown ¶
func (r AttackLayer3SummaryVerticalParamsProtocol) IsKnown() bool
type AttackLayer3SummaryVerticalResponse ¶
type AttackLayer3SummaryVerticalResponse struct {
// Metadata for the results.
Meta AttackLayer3SummaryVerticalResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON attackLayer3SummaryVerticalResponseJSON `json:"-"`
}
func (*AttackLayer3SummaryVerticalResponse) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVerticalResponse) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVerticalResponseEnvelope ¶
type AttackLayer3SummaryVerticalResponseEnvelope struct {
Result AttackLayer3SummaryVerticalResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON attackLayer3SummaryVerticalResponseEnvelopeJSON `json:"-"`
}
func (*AttackLayer3SummaryVerticalResponseEnvelope) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVerticalResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVerticalResponseMeta ¶
type AttackLayer3SummaryVerticalResponseMeta struct {
ConfidenceInfo AttackLayer3SummaryVerticalResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3SummaryVerticalResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3SummaryVerticalResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3SummaryVerticalResponseMetaUnit `json:"units,required"`
JSON attackLayer3SummaryVerticalResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3SummaryVerticalResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVerticalResponseMetaConfidenceInfo ¶
type AttackLayer3SummaryVerticalResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3SummaryVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3SummaryVerticalResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3SummaryVerticalResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVerticalResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVerticalResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3SummaryVerticalResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3SummaryVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3SummaryVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVerticalResponseMetaDateRange ¶
type AttackLayer3SummaryVerticalResponseMetaDateRange 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 attackLayer3SummaryVerticalResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3SummaryVerticalResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVerticalResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3SummaryVerticalResponseMetaNormalization ¶
type AttackLayer3SummaryVerticalResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3SummaryVerticalResponseMetaNormalizationPercentage AttackLayer3SummaryVerticalResponseMetaNormalization = "PERCENTAGE" AttackLayer3SummaryVerticalResponseMetaNormalizationMin0Max AttackLayer3SummaryVerticalResponseMetaNormalization = "MIN0_MAX" AttackLayer3SummaryVerticalResponseMetaNormalizationMinMax AttackLayer3SummaryVerticalResponseMetaNormalization = "MIN_MAX" AttackLayer3SummaryVerticalResponseMetaNormalizationRawValues AttackLayer3SummaryVerticalResponseMetaNormalization = "RAW_VALUES" AttackLayer3SummaryVerticalResponseMetaNormalizationPercentageChange AttackLayer3SummaryVerticalResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3SummaryVerticalResponseMetaNormalizationRollingAverage AttackLayer3SummaryVerticalResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3SummaryVerticalResponseMetaNormalizationOverlappedPercentage AttackLayer3SummaryVerticalResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3SummaryVerticalResponseMetaNormalizationRatio AttackLayer3SummaryVerticalResponseMetaNormalization = "RATIO" )
func (AttackLayer3SummaryVerticalResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3SummaryVerticalResponseMetaNormalization) IsKnown() bool
type AttackLayer3SummaryVerticalResponseMetaUnit ¶
type AttackLayer3SummaryVerticalResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3SummaryVerticalResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3SummaryVerticalResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3SummaryVerticalResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupBitrateParams ¶
type AttackLayer3TimeseriesGroupBitrateParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesGroupBitrateParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesGroupBitrateParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TimeseriesGroupBitrateParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesGroupBitrateParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TimeseriesGroupBitrateParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TimeseriesGroupBitrateParams) URLQuery ¶
func (r AttackLayer3TimeseriesGroupBitrateParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TimeseriesGroupBitrateParams's query parameters as `url.Values`.
type AttackLayer3TimeseriesGroupBitrateParamsAggInterval ¶
type AttackLayer3TimeseriesGroupBitrateParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesGroupBitrateParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateParamsDirection ¶
type AttackLayer3TimeseriesGroupBitrateParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesGroupBitrateParamsDirectionOrigin AttackLayer3TimeseriesGroupBitrateParamsDirection = "ORIGIN" AttackLayer3TimeseriesGroupBitrateParamsDirectionTarget AttackLayer3TimeseriesGroupBitrateParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesGroupBitrateParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesGroupBitrateParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateParamsFormat ¶
type AttackLayer3TimeseriesGroupBitrateParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesGroupBitrateParamsFormatJson AttackLayer3TimeseriesGroupBitrateParamsFormat = "JSON" AttackLayer3TimeseriesGroupBitrateParamsFormatCsv AttackLayer3TimeseriesGroupBitrateParamsFormat = "CSV" )
func (AttackLayer3TimeseriesGroupBitrateParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesGroupBitrateParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateParamsIPVersion ¶
type AttackLayer3TimeseriesGroupBitrateParamsIPVersion string
const ( AttackLayer3TimeseriesGroupBitrateParamsIPVersionIPv4 AttackLayer3TimeseriesGroupBitrateParamsIPVersion = "IPv4" AttackLayer3TimeseriesGroupBitrateParamsIPVersionIPv6 AttackLayer3TimeseriesGroupBitrateParamsIPVersion = "IPv6" )
func (AttackLayer3TimeseriesGroupBitrateParamsIPVersion) IsKnown ¶
func (r AttackLayer3TimeseriesGroupBitrateParamsIPVersion) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateParamsNormalization ¶
type AttackLayer3TimeseriesGroupBitrateParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupBitrateParamsNormalizationPercentage AttackLayer3TimeseriesGroupBitrateParamsNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupBitrateParamsNormalizationMin0Max AttackLayer3TimeseriesGroupBitrateParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesGroupBitrateParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupBitrateParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateParamsProtocol ¶
type AttackLayer3TimeseriesGroupBitrateParamsProtocol string
const ( AttackLayer3TimeseriesGroupBitrateParamsProtocolUdp AttackLayer3TimeseriesGroupBitrateParamsProtocol = "UDP" AttackLayer3TimeseriesGroupBitrateParamsProtocolTCP AttackLayer3TimeseriesGroupBitrateParamsProtocol = "TCP" AttackLayer3TimeseriesGroupBitrateParamsProtocolIcmp AttackLayer3TimeseriesGroupBitrateParamsProtocol = "ICMP" AttackLayer3TimeseriesGroupBitrateParamsProtocolGRE AttackLayer3TimeseriesGroupBitrateParamsProtocol = "GRE" )
func (AttackLayer3TimeseriesGroupBitrateParamsProtocol) IsKnown ¶
func (r AttackLayer3TimeseriesGroupBitrateParamsProtocol) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateResponse ¶
type AttackLayer3TimeseriesGroupBitrateResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesGroupBitrateResponseMeta `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 AttackLayer3TimeseriesGroupBitrateResponseMeta ¶
type AttackLayer3TimeseriesGroupBitrateResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesGroupBitrateResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesGroupBitrateResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesGroupBitrateResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesGroupBitrateResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupBitrateResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval ¶
type AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesGroupBitrateResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesGroupBitrateResponseMetaAggIntervalOneHour AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesGroupBitrateResponseMetaAggIntervalOneDay AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesGroupBitrateResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesGroupBitrateResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesGroupBitrateResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupBitrateResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupBitrateResponseMetaDateRange ¶
type AttackLayer3TimeseriesGroupBitrateResponseMetaDateRange 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 attackLayer3TimeseriesGroupBitrateResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupBitrateResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupBitrateResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization ¶
type AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationPercentage AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationMin0Max AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationMinMax AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationRawValues AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesGroupBitrateResponseMetaNormalizationRatio AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupBitrateResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupBitrateResponseMetaUnit ¶
type AttackLayer3TimeseriesGroupBitrateResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesGroupBitrateResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupBitrateResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupBitrateResponseMetaUnit) 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 []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesGroupDurationParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesGroupDurationParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TimeseriesGroupDurationParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesGroupDurationParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TimeseriesGroupDurationParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TimeseriesGroupDurationParams) URLQuery ¶
func (r AttackLayer3TimeseriesGroupDurationParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TimeseriesGroupDurationParams's query parameters as `url.Values`.
type AttackLayer3TimeseriesGroupDurationParamsAggInterval ¶
type AttackLayer3TimeseriesGroupDurationParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesGroupDurationParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationParamsDirection ¶
type AttackLayer3TimeseriesGroupDurationParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesGroupDurationParamsDirectionOrigin AttackLayer3TimeseriesGroupDurationParamsDirection = "ORIGIN" AttackLayer3TimeseriesGroupDurationParamsDirectionTarget AttackLayer3TimeseriesGroupDurationParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesGroupDurationParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesGroupDurationParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationParamsFormat ¶
type AttackLayer3TimeseriesGroupDurationParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesGroupDurationParamsFormatJson AttackLayer3TimeseriesGroupDurationParamsFormat = "JSON" AttackLayer3TimeseriesGroupDurationParamsFormatCsv AttackLayer3TimeseriesGroupDurationParamsFormat = "CSV" )
func (AttackLayer3TimeseriesGroupDurationParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesGroupDurationParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationParamsIPVersion ¶
type AttackLayer3TimeseriesGroupDurationParamsIPVersion string
const ( AttackLayer3TimeseriesGroupDurationParamsIPVersionIPv4 AttackLayer3TimeseriesGroupDurationParamsIPVersion = "IPv4" AttackLayer3TimeseriesGroupDurationParamsIPVersionIPv6 AttackLayer3TimeseriesGroupDurationParamsIPVersion = "IPv6" )
func (AttackLayer3TimeseriesGroupDurationParamsIPVersion) IsKnown ¶
func (r AttackLayer3TimeseriesGroupDurationParamsIPVersion) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationParamsNormalization ¶
type AttackLayer3TimeseriesGroupDurationParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupDurationParamsNormalizationPercentage AttackLayer3TimeseriesGroupDurationParamsNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupDurationParamsNormalizationMin0Max AttackLayer3TimeseriesGroupDurationParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesGroupDurationParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupDurationParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationParamsProtocol ¶
type AttackLayer3TimeseriesGroupDurationParamsProtocol string
const ( AttackLayer3TimeseriesGroupDurationParamsProtocolUdp AttackLayer3TimeseriesGroupDurationParamsProtocol = "UDP" AttackLayer3TimeseriesGroupDurationParamsProtocolTCP AttackLayer3TimeseriesGroupDurationParamsProtocol = "TCP" AttackLayer3TimeseriesGroupDurationParamsProtocolIcmp AttackLayer3TimeseriesGroupDurationParamsProtocol = "ICMP" AttackLayer3TimeseriesGroupDurationParamsProtocolGRE AttackLayer3TimeseriesGroupDurationParamsProtocol = "GRE" )
func (AttackLayer3TimeseriesGroupDurationParamsProtocol) IsKnown ¶
func (r AttackLayer3TimeseriesGroupDurationParamsProtocol) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationResponse ¶
type AttackLayer3TimeseriesGroupDurationResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesGroupDurationResponseMeta `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 AttackLayer3TimeseriesGroupDurationResponseMeta ¶
type AttackLayer3TimeseriesGroupDurationResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesGroupDurationResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesGroupDurationResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesGroupDurationResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesGroupDurationResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesGroupDurationResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupDurationResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval ¶
type AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesGroupDurationResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesGroupDurationResponseMetaAggIntervalOneHour AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesGroupDurationResponseMetaAggIntervalOneDay AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesGroupDurationResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesGroupDurationResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesGroupDurationResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupDurationResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupDurationResponseMetaDateRange ¶
type AttackLayer3TimeseriesGroupDurationResponseMetaDateRange 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 attackLayer3TimeseriesGroupDurationResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupDurationResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupDurationResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupDurationResponseMetaNormalization ¶
type AttackLayer3TimeseriesGroupDurationResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationPercentage AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationMin0Max AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationMinMax AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationRawValues AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesGroupDurationResponseMetaNormalizationRatio AttackLayer3TimeseriesGroupDurationResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesGroupDurationResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupDurationResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupDurationResponseMetaUnit ¶
type AttackLayer3TimeseriesGroupDurationResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesGroupDurationResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupDurationResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupDurationResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupDurationResponseSerie0 ¶
type AttackLayer3TimeseriesGroupDurationResponseSerie0 struct {
OneHourToThreeHours []string `json:"_1_HOUR_TO_3_HOURS,required"`
TenMinsToTwentyMins []string `json:"_10_MINS_TO_20_MINS,required"`
TwentyMinsToFortyMins []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 []time.Time `json:"timestamps,required" format:"date-time"`
Under10Mins []string `json:"UNDER_10_MINS,required"`
JSON attackLayer3TimeseriesGroupDurationResponseSerie0JSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupDurationResponseSerie0) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupDurationResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIPVersionParams ¶
type AttackLayer3TimeseriesGroupIPVersionParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesGroupIPVersionParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesGroupIPVersionParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesGroupIPVersionParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TimeseriesGroupIPVersionParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TimeseriesGroupIPVersionParams) URLQuery ¶
func (r AttackLayer3TimeseriesGroupIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TimeseriesGroupIPVersionParams's query parameters as `url.Values`.
type AttackLayer3TimeseriesGroupIPVersionParamsAggInterval ¶
type AttackLayer3TimeseriesGroupIPVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesGroupIPVersionParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupIPVersionParamsDirection ¶
type AttackLayer3TimeseriesGroupIPVersionParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesGroupIPVersionParamsDirectionOrigin AttackLayer3TimeseriesGroupIPVersionParamsDirection = "ORIGIN" AttackLayer3TimeseriesGroupIPVersionParamsDirectionTarget AttackLayer3TimeseriesGroupIPVersionParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesGroupIPVersionParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIPVersionParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesGroupIPVersionParamsFormat ¶
type AttackLayer3TimeseriesGroupIPVersionParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesGroupIPVersionParamsFormatJson AttackLayer3TimeseriesGroupIPVersionParamsFormat = "JSON" AttackLayer3TimeseriesGroupIPVersionParamsFormatCsv AttackLayer3TimeseriesGroupIPVersionParamsFormat = "CSV" )
func (AttackLayer3TimeseriesGroupIPVersionParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIPVersionParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesGroupIPVersionParamsNormalization ¶
type AttackLayer3TimeseriesGroupIPVersionParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupIPVersionParamsNormalizationPercentage AttackLayer3TimeseriesGroupIPVersionParamsNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupIPVersionParamsNormalizationMin0Max AttackLayer3TimeseriesGroupIPVersionParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesGroupIPVersionParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIPVersionParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupIPVersionParamsProtocol ¶
type AttackLayer3TimeseriesGroupIPVersionParamsProtocol string
const ( AttackLayer3TimeseriesGroupIPVersionParamsProtocolUdp AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "UDP" AttackLayer3TimeseriesGroupIPVersionParamsProtocolTCP AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "TCP" AttackLayer3TimeseriesGroupIPVersionParamsProtocolIcmp AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "ICMP" AttackLayer3TimeseriesGroupIPVersionParamsProtocolGRE AttackLayer3TimeseriesGroupIPVersionParamsProtocol = "GRE" )
func (AttackLayer3TimeseriesGroupIPVersionParamsProtocol) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIPVersionParamsProtocol) IsKnown() bool
type AttackLayer3TimeseriesGroupIPVersionResponse ¶
type AttackLayer3TimeseriesGroupIPVersionResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesGroupIPVersionResponseMeta `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 AttackLayer3TimeseriesGroupIPVersionResponseMeta ¶
type AttackLayer3TimeseriesGroupIPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesGroupIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesGroupIPVersionResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesGroupIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesGroupIPVersionResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval ¶
type AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesGroupIPVersionResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesGroupIPVersionResponseMetaAggIntervalOneHour AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesGroupIPVersionResponseMetaAggIntervalOneDay AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesGroupIPVersionResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesGroupIPVersionResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIPVersionResponseMetaDateRange ¶
type AttackLayer3TimeseriesGroupIPVersionResponseMetaDateRange 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 attackLayer3TimeseriesGroupIPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization ¶
type AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationPercentage AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationMin0Max AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationMinMax AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationRawValues AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalizationRatio AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIPVersionResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupIPVersionResponseMetaUnit ¶
type AttackLayer3TimeseriesGroupIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesGroupIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIPVersionResponseSerie0 ¶
type AttackLayer3TimeseriesGroupIPVersionResponseSerie0 struct {
IPv4 []string `json:"IPv4,required"`
IPv6 []string `json:"IPv6,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIndustryParams ¶
type AttackLayer3TimeseriesGroupIndustryParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesGroupIndustryParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesGroupIndustryParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TimeseriesGroupIndustryParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesGroupIndustryParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TimeseriesGroupIndustryParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TimeseriesGroupIndustryParams) URLQuery ¶
func (r AttackLayer3TimeseriesGroupIndustryParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TimeseriesGroupIndustryParams's query parameters as `url.Values`.
type AttackLayer3TimeseriesGroupIndustryParamsAggInterval ¶
type AttackLayer3TimeseriesGroupIndustryParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesGroupIndustryParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryParamsDirection ¶
type AttackLayer3TimeseriesGroupIndustryParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesGroupIndustryParamsDirectionOrigin AttackLayer3TimeseriesGroupIndustryParamsDirection = "ORIGIN" AttackLayer3TimeseriesGroupIndustryParamsDirectionTarget AttackLayer3TimeseriesGroupIndustryParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesGroupIndustryParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIndustryParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryParamsFormat ¶
type AttackLayer3TimeseriesGroupIndustryParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesGroupIndustryParamsFormatJson AttackLayer3TimeseriesGroupIndustryParamsFormat = "JSON" AttackLayer3TimeseriesGroupIndustryParamsFormatCsv AttackLayer3TimeseriesGroupIndustryParamsFormat = "CSV" )
func (AttackLayer3TimeseriesGroupIndustryParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIndustryParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryParamsIPVersion ¶
type AttackLayer3TimeseriesGroupIndustryParamsIPVersion string
const ( AttackLayer3TimeseriesGroupIndustryParamsIPVersionIPv4 AttackLayer3TimeseriesGroupIndustryParamsIPVersion = "IPv4" AttackLayer3TimeseriesGroupIndustryParamsIPVersionIPv6 AttackLayer3TimeseriesGroupIndustryParamsIPVersion = "IPv6" )
func (AttackLayer3TimeseriesGroupIndustryParamsIPVersion) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIndustryParamsIPVersion) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryParamsNormalization ¶
type AttackLayer3TimeseriesGroupIndustryParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupIndustryParamsNormalizationPercentage AttackLayer3TimeseriesGroupIndustryParamsNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupIndustryParamsNormalizationMin0Max AttackLayer3TimeseriesGroupIndustryParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesGroupIndustryParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIndustryParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryParamsProtocol ¶
type AttackLayer3TimeseriesGroupIndustryParamsProtocol string
const ( AttackLayer3TimeseriesGroupIndustryParamsProtocolUdp AttackLayer3TimeseriesGroupIndustryParamsProtocol = "UDP" AttackLayer3TimeseriesGroupIndustryParamsProtocolTCP AttackLayer3TimeseriesGroupIndustryParamsProtocol = "TCP" AttackLayer3TimeseriesGroupIndustryParamsProtocolIcmp AttackLayer3TimeseriesGroupIndustryParamsProtocol = "ICMP" AttackLayer3TimeseriesGroupIndustryParamsProtocolGRE AttackLayer3TimeseriesGroupIndustryParamsProtocol = "GRE" )
func (AttackLayer3TimeseriesGroupIndustryParamsProtocol) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIndustryParamsProtocol) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryResponse ¶
type AttackLayer3TimeseriesGroupIndustryResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesGroupIndustryResponseMeta `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 AttackLayer3TimeseriesGroupIndustryResponseMeta ¶
type AttackLayer3TimeseriesGroupIndustryResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesGroupIndustryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesGroupIndustryResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesGroupIndustryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesGroupIndustryResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval ¶
type AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesGroupIndustryResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesGroupIndustryResponseMetaAggIntervalOneHour AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesGroupIndustryResponseMetaAggIntervalOneDay AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesGroupIndustryResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesGroupIndustryResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIndustryResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIndustryResponseMetaDateRange ¶
type AttackLayer3TimeseriesGroupIndustryResponseMetaDateRange 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 attackLayer3TimeseriesGroupIndustryResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupIndustryResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIndustryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization ¶
type AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationPercentage AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationMin0Max AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationMinMax AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationRawValues AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesGroupIndustryResponseMetaNormalizationRatio AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupIndustryResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupIndustryResponseMetaUnit ¶
type AttackLayer3TimeseriesGroupIndustryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesGroupIndustryResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupIndustryResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupIndustryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupIndustryResponseSerie0 ¶
type AttackLayer3TimeseriesGroupIndustryResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesGroupProtocolParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesGroupProtocolParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TimeseriesGroupProtocolParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesGroupProtocolParamsNormalization] `query:"normalization"`
}
func (AttackLayer3TimeseriesGroupProtocolParams) URLQuery ¶
func (r AttackLayer3TimeseriesGroupProtocolParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TimeseriesGroupProtocolParams's query parameters as `url.Values`.
type AttackLayer3TimeseriesGroupProtocolParamsAggInterval ¶
type AttackLayer3TimeseriesGroupProtocolParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesGroupProtocolParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupProtocolParamsDirection ¶
type AttackLayer3TimeseriesGroupProtocolParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesGroupProtocolParamsDirectionOrigin AttackLayer3TimeseriesGroupProtocolParamsDirection = "ORIGIN" AttackLayer3TimeseriesGroupProtocolParamsDirectionTarget AttackLayer3TimeseriesGroupProtocolParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesGroupProtocolParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesGroupProtocolParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesGroupProtocolParamsFormat ¶
type AttackLayer3TimeseriesGroupProtocolParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesGroupProtocolParamsFormatJson AttackLayer3TimeseriesGroupProtocolParamsFormat = "JSON" AttackLayer3TimeseriesGroupProtocolParamsFormatCsv AttackLayer3TimeseriesGroupProtocolParamsFormat = "CSV" )
func (AttackLayer3TimeseriesGroupProtocolParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesGroupProtocolParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesGroupProtocolParamsIPVersion ¶
type AttackLayer3TimeseriesGroupProtocolParamsIPVersion string
const ( AttackLayer3TimeseriesGroupProtocolParamsIPVersionIPv4 AttackLayer3TimeseriesGroupProtocolParamsIPVersion = "IPv4" AttackLayer3TimeseriesGroupProtocolParamsIPVersionIPv6 AttackLayer3TimeseriesGroupProtocolParamsIPVersion = "IPv6" )
func (AttackLayer3TimeseriesGroupProtocolParamsIPVersion) IsKnown ¶
func (r AttackLayer3TimeseriesGroupProtocolParamsIPVersion) IsKnown() bool
type AttackLayer3TimeseriesGroupProtocolParamsNormalization ¶
type AttackLayer3TimeseriesGroupProtocolParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupProtocolParamsNormalizationPercentage AttackLayer3TimeseriesGroupProtocolParamsNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupProtocolParamsNormalizationMin0Max AttackLayer3TimeseriesGroupProtocolParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesGroupProtocolParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupProtocolParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupProtocolResponse ¶
type AttackLayer3TimeseriesGroupProtocolResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesGroupProtocolResponseMeta `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 AttackLayer3TimeseriesGroupProtocolResponseMeta ¶
type AttackLayer3TimeseriesGroupProtocolResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesGroupProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesGroupProtocolResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesGroupProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesGroupProtocolResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval ¶
type AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesGroupProtocolResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesGroupProtocolResponseMetaAggIntervalOneHour AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesGroupProtocolResponseMetaAggIntervalOneDay AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesGroupProtocolResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesGroupProtocolResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesGroupProtocolResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupProtocolResponseMetaDateRange ¶
type AttackLayer3TimeseriesGroupProtocolResponseMetaDateRange 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 attackLayer3TimeseriesGroupProtocolResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupProtocolResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization ¶
type AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationPercentage AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationMin0Max AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationMinMax AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationRawValues AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesGroupProtocolResponseMetaNormalizationRatio AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupProtocolResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupProtocolResponseMetaUnit ¶
type AttackLayer3TimeseriesGroupProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesGroupProtocolResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupProtocolResponseMetaUnit) 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 []time.Time `json:"timestamps,required" format:"date-time"`
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 ¶
func (r *AttackLayer3TimeseriesGroupService) Bitrate(ctx context.Context, query AttackLayer3TimeseriesGroupBitrateParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesGroupBitrateResponse, err error)
Retrieves the distribution of layer 3 attacks by bitrate over time.
func (*AttackLayer3TimeseriesGroupService) Duration ¶
func (r *AttackLayer3TimeseriesGroupService) Duration(ctx context.Context, query AttackLayer3TimeseriesGroupDurationParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesGroupDurationResponse, err error)
Retrieves the distribution of layer 3 attacks by duration over time.
func (*AttackLayer3TimeseriesGroupService) IPVersion ¶
func (r *AttackLayer3TimeseriesGroupService) IPVersion(ctx context.Context, query AttackLayer3TimeseriesGroupIPVersionParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesGroupIPVersionResponse, err error)
Retrieves the distribution of layer 3 attacks by IP version over time.
func (*AttackLayer3TimeseriesGroupService) Industry ¶
func (r *AttackLayer3TimeseriesGroupService) Industry(ctx context.Context, query AttackLayer3TimeseriesGroupIndustryParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesGroupIndustryResponse, err error)
Retrieves the distribution of layer 3 attacks by targeted industry over time.
func (*AttackLayer3TimeseriesGroupService) Protocol ¶
func (r *AttackLayer3TimeseriesGroupService) Protocol(ctx context.Context, query AttackLayer3TimeseriesGroupProtocolParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesGroupProtocolResponse, err error)
Retrieves the distribution of layer 3 attacks by protocol over time.
func (*AttackLayer3TimeseriesGroupService) Vector ¶
func (r *AttackLayer3TimeseriesGroupService) Vector(ctx context.Context, query AttackLayer3TimeseriesGroupVectorParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesGroupVectorResponse, err error)
Retrieves the distribution of layer 3 attacks by vector over time.
func (*AttackLayer3TimeseriesGroupService) Vertical ¶
func (r *AttackLayer3TimeseriesGroupService) Vertical(ctx context.Context, query AttackLayer3TimeseriesGroupVerticalParams, opts ...option.RequestOption) (res *AttackLayer3TimeseriesGroupVerticalResponse, err error)
Retrieves the distribution of layer 3 attacks by targeted vertical over time.
type AttackLayer3TimeseriesGroupVectorParams ¶
type AttackLayer3TimeseriesGroupVectorParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesGroupVectorParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesGroupVectorParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TimeseriesGroupVectorParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesGroupVectorParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TimeseriesGroupVectorParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TimeseriesGroupVectorParams) URLQuery ¶
func (r AttackLayer3TimeseriesGroupVectorParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TimeseriesGroupVectorParams's query parameters as `url.Values`.
type AttackLayer3TimeseriesGroupVectorParamsAggInterval ¶
type AttackLayer3TimeseriesGroupVectorParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesGroupVectorParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorParamsDirection ¶
type AttackLayer3TimeseriesGroupVectorParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesGroupVectorParamsDirectionOrigin AttackLayer3TimeseriesGroupVectorParamsDirection = "ORIGIN" AttackLayer3TimeseriesGroupVectorParamsDirectionTarget AttackLayer3TimeseriesGroupVectorParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesGroupVectorParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVectorParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorParamsFormat ¶
type AttackLayer3TimeseriesGroupVectorParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesGroupVectorParamsFormatJson AttackLayer3TimeseriesGroupVectorParamsFormat = "JSON" AttackLayer3TimeseriesGroupVectorParamsFormatCsv AttackLayer3TimeseriesGroupVectorParamsFormat = "CSV" )
func (AttackLayer3TimeseriesGroupVectorParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVectorParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorParamsIPVersion ¶
type AttackLayer3TimeseriesGroupVectorParamsIPVersion string
const ( AttackLayer3TimeseriesGroupVectorParamsIPVersionIPv4 AttackLayer3TimeseriesGroupVectorParamsIPVersion = "IPv4" AttackLayer3TimeseriesGroupVectorParamsIPVersionIPv6 AttackLayer3TimeseriesGroupVectorParamsIPVersion = "IPv6" )
func (AttackLayer3TimeseriesGroupVectorParamsIPVersion) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVectorParamsIPVersion) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorParamsNormalization ¶
type AttackLayer3TimeseriesGroupVectorParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupVectorParamsNormalizationPercentage AttackLayer3TimeseriesGroupVectorParamsNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupVectorParamsNormalizationMin0Max AttackLayer3TimeseriesGroupVectorParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesGroupVectorParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVectorParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorParamsProtocol ¶
type AttackLayer3TimeseriesGroupVectorParamsProtocol string
const ( AttackLayer3TimeseriesGroupVectorParamsProtocolUdp AttackLayer3TimeseriesGroupVectorParamsProtocol = "UDP" AttackLayer3TimeseriesGroupVectorParamsProtocolTCP AttackLayer3TimeseriesGroupVectorParamsProtocol = "TCP" AttackLayer3TimeseriesGroupVectorParamsProtocolIcmp AttackLayer3TimeseriesGroupVectorParamsProtocol = "ICMP" AttackLayer3TimeseriesGroupVectorParamsProtocolGRE AttackLayer3TimeseriesGroupVectorParamsProtocol = "GRE" )
func (AttackLayer3TimeseriesGroupVectorParamsProtocol) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVectorParamsProtocol) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorResponse ¶
type AttackLayer3TimeseriesGroupVectorResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesGroupVectorResponseMeta `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 AttackLayer3TimeseriesGroupVectorResponseMeta ¶
type AttackLayer3TimeseriesGroupVectorResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesGroupVectorResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesGroupVectorResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesGroupVectorResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesGroupVectorResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesGroupVectorResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVectorResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval ¶
type AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesGroupVectorResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesGroupVectorResponseMetaAggIntervalOneHour AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesGroupVectorResponseMetaAggIntervalOneDay AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesGroupVectorResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesGroupVectorResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVectorResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVectorResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVectorResponseMetaDateRange ¶
type AttackLayer3TimeseriesGroupVectorResponseMetaDateRange 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 attackLayer3TimeseriesGroupVectorResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupVectorResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVectorResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVectorResponseMetaNormalization ¶
type AttackLayer3TimeseriesGroupVectorResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationPercentage AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationMin0Max AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationMinMax AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationRawValues AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesGroupVectorResponseMetaNormalizationRatio AttackLayer3TimeseriesGroupVectorResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesGroupVectorResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVectorResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupVectorResponseMetaUnit ¶
type AttackLayer3TimeseriesGroupVectorResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesGroupVectorResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupVectorResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVectorResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVectorResponseSerie0 ¶
type AttackLayer3TimeseriesGroupVectorResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesGroupVerticalParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesGroupVerticalParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TimeseriesGroupVerticalParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesGroupVerticalParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TimeseriesGroupVerticalParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TimeseriesGroupVerticalParams) URLQuery ¶
func (r AttackLayer3TimeseriesGroupVerticalParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TimeseriesGroupVerticalParams's query parameters as `url.Values`.
type AttackLayer3TimeseriesGroupVerticalParamsAggInterval ¶
type AttackLayer3TimeseriesGroupVerticalParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesGroupVerticalParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalParamsDirection ¶
type AttackLayer3TimeseriesGroupVerticalParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesGroupVerticalParamsDirectionOrigin AttackLayer3TimeseriesGroupVerticalParamsDirection = "ORIGIN" AttackLayer3TimeseriesGroupVerticalParamsDirectionTarget AttackLayer3TimeseriesGroupVerticalParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesGroupVerticalParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVerticalParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalParamsFormat ¶
type AttackLayer3TimeseriesGroupVerticalParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesGroupVerticalParamsFormatJson AttackLayer3TimeseriesGroupVerticalParamsFormat = "JSON" AttackLayer3TimeseriesGroupVerticalParamsFormatCsv AttackLayer3TimeseriesGroupVerticalParamsFormat = "CSV" )
func (AttackLayer3TimeseriesGroupVerticalParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVerticalParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalParamsIPVersion ¶
type AttackLayer3TimeseriesGroupVerticalParamsIPVersion string
const ( AttackLayer3TimeseriesGroupVerticalParamsIPVersionIPv4 AttackLayer3TimeseriesGroupVerticalParamsIPVersion = "IPv4" AttackLayer3TimeseriesGroupVerticalParamsIPVersionIPv6 AttackLayer3TimeseriesGroupVerticalParamsIPVersion = "IPv6" )
func (AttackLayer3TimeseriesGroupVerticalParamsIPVersion) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVerticalParamsIPVersion) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalParamsNormalization ¶
type AttackLayer3TimeseriesGroupVerticalParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupVerticalParamsNormalizationPercentage AttackLayer3TimeseriesGroupVerticalParamsNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupVerticalParamsNormalizationMin0Max AttackLayer3TimeseriesGroupVerticalParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesGroupVerticalParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVerticalParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalParamsProtocol ¶
type AttackLayer3TimeseriesGroupVerticalParamsProtocol string
const ( AttackLayer3TimeseriesGroupVerticalParamsProtocolUdp AttackLayer3TimeseriesGroupVerticalParamsProtocol = "UDP" AttackLayer3TimeseriesGroupVerticalParamsProtocolTCP AttackLayer3TimeseriesGroupVerticalParamsProtocol = "TCP" AttackLayer3TimeseriesGroupVerticalParamsProtocolIcmp AttackLayer3TimeseriesGroupVerticalParamsProtocol = "ICMP" AttackLayer3TimeseriesGroupVerticalParamsProtocolGRE AttackLayer3TimeseriesGroupVerticalParamsProtocol = "GRE" )
func (AttackLayer3TimeseriesGroupVerticalParamsProtocol) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVerticalParamsProtocol) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalResponse ¶
type AttackLayer3TimeseriesGroupVerticalResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesGroupVerticalResponseMeta `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 AttackLayer3TimeseriesGroupVerticalResponseMeta ¶
type AttackLayer3TimeseriesGroupVerticalResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesGroupVerticalResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesGroupVerticalResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesGroupVerticalResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesGroupVerticalResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval ¶
type AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesGroupVerticalResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesGroupVerticalResponseMetaAggIntervalOneHour AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesGroupVerticalResponseMetaAggIntervalOneDay AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesGroupVerticalResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesGroupVerticalResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVerticalResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVerticalResponseMetaDateRange ¶
type AttackLayer3TimeseriesGroupVerticalResponseMetaDateRange 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 attackLayer3TimeseriesGroupVerticalResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupVerticalResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVerticalResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization ¶
type AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationPercentage AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationMin0Max AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationMinMax AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationRawValues AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesGroupVerticalResponseMetaNormalizationRatio AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesGroupVerticalResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesGroupVerticalResponseMetaUnit ¶
type AttackLayer3TimeseriesGroupVerticalResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesGroupVerticalResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesGroupVerticalResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesGroupVerticalResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesGroupVerticalResponseSerie0 ¶
type AttackLayer3TimeseriesGroupVerticalResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Specifies whether the `location` filter applies to the source or target
// location.
Direction param.Field[AttackLayer3TimeseriesParamsDirection] `query:"direction"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TimeseriesParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TimeseriesParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TimeseriesParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
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 of the results (e.g., 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 ¶
func (r AttackLayer3TimeseriesParamsAggInterval) IsKnown() bool
type AttackLayer3TimeseriesParamsDirection ¶
type AttackLayer3TimeseriesParamsDirection string
Specifies whether the `location` filter applies to the source or target location.
const ( AttackLayer3TimeseriesParamsDirectionOrigin AttackLayer3TimeseriesParamsDirection = "ORIGIN" AttackLayer3TimeseriesParamsDirectionTarget AttackLayer3TimeseriesParamsDirection = "TARGET" )
func (AttackLayer3TimeseriesParamsDirection) IsKnown ¶
func (r AttackLayer3TimeseriesParamsDirection) IsKnown() bool
type AttackLayer3TimeseriesParamsFormat ¶
type AttackLayer3TimeseriesParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TimeseriesParamsFormatJson AttackLayer3TimeseriesParamsFormat = "JSON" AttackLayer3TimeseriesParamsFormatCsv AttackLayer3TimeseriesParamsFormat = "CSV" )
func (AttackLayer3TimeseriesParamsFormat) IsKnown ¶
func (r AttackLayer3TimeseriesParamsFormat) IsKnown() bool
type AttackLayer3TimeseriesParamsIPVersion ¶
type AttackLayer3TimeseriesParamsIPVersion string
const ( AttackLayer3TimeseriesParamsIPVersionIPv4 AttackLayer3TimeseriesParamsIPVersion = "IPv4" AttackLayer3TimeseriesParamsIPVersionIPv6 AttackLayer3TimeseriesParamsIPVersion = "IPv6" )
func (AttackLayer3TimeseriesParamsIPVersion) IsKnown ¶
func (r AttackLayer3TimeseriesParamsIPVersion) IsKnown() bool
type AttackLayer3TimeseriesParamsMetric ¶
type AttackLayer3TimeseriesParamsMetric string
Measurement units, eg. bytes.
const ( AttackLayer3TimeseriesParamsMetricBytes AttackLayer3TimeseriesParamsMetric = "BYTES" AttackLayer3TimeseriesParamsMetricBytesOld AttackLayer3TimeseriesParamsMetric = "BYTES_OLD" )
func (AttackLayer3TimeseriesParamsMetric) IsKnown ¶
func (r AttackLayer3TimeseriesParamsMetric) IsKnown() bool
type AttackLayer3TimeseriesParamsNormalization ¶
type AttackLayer3TimeseriesParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesParamsNormalizationPercentageChange AttackLayer3TimeseriesParamsNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesParamsNormalizationMin0Max AttackLayer3TimeseriesParamsNormalization = "MIN0_MAX" )
func (AttackLayer3TimeseriesParamsNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesParamsNormalization) IsKnown() bool
type AttackLayer3TimeseriesParamsProtocol ¶
type AttackLayer3TimeseriesParamsProtocol string
const ( AttackLayer3TimeseriesParamsProtocolUdp AttackLayer3TimeseriesParamsProtocol = "UDP" AttackLayer3TimeseriesParamsProtocolTCP AttackLayer3TimeseriesParamsProtocol = "TCP" AttackLayer3TimeseriesParamsProtocolIcmp AttackLayer3TimeseriesParamsProtocol = "ICMP" AttackLayer3TimeseriesParamsProtocolGRE AttackLayer3TimeseriesParamsProtocol = "GRE" )
func (AttackLayer3TimeseriesParamsProtocol) IsKnown ¶
func (r AttackLayer3TimeseriesParamsProtocol) IsKnown() bool
type AttackLayer3TimeseriesResponse ¶
type AttackLayer3TimeseriesResponse struct {
// Metadata for the results.
Meta AttackLayer3TimeseriesResponseMeta `json:"meta,required"`
ExtraFields map[string]AttackLayer3TimeseriesResponse `json:"-,extras"`
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 AttackLayer3TimeseriesResponseMeta ¶
type AttackLayer3TimeseriesResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer3TimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer3TimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer3TimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TimeseriesResponseMetaUnit `json:"units,required"`
JSON attackLayer3TimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TimeseriesResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesResponseMetaAggInterval ¶
type AttackLayer3TimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer3TimeseriesResponseMetaAggIntervalFifteenMinutes AttackLayer3TimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer3TimeseriesResponseMetaAggIntervalOneHour AttackLayer3TimeseriesResponseMetaAggInterval = "ONE_HOUR" AttackLayer3TimeseriesResponseMetaAggIntervalOneDay AttackLayer3TimeseriesResponseMetaAggInterval = "ONE_DAY" AttackLayer3TimeseriesResponseMetaAggIntervalOneWeek AttackLayer3TimeseriesResponseMetaAggInterval = "ONE_WEEK" AttackLayer3TimeseriesResponseMetaAggIntervalOneMonth AttackLayer3TimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer3TimeseriesResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer3TimeseriesResponseMetaAggInterval) IsKnown() bool
type AttackLayer3TimeseriesResponseMetaConfidenceInfo ¶
type AttackLayer3TimeseriesResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TimeseriesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TimeseriesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TimeseriesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesResponseMetaDateRange ¶
type AttackLayer3TimeseriesResponseMetaDateRange 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 attackLayer3TimeseriesResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer3TimeseriesResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TimeseriesResponseMetaNormalization ¶
type AttackLayer3TimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TimeseriesResponseMetaNormalizationPercentage AttackLayer3TimeseriesResponseMetaNormalization = "PERCENTAGE" AttackLayer3TimeseriesResponseMetaNormalizationMin0Max AttackLayer3TimeseriesResponseMetaNormalization = "MIN0_MAX" AttackLayer3TimeseriesResponseMetaNormalizationMinMax AttackLayer3TimeseriesResponseMetaNormalization = "MIN_MAX" AttackLayer3TimeseriesResponseMetaNormalizationRawValues AttackLayer3TimeseriesResponseMetaNormalization = "RAW_VALUES" AttackLayer3TimeseriesResponseMetaNormalizationPercentageChange AttackLayer3TimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TimeseriesResponseMetaNormalizationRollingAverage AttackLayer3TimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TimeseriesResponseMetaNormalizationOverlappedPercentage AttackLayer3TimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TimeseriesResponseMetaNormalizationRatio AttackLayer3TimeseriesResponseMetaNormalization = "RATIO" )
func (AttackLayer3TimeseriesResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TimeseriesResponseMetaNormalization) IsKnown() bool
type AttackLayer3TimeseriesResponseMetaUnit ¶
type AttackLayer3TimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TimeseriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopAttacksParams ¶
type AttackLayer3TopAttacksParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TopAttacksParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TopAttacksParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Specifies whether the `limitPerLocation` applies to the source or target
// location.
LimitDirection param.Field[AttackLayer3TopAttacksParamsLimitDirection] `query:"limitDirection"`
// Limits the number of attacks per origin/target (refer to `limitDirection`
// parameter) location.
LimitPerLocation param.Field[int64] `query:"limitPerLocation"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Orders results based on attack magnitude, defined by total mitigated bytes or
// total mitigated attacks.
Magnitude param.Field[AttackLayer3TopAttacksParamsMagnitude] `query:"magnitude"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer3TopAttacksParamsNormalization] `query:"normalization"`
// Filters the results by layer 3/4 protocol.
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 in which results will be returned.
const ( AttackLayer3TopAttacksParamsFormatJson AttackLayer3TopAttacksParamsFormat = "JSON" AttackLayer3TopAttacksParamsFormatCsv AttackLayer3TopAttacksParamsFormat = "CSV" )
func (AttackLayer3TopAttacksParamsFormat) IsKnown ¶
func (r AttackLayer3TopAttacksParamsFormat) IsKnown() bool
type AttackLayer3TopAttacksParamsIPVersion ¶
type AttackLayer3TopAttacksParamsIPVersion string
const ( AttackLayer3TopAttacksParamsIPVersionIPv4 AttackLayer3TopAttacksParamsIPVersion = "IPv4" AttackLayer3TopAttacksParamsIPVersionIPv6 AttackLayer3TopAttacksParamsIPVersion = "IPv6" )
func (AttackLayer3TopAttacksParamsIPVersion) IsKnown ¶
func (r AttackLayer3TopAttacksParamsIPVersion) IsKnown() bool
type AttackLayer3TopAttacksParamsLimitDirection ¶
type AttackLayer3TopAttacksParamsLimitDirection string
Specifies whether the `limitPerLocation` applies to the source or target location.
const ( AttackLayer3TopAttacksParamsLimitDirectionOrigin AttackLayer3TopAttacksParamsLimitDirection = "ORIGIN" AttackLayer3TopAttacksParamsLimitDirectionTarget AttackLayer3TopAttacksParamsLimitDirection = "TARGET" )
func (AttackLayer3TopAttacksParamsLimitDirection) IsKnown ¶
func (r AttackLayer3TopAttacksParamsLimitDirection) IsKnown() bool
type AttackLayer3TopAttacksParamsMagnitude ¶
type AttackLayer3TopAttacksParamsMagnitude string
Orders results based on attack magnitude, defined by total mitigated bytes or total mitigated attacks.
const ( AttackLayer3TopAttacksParamsMagnitudeMitigatedBytes AttackLayer3TopAttacksParamsMagnitude = "MITIGATED_BYTES" AttackLayer3TopAttacksParamsMagnitudeMitigatedAttacks AttackLayer3TopAttacksParamsMagnitude = "MITIGATED_ATTACKS" )
func (AttackLayer3TopAttacksParamsMagnitude) IsKnown ¶
func (r AttackLayer3TopAttacksParamsMagnitude) IsKnown() bool
type AttackLayer3TopAttacksParamsNormalization ¶
type AttackLayer3TopAttacksParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TopAttacksParamsNormalizationPercentage AttackLayer3TopAttacksParamsNormalization = "PERCENTAGE" AttackLayer3TopAttacksParamsNormalizationMinMax AttackLayer3TopAttacksParamsNormalization = "MIN_MAX" )
func (AttackLayer3TopAttacksParamsNormalization) IsKnown ¶
func (r AttackLayer3TopAttacksParamsNormalization) IsKnown() bool
type AttackLayer3TopAttacksParamsProtocol ¶
type AttackLayer3TopAttacksParamsProtocol string
const ( AttackLayer3TopAttacksParamsProtocolUdp AttackLayer3TopAttacksParamsProtocol = "UDP" AttackLayer3TopAttacksParamsProtocolTCP AttackLayer3TopAttacksParamsProtocol = "TCP" AttackLayer3TopAttacksParamsProtocolIcmp AttackLayer3TopAttacksParamsProtocol = "ICMP" AttackLayer3TopAttacksParamsProtocolGRE AttackLayer3TopAttacksParamsProtocol = "GRE" )
func (AttackLayer3TopAttacksParamsProtocol) IsKnown ¶
func (r AttackLayer3TopAttacksParamsProtocol) IsKnown() bool
type AttackLayer3TopAttacksResponse ¶
type AttackLayer3TopAttacksResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3TopAttacksResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer3TopAttacksResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TopAttacksResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TopAttacksResponseMetaUnit `json:"units,required"`
JSON attackLayer3TopAttacksResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TopAttacksResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TopAttacksResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopAttacksResponseMetaConfidenceInfo ¶
type AttackLayer3TopAttacksResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TopAttacksResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TopAttacksResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3TopAttacksResponseMetaNormalization ¶
type AttackLayer3TopAttacksResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TopAttacksResponseMetaNormalizationPercentage AttackLayer3TopAttacksResponseMetaNormalization = "PERCENTAGE" AttackLayer3TopAttacksResponseMetaNormalizationMin0Max AttackLayer3TopAttacksResponseMetaNormalization = "MIN0_MAX" AttackLayer3TopAttacksResponseMetaNormalizationMinMax AttackLayer3TopAttacksResponseMetaNormalization = "MIN_MAX" AttackLayer3TopAttacksResponseMetaNormalizationRawValues AttackLayer3TopAttacksResponseMetaNormalization = "RAW_VALUES" AttackLayer3TopAttacksResponseMetaNormalizationPercentageChange AttackLayer3TopAttacksResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TopAttacksResponseMetaNormalizationRollingAverage AttackLayer3TopAttacksResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TopAttacksResponseMetaNormalizationOverlappedPercentage AttackLayer3TopAttacksResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TopAttacksResponseMetaNormalizationRatio AttackLayer3TopAttacksResponseMetaNormalization = "RATIO" )
func (AttackLayer3TopAttacksResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TopAttacksResponseMetaNormalization) IsKnown() bool
type AttackLayer3TopAttacksResponseMetaUnit ¶
type AttackLayer3TopAttacksResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TopAttacksResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TopAttacksResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TopAttacksResponseMetaUnit) 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 {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TopIndustryParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TopIndustryParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
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 in which results will be returned.
const ( AttackLayer3TopIndustryParamsFormatJson AttackLayer3TopIndustryParamsFormat = "JSON" AttackLayer3TopIndustryParamsFormatCsv AttackLayer3TopIndustryParamsFormat = "CSV" )
func (AttackLayer3TopIndustryParamsFormat) IsKnown ¶
func (r AttackLayer3TopIndustryParamsFormat) IsKnown() bool
type AttackLayer3TopIndustryParamsIPVersion ¶
type AttackLayer3TopIndustryParamsIPVersion string
const ( AttackLayer3TopIndustryParamsIPVersionIPv4 AttackLayer3TopIndustryParamsIPVersion = "IPv4" AttackLayer3TopIndustryParamsIPVersionIPv6 AttackLayer3TopIndustryParamsIPVersion = "IPv6" )
func (AttackLayer3TopIndustryParamsIPVersion) IsKnown ¶
func (r AttackLayer3TopIndustryParamsIPVersion) IsKnown() bool
type AttackLayer3TopIndustryParamsProtocol ¶
type AttackLayer3TopIndustryParamsProtocol string
const ( AttackLayer3TopIndustryParamsProtocolUdp AttackLayer3TopIndustryParamsProtocol = "UDP" AttackLayer3TopIndustryParamsProtocolTCP AttackLayer3TopIndustryParamsProtocol = "TCP" AttackLayer3TopIndustryParamsProtocolIcmp AttackLayer3TopIndustryParamsProtocol = "ICMP" AttackLayer3TopIndustryParamsProtocolGRE AttackLayer3TopIndustryParamsProtocol = "GRE" )
func (AttackLayer3TopIndustryParamsProtocol) IsKnown ¶
func (r AttackLayer3TopIndustryParamsProtocol) IsKnown() bool
type AttackLayer3TopIndustryResponse ¶
type AttackLayer3TopIndustryResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3TopIndustryResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer3TopIndustryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TopIndustryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TopIndustryResponseMetaUnit `json:"units,required"`
JSON attackLayer3TopIndustryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TopIndustryResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TopIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopIndustryResponseMetaConfidenceInfo ¶
type AttackLayer3TopIndustryResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TopIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TopIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3TopIndustryResponseMetaNormalization ¶
type AttackLayer3TopIndustryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TopIndustryResponseMetaNormalizationPercentage AttackLayer3TopIndustryResponseMetaNormalization = "PERCENTAGE" AttackLayer3TopIndustryResponseMetaNormalizationMin0Max AttackLayer3TopIndustryResponseMetaNormalization = "MIN0_MAX" AttackLayer3TopIndustryResponseMetaNormalizationMinMax AttackLayer3TopIndustryResponseMetaNormalization = "MIN_MAX" AttackLayer3TopIndustryResponseMetaNormalizationRawValues AttackLayer3TopIndustryResponseMetaNormalization = "RAW_VALUES" AttackLayer3TopIndustryResponseMetaNormalizationPercentageChange AttackLayer3TopIndustryResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TopIndustryResponseMetaNormalizationRollingAverage AttackLayer3TopIndustryResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TopIndustryResponseMetaNormalizationOverlappedPercentage AttackLayer3TopIndustryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TopIndustryResponseMetaNormalizationRatio AttackLayer3TopIndustryResponseMetaNormalization = "RATIO" )
func (AttackLayer3TopIndustryResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TopIndustryResponseMetaNormalization) IsKnown() bool
type AttackLayer3TopIndustryResponseMetaUnit ¶
type AttackLayer3TopIndustryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TopIndustryResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TopIndustryResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TopIndustryResponseMetaUnit) 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 {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TopLocationOriginParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TopLocationOriginParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TopLocationOriginParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TopLocationOriginParams) URLQuery ¶
func (r AttackLayer3TopLocationOriginParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TopLocationOriginParams's query parameters as `url.Values`.
type AttackLayer3TopLocationOriginParamsFormat ¶
type AttackLayer3TopLocationOriginParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TopLocationOriginParamsFormatJson AttackLayer3TopLocationOriginParamsFormat = "JSON" AttackLayer3TopLocationOriginParamsFormatCsv AttackLayer3TopLocationOriginParamsFormat = "CSV" )
func (AttackLayer3TopLocationOriginParamsFormat) IsKnown ¶
func (r AttackLayer3TopLocationOriginParamsFormat) IsKnown() bool
type AttackLayer3TopLocationOriginParamsIPVersion ¶
type AttackLayer3TopLocationOriginParamsIPVersion string
const ( AttackLayer3TopLocationOriginParamsIPVersionIPv4 AttackLayer3TopLocationOriginParamsIPVersion = "IPv4" AttackLayer3TopLocationOriginParamsIPVersionIPv6 AttackLayer3TopLocationOriginParamsIPVersion = "IPv6" )
func (AttackLayer3TopLocationOriginParamsIPVersion) IsKnown ¶
func (r AttackLayer3TopLocationOriginParamsIPVersion) IsKnown() bool
type AttackLayer3TopLocationOriginParamsProtocol ¶
type AttackLayer3TopLocationOriginParamsProtocol string
const ( AttackLayer3TopLocationOriginParamsProtocolUdp AttackLayer3TopLocationOriginParamsProtocol = "UDP" AttackLayer3TopLocationOriginParamsProtocolTCP AttackLayer3TopLocationOriginParamsProtocol = "TCP" AttackLayer3TopLocationOriginParamsProtocolIcmp AttackLayer3TopLocationOriginParamsProtocol = "ICMP" AttackLayer3TopLocationOriginParamsProtocolGRE AttackLayer3TopLocationOriginParamsProtocol = "GRE" )
func (AttackLayer3TopLocationOriginParamsProtocol) IsKnown ¶
func (r AttackLayer3TopLocationOriginParamsProtocol) IsKnown() bool
type AttackLayer3TopLocationOriginResponse ¶
type AttackLayer3TopLocationOriginResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3TopLocationOriginResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer3TopLocationOriginResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TopLocationOriginResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TopLocationOriginResponseMetaUnit `json:"units,required"`
JSON attackLayer3TopLocationOriginResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TopLocationOriginResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationOriginResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopLocationOriginResponseMetaConfidenceInfo ¶
type AttackLayer3TopLocationOriginResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TopLocationOriginResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TopLocationOriginResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationOriginResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3TopLocationOriginResponseMetaNormalization ¶
type AttackLayer3TopLocationOriginResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TopLocationOriginResponseMetaNormalizationPercentage AttackLayer3TopLocationOriginResponseMetaNormalization = "PERCENTAGE" AttackLayer3TopLocationOriginResponseMetaNormalizationMin0Max AttackLayer3TopLocationOriginResponseMetaNormalization = "MIN0_MAX" AttackLayer3TopLocationOriginResponseMetaNormalizationMinMax AttackLayer3TopLocationOriginResponseMetaNormalization = "MIN_MAX" AttackLayer3TopLocationOriginResponseMetaNormalizationRawValues AttackLayer3TopLocationOriginResponseMetaNormalization = "RAW_VALUES" AttackLayer3TopLocationOriginResponseMetaNormalizationPercentageChange AttackLayer3TopLocationOriginResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TopLocationOriginResponseMetaNormalizationRollingAverage AttackLayer3TopLocationOriginResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TopLocationOriginResponseMetaNormalizationOverlappedPercentage AttackLayer3TopLocationOriginResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TopLocationOriginResponseMetaNormalizationRatio AttackLayer3TopLocationOriginResponseMetaNormalization = "RATIO" )
func (AttackLayer3TopLocationOriginResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TopLocationOriginResponseMetaNormalization) IsKnown() bool
type AttackLayer3TopLocationOriginResponseMetaUnit ¶
type AttackLayer3TopLocationOriginResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TopLocationOriginResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TopLocationOriginResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationOriginResponseMetaUnit) 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 ¶
func (r *AttackLayer3TopLocationService) Origin(ctx context.Context, query AttackLayer3TopLocationOriginParams, opts ...option.RequestOption) (res *AttackLayer3TopLocationOriginResponse, err error)
Retrieves the origin locations of layer 3 attacks.
func (*AttackLayer3TopLocationService) Target ¶
func (r *AttackLayer3TopLocationService) Target(ctx context.Context, query AttackLayer3TopLocationTargetParams, opts ...option.RequestOption) (res *AttackLayer3TopLocationTargetResponse, err error)
Retrieves the target locations of layer 3 attacks.
type AttackLayer3TopLocationTargetParams ¶
type AttackLayer3TopLocationTargetParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TopLocationTargetParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TopLocationTargetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
Protocol param.Field[[]AttackLayer3TopLocationTargetParamsProtocol] `query:"protocol"`
}
func (AttackLayer3TopLocationTargetParams) URLQuery ¶
func (r AttackLayer3TopLocationTargetParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer3TopLocationTargetParams's query parameters as `url.Values`.
type AttackLayer3TopLocationTargetParamsFormat ¶
type AttackLayer3TopLocationTargetParamsFormat string
Format in which results will be returned.
const ( AttackLayer3TopLocationTargetParamsFormatJson AttackLayer3TopLocationTargetParamsFormat = "JSON" AttackLayer3TopLocationTargetParamsFormatCsv AttackLayer3TopLocationTargetParamsFormat = "CSV" )
func (AttackLayer3TopLocationTargetParamsFormat) IsKnown ¶
func (r AttackLayer3TopLocationTargetParamsFormat) IsKnown() bool
type AttackLayer3TopLocationTargetParamsIPVersion ¶
type AttackLayer3TopLocationTargetParamsIPVersion string
const ( AttackLayer3TopLocationTargetParamsIPVersionIPv4 AttackLayer3TopLocationTargetParamsIPVersion = "IPv4" AttackLayer3TopLocationTargetParamsIPVersionIPv6 AttackLayer3TopLocationTargetParamsIPVersion = "IPv6" )
func (AttackLayer3TopLocationTargetParamsIPVersion) IsKnown ¶
func (r AttackLayer3TopLocationTargetParamsIPVersion) IsKnown() bool
type AttackLayer3TopLocationTargetParamsProtocol ¶
type AttackLayer3TopLocationTargetParamsProtocol string
const ( AttackLayer3TopLocationTargetParamsProtocolUdp AttackLayer3TopLocationTargetParamsProtocol = "UDP" AttackLayer3TopLocationTargetParamsProtocolTCP AttackLayer3TopLocationTargetParamsProtocol = "TCP" AttackLayer3TopLocationTargetParamsProtocolIcmp AttackLayer3TopLocationTargetParamsProtocol = "ICMP" AttackLayer3TopLocationTargetParamsProtocolGRE AttackLayer3TopLocationTargetParamsProtocol = "GRE" )
func (AttackLayer3TopLocationTargetParamsProtocol) IsKnown ¶
func (r AttackLayer3TopLocationTargetParamsProtocol) IsKnown() bool
type AttackLayer3TopLocationTargetResponse ¶
type AttackLayer3TopLocationTargetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3TopLocationTargetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer3TopLocationTargetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TopLocationTargetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TopLocationTargetResponseMetaUnit `json:"units,required"`
JSON attackLayer3TopLocationTargetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TopLocationTargetResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationTargetResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopLocationTargetResponseMetaConfidenceInfo ¶
type AttackLayer3TopLocationTargetResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer3TopLocationTargetResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer3TopLocationTargetResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationTargetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationTargetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3TopLocationTargetResponseMetaNormalization ¶
type AttackLayer3TopLocationTargetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TopLocationTargetResponseMetaNormalizationPercentage AttackLayer3TopLocationTargetResponseMetaNormalization = "PERCENTAGE" AttackLayer3TopLocationTargetResponseMetaNormalizationMin0Max AttackLayer3TopLocationTargetResponseMetaNormalization = "MIN0_MAX" AttackLayer3TopLocationTargetResponseMetaNormalizationMinMax AttackLayer3TopLocationTargetResponseMetaNormalization = "MIN_MAX" AttackLayer3TopLocationTargetResponseMetaNormalizationRawValues AttackLayer3TopLocationTargetResponseMetaNormalization = "RAW_VALUES" AttackLayer3TopLocationTargetResponseMetaNormalizationPercentageChange AttackLayer3TopLocationTargetResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TopLocationTargetResponseMetaNormalizationRollingAverage AttackLayer3TopLocationTargetResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TopLocationTargetResponseMetaNormalizationOverlappedPercentage AttackLayer3TopLocationTargetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TopLocationTargetResponseMetaNormalizationRatio AttackLayer3TopLocationTargetResponseMetaNormalization = "RATIO" )
func (AttackLayer3TopLocationTargetResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TopLocationTargetResponseMetaNormalization) IsKnown() bool
type AttackLayer3TopLocationTargetResponseMetaUnit ¶
type AttackLayer3TopLocationTargetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TopLocationTargetResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TopLocationTargetResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TopLocationTargetResponseMetaUnit) 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 ¶
func (r *AttackLayer3TopService) Attacks(ctx context.Context, query AttackLayer3TopAttacksParams, opts ...option.RequestOption) (res *AttackLayer3TopAttacksResponse, err error)
Retrieves the top layer 3 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 by origin/target location (useful if all the top attacks are from or to the same location).
func (*AttackLayer3TopService) Industry
deprecated
func (r *AttackLayer3TopService) Industry(ctx context.Context, query AttackLayer3TopIndustryParams, opts ...option.RequestOption) (res *AttackLayer3TopIndustryResponse, err error)
This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint.
Deprecated: deprecated
func (*AttackLayer3TopService) Vertical
deprecated
func (r *AttackLayer3TopService) Vertical(ctx context.Context, query AttackLayer3TopVerticalParams, opts ...option.RequestOption) (res *AttackLayer3TopVerticalResponse, err error)
This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint.
Deprecated: deprecated
type AttackLayer3TopVerticalParams ¶
type AttackLayer3TopVerticalParams struct {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer3TopVerticalParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer3TopVerticalParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters the results by layer 3/4 protocol.
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 in which results will be returned.
const ( AttackLayer3TopVerticalParamsFormatJson AttackLayer3TopVerticalParamsFormat = "JSON" AttackLayer3TopVerticalParamsFormatCsv AttackLayer3TopVerticalParamsFormat = "CSV" )
func (AttackLayer3TopVerticalParamsFormat) IsKnown ¶
func (r AttackLayer3TopVerticalParamsFormat) IsKnown() bool
type AttackLayer3TopVerticalParamsIPVersion ¶
type AttackLayer3TopVerticalParamsIPVersion string
const ( AttackLayer3TopVerticalParamsIPVersionIPv4 AttackLayer3TopVerticalParamsIPVersion = "IPv4" AttackLayer3TopVerticalParamsIPVersionIPv6 AttackLayer3TopVerticalParamsIPVersion = "IPv6" )
func (AttackLayer3TopVerticalParamsIPVersion) IsKnown ¶
func (r AttackLayer3TopVerticalParamsIPVersion) IsKnown() bool
type AttackLayer3TopVerticalParamsProtocol ¶
type AttackLayer3TopVerticalParamsProtocol string
const ( AttackLayer3TopVerticalParamsProtocolUdp AttackLayer3TopVerticalParamsProtocol = "UDP" AttackLayer3TopVerticalParamsProtocolTCP AttackLayer3TopVerticalParamsProtocol = "TCP" AttackLayer3TopVerticalParamsProtocolIcmp AttackLayer3TopVerticalParamsProtocol = "ICMP" AttackLayer3TopVerticalParamsProtocolGRE AttackLayer3TopVerticalParamsProtocol = "GRE" )
func (AttackLayer3TopVerticalParamsProtocol) IsKnown ¶
func (r AttackLayer3TopVerticalParamsProtocol) IsKnown() bool
type AttackLayer3TopVerticalResponse ¶
type AttackLayer3TopVerticalResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer3TopVerticalResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer3TopVerticalResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer3TopVerticalResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer3TopVerticalResponseMetaUnit `json:"units,required"`
JSON attackLayer3TopVerticalResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer3TopVerticalResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer3TopVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer3TopVerticalResponseMetaConfidenceInfo ¶
type AttackLayer3TopVerticalResponseMetaConfidenceInfo struct {
Annotations []AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer3TopVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer3TopVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer3TopVerticalResponseMetaNormalization ¶
type AttackLayer3TopVerticalResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer3TopVerticalResponseMetaNormalizationPercentage AttackLayer3TopVerticalResponseMetaNormalization = "PERCENTAGE" AttackLayer3TopVerticalResponseMetaNormalizationMin0Max AttackLayer3TopVerticalResponseMetaNormalization = "MIN0_MAX" AttackLayer3TopVerticalResponseMetaNormalizationMinMax AttackLayer3TopVerticalResponseMetaNormalization = "MIN_MAX" AttackLayer3TopVerticalResponseMetaNormalizationRawValues AttackLayer3TopVerticalResponseMetaNormalization = "RAW_VALUES" AttackLayer3TopVerticalResponseMetaNormalizationPercentageChange AttackLayer3TopVerticalResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer3TopVerticalResponseMetaNormalizationRollingAverage AttackLayer3TopVerticalResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer3TopVerticalResponseMetaNormalizationOverlappedPercentage AttackLayer3TopVerticalResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer3TopVerticalResponseMetaNormalizationRatio AttackLayer3TopVerticalResponseMetaNormalization = "RATIO" )
func (AttackLayer3TopVerticalResponseMetaNormalization) IsKnown ¶
func (r AttackLayer3TopVerticalResponseMetaNormalization) IsKnown() bool
type AttackLayer3TopVerticalResponseMetaUnit ¶
type AttackLayer3TopVerticalResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer3TopVerticalResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer3TopVerticalResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer3TopVerticalResponseMetaUnit) 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 ¶
func (r *AttackLayer7Service) Timeseries(ctx context.Context, query AttackLayer7TimeseriesParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesResponse, err error)
Retrieves layer 7 attacks over time.
type AttackLayer7SummaryHTTPMethodParams ¶
type AttackLayer7SummaryHTTPMethodParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7SummaryHTTPMethodParamsFormat] `query:"format"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7SummaryHTTPMethodParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7SummaryHTTPMethodParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7SummaryHTTPMethodParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7SummaryHTTPMethodParams) URLQuery ¶
func (r AttackLayer7SummaryHTTPMethodParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7SummaryHTTPMethodParams's query parameters as `url.Values`.
type AttackLayer7SummaryHTTPMethodParamsFormat ¶
type AttackLayer7SummaryHTTPMethodParamsFormat string
Format in which results will be returned.
const ( AttackLayer7SummaryHTTPMethodParamsFormatJson AttackLayer7SummaryHTTPMethodParamsFormat = "JSON" AttackLayer7SummaryHTTPMethodParamsFormatCsv AttackLayer7SummaryHTTPMethodParamsFormat = "CSV" )
func (AttackLayer7SummaryHTTPMethodParamsFormat) IsKnown ¶
func (r AttackLayer7SummaryHTTPMethodParamsFormat) IsKnown() bool
type AttackLayer7SummaryHTTPMethodParamsHTTPVersion ¶
type AttackLayer7SummaryHTTPMethodParamsHTTPVersion string
const ( AttackLayer7SummaryHTTPMethodParamsHTTPVersionHttPv1 AttackLayer7SummaryHTTPMethodParamsHTTPVersion = "HTTPv1" AttackLayer7SummaryHTTPMethodParamsHTTPVersionHttPv2 AttackLayer7SummaryHTTPMethodParamsHTTPVersion = "HTTPv2" AttackLayer7SummaryHTTPMethodParamsHTTPVersionHttPv3 AttackLayer7SummaryHTTPMethodParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7SummaryHTTPMethodParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7SummaryHTTPMethodParamsHTTPVersion) IsKnown() bool
type AttackLayer7SummaryHTTPMethodParamsIPVersion ¶
type AttackLayer7SummaryHTTPMethodParamsIPVersion string
const ( AttackLayer7SummaryHTTPMethodParamsIPVersionIPv4 AttackLayer7SummaryHTTPMethodParamsIPVersion = "IPv4" AttackLayer7SummaryHTTPMethodParamsIPVersionIPv6 AttackLayer7SummaryHTTPMethodParamsIPVersion = "IPv6" )
func (AttackLayer7SummaryHTTPMethodParamsIPVersion) IsKnown ¶
func (r AttackLayer7SummaryHTTPMethodParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryHTTPMethodParamsMitigationProduct) IsKnown() bool
type AttackLayer7SummaryHTTPMethodResponse ¶
type AttackLayer7SummaryHTTPMethodResponse struct {
// Metadata for the results.
Meta AttackLayer7SummaryHTTPMethodResponseMeta `json:"meta,required"`
Summary0 map[string]string `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 {
ConfidenceInfo AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7SummaryHTTPMethodResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7SummaryHTTPMethodResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7SummaryHTTPMethodResponseMetaUnit `json:"units,required"`
JSON attackLayer7SummaryHTTPMethodResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7SummaryHTTPMethodResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPMethodResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo ¶
type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPMethodResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7SummaryHTTPMethodResponseMetaNormalization ¶
type AttackLayer7SummaryHTTPMethodResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7SummaryHTTPMethodResponseMetaNormalizationPercentage AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "PERCENTAGE" AttackLayer7SummaryHTTPMethodResponseMetaNormalizationMin0Max AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "MIN0_MAX" AttackLayer7SummaryHTTPMethodResponseMetaNormalizationMinMax AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "MIN_MAX" AttackLayer7SummaryHTTPMethodResponseMetaNormalizationRawValues AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "RAW_VALUES" AttackLayer7SummaryHTTPMethodResponseMetaNormalizationPercentageChange AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7SummaryHTTPMethodResponseMetaNormalizationRollingAverage AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7SummaryHTTPMethodResponseMetaNormalizationOverlappedPercentage AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7SummaryHTTPMethodResponseMetaNormalizationRatio AttackLayer7SummaryHTTPMethodResponseMetaNormalization = "RATIO" )
func (AttackLayer7SummaryHTTPMethodResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7SummaryHTTPMethodResponseMetaNormalization) IsKnown() bool
type AttackLayer7SummaryHTTPMethodResponseMetaUnit ¶
type AttackLayer7SummaryHTTPMethodResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7SummaryHTTPMethodResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7SummaryHTTPMethodResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPMethodResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryHTTPVersionParams ¶
type AttackLayer7SummaryHTTPVersionParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7SummaryHTTPVersionParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7SummaryHTTPVersionParamsHTTPMethod] `query:"httpMethod"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7SummaryHTTPVersionParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7SummaryHTTPVersionParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7SummaryHTTPVersionParams) URLQuery ¶
func (r AttackLayer7SummaryHTTPVersionParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7SummaryHTTPVersionParams's query parameters as `url.Values`.
type AttackLayer7SummaryHTTPVersionParamsFormat ¶
type AttackLayer7SummaryHTTPVersionParamsFormat string
Format in which results will be returned.
const ( AttackLayer7SummaryHTTPVersionParamsFormatJson AttackLayer7SummaryHTTPVersionParamsFormat = "JSON" AttackLayer7SummaryHTTPVersionParamsFormatCsv AttackLayer7SummaryHTTPVersionParamsFormat = "CSV" )
func (AttackLayer7SummaryHTTPVersionParamsFormat) IsKnown ¶
func (r AttackLayer7SummaryHTTPVersionParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryHTTPVersionParamsHTTPMethod) IsKnown() bool
type AttackLayer7SummaryHTTPVersionParamsIPVersion ¶
type AttackLayer7SummaryHTTPVersionParamsIPVersion string
const ( AttackLayer7SummaryHTTPVersionParamsIPVersionIPv4 AttackLayer7SummaryHTTPVersionParamsIPVersion = "IPv4" AttackLayer7SummaryHTTPVersionParamsIPVersionIPv6 AttackLayer7SummaryHTTPVersionParamsIPVersion = "IPv6" )
func (AttackLayer7SummaryHTTPVersionParamsIPVersion) IsKnown ¶
func (r AttackLayer7SummaryHTTPVersionParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryHTTPVersionParamsMitigationProduct) IsKnown() bool
type AttackLayer7SummaryHTTPVersionResponse ¶
type AttackLayer7SummaryHTTPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7SummaryHTTPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7SummaryHTTPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7SummaryHTTPVersionResponseMetaUnit `json:"units,required"`
JSON attackLayer7SummaryHTTPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7SummaryHTTPVersionResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo ¶
type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7SummaryHTTPVersionResponseMetaNormalization ¶
type AttackLayer7SummaryHTTPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7SummaryHTTPVersionResponseMetaNormalizationPercentage AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "PERCENTAGE" AttackLayer7SummaryHTTPVersionResponseMetaNormalizationMin0Max AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "MIN0_MAX" AttackLayer7SummaryHTTPVersionResponseMetaNormalizationMinMax AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "MIN_MAX" AttackLayer7SummaryHTTPVersionResponseMetaNormalizationRawValues AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "RAW_VALUES" AttackLayer7SummaryHTTPVersionResponseMetaNormalizationPercentageChange AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7SummaryHTTPVersionResponseMetaNormalizationRollingAverage AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7SummaryHTTPVersionResponseMetaNormalizationOverlappedPercentage AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7SummaryHTTPVersionResponseMetaNormalizationRatio AttackLayer7SummaryHTTPVersionResponseMetaNormalization = "RATIO" )
func (AttackLayer7SummaryHTTPVersionResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7SummaryHTTPVersionResponseMetaNormalization) IsKnown() bool
type AttackLayer7SummaryHTTPVersionResponseMetaUnit ¶
type AttackLayer7SummaryHTTPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7SummaryHTTPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7SummaryHTTPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7SummaryHTTPVersionResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7SummaryIPVersionParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7SummaryIPVersionParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7SummaryIPVersionParamsHTTPVersion] `query:"httpVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7SummaryIPVersionParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7SummaryIPVersionParams) URLQuery ¶
func (r AttackLayer7SummaryIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7SummaryIPVersionParams's query parameters as `url.Values`.
type AttackLayer7SummaryIPVersionParamsFormat ¶
type AttackLayer7SummaryIPVersionParamsFormat string
Format in which results will be returned.
const ( AttackLayer7SummaryIPVersionParamsFormatJson AttackLayer7SummaryIPVersionParamsFormat = "JSON" AttackLayer7SummaryIPVersionParamsFormatCsv AttackLayer7SummaryIPVersionParamsFormat = "CSV" )
func (AttackLayer7SummaryIPVersionParamsFormat) IsKnown ¶
func (r AttackLayer7SummaryIPVersionParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryIPVersionParamsHTTPMethod) IsKnown() bool
type AttackLayer7SummaryIPVersionParamsHTTPVersion ¶
type AttackLayer7SummaryIPVersionParamsHTTPVersion string
const ( AttackLayer7SummaryIPVersionParamsHTTPVersionHttPv1 AttackLayer7SummaryIPVersionParamsHTTPVersion = "HTTPv1" AttackLayer7SummaryIPVersionParamsHTTPVersionHttPv2 AttackLayer7SummaryIPVersionParamsHTTPVersion = "HTTPv2" AttackLayer7SummaryIPVersionParamsHTTPVersionHttPv3 AttackLayer7SummaryIPVersionParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7SummaryIPVersionParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7SummaryIPVersionParamsHTTPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryIPVersionParamsMitigationProduct) IsKnown() bool
type AttackLayer7SummaryIPVersionResponse ¶
type AttackLayer7SummaryIPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7SummaryIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7SummaryIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7SummaryIPVersionResponseMetaUnit `json:"units,required"`
JSON attackLayer7SummaryIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7SummaryIPVersionResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo ¶
type AttackLayer7SummaryIPVersionResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7SummaryIPVersionResponseMetaNormalization ¶
type AttackLayer7SummaryIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7SummaryIPVersionResponseMetaNormalizationPercentage AttackLayer7SummaryIPVersionResponseMetaNormalization = "PERCENTAGE" AttackLayer7SummaryIPVersionResponseMetaNormalizationMin0Max AttackLayer7SummaryIPVersionResponseMetaNormalization = "MIN0_MAX" AttackLayer7SummaryIPVersionResponseMetaNormalizationMinMax AttackLayer7SummaryIPVersionResponseMetaNormalization = "MIN_MAX" AttackLayer7SummaryIPVersionResponseMetaNormalizationRawValues AttackLayer7SummaryIPVersionResponseMetaNormalization = "RAW_VALUES" AttackLayer7SummaryIPVersionResponseMetaNormalizationPercentageChange AttackLayer7SummaryIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7SummaryIPVersionResponseMetaNormalizationRollingAverage AttackLayer7SummaryIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7SummaryIPVersionResponseMetaNormalizationOverlappedPercentage AttackLayer7SummaryIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7SummaryIPVersionResponseMetaNormalizationRatio AttackLayer7SummaryIPVersionResponseMetaNormalization = "RATIO" )
func (AttackLayer7SummaryIPVersionResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7SummaryIPVersionResponseMetaNormalization) IsKnown() bool
type AttackLayer7SummaryIPVersionResponseMetaUnit ¶
type AttackLayer7SummaryIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7SummaryIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7SummaryIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIPVersionResponseMetaUnit) 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 AttackLayer7SummaryIndustryParams ¶
type AttackLayer7SummaryIndustryParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7SummaryIndustryParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7SummaryIndustryParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7SummaryIndustryParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7SummaryIndustryParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7SummaryIndustryParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7SummaryIndustryParams) URLQuery ¶
func (r AttackLayer7SummaryIndustryParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7SummaryIndustryParams's query parameters as `url.Values`.
type AttackLayer7SummaryIndustryParamsFormat ¶
type AttackLayer7SummaryIndustryParamsFormat string
Format in which results will be returned.
const ( AttackLayer7SummaryIndustryParamsFormatJson AttackLayer7SummaryIndustryParamsFormat = "JSON" AttackLayer7SummaryIndustryParamsFormatCsv AttackLayer7SummaryIndustryParamsFormat = "CSV" )
func (AttackLayer7SummaryIndustryParamsFormat) IsKnown ¶
func (r AttackLayer7SummaryIndustryParamsFormat) IsKnown() bool
type AttackLayer7SummaryIndustryParamsHTTPMethod ¶
type AttackLayer7SummaryIndustryParamsHTTPMethod string
const ( AttackLayer7SummaryIndustryParamsHTTPMethodGet AttackLayer7SummaryIndustryParamsHTTPMethod = "GET" AttackLayer7SummaryIndustryParamsHTTPMethodPost AttackLayer7SummaryIndustryParamsHTTPMethod = "POST" AttackLayer7SummaryIndustryParamsHTTPMethodDelete AttackLayer7SummaryIndustryParamsHTTPMethod = "DELETE" AttackLayer7SummaryIndustryParamsHTTPMethodPut AttackLayer7SummaryIndustryParamsHTTPMethod = "PUT" AttackLayer7SummaryIndustryParamsHTTPMethodHead AttackLayer7SummaryIndustryParamsHTTPMethod = "HEAD" AttackLayer7SummaryIndustryParamsHTTPMethodPurge AttackLayer7SummaryIndustryParamsHTTPMethod = "PURGE" AttackLayer7SummaryIndustryParamsHTTPMethodOptions AttackLayer7SummaryIndustryParamsHTTPMethod = "OPTIONS" AttackLayer7SummaryIndustryParamsHTTPMethodPropfind AttackLayer7SummaryIndustryParamsHTTPMethod = "PROPFIND" AttackLayer7SummaryIndustryParamsHTTPMethodMkcol AttackLayer7SummaryIndustryParamsHTTPMethod = "MKCOL" AttackLayer7SummaryIndustryParamsHTTPMethodPatch AttackLayer7SummaryIndustryParamsHTTPMethod = "PATCH" AttackLayer7SummaryIndustryParamsHTTPMethodACL AttackLayer7SummaryIndustryParamsHTTPMethod = "ACL" AttackLayer7SummaryIndustryParamsHTTPMethodBcopy AttackLayer7SummaryIndustryParamsHTTPMethod = "BCOPY" AttackLayer7SummaryIndustryParamsHTTPMethodBdelete AttackLayer7SummaryIndustryParamsHTTPMethod = "BDELETE" AttackLayer7SummaryIndustryParamsHTTPMethodBmove AttackLayer7SummaryIndustryParamsHTTPMethod = "BMOVE" AttackLayer7SummaryIndustryParamsHTTPMethodBpropfind AttackLayer7SummaryIndustryParamsHTTPMethod = "BPROPFIND" AttackLayer7SummaryIndustryParamsHTTPMethodBproppatch AttackLayer7SummaryIndustryParamsHTTPMethod = "BPROPPATCH" AttackLayer7SummaryIndustryParamsHTTPMethodCheckin AttackLayer7SummaryIndustryParamsHTTPMethod = "CHECKIN" AttackLayer7SummaryIndustryParamsHTTPMethodCheckout AttackLayer7SummaryIndustryParamsHTTPMethod = "CHECKOUT" AttackLayer7SummaryIndustryParamsHTTPMethodConnect AttackLayer7SummaryIndustryParamsHTTPMethod = "CONNECT" AttackLayer7SummaryIndustryParamsHTTPMethodCopy AttackLayer7SummaryIndustryParamsHTTPMethod = "COPY" AttackLayer7SummaryIndustryParamsHTTPMethodLabel AttackLayer7SummaryIndustryParamsHTTPMethod = "LABEL" AttackLayer7SummaryIndustryParamsHTTPMethodLock AttackLayer7SummaryIndustryParamsHTTPMethod = "LOCK" AttackLayer7SummaryIndustryParamsHTTPMethodMerge AttackLayer7SummaryIndustryParamsHTTPMethod = "MERGE" AttackLayer7SummaryIndustryParamsHTTPMethodMkactivity AttackLayer7SummaryIndustryParamsHTTPMethod = "MKACTIVITY" AttackLayer7SummaryIndustryParamsHTTPMethodMkworkspace AttackLayer7SummaryIndustryParamsHTTPMethod = "MKWORKSPACE" AttackLayer7SummaryIndustryParamsHTTPMethodMove AttackLayer7SummaryIndustryParamsHTTPMethod = "MOVE" AttackLayer7SummaryIndustryParamsHTTPMethodNotify AttackLayer7SummaryIndustryParamsHTTPMethod = "NOTIFY" AttackLayer7SummaryIndustryParamsHTTPMethodOrderpatch AttackLayer7SummaryIndustryParamsHTTPMethod = "ORDERPATCH" AttackLayer7SummaryIndustryParamsHTTPMethodPoll AttackLayer7SummaryIndustryParamsHTTPMethod = "POLL" AttackLayer7SummaryIndustryParamsHTTPMethodProppatch AttackLayer7SummaryIndustryParamsHTTPMethod = "PROPPATCH" AttackLayer7SummaryIndustryParamsHTTPMethodReport AttackLayer7SummaryIndustryParamsHTTPMethod = "REPORT" AttackLayer7SummaryIndustryParamsHTTPMethodSearch AttackLayer7SummaryIndustryParamsHTTPMethod = "SEARCH" AttackLayer7SummaryIndustryParamsHTTPMethodSubscribe AttackLayer7SummaryIndustryParamsHTTPMethod = "SUBSCRIBE" AttackLayer7SummaryIndustryParamsHTTPMethodTrace AttackLayer7SummaryIndustryParamsHTTPMethod = "TRACE" AttackLayer7SummaryIndustryParamsHTTPMethodUncheckout AttackLayer7SummaryIndustryParamsHTTPMethod = "UNCHECKOUT" AttackLayer7SummaryIndustryParamsHTTPMethodUnlock AttackLayer7SummaryIndustryParamsHTTPMethod = "UNLOCK" AttackLayer7SummaryIndustryParamsHTTPMethodUnsubscribe AttackLayer7SummaryIndustryParamsHTTPMethod = "UNSUBSCRIBE" AttackLayer7SummaryIndustryParamsHTTPMethodUpdate AttackLayer7SummaryIndustryParamsHTTPMethod = "UPDATE" AttackLayer7SummaryIndustryParamsHTTPMethodVersioncontrol AttackLayer7SummaryIndustryParamsHTTPMethod = "VERSIONCONTROL" AttackLayer7SummaryIndustryParamsHTTPMethodBaselinecontrol AttackLayer7SummaryIndustryParamsHTTPMethod = "BASELINECONTROL" AttackLayer7SummaryIndustryParamsHTTPMethodXmsenumatts AttackLayer7SummaryIndustryParamsHTTPMethod = "XMSENUMATTS" AttackLayer7SummaryIndustryParamsHTTPMethodRpcOutData AttackLayer7SummaryIndustryParamsHTTPMethod = "RPC_OUT_DATA" AttackLayer7SummaryIndustryParamsHTTPMethodRpcInData AttackLayer7SummaryIndustryParamsHTTPMethod = "RPC_IN_DATA" AttackLayer7SummaryIndustryParamsHTTPMethodJson AttackLayer7SummaryIndustryParamsHTTPMethod = "JSON" AttackLayer7SummaryIndustryParamsHTTPMethodCook AttackLayer7SummaryIndustryParamsHTTPMethod = "COOK" AttackLayer7SummaryIndustryParamsHTTPMethodTrack AttackLayer7SummaryIndustryParamsHTTPMethod = "TRACK" )
func (AttackLayer7SummaryIndustryParamsHTTPMethod) IsKnown ¶
func (r AttackLayer7SummaryIndustryParamsHTTPMethod) IsKnown() bool
type AttackLayer7SummaryIndustryParamsHTTPVersion ¶
type AttackLayer7SummaryIndustryParamsHTTPVersion string
const ( AttackLayer7SummaryIndustryParamsHTTPVersionHttPv1 AttackLayer7SummaryIndustryParamsHTTPVersion = "HTTPv1" AttackLayer7SummaryIndustryParamsHTTPVersionHttPv2 AttackLayer7SummaryIndustryParamsHTTPVersion = "HTTPv2" AttackLayer7SummaryIndustryParamsHTTPVersionHttPv3 AttackLayer7SummaryIndustryParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7SummaryIndustryParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7SummaryIndustryParamsHTTPVersion) IsKnown() bool
type AttackLayer7SummaryIndustryParamsIPVersion ¶
type AttackLayer7SummaryIndustryParamsIPVersion string
const ( AttackLayer7SummaryIndustryParamsIPVersionIPv4 AttackLayer7SummaryIndustryParamsIPVersion = "IPv4" AttackLayer7SummaryIndustryParamsIPVersionIPv6 AttackLayer7SummaryIndustryParamsIPVersion = "IPv6" )
func (AttackLayer7SummaryIndustryParamsIPVersion) IsKnown ¶
func (r AttackLayer7SummaryIndustryParamsIPVersion) IsKnown() bool
type AttackLayer7SummaryIndustryParamsMitigationProduct ¶
type AttackLayer7SummaryIndustryParamsMitigationProduct string
const ( AttackLayer7SummaryIndustryParamsMitigationProductDDoS AttackLayer7SummaryIndustryParamsMitigationProduct = "DDOS" AttackLayer7SummaryIndustryParamsMitigationProductWAF AttackLayer7SummaryIndustryParamsMitigationProduct = "WAF" AttackLayer7SummaryIndustryParamsMitigationProductBotManagement AttackLayer7SummaryIndustryParamsMitigationProduct = "BOT_MANAGEMENT" AttackLayer7SummaryIndustryParamsMitigationProductAccessRules AttackLayer7SummaryIndustryParamsMitigationProduct = "ACCESS_RULES" AttackLayer7SummaryIndustryParamsMitigationProductIPReputation AttackLayer7SummaryIndustryParamsMitigationProduct = "IP_REPUTATION" AttackLayer7SummaryIndustryParamsMitigationProductAPIShield AttackLayer7SummaryIndustryParamsMitigationProduct = "API_SHIELD" AttackLayer7SummaryIndustryParamsMitigationProductDataLossPrevention AttackLayer7SummaryIndustryParamsMitigationProduct = "DATA_LOSS_PREVENTION" )
func (AttackLayer7SummaryIndustryParamsMitigationProduct) IsKnown ¶
func (r AttackLayer7SummaryIndustryParamsMitigationProduct) IsKnown() bool
type AttackLayer7SummaryIndustryResponse ¶
type AttackLayer7SummaryIndustryResponse struct {
// Metadata for the results.
Meta AttackLayer7SummaryIndustryResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON attackLayer7SummaryIndustryResponseJSON `json:"-"`
}
func (*AttackLayer7SummaryIndustryResponse) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIndustryResponse) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryIndustryResponseEnvelope ¶
type AttackLayer7SummaryIndustryResponseEnvelope struct {
Result AttackLayer7SummaryIndustryResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON attackLayer7SummaryIndustryResponseEnvelopeJSON `json:"-"`
}
func (*AttackLayer7SummaryIndustryResponseEnvelope) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIndustryResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryIndustryResponseMeta ¶
type AttackLayer7SummaryIndustryResponseMeta struct {
ConfidenceInfo AttackLayer7SummaryIndustryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7SummaryIndustryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7SummaryIndustryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7SummaryIndustryResponseMetaUnit `json:"units,required"`
JSON attackLayer7SummaryIndustryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7SummaryIndustryResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryIndustryResponseMetaConfidenceInfo ¶
type AttackLayer7SummaryIndustryResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7SummaryIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7SummaryIndustryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7SummaryIndustryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIndustryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryIndustryResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7SummaryIndustryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7SummaryIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7SummaryIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryIndustryResponseMetaDateRange ¶
type AttackLayer7SummaryIndustryResponseMetaDateRange 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 attackLayer7SummaryIndustryResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7SummaryIndustryResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIndustryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryIndustryResponseMetaNormalization ¶
type AttackLayer7SummaryIndustryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7SummaryIndustryResponseMetaNormalizationPercentage AttackLayer7SummaryIndustryResponseMetaNormalization = "PERCENTAGE" AttackLayer7SummaryIndustryResponseMetaNormalizationMin0Max AttackLayer7SummaryIndustryResponseMetaNormalization = "MIN0_MAX" AttackLayer7SummaryIndustryResponseMetaNormalizationMinMax AttackLayer7SummaryIndustryResponseMetaNormalization = "MIN_MAX" AttackLayer7SummaryIndustryResponseMetaNormalizationRawValues AttackLayer7SummaryIndustryResponseMetaNormalization = "RAW_VALUES" AttackLayer7SummaryIndustryResponseMetaNormalizationPercentageChange AttackLayer7SummaryIndustryResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7SummaryIndustryResponseMetaNormalizationRollingAverage AttackLayer7SummaryIndustryResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7SummaryIndustryResponseMetaNormalizationOverlappedPercentage AttackLayer7SummaryIndustryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7SummaryIndustryResponseMetaNormalizationRatio AttackLayer7SummaryIndustryResponseMetaNormalization = "RATIO" )
func (AttackLayer7SummaryIndustryResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7SummaryIndustryResponseMetaNormalization) IsKnown() bool
type AttackLayer7SummaryIndustryResponseMetaUnit ¶
type AttackLayer7SummaryIndustryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7SummaryIndustryResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7SummaryIndustryResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7SummaryIndustryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryManagedRulesParams ¶
type AttackLayer7SummaryManagedRulesParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7SummaryManagedRulesParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7SummaryManagedRulesParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7SummaryManagedRulesParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7SummaryManagedRulesParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7SummaryManagedRulesParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7SummaryManagedRulesParams) URLQuery ¶
func (r AttackLayer7SummaryManagedRulesParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7SummaryManagedRulesParams's query parameters as `url.Values`.
type AttackLayer7SummaryManagedRulesParamsFormat ¶
type AttackLayer7SummaryManagedRulesParamsFormat string
Format in which results will be returned.
const ( AttackLayer7SummaryManagedRulesParamsFormatJson AttackLayer7SummaryManagedRulesParamsFormat = "JSON" AttackLayer7SummaryManagedRulesParamsFormatCsv AttackLayer7SummaryManagedRulesParamsFormat = "CSV" )
func (AttackLayer7SummaryManagedRulesParamsFormat) IsKnown ¶
func (r AttackLayer7SummaryManagedRulesParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryManagedRulesParamsHTTPMethod) IsKnown() bool
type AttackLayer7SummaryManagedRulesParamsHTTPVersion ¶
type AttackLayer7SummaryManagedRulesParamsHTTPVersion string
const ( AttackLayer7SummaryManagedRulesParamsHTTPVersionHttPv1 AttackLayer7SummaryManagedRulesParamsHTTPVersion = "HTTPv1" AttackLayer7SummaryManagedRulesParamsHTTPVersionHttPv2 AttackLayer7SummaryManagedRulesParamsHTTPVersion = "HTTPv2" AttackLayer7SummaryManagedRulesParamsHTTPVersionHttPv3 AttackLayer7SummaryManagedRulesParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7SummaryManagedRulesParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7SummaryManagedRulesParamsHTTPVersion) IsKnown() bool
type AttackLayer7SummaryManagedRulesParamsIPVersion ¶
type AttackLayer7SummaryManagedRulesParamsIPVersion string
const ( AttackLayer7SummaryManagedRulesParamsIPVersionIPv4 AttackLayer7SummaryManagedRulesParamsIPVersion = "IPv4" AttackLayer7SummaryManagedRulesParamsIPVersionIPv6 AttackLayer7SummaryManagedRulesParamsIPVersion = "IPv6" )
func (AttackLayer7SummaryManagedRulesParamsIPVersion) IsKnown ¶
func (r AttackLayer7SummaryManagedRulesParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryManagedRulesParamsMitigationProduct) IsKnown() bool
type AttackLayer7SummaryManagedRulesResponse ¶
type AttackLayer7SummaryManagedRulesResponse struct {
// Metadata for the results.
Meta AttackLayer7SummaryManagedRulesResponseMeta `json:"meta,required"`
Summary0 map[string]string `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 {
ConfidenceInfo AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7SummaryManagedRulesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7SummaryManagedRulesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7SummaryManagedRulesResponseMetaUnit `json:"units,required"`
JSON attackLayer7SummaryManagedRulesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7SummaryManagedRulesResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7SummaryManagedRulesResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo ¶
type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7SummaryManagedRulesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7SummaryManagedRulesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7SummaryManagedRulesResponseMetaNormalization ¶
type AttackLayer7SummaryManagedRulesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7SummaryManagedRulesResponseMetaNormalizationPercentage AttackLayer7SummaryManagedRulesResponseMetaNormalization = "PERCENTAGE" AttackLayer7SummaryManagedRulesResponseMetaNormalizationMin0Max AttackLayer7SummaryManagedRulesResponseMetaNormalization = "MIN0_MAX" AttackLayer7SummaryManagedRulesResponseMetaNormalizationMinMax AttackLayer7SummaryManagedRulesResponseMetaNormalization = "MIN_MAX" AttackLayer7SummaryManagedRulesResponseMetaNormalizationRawValues AttackLayer7SummaryManagedRulesResponseMetaNormalization = "RAW_VALUES" AttackLayer7SummaryManagedRulesResponseMetaNormalizationPercentageChange AttackLayer7SummaryManagedRulesResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7SummaryManagedRulesResponseMetaNormalizationRollingAverage AttackLayer7SummaryManagedRulesResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7SummaryManagedRulesResponseMetaNormalizationOverlappedPercentage AttackLayer7SummaryManagedRulesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7SummaryManagedRulesResponseMetaNormalizationRatio AttackLayer7SummaryManagedRulesResponseMetaNormalization = "RATIO" )
func (AttackLayer7SummaryManagedRulesResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7SummaryManagedRulesResponseMetaNormalization) IsKnown() bool
type AttackLayer7SummaryManagedRulesResponseMetaUnit ¶
type AttackLayer7SummaryManagedRulesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7SummaryManagedRulesResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7SummaryManagedRulesResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7SummaryManagedRulesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryMitigationProductParams ¶
type AttackLayer7SummaryMitigationProductParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7SummaryMitigationProductParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7SummaryMitigationProductParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7SummaryMitigationProductParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7SummaryMitigationProductParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7SummaryMitigationProductParams) URLQuery ¶
func (r AttackLayer7SummaryMitigationProductParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7SummaryMitigationProductParams's query parameters as `url.Values`.
type AttackLayer7SummaryMitigationProductParamsFormat ¶
type AttackLayer7SummaryMitigationProductParamsFormat string
Format in which results will be returned.
const ( AttackLayer7SummaryMitigationProductParamsFormatJson AttackLayer7SummaryMitigationProductParamsFormat = "JSON" AttackLayer7SummaryMitigationProductParamsFormatCsv AttackLayer7SummaryMitigationProductParamsFormat = "CSV" )
func (AttackLayer7SummaryMitigationProductParamsFormat) IsKnown ¶
func (r AttackLayer7SummaryMitigationProductParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7SummaryMitigationProductParamsHTTPMethod) IsKnown() bool
type AttackLayer7SummaryMitigationProductParamsHTTPVersion ¶
type AttackLayer7SummaryMitigationProductParamsHTTPVersion string
const ( AttackLayer7SummaryMitigationProductParamsHTTPVersionHttPv1 AttackLayer7SummaryMitigationProductParamsHTTPVersion = "HTTPv1" AttackLayer7SummaryMitigationProductParamsHTTPVersionHttPv2 AttackLayer7SummaryMitigationProductParamsHTTPVersion = "HTTPv2" AttackLayer7SummaryMitigationProductParamsHTTPVersionHttPv3 AttackLayer7SummaryMitigationProductParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7SummaryMitigationProductParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7SummaryMitigationProductParamsHTTPVersion) IsKnown() bool
type AttackLayer7SummaryMitigationProductParamsIPVersion ¶
type AttackLayer7SummaryMitigationProductParamsIPVersion string
const ( AttackLayer7SummaryMitigationProductParamsIPVersionIPv4 AttackLayer7SummaryMitigationProductParamsIPVersion = "IPv4" AttackLayer7SummaryMitigationProductParamsIPVersionIPv6 AttackLayer7SummaryMitigationProductParamsIPVersion = "IPv6" )
func (AttackLayer7SummaryMitigationProductParamsIPVersion) IsKnown ¶
func (r AttackLayer7SummaryMitigationProductParamsIPVersion) IsKnown() bool
type AttackLayer7SummaryMitigationProductResponse ¶
type AttackLayer7SummaryMitigationProductResponse struct {
// Metadata for the results.
Meta AttackLayer7SummaryMitigationProductResponseMeta `json:"meta,required"`
Summary0 map[string]string `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 {
ConfidenceInfo AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7SummaryMitigationProductResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7SummaryMitigationProductResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7SummaryMitigationProductResponseMetaUnit `json:"units,required"`
JSON attackLayer7SummaryMitigationProductResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7SummaryMitigationProductResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7SummaryMitigationProductResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo ¶
type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7SummaryMitigationProductResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7SummaryMitigationProductResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r *AttackLayer7SummaryMitigationProductResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryMitigationProductResponseMetaNormalization ¶
type AttackLayer7SummaryMitigationProductResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7SummaryMitigationProductResponseMetaNormalizationPercentage AttackLayer7SummaryMitigationProductResponseMetaNormalization = "PERCENTAGE" AttackLayer7SummaryMitigationProductResponseMetaNormalizationMin0Max AttackLayer7SummaryMitigationProductResponseMetaNormalization = "MIN0_MAX" AttackLayer7SummaryMitigationProductResponseMetaNormalizationMinMax AttackLayer7SummaryMitigationProductResponseMetaNormalization = "MIN_MAX" AttackLayer7SummaryMitigationProductResponseMetaNormalizationRawValues AttackLayer7SummaryMitigationProductResponseMetaNormalization = "RAW_VALUES" AttackLayer7SummaryMitigationProductResponseMetaNormalizationPercentageChange AttackLayer7SummaryMitigationProductResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7SummaryMitigationProductResponseMetaNormalizationRollingAverage AttackLayer7SummaryMitigationProductResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7SummaryMitigationProductResponseMetaNormalizationOverlappedPercentage AttackLayer7SummaryMitigationProductResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7SummaryMitigationProductResponseMetaNormalizationRatio AttackLayer7SummaryMitigationProductResponseMetaNormalization = "RATIO" )
func (AttackLayer7SummaryMitigationProductResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7SummaryMitigationProductResponseMetaNormalization) IsKnown() bool
type AttackLayer7SummaryMitigationProductResponseMetaUnit ¶
type AttackLayer7SummaryMitigationProductResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7SummaryMitigationProductResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7SummaryMitigationProductResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7SummaryMitigationProductResponseMetaUnit) 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) HTTPMethod ¶
func (r *AttackLayer7SummaryService) HTTPMethod(ctx context.Context, query AttackLayer7SummaryHTTPMethodParams, opts ...option.RequestOption) (res *AttackLayer7SummaryHTTPMethodResponse, err error)
Retrieves the distribution of layer 7 attacks by HTTP method.
func (*AttackLayer7SummaryService) HTTPVersion ¶
func (r *AttackLayer7SummaryService) HTTPVersion(ctx context.Context, query AttackLayer7SummaryHTTPVersionParams, opts ...option.RequestOption) (res *AttackLayer7SummaryHTTPVersionResponse, err error)
Retrieves the distribution of layer 7 attacks by HTTP version.
func (*AttackLayer7SummaryService) IPVersion ¶
func (r *AttackLayer7SummaryService) IPVersion(ctx context.Context, query AttackLayer7SummaryIPVersionParams, opts ...option.RequestOption) (res *AttackLayer7SummaryIPVersionResponse, err error)
Retrieves the distribution of layer 7 attacks by IP version.
func (*AttackLayer7SummaryService) Industry ¶
func (r *AttackLayer7SummaryService) Industry(ctx context.Context, query AttackLayer7SummaryIndustryParams, opts ...option.RequestOption) (res *AttackLayer7SummaryIndustryResponse, err error)
Retrieves the distribution of layer 7 attacks by targeted industry.
func (*AttackLayer7SummaryService) ManagedRules ¶
func (r *AttackLayer7SummaryService) ManagedRules(ctx context.Context, query AttackLayer7SummaryManagedRulesParams, opts ...option.RequestOption) (res *AttackLayer7SummaryManagedRulesResponse, err error)
Retrieves the distribution of layer 7 attacks by managed rules.
func (*AttackLayer7SummaryService) MitigationProduct ¶
func (r *AttackLayer7SummaryService) MitigationProduct(ctx context.Context, query AttackLayer7SummaryMitigationProductParams, opts ...option.RequestOption) (res *AttackLayer7SummaryMitigationProductResponse, err error)
Retrieves the distribution of layer 7 attacks by mitigation product.
func (*AttackLayer7SummaryService) Vertical ¶
func (r *AttackLayer7SummaryService) Vertical(ctx context.Context, query AttackLayer7SummaryVerticalParams, opts ...option.RequestOption) (res *AttackLayer7SummaryVerticalResponse, err error)
Retrieves the distribution of layer 7 attacks by targeted vertical.
type AttackLayer7SummaryVerticalParams ¶
type AttackLayer7SummaryVerticalParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7SummaryVerticalParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7SummaryVerticalParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7SummaryVerticalParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7SummaryVerticalParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7SummaryVerticalParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7SummaryVerticalParams) URLQuery ¶
func (r AttackLayer7SummaryVerticalParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7SummaryVerticalParams's query parameters as `url.Values`.
type AttackLayer7SummaryVerticalParamsFormat ¶
type AttackLayer7SummaryVerticalParamsFormat string
Format in which results will be returned.
const ( AttackLayer7SummaryVerticalParamsFormatJson AttackLayer7SummaryVerticalParamsFormat = "JSON" AttackLayer7SummaryVerticalParamsFormatCsv AttackLayer7SummaryVerticalParamsFormat = "CSV" )
func (AttackLayer7SummaryVerticalParamsFormat) IsKnown ¶
func (r AttackLayer7SummaryVerticalParamsFormat) IsKnown() bool
type AttackLayer7SummaryVerticalParamsHTTPMethod ¶
type AttackLayer7SummaryVerticalParamsHTTPMethod string
const ( AttackLayer7SummaryVerticalParamsHTTPMethodGet AttackLayer7SummaryVerticalParamsHTTPMethod = "GET" AttackLayer7SummaryVerticalParamsHTTPMethodPost AttackLayer7SummaryVerticalParamsHTTPMethod = "POST" AttackLayer7SummaryVerticalParamsHTTPMethodDelete AttackLayer7SummaryVerticalParamsHTTPMethod = "DELETE" AttackLayer7SummaryVerticalParamsHTTPMethodPut AttackLayer7SummaryVerticalParamsHTTPMethod = "PUT" AttackLayer7SummaryVerticalParamsHTTPMethodHead AttackLayer7SummaryVerticalParamsHTTPMethod = "HEAD" AttackLayer7SummaryVerticalParamsHTTPMethodPurge AttackLayer7SummaryVerticalParamsHTTPMethod = "PURGE" AttackLayer7SummaryVerticalParamsHTTPMethodOptions AttackLayer7SummaryVerticalParamsHTTPMethod = "OPTIONS" AttackLayer7SummaryVerticalParamsHTTPMethodPropfind AttackLayer7SummaryVerticalParamsHTTPMethod = "PROPFIND" AttackLayer7SummaryVerticalParamsHTTPMethodMkcol AttackLayer7SummaryVerticalParamsHTTPMethod = "MKCOL" AttackLayer7SummaryVerticalParamsHTTPMethodPatch AttackLayer7SummaryVerticalParamsHTTPMethod = "PATCH" AttackLayer7SummaryVerticalParamsHTTPMethodACL AttackLayer7SummaryVerticalParamsHTTPMethod = "ACL" AttackLayer7SummaryVerticalParamsHTTPMethodBcopy AttackLayer7SummaryVerticalParamsHTTPMethod = "BCOPY" AttackLayer7SummaryVerticalParamsHTTPMethodBdelete AttackLayer7SummaryVerticalParamsHTTPMethod = "BDELETE" AttackLayer7SummaryVerticalParamsHTTPMethodBmove AttackLayer7SummaryVerticalParamsHTTPMethod = "BMOVE" AttackLayer7SummaryVerticalParamsHTTPMethodBpropfind AttackLayer7SummaryVerticalParamsHTTPMethod = "BPROPFIND" AttackLayer7SummaryVerticalParamsHTTPMethodBproppatch AttackLayer7SummaryVerticalParamsHTTPMethod = "BPROPPATCH" AttackLayer7SummaryVerticalParamsHTTPMethodCheckin AttackLayer7SummaryVerticalParamsHTTPMethod = "CHECKIN" AttackLayer7SummaryVerticalParamsHTTPMethodCheckout AttackLayer7SummaryVerticalParamsHTTPMethod = "CHECKOUT" AttackLayer7SummaryVerticalParamsHTTPMethodConnect AttackLayer7SummaryVerticalParamsHTTPMethod = "CONNECT" AttackLayer7SummaryVerticalParamsHTTPMethodCopy AttackLayer7SummaryVerticalParamsHTTPMethod = "COPY" AttackLayer7SummaryVerticalParamsHTTPMethodLabel AttackLayer7SummaryVerticalParamsHTTPMethod = "LABEL" AttackLayer7SummaryVerticalParamsHTTPMethodLock AttackLayer7SummaryVerticalParamsHTTPMethod = "LOCK" AttackLayer7SummaryVerticalParamsHTTPMethodMerge AttackLayer7SummaryVerticalParamsHTTPMethod = "MERGE" AttackLayer7SummaryVerticalParamsHTTPMethodMkactivity AttackLayer7SummaryVerticalParamsHTTPMethod = "MKACTIVITY" AttackLayer7SummaryVerticalParamsHTTPMethodMkworkspace AttackLayer7SummaryVerticalParamsHTTPMethod = "MKWORKSPACE" AttackLayer7SummaryVerticalParamsHTTPMethodMove AttackLayer7SummaryVerticalParamsHTTPMethod = "MOVE" AttackLayer7SummaryVerticalParamsHTTPMethodNotify AttackLayer7SummaryVerticalParamsHTTPMethod = "NOTIFY" AttackLayer7SummaryVerticalParamsHTTPMethodOrderpatch AttackLayer7SummaryVerticalParamsHTTPMethod = "ORDERPATCH" AttackLayer7SummaryVerticalParamsHTTPMethodPoll AttackLayer7SummaryVerticalParamsHTTPMethod = "POLL" AttackLayer7SummaryVerticalParamsHTTPMethodProppatch AttackLayer7SummaryVerticalParamsHTTPMethod = "PROPPATCH" AttackLayer7SummaryVerticalParamsHTTPMethodReport AttackLayer7SummaryVerticalParamsHTTPMethod = "REPORT" AttackLayer7SummaryVerticalParamsHTTPMethodSearch AttackLayer7SummaryVerticalParamsHTTPMethod = "SEARCH" AttackLayer7SummaryVerticalParamsHTTPMethodSubscribe AttackLayer7SummaryVerticalParamsHTTPMethod = "SUBSCRIBE" AttackLayer7SummaryVerticalParamsHTTPMethodTrace AttackLayer7SummaryVerticalParamsHTTPMethod = "TRACE" AttackLayer7SummaryVerticalParamsHTTPMethodUncheckout AttackLayer7SummaryVerticalParamsHTTPMethod = "UNCHECKOUT" AttackLayer7SummaryVerticalParamsHTTPMethodUnlock AttackLayer7SummaryVerticalParamsHTTPMethod = "UNLOCK" AttackLayer7SummaryVerticalParamsHTTPMethodUnsubscribe AttackLayer7SummaryVerticalParamsHTTPMethod = "UNSUBSCRIBE" AttackLayer7SummaryVerticalParamsHTTPMethodUpdate AttackLayer7SummaryVerticalParamsHTTPMethod = "UPDATE" AttackLayer7SummaryVerticalParamsHTTPMethodVersioncontrol AttackLayer7SummaryVerticalParamsHTTPMethod = "VERSIONCONTROL" AttackLayer7SummaryVerticalParamsHTTPMethodBaselinecontrol AttackLayer7SummaryVerticalParamsHTTPMethod = "BASELINECONTROL" AttackLayer7SummaryVerticalParamsHTTPMethodXmsenumatts AttackLayer7SummaryVerticalParamsHTTPMethod = "XMSENUMATTS" AttackLayer7SummaryVerticalParamsHTTPMethodRpcOutData AttackLayer7SummaryVerticalParamsHTTPMethod = "RPC_OUT_DATA" AttackLayer7SummaryVerticalParamsHTTPMethodRpcInData AttackLayer7SummaryVerticalParamsHTTPMethod = "RPC_IN_DATA" AttackLayer7SummaryVerticalParamsHTTPMethodJson AttackLayer7SummaryVerticalParamsHTTPMethod = "JSON" AttackLayer7SummaryVerticalParamsHTTPMethodCook AttackLayer7SummaryVerticalParamsHTTPMethod = "COOK" AttackLayer7SummaryVerticalParamsHTTPMethodTrack AttackLayer7SummaryVerticalParamsHTTPMethod = "TRACK" )
func (AttackLayer7SummaryVerticalParamsHTTPMethod) IsKnown ¶
func (r AttackLayer7SummaryVerticalParamsHTTPMethod) IsKnown() bool
type AttackLayer7SummaryVerticalParamsHTTPVersion ¶
type AttackLayer7SummaryVerticalParamsHTTPVersion string
const ( AttackLayer7SummaryVerticalParamsHTTPVersionHttPv1 AttackLayer7SummaryVerticalParamsHTTPVersion = "HTTPv1" AttackLayer7SummaryVerticalParamsHTTPVersionHttPv2 AttackLayer7SummaryVerticalParamsHTTPVersion = "HTTPv2" AttackLayer7SummaryVerticalParamsHTTPVersionHttPv3 AttackLayer7SummaryVerticalParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7SummaryVerticalParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7SummaryVerticalParamsHTTPVersion) IsKnown() bool
type AttackLayer7SummaryVerticalParamsIPVersion ¶
type AttackLayer7SummaryVerticalParamsIPVersion string
const ( AttackLayer7SummaryVerticalParamsIPVersionIPv4 AttackLayer7SummaryVerticalParamsIPVersion = "IPv4" AttackLayer7SummaryVerticalParamsIPVersionIPv6 AttackLayer7SummaryVerticalParamsIPVersion = "IPv6" )
func (AttackLayer7SummaryVerticalParamsIPVersion) IsKnown ¶
func (r AttackLayer7SummaryVerticalParamsIPVersion) IsKnown() bool
type AttackLayer7SummaryVerticalParamsMitigationProduct ¶
type AttackLayer7SummaryVerticalParamsMitigationProduct string
const ( AttackLayer7SummaryVerticalParamsMitigationProductDDoS AttackLayer7SummaryVerticalParamsMitigationProduct = "DDOS" AttackLayer7SummaryVerticalParamsMitigationProductWAF AttackLayer7SummaryVerticalParamsMitigationProduct = "WAF" AttackLayer7SummaryVerticalParamsMitigationProductBotManagement AttackLayer7SummaryVerticalParamsMitigationProduct = "BOT_MANAGEMENT" AttackLayer7SummaryVerticalParamsMitigationProductAccessRules AttackLayer7SummaryVerticalParamsMitigationProduct = "ACCESS_RULES" AttackLayer7SummaryVerticalParamsMitigationProductIPReputation AttackLayer7SummaryVerticalParamsMitigationProduct = "IP_REPUTATION" AttackLayer7SummaryVerticalParamsMitigationProductAPIShield AttackLayer7SummaryVerticalParamsMitigationProduct = "API_SHIELD" AttackLayer7SummaryVerticalParamsMitigationProductDataLossPrevention AttackLayer7SummaryVerticalParamsMitigationProduct = "DATA_LOSS_PREVENTION" )
func (AttackLayer7SummaryVerticalParamsMitigationProduct) IsKnown ¶
func (r AttackLayer7SummaryVerticalParamsMitigationProduct) IsKnown() bool
type AttackLayer7SummaryVerticalResponse ¶
type AttackLayer7SummaryVerticalResponse struct {
// Metadata for the results.
Meta AttackLayer7SummaryVerticalResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON attackLayer7SummaryVerticalResponseJSON `json:"-"`
}
func (*AttackLayer7SummaryVerticalResponse) UnmarshalJSON ¶
func (r *AttackLayer7SummaryVerticalResponse) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryVerticalResponseEnvelope ¶
type AttackLayer7SummaryVerticalResponseEnvelope struct {
Result AttackLayer7SummaryVerticalResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON attackLayer7SummaryVerticalResponseEnvelopeJSON `json:"-"`
}
func (*AttackLayer7SummaryVerticalResponseEnvelope) UnmarshalJSON ¶
func (r *AttackLayer7SummaryVerticalResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryVerticalResponseMeta ¶
type AttackLayer7SummaryVerticalResponseMeta struct {
ConfidenceInfo AttackLayer7SummaryVerticalResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7SummaryVerticalResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7SummaryVerticalResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7SummaryVerticalResponseMetaUnit `json:"units,required"`
JSON attackLayer7SummaryVerticalResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7SummaryVerticalResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7SummaryVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryVerticalResponseMetaConfidenceInfo ¶
type AttackLayer7SummaryVerticalResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7SummaryVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7SummaryVerticalResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7SummaryVerticalResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7SummaryVerticalResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryVerticalResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7SummaryVerticalResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7SummaryVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7SummaryVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7SummaryVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryVerticalResponseMetaDateRange ¶
type AttackLayer7SummaryVerticalResponseMetaDateRange 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 attackLayer7SummaryVerticalResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7SummaryVerticalResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7SummaryVerticalResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7SummaryVerticalResponseMetaNormalization ¶
type AttackLayer7SummaryVerticalResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7SummaryVerticalResponseMetaNormalizationPercentage AttackLayer7SummaryVerticalResponseMetaNormalization = "PERCENTAGE" AttackLayer7SummaryVerticalResponseMetaNormalizationMin0Max AttackLayer7SummaryVerticalResponseMetaNormalization = "MIN0_MAX" AttackLayer7SummaryVerticalResponseMetaNormalizationMinMax AttackLayer7SummaryVerticalResponseMetaNormalization = "MIN_MAX" AttackLayer7SummaryVerticalResponseMetaNormalizationRawValues AttackLayer7SummaryVerticalResponseMetaNormalization = "RAW_VALUES" AttackLayer7SummaryVerticalResponseMetaNormalizationPercentageChange AttackLayer7SummaryVerticalResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7SummaryVerticalResponseMetaNormalizationRollingAverage AttackLayer7SummaryVerticalResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7SummaryVerticalResponseMetaNormalizationOverlappedPercentage AttackLayer7SummaryVerticalResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7SummaryVerticalResponseMetaNormalizationRatio AttackLayer7SummaryVerticalResponseMetaNormalization = "RATIO" )
func (AttackLayer7SummaryVerticalResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7SummaryVerticalResponseMetaNormalization) IsKnown() bool
type AttackLayer7SummaryVerticalResponseMetaUnit ¶
type AttackLayer7SummaryVerticalResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7SummaryVerticalResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7SummaryVerticalResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7SummaryVerticalResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPMethodParams ¶
type AttackLayer7TimeseriesGroupHTTPMethodParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesGroupHTTPMethodParamsFormat] `query:"format"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization] `query:"normalization"`
}
func (AttackLayer7TimeseriesGroupHTTPMethodParams) URLQuery ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TimeseriesGroupHTTPMethodParams's query parameters as `url.Values`.
type AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval ¶
type AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPMethodParamsFormat ¶
type AttackLayer7TimeseriesGroupHTTPMethodParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesGroupHTTPMethodParamsFormatJson AttackLayer7TimeseriesGroupHTTPMethodParamsFormat = "JSON" AttackLayer7TimeseriesGroupHTTPMethodParamsFormatCsv AttackLayer7TimeseriesGroupHTTPMethodParamsFormat = "CSV" )
func (AttackLayer7TimeseriesGroupHTTPMethodParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodParamsFormat) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion ¶
type AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion string
const ( AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion = "HTTPv1" AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion = "HTTPv2" AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodParamsHTTPVersion) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion ¶
type AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion string
const ( AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersionIPv4 AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion = "IPv4" AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersionIPv6 AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion = "IPv6" )
func (AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodParamsMitigationProduct) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization ¶
type AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupHTTPMethodParamsNormalizationPercentage AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupHTTPMethodParamsNormalizationMin0Max AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPMethodResponse ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponse struct {
// Metadata for the results.
Meta AttackLayer7TimeseriesGroupHTTPMethodResponseMeta `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 AttackLayer7TimeseriesGroupHTTPMethodResponseMeta ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesGroupHTTPMethodResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesGroupHTTPMethodResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesGroupHTTPMethodResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesGroupHTTPMethodResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggIntervalOneHour AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggIntervalOneDay AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaDateRange ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaDateRange 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 attackLayer7TimeseriesGroupHTTPMethodResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPMethodResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationPercentage AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationMin0Max AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationMinMax AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationRawValues AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalizationRatio AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPMethodResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaUnit ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesGroupHTTPMethodResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPMethodResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0 ¶
type AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON attackLayer7TimeseriesGroupHTTPMethodResponseSerie0JSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPMethodResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPVersionParams ¶
type AttackLayer7TimeseriesGroupHTTPVersionParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesGroupHTTPVersionParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod] `query:"httpMethod"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization] `query:"normalization"`
}
func (AttackLayer7TimeseriesGroupHTTPVersionParams) URLQuery ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TimeseriesGroupHTTPVersionParams's query parameters as `url.Values`.
type AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval ¶
type AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPVersionParamsFormat ¶
type AttackLayer7TimeseriesGroupHTTPVersionParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesGroupHTTPVersionParamsFormatJson AttackLayer7TimeseriesGroupHTTPVersionParamsFormat = "JSON" AttackLayer7TimeseriesGroupHTTPVersionParamsFormatCsv AttackLayer7TimeseriesGroupHTTPVersionParamsFormat = "CSV" )
func (AttackLayer7TimeseriesGroupHTTPVersionParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionParamsHTTPMethod) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion ¶
type AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion string
const ( AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersionIPv4 AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion = "IPv4" AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersionIPv6 AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion = "IPv6" )
func (AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionParamsMitigationProduct) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization ¶
type AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupHTTPVersionParamsNormalizationPercentage AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupHTTPVersionParamsNormalizationMin0Max AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPVersionResponse ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponse struct {
// Metadata for the results.
Meta AttackLayer7TimeseriesGroupHTTPVersionResponseMeta `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 AttackLayer7TimeseriesGroupHTTPVersionResponseMeta ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesGroupHTTPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesGroupHTTPVersionResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesGroupHTTPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesGroupHTTPVersionResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggIntervalOneHour AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggIntervalOneDay AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaDateRange ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaDateRange 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 attackLayer7TimeseriesGroupHTTPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationPercentage AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationMin0Max AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationMinMax AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationRawValues AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalizationRatio AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupHTTPVersionResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaUnit ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesGroupHTTPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0 ¶
type AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0 struct {
HTTP1X []string `json:"HTTP/1.x,required"`
HTTP2 []string `json:"HTTP/2,required"`
HTTP3 []string `json:"HTTP/3,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupHTTPVersionResponseSerie0JSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIPVersionParams ¶
type AttackLayer7TimeseriesGroupIPVersionParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesGroupIPVersionParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion] `query:"httpVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer7TimeseriesGroupIPVersionParamsNormalization] `query:"normalization"`
}
func (AttackLayer7TimeseriesGroupIPVersionParams) URLQuery ¶
func (r AttackLayer7TimeseriesGroupIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TimeseriesGroupIPVersionParams's query parameters as `url.Values`.
type AttackLayer7TimeseriesGroupIPVersionParamsAggInterval ¶
type AttackLayer7TimeseriesGroupIPVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesGroupIPVersionParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupIPVersionParamsFormat ¶
type AttackLayer7TimeseriesGroupIPVersionParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesGroupIPVersionParamsFormatJson AttackLayer7TimeseriesGroupIPVersionParamsFormat = "JSON" AttackLayer7TimeseriesGroupIPVersionParamsFormatCsv AttackLayer7TimeseriesGroupIPVersionParamsFormat = "CSV" )
func (AttackLayer7TimeseriesGroupIPVersionParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIPVersionParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupIPVersionParamsHTTPMethod) IsKnown() bool
type AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion ¶
type AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion string
const ( AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv1" AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv2" AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIPVersionParamsHTTPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupIPVersionParamsMitigationProduct) IsKnown() bool
type AttackLayer7TimeseriesGroupIPVersionParamsNormalization ¶
type AttackLayer7TimeseriesGroupIPVersionParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupIPVersionParamsNormalizationPercentage AttackLayer7TimeseriesGroupIPVersionParamsNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupIPVersionParamsNormalizationMin0Max AttackLayer7TimeseriesGroupIPVersionParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesGroupIPVersionParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIPVersionParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupIPVersionResponse ¶
type AttackLayer7TimeseriesGroupIPVersionResponse struct {
// Metadata for the results.
Meta AttackLayer7TimeseriesGroupIPVersionResponseMeta `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 AttackLayer7TimeseriesGroupIPVersionResponseMeta ¶
type AttackLayer7TimeseriesGroupIPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesGroupIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesGroupIPVersionResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesGroupIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesGroupIPVersionResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval ¶
type AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesGroupIPVersionResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesGroupIPVersionResponseMetaAggIntervalOneHour AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesGroupIPVersionResponseMetaAggIntervalOneDay AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesGroupIPVersionResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesGroupIPVersionResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIPVersionResponseMetaDateRange ¶
type AttackLayer7TimeseriesGroupIPVersionResponseMetaDateRange 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 attackLayer7TimeseriesGroupIPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization ¶
type AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationPercentage AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationMin0Max AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationMinMax AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationRawValues AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalizationRatio AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIPVersionResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupIPVersionResponseMetaUnit ¶
type AttackLayer7TimeseriesGroupIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesGroupIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIPVersionResponseSerie0 ¶
type AttackLayer7TimeseriesGroupIPVersionResponseSerie0 struct {
IPv4 []string `json:"IPv4,required"`
IPv6 []string `json:"IPv6,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIndustryParams ¶
type AttackLayer7TimeseriesGroupIndustryParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesGroupIndustryParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer7TimeseriesGroupIndustryParamsNormalization] `query:"normalization"`
}
func (AttackLayer7TimeseriesGroupIndustryParams) URLQuery ¶
func (r AttackLayer7TimeseriesGroupIndustryParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TimeseriesGroupIndustryParams's query parameters as `url.Values`.
type AttackLayer7TimeseriesGroupIndustryParamsAggInterval ¶
type AttackLayer7TimeseriesGroupIndustryParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesGroupIndustryParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupIndustryParamsFormat ¶
type AttackLayer7TimeseriesGroupIndustryParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesGroupIndustryParamsFormatJson AttackLayer7TimeseriesGroupIndustryParamsFormat = "JSON" AttackLayer7TimeseriesGroupIndustryParamsFormatCsv AttackLayer7TimeseriesGroupIndustryParamsFormat = "CSV" )
func (AttackLayer7TimeseriesGroupIndustryParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIndustryParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupIndustryParamsHTTPMethod) IsKnown() bool
type AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion ¶
type AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion string
const ( AttackLayer7TimeseriesGroupIndustryParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion = "HTTPv1" AttackLayer7TimeseriesGroupIndustryParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion = "HTTPv2" AttackLayer7TimeseriesGroupIndustryParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIndustryParamsHTTPVersion) IsKnown() bool
type AttackLayer7TimeseriesGroupIndustryParamsIPVersion ¶
type AttackLayer7TimeseriesGroupIndustryParamsIPVersion string
const ( AttackLayer7TimeseriesGroupIndustryParamsIPVersionIPv4 AttackLayer7TimeseriesGroupIndustryParamsIPVersion = "IPv4" AttackLayer7TimeseriesGroupIndustryParamsIPVersionIPv6 AttackLayer7TimeseriesGroupIndustryParamsIPVersion = "IPv6" )
func (AttackLayer7TimeseriesGroupIndustryParamsIPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIndustryParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupIndustryParamsMitigationProduct) IsKnown() bool
type AttackLayer7TimeseriesGroupIndustryParamsNormalization ¶
type AttackLayer7TimeseriesGroupIndustryParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupIndustryParamsNormalizationPercentage AttackLayer7TimeseriesGroupIndustryParamsNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupIndustryParamsNormalizationMin0Max AttackLayer7TimeseriesGroupIndustryParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesGroupIndustryParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIndustryParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupIndustryResponse ¶
type AttackLayer7TimeseriesGroupIndustryResponse struct {
// Metadata for the results.
Meta AttackLayer7TimeseriesGroupIndustryResponseMeta `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 AttackLayer7TimeseriesGroupIndustryResponseMeta ¶
type AttackLayer7TimeseriesGroupIndustryResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesGroupIndustryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesGroupIndustryResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesGroupIndustryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesGroupIndustryResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval ¶
type AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesGroupIndustryResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesGroupIndustryResponseMetaAggIntervalOneHour AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesGroupIndustryResponseMetaAggIntervalOneDay AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesGroupIndustryResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesGroupIndustryResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIndustryResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIndustryResponseMetaDateRange ¶
type AttackLayer7TimeseriesGroupIndustryResponseMetaDateRange 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 attackLayer7TimeseriesGroupIndustryResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupIndustryResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIndustryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization ¶
type AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationPercentage AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationMin0Max AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationMinMax AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationRawValues AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesGroupIndustryResponseMetaNormalizationRatio AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupIndustryResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupIndustryResponseMetaUnit ¶
type AttackLayer7TimeseriesGroupIndustryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesGroupIndustryResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupIndustryResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupIndustryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupIndustryResponseSerie0 ¶
type AttackLayer7TimeseriesGroupIndustryResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesGroupManagedRulesParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer7TimeseriesGroupManagedRulesParamsNormalization] `query:"normalization"`
}
func (AttackLayer7TimeseriesGroupManagedRulesParams) URLQuery ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TimeseriesGroupManagedRulesParams's query parameters as `url.Values`.
type AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval ¶
type AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupManagedRulesParamsFormat ¶
type AttackLayer7TimeseriesGroupManagedRulesParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesGroupManagedRulesParamsFormatJson AttackLayer7TimeseriesGroupManagedRulesParamsFormat = "JSON" AttackLayer7TimeseriesGroupManagedRulesParamsFormatCsv AttackLayer7TimeseriesGroupManagedRulesParamsFormat = "CSV" )
func (AttackLayer7TimeseriesGroupManagedRulesParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParamsHTTPMethod) IsKnown() bool
type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion ¶
type AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion string
const ( AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion = "HTTPv1" AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion = "HTTPv2" AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParamsHTTPVersion) IsKnown() bool
type AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion ¶
type AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion string
const ( AttackLayer7TimeseriesGroupManagedRulesParamsIPVersionIPv4 AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion = "IPv4" AttackLayer7TimeseriesGroupManagedRulesParamsIPVersionIPv6 AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion = "IPv6" )
func (AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParamsMitigationProduct) IsKnown() bool
type AttackLayer7TimeseriesGroupManagedRulesParamsNormalization ¶
type AttackLayer7TimeseriesGroupManagedRulesParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupManagedRulesParamsNormalizationPercentage AttackLayer7TimeseriesGroupManagedRulesParamsNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupManagedRulesParamsNormalizationMin0Max AttackLayer7TimeseriesGroupManagedRulesParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesGroupManagedRulesParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupManagedRulesParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupManagedRulesResponse ¶
type AttackLayer7TimeseriesGroupManagedRulesResponse struct {
// Metadata for the results.
Meta AttackLayer7TimeseriesGroupManagedRulesResponseMeta `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 ¶
func (r *AttackLayer7TimeseriesGroupManagedRulesResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupManagedRulesResponseMeta ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesGroupManagedRulesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesGroupManagedRulesResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesGroupManagedRulesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesGroupManagedRulesResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupManagedRulesResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggIntervalOneHour AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggIntervalOneDay AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesGroupManagedRulesResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupManagedRulesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaDateRange ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaDateRange 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 attackLayer7TimeseriesGroupManagedRulesResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupManagedRulesResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupManagedRulesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationPercentage AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationMin0Max AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationMinMax AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationRawValues AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalizationRatio AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupManagedRulesResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaUnit ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesGroupManagedRulesResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupManagedRulesResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupManagedRulesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupManagedRulesResponseSerie0 ¶
type AttackLayer7TimeseriesGroupManagedRulesResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON attackLayer7TimeseriesGroupManagedRulesResponseSerie0JSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupManagedRulesResponseSerie0) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupManagedRulesResponseSerie0) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupMitigationProductParams ¶
type AttackLayer7TimeseriesGroupMitigationProductParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesGroupMitigationProductParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer7TimeseriesGroupMitigationProductParamsNormalization] `query:"normalization"`
}
func (AttackLayer7TimeseriesGroupMitigationProductParams) URLQuery ¶
func (r AttackLayer7TimeseriesGroupMitigationProductParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TimeseriesGroupMitigationProductParams's query parameters as `url.Values`.
type AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval ¶
type AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesGroupMitigationProductParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupMitigationProductParamsFormat ¶
type AttackLayer7TimeseriesGroupMitigationProductParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesGroupMitigationProductParamsFormatJson AttackLayer7TimeseriesGroupMitigationProductParamsFormat = "JSON" AttackLayer7TimeseriesGroupMitigationProductParamsFormatCsv AttackLayer7TimeseriesGroupMitigationProductParamsFormat = "CSV" )
func (AttackLayer7TimeseriesGroupMitigationProductParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesGroupMitigationProductParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupMitigationProductParamsHTTPMethod) IsKnown() bool
type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion ¶
type AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion string
const ( AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion = "HTTPv1" AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion = "HTTPv2" AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupMitigationProductParamsHTTPVersion) IsKnown() bool
type AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion ¶
type AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion string
const ( AttackLayer7TimeseriesGroupMitigationProductParamsIPVersionIPv4 AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion = "IPv4" AttackLayer7TimeseriesGroupMitigationProductParamsIPVersionIPv6 AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion = "IPv6" )
func (AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupMitigationProductParamsIPVersion) IsKnown() bool
type AttackLayer7TimeseriesGroupMitigationProductParamsNormalization ¶
type AttackLayer7TimeseriesGroupMitigationProductParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupMitigationProductParamsNormalizationPercentage AttackLayer7TimeseriesGroupMitigationProductParamsNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupMitigationProductParamsNormalizationMin0Max AttackLayer7TimeseriesGroupMitigationProductParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesGroupMitigationProductParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupMitigationProductParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupMitigationProductResponse ¶
type AttackLayer7TimeseriesGroupMitigationProductResponse struct {
// Metadata for the results.
Meta AttackLayer7TimeseriesGroupMitigationProductResponseMeta `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 ¶
func (r *AttackLayer7TimeseriesGroupMitigationProductResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupMitigationProductResponseMeta ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesGroupMitigationProductResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesGroupMitigationProductResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesGroupMitigationProductResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesGroupMitigationProductResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupMitigationProductResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggIntervalOneHour AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggIntervalOneDay AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesGroupMitigationProductResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupMitigationProductResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaDateRange ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaDateRange 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 attackLayer7TimeseriesGroupMitigationProductResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupMitigationProductResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupMitigationProductResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationPercentage AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationMin0Max AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationMinMax AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationRawValues AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalizationRatio AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupMitigationProductResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaUnit ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesGroupMitigationProductResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupMitigationProductResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupMitigationProductResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupMitigationProductResponseSerie0 ¶
type AttackLayer7TimeseriesGroupMitigationProductResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON attackLayer7TimeseriesGroupMitigationProductResponseSerie0JSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupMitigationProductResponseSerie0) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupMitigationProductResponseSerie0) UnmarshalJSON(data []byte) (err error)
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) HTTPMethod ¶
func (r *AttackLayer7TimeseriesGroupService) HTTPMethod(ctx context.Context, query AttackLayer7TimeseriesGroupHTTPMethodParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesGroupHTTPMethodResponse, err error)
Retrieves the distribution of layer 7 attacks by HTTP method over time.
func (*AttackLayer7TimeseriesGroupService) HTTPVersion ¶
func (r *AttackLayer7TimeseriesGroupService) HTTPVersion(ctx context.Context, query AttackLayer7TimeseriesGroupHTTPVersionParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesGroupHTTPVersionResponse, err error)
Retrieves the distribution of layer 7 attacks by HTTP version over time.
func (*AttackLayer7TimeseriesGroupService) IPVersion ¶
func (r *AttackLayer7TimeseriesGroupService) IPVersion(ctx context.Context, query AttackLayer7TimeseriesGroupIPVersionParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesGroupIPVersionResponse, err error)
Retrieves the distribution of layer 7 attacks by IP version used over time.
func (*AttackLayer7TimeseriesGroupService) Industry ¶
func (r *AttackLayer7TimeseriesGroupService) Industry(ctx context.Context, query AttackLayer7TimeseriesGroupIndustryParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesGroupIndustryResponse, err error)
Retrieves the distribution of layer 7 attacks by targeted industry over time.
func (*AttackLayer7TimeseriesGroupService) ManagedRules ¶
func (r *AttackLayer7TimeseriesGroupService) ManagedRules(ctx context.Context, query AttackLayer7TimeseriesGroupManagedRulesParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesGroupManagedRulesResponse, err error)
Retrieves the distribution of layer 7 attacks by managed rules over time.
func (*AttackLayer7TimeseriesGroupService) MitigationProduct ¶
func (r *AttackLayer7TimeseriesGroupService) MitigationProduct(ctx context.Context, query AttackLayer7TimeseriesGroupMitigationProductParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesGroupMitigationProductResponse, err error)
Retrieves the distribution of layer 7 attacks by mitigation product over time.
func (*AttackLayer7TimeseriesGroupService) Vertical ¶
func (r *AttackLayer7TimeseriesGroupService) Vertical(ctx context.Context, query AttackLayer7TimeseriesGroupVerticalParams, opts ...option.RequestOption) (res *AttackLayer7TimeseriesGroupVerticalResponse, err error)
Retrieves the distribution of layer 7 attacks by targeted vertical over time.
type AttackLayer7TimeseriesGroupVerticalParams ¶
type AttackLayer7TimeseriesGroupVerticalParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesGroupVerticalParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[AttackLayer7TimeseriesGroupVerticalParamsNormalization] `query:"normalization"`
}
func (AttackLayer7TimeseriesGroupVerticalParams) URLQuery ¶
func (r AttackLayer7TimeseriesGroupVerticalParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TimeseriesGroupVerticalParams's query parameters as `url.Values`.
type AttackLayer7TimeseriesGroupVerticalParamsAggInterval ¶
type AttackLayer7TimeseriesGroupVerticalParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesGroupVerticalParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupVerticalParamsFormat ¶
type AttackLayer7TimeseriesGroupVerticalParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesGroupVerticalParamsFormatJson AttackLayer7TimeseriesGroupVerticalParamsFormat = "JSON" AttackLayer7TimeseriesGroupVerticalParamsFormatCsv AttackLayer7TimeseriesGroupVerticalParamsFormat = "CSV" )
func (AttackLayer7TimeseriesGroupVerticalParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesGroupVerticalParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupVerticalParamsHTTPMethod) IsKnown() bool
type AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion ¶
type AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion string
const ( AttackLayer7TimeseriesGroupVerticalParamsHTTPVersionHttPv1 AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion = "HTTPv1" AttackLayer7TimeseriesGroupVerticalParamsHTTPVersionHttPv2 AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion = "HTTPv2" AttackLayer7TimeseriesGroupVerticalParamsHTTPVersionHttPv3 AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupVerticalParamsHTTPVersion) IsKnown() bool
type AttackLayer7TimeseriesGroupVerticalParamsIPVersion ¶
type AttackLayer7TimeseriesGroupVerticalParamsIPVersion string
const ( AttackLayer7TimeseriesGroupVerticalParamsIPVersionIPv4 AttackLayer7TimeseriesGroupVerticalParamsIPVersion = "IPv4" AttackLayer7TimeseriesGroupVerticalParamsIPVersionIPv6 AttackLayer7TimeseriesGroupVerticalParamsIPVersion = "IPv6" )
func (AttackLayer7TimeseriesGroupVerticalParamsIPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesGroupVerticalParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesGroupVerticalParamsMitigationProduct) IsKnown() bool
type AttackLayer7TimeseriesGroupVerticalParamsNormalization ¶
type AttackLayer7TimeseriesGroupVerticalParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupVerticalParamsNormalizationPercentage AttackLayer7TimeseriesGroupVerticalParamsNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupVerticalParamsNormalizationMin0Max AttackLayer7TimeseriesGroupVerticalParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesGroupVerticalParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupVerticalParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupVerticalResponse ¶
type AttackLayer7TimeseriesGroupVerticalResponse struct {
// Metadata for the results.
Meta AttackLayer7TimeseriesGroupVerticalResponseMeta `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 AttackLayer7TimeseriesGroupVerticalResponseMeta ¶
type AttackLayer7TimeseriesGroupVerticalResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesGroupVerticalResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesGroupVerticalResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesGroupVerticalResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesGroupVerticalResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval ¶
type AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesGroupVerticalResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesGroupVerticalResponseMetaAggIntervalOneHour AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesGroupVerticalResponseMetaAggIntervalOneDay AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesGroupVerticalResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesGroupVerticalResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesGroupVerticalResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupVerticalResponseMetaDateRange ¶
type AttackLayer7TimeseriesGroupVerticalResponseMetaDateRange 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 attackLayer7TimeseriesGroupVerticalResponseMetaDateRangeJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupVerticalResponseMetaDateRange) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupVerticalResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization ¶
type AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationPercentage AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationMin0Max AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationMinMax AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationRawValues AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesGroupVerticalResponseMetaNormalizationRatio AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesGroupVerticalResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesGroupVerticalResponseMetaUnit ¶
type AttackLayer7TimeseriesGroupVerticalResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesGroupVerticalResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesGroupVerticalResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesGroupVerticalResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesGroupVerticalResponseSerie0 ¶
type AttackLayer7TimeseriesGroupVerticalResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TimeseriesParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TimeseriesParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TimeseriesParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TimeseriesParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TimeseriesParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. 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 of the results (e.g., 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 ¶
func (r AttackLayer7TimeseriesParamsAggInterval) IsKnown() bool
type AttackLayer7TimeseriesParamsFormat ¶
type AttackLayer7TimeseriesParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TimeseriesParamsFormatJson AttackLayer7TimeseriesParamsFormat = "JSON" AttackLayer7TimeseriesParamsFormatCsv AttackLayer7TimeseriesParamsFormat = "CSV" )
func (AttackLayer7TimeseriesParamsFormat) IsKnown ¶
func (r AttackLayer7TimeseriesParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesParamsHTTPMethod) IsKnown() bool
type AttackLayer7TimeseriesParamsHTTPVersion ¶
type AttackLayer7TimeseriesParamsHTTPVersion string
const ( AttackLayer7TimeseriesParamsHTTPVersionHttPv1 AttackLayer7TimeseriesParamsHTTPVersion = "HTTPv1" AttackLayer7TimeseriesParamsHTTPVersionHttPv2 AttackLayer7TimeseriesParamsHTTPVersion = "HTTPv2" AttackLayer7TimeseriesParamsHTTPVersionHttPv3 AttackLayer7TimeseriesParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TimeseriesParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesParamsHTTPVersion) IsKnown() bool
type AttackLayer7TimeseriesParamsIPVersion ¶
type AttackLayer7TimeseriesParamsIPVersion string
const ( AttackLayer7TimeseriesParamsIPVersionIPv4 AttackLayer7TimeseriesParamsIPVersion = "IPv4" AttackLayer7TimeseriesParamsIPVersionIPv6 AttackLayer7TimeseriesParamsIPVersion = "IPv6" )
func (AttackLayer7TimeseriesParamsIPVersion) IsKnown ¶
func (r AttackLayer7TimeseriesParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TimeseriesParamsMitigationProduct) IsKnown() bool
type AttackLayer7TimeseriesParamsNormalization ¶
type AttackLayer7TimeseriesParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesParamsNormalizationPercentageChange AttackLayer7TimeseriesParamsNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesParamsNormalizationMin0Max AttackLayer7TimeseriesParamsNormalization = "MIN0_MAX" )
func (AttackLayer7TimeseriesParamsNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesParamsNormalization) IsKnown() bool
type AttackLayer7TimeseriesResponse ¶
type AttackLayer7TimeseriesResponse struct {
// Metadata for the results.
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 {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval AttackLayer7TimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo AttackLayer7TimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []AttackLayer7TimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TimeseriesResponseMetaUnit `json:"units,required"`
JSON attackLayer7TimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TimeseriesResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TimeseriesResponseMetaAggInterval ¶
type AttackLayer7TimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( AttackLayer7TimeseriesResponseMetaAggIntervalFifteenMinutes AttackLayer7TimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" AttackLayer7TimeseriesResponseMetaAggIntervalOneHour AttackLayer7TimeseriesResponseMetaAggInterval = "ONE_HOUR" AttackLayer7TimeseriesResponseMetaAggIntervalOneDay AttackLayer7TimeseriesResponseMetaAggInterval = "ONE_DAY" AttackLayer7TimeseriesResponseMetaAggIntervalOneWeek AttackLayer7TimeseriesResponseMetaAggInterval = "ONE_WEEK" AttackLayer7TimeseriesResponseMetaAggIntervalOneMonth AttackLayer7TimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (AttackLayer7TimeseriesResponseMetaAggInterval) IsKnown ¶
func (r AttackLayer7TimeseriesResponseMetaAggInterval) IsKnown() bool
type AttackLayer7TimeseriesResponseMetaConfidenceInfo ¶
type AttackLayer7TimeseriesResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7TimeseriesResponseMetaNormalization ¶
type AttackLayer7TimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TimeseriesResponseMetaNormalizationPercentage AttackLayer7TimeseriesResponseMetaNormalization = "PERCENTAGE" AttackLayer7TimeseriesResponseMetaNormalizationMin0Max AttackLayer7TimeseriesResponseMetaNormalization = "MIN0_MAX" AttackLayer7TimeseriesResponseMetaNormalizationMinMax AttackLayer7TimeseriesResponseMetaNormalization = "MIN_MAX" AttackLayer7TimeseriesResponseMetaNormalizationRawValues AttackLayer7TimeseriesResponseMetaNormalization = "RAW_VALUES" AttackLayer7TimeseriesResponseMetaNormalizationPercentageChange AttackLayer7TimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TimeseriesResponseMetaNormalizationRollingAverage AttackLayer7TimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TimeseriesResponseMetaNormalizationOverlappedPercentage AttackLayer7TimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TimeseriesResponseMetaNormalizationRatio AttackLayer7TimeseriesResponseMetaNormalization = "RATIO" )
func (AttackLayer7TimeseriesResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TimeseriesResponseMetaNormalization) IsKnown() bool
type AttackLayer7TimeseriesResponseMetaUnit ¶
type AttackLayer7TimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TimeseriesResponseMetaUnit) 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 {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TopAseOriginParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TopAseOriginParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TopAseOriginParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TopAseOriginParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TopAseOriginParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
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 in which results will be returned.
const ( AttackLayer7TopAseOriginParamsFormatJson AttackLayer7TopAseOriginParamsFormat = "JSON" AttackLayer7TopAseOriginParamsFormatCsv AttackLayer7TopAseOriginParamsFormat = "CSV" )
func (AttackLayer7TopAseOriginParamsFormat) IsKnown ¶
func (r AttackLayer7TopAseOriginParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TopAseOriginParamsHTTPMethod) IsKnown() bool
type AttackLayer7TopAseOriginParamsHTTPVersion ¶
type AttackLayer7TopAseOriginParamsHTTPVersion string
const ( AttackLayer7TopAseOriginParamsHTTPVersionHttPv1 AttackLayer7TopAseOriginParamsHTTPVersion = "HTTPv1" AttackLayer7TopAseOriginParamsHTTPVersionHttPv2 AttackLayer7TopAseOriginParamsHTTPVersion = "HTTPv2" AttackLayer7TopAseOriginParamsHTTPVersionHttPv3 AttackLayer7TopAseOriginParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TopAseOriginParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TopAseOriginParamsHTTPVersion) IsKnown() bool
type AttackLayer7TopAseOriginParamsIPVersion ¶
type AttackLayer7TopAseOriginParamsIPVersion string
const ( AttackLayer7TopAseOriginParamsIPVersionIPv4 AttackLayer7TopAseOriginParamsIPVersion = "IPv4" AttackLayer7TopAseOriginParamsIPVersionIPv6 AttackLayer7TopAseOriginParamsIPVersion = "IPv6" )
func (AttackLayer7TopAseOriginParamsIPVersion) IsKnown ¶
func (r AttackLayer7TopAseOriginParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TopAseOriginParamsMitigationProduct) IsKnown() bool
type AttackLayer7TopAseOriginResponse ¶
type AttackLayer7TopAseOriginResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7TopAseOriginResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer7TopAseOriginResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TopAseOriginResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TopAseOriginResponseMetaUnit `json:"units,required"`
JSON attackLayer7TopAseOriginResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TopAseOriginResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TopAseOriginResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopAseOriginResponseMetaConfidenceInfo ¶
type AttackLayer7TopAseOriginResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TopAseOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7TopAseOriginResponseMetaNormalization ¶
type AttackLayer7TopAseOriginResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TopAseOriginResponseMetaNormalizationPercentage AttackLayer7TopAseOriginResponseMetaNormalization = "PERCENTAGE" AttackLayer7TopAseOriginResponseMetaNormalizationMin0Max AttackLayer7TopAseOriginResponseMetaNormalization = "MIN0_MAX" AttackLayer7TopAseOriginResponseMetaNormalizationMinMax AttackLayer7TopAseOriginResponseMetaNormalization = "MIN_MAX" AttackLayer7TopAseOriginResponseMetaNormalizationRawValues AttackLayer7TopAseOriginResponseMetaNormalization = "RAW_VALUES" AttackLayer7TopAseOriginResponseMetaNormalizationPercentageChange AttackLayer7TopAseOriginResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TopAseOriginResponseMetaNormalizationRollingAverage AttackLayer7TopAseOriginResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TopAseOriginResponseMetaNormalizationOverlappedPercentage AttackLayer7TopAseOriginResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TopAseOriginResponseMetaNormalizationRatio AttackLayer7TopAseOriginResponseMetaNormalization = "RATIO" )
func (AttackLayer7TopAseOriginResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TopAseOriginResponseMetaNormalization) IsKnown() bool
type AttackLayer7TopAseOriginResponseMetaUnit ¶
type AttackLayer7TopAseOriginResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TopAseOriginResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TopAseOriginResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TopAseOriginResponseMetaUnit) 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 ¶
func (r *AttackLayer7TopAseService) Origin(ctx context.Context, query AttackLayer7TopAseOriginParams, opts ...option.RequestOption) (res *AttackLayer7TopAseOriginResponse, err error)
Retrieves the top origin autonomous systems of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin autonomous systems determined by the client IP address.
type AttackLayer7TopAttacksParams ¶
type AttackLayer7TopAttacksParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TopAttacksParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Specifies whether the `limitPerLocation` applies to the source or target
// location.
LimitDirection param.Field[AttackLayer7TopAttacksParamsLimitDirection] `query:"limitDirection"`
// Limits the number of attacks per origin/target (refer to `limitDirection`
// parameter) location.
LimitPerLocation param.Field[int64] `query:"limitPerLocation"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TopAttacksParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. 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 in which results will be returned.
const ( AttackLayer7TopAttacksParamsFormatJson AttackLayer7TopAttacksParamsFormat = "JSON" AttackLayer7TopAttacksParamsFormatCsv AttackLayer7TopAttacksParamsFormat = "CSV" )
func (AttackLayer7TopAttacksParamsFormat) IsKnown ¶
func (r AttackLayer7TopAttacksParamsFormat) IsKnown() bool
type AttackLayer7TopAttacksParamsLimitDirection ¶
type AttackLayer7TopAttacksParamsLimitDirection string
Specifies whether the `limitPerLocation` applies to the source or target location.
const ( AttackLayer7TopAttacksParamsLimitDirectionOrigin AttackLayer7TopAttacksParamsLimitDirection = "ORIGIN" AttackLayer7TopAttacksParamsLimitDirectionTarget AttackLayer7TopAttacksParamsLimitDirection = "TARGET" )
func (AttackLayer7TopAttacksParamsLimitDirection) IsKnown ¶
func (r AttackLayer7TopAttacksParamsLimitDirection) IsKnown() bool
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 ¶
func (r AttackLayer7TopAttacksParamsMitigationProduct) IsKnown() bool
type AttackLayer7TopAttacksParamsNormalization ¶
type AttackLayer7TopAttacksParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TopAttacksParamsNormalizationPercentage AttackLayer7TopAttacksParamsNormalization = "PERCENTAGE" AttackLayer7TopAttacksParamsNormalizationMinMax AttackLayer7TopAttacksParamsNormalization = "MIN_MAX" )
func (AttackLayer7TopAttacksParamsNormalization) IsKnown ¶
func (r AttackLayer7TopAttacksParamsNormalization) IsKnown() bool
type AttackLayer7TopAttacksResponse ¶
type AttackLayer7TopAttacksResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7TopAttacksResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer7TopAttacksResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TopAttacksResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TopAttacksResponseMetaUnit `json:"units,required"`
JSON attackLayer7TopAttacksResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TopAttacksResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TopAttacksResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopAttacksResponseMetaConfidenceInfo ¶
type AttackLayer7TopAttacksResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TopAttacksResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TopAttacksResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7TopAttacksResponseMetaNormalization ¶
type AttackLayer7TopAttacksResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TopAttacksResponseMetaNormalizationPercentage AttackLayer7TopAttacksResponseMetaNormalization = "PERCENTAGE" AttackLayer7TopAttacksResponseMetaNormalizationMin0Max AttackLayer7TopAttacksResponseMetaNormalization = "MIN0_MAX" AttackLayer7TopAttacksResponseMetaNormalizationMinMax AttackLayer7TopAttacksResponseMetaNormalization = "MIN_MAX" AttackLayer7TopAttacksResponseMetaNormalizationRawValues AttackLayer7TopAttacksResponseMetaNormalization = "RAW_VALUES" AttackLayer7TopAttacksResponseMetaNormalizationPercentageChange AttackLayer7TopAttacksResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TopAttacksResponseMetaNormalizationRollingAverage AttackLayer7TopAttacksResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TopAttacksResponseMetaNormalizationOverlappedPercentage AttackLayer7TopAttacksResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TopAttacksResponseMetaNormalizationRatio AttackLayer7TopAttacksResponseMetaNormalization = "RATIO" )
func (AttackLayer7TopAttacksResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TopAttacksResponseMetaNormalization) IsKnown() bool
type AttackLayer7TopAttacksResponseMetaUnit ¶
type AttackLayer7TopAttacksResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TopAttacksResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TopAttacksResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TopAttacksResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TopIndustryParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TopIndustryParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TopIndustryParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TopIndustryParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TopIndustryParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
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 in which results will be returned.
const ( AttackLayer7TopIndustryParamsFormatJson AttackLayer7TopIndustryParamsFormat = "JSON" AttackLayer7TopIndustryParamsFormatCsv AttackLayer7TopIndustryParamsFormat = "CSV" )
func (AttackLayer7TopIndustryParamsFormat) IsKnown ¶
func (r AttackLayer7TopIndustryParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TopIndustryParamsHTTPMethod) IsKnown() bool
type AttackLayer7TopIndustryParamsHTTPVersion ¶
type AttackLayer7TopIndustryParamsHTTPVersion string
const ( AttackLayer7TopIndustryParamsHTTPVersionHttPv1 AttackLayer7TopIndustryParamsHTTPVersion = "HTTPv1" AttackLayer7TopIndustryParamsHTTPVersionHttPv2 AttackLayer7TopIndustryParamsHTTPVersion = "HTTPv2" AttackLayer7TopIndustryParamsHTTPVersionHttPv3 AttackLayer7TopIndustryParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TopIndustryParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TopIndustryParamsHTTPVersion) IsKnown() bool
type AttackLayer7TopIndustryParamsIPVersion ¶
type AttackLayer7TopIndustryParamsIPVersion string
const ( AttackLayer7TopIndustryParamsIPVersionIPv4 AttackLayer7TopIndustryParamsIPVersion = "IPv4" AttackLayer7TopIndustryParamsIPVersionIPv6 AttackLayer7TopIndustryParamsIPVersion = "IPv6" )
func (AttackLayer7TopIndustryParamsIPVersion) IsKnown ¶
func (r AttackLayer7TopIndustryParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TopIndustryParamsMitigationProduct) IsKnown() bool
type AttackLayer7TopIndustryResponse ¶
type AttackLayer7TopIndustryResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7TopIndustryResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer7TopIndustryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TopIndustryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TopIndustryResponseMetaUnit `json:"units,required"`
JSON attackLayer7TopIndustryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TopIndustryResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TopIndustryResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopIndustryResponseMetaConfidenceInfo ¶
type AttackLayer7TopIndustryResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TopIndustryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TopIndustryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7TopIndustryResponseMetaNormalization ¶
type AttackLayer7TopIndustryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TopIndustryResponseMetaNormalizationPercentage AttackLayer7TopIndustryResponseMetaNormalization = "PERCENTAGE" AttackLayer7TopIndustryResponseMetaNormalizationMin0Max AttackLayer7TopIndustryResponseMetaNormalization = "MIN0_MAX" AttackLayer7TopIndustryResponseMetaNormalizationMinMax AttackLayer7TopIndustryResponseMetaNormalization = "MIN_MAX" AttackLayer7TopIndustryResponseMetaNormalizationRawValues AttackLayer7TopIndustryResponseMetaNormalization = "RAW_VALUES" AttackLayer7TopIndustryResponseMetaNormalizationPercentageChange AttackLayer7TopIndustryResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TopIndustryResponseMetaNormalizationRollingAverage AttackLayer7TopIndustryResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TopIndustryResponseMetaNormalizationOverlappedPercentage AttackLayer7TopIndustryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TopIndustryResponseMetaNormalizationRatio AttackLayer7TopIndustryResponseMetaNormalization = "RATIO" )
func (AttackLayer7TopIndustryResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TopIndustryResponseMetaNormalization) IsKnown() bool
type AttackLayer7TopIndustryResponseMetaUnit ¶
type AttackLayer7TopIndustryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TopIndustryResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TopIndustryResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TopIndustryResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TopLocationOriginParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TopLocationOriginParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TopLocationOriginParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TopLocationOriginParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TopLocationOriginParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7TopLocationOriginParams) URLQuery ¶
func (r AttackLayer7TopLocationOriginParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TopLocationOriginParams's query parameters as `url.Values`.
type AttackLayer7TopLocationOriginParamsFormat ¶
type AttackLayer7TopLocationOriginParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TopLocationOriginParamsFormatJson AttackLayer7TopLocationOriginParamsFormat = "JSON" AttackLayer7TopLocationOriginParamsFormatCsv AttackLayer7TopLocationOriginParamsFormat = "CSV" )
func (AttackLayer7TopLocationOriginParamsFormat) IsKnown ¶
func (r AttackLayer7TopLocationOriginParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TopLocationOriginParamsHTTPMethod) IsKnown() bool
type AttackLayer7TopLocationOriginParamsHTTPVersion ¶
type AttackLayer7TopLocationOriginParamsHTTPVersion string
const ( AttackLayer7TopLocationOriginParamsHTTPVersionHttPv1 AttackLayer7TopLocationOriginParamsHTTPVersion = "HTTPv1" AttackLayer7TopLocationOriginParamsHTTPVersionHttPv2 AttackLayer7TopLocationOriginParamsHTTPVersion = "HTTPv2" AttackLayer7TopLocationOriginParamsHTTPVersionHttPv3 AttackLayer7TopLocationOriginParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TopLocationOriginParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TopLocationOriginParamsHTTPVersion) IsKnown() bool
type AttackLayer7TopLocationOriginParamsIPVersion ¶
type AttackLayer7TopLocationOriginParamsIPVersion string
const ( AttackLayer7TopLocationOriginParamsIPVersionIPv4 AttackLayer7TopLocationOriginParamsIPVersion = "IPv4" AttackLayer7TopLocationOriginParamsIPVersionIPv6 AttackLayer7TopLocationOriginParamsIPVersion = "IPv6" )
func (AttackLayer7TopLocationOriginParamsIPVersion) IsKnown ¶
func (r AttackLayer7TopLocationOriginParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TopLocationOriginParamsMitigationProduct) IsKnown() bool
type AttackLayer7TopLocationOriginResponse ¶
type AttackLayer7TopLocationOriginResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7TopLocationOriginResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer7TopLocationOriginResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TopLocationOriginResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TopLocationOriginResponseMetaUnit `json:"units,required"`
JSON attackLayer7TopLocationOriginResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TopLocationOriginResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationOriginResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopLocationOriginResponseMetaConfidenceInfo ¶
type AttackLayer7TopLocationOriginResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TopLocationOriginResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TopLocationOriginResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationOriginResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationOriginResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7TopLocationOriginResponseMetaNormalization ¶
type AttackLayer7TopLocationOriginResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TopLocationOriginResponseMetaNormalizationPercentage AttackLayer7TopLocationOriginResponseMetaNormalization = "PERCENTAGE" AttackLayer7TopLocationOriginResponseMetaNormalizationMin0Max AttackLayer7TopLocationOriginResponseMetaNormalization = "MIN0_MAX" AttackLayer7TopLocationOriginResponseMetaNormalizationMinMax AttackLayer7TopLocationOriginResponseMetaNormalization = "MIN_MAX" AttackLayer7TopLocationOriginResponseMetaNormalizationRawValues AttackLayer7TopLocationOriginResponseMetaNormalization = "RAW_VALUES" AttackLayer7TopLocationOriginResponseMetaNormalizationPercentageChange AttackLayer7TopLocationOriginResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TopLocationOriginResponseMetaNormalizationRollingAverage AttackLayer7TopLocationOriginResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TopLocationOriginResponseMetaNormalizationOverlappedPercentage AttackLayer7TopLocationOriginResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TopLocationOriginResponseMetaNormalizationRatio AttackLayer7TopLocationOriginResponseMetaNormalization = "RATIO" )
func (AttackLayer7TopLocationOriginResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TopLocationOriginResponseMetaNormalization) IsKnown() bool
type AttackLayer7TopLocationOriginResponseMetaUnit ¶
type AttackLayer7TopLocationOriginResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TopLocationOriginResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TopLocationOriginResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationOriginResponseMetaUnit) 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 ¶
func (r *AttackLayer7TopLocationService) Origin(ctx context.Context, query AttackLayer7TopLocationOriginParams, opts ...option.RequestOption) (res *AttackLayer7TopLocationOriginResponse, err error)
Retrieves the top origin locations of layer 7 attacks. Values are percentages of the total layer 7 attacks, with the origin location determined by the client IP address.
func (*AttackLayer7TopLocationService) Target ¶
func (r *AttackLayer7TopLocationService) Target(ctx context.Context, query AttackLayer7TopLocationTargetParams, opts ...option.RequestOption) (res *AttackLayer7TopLocationTargetResponse, err error)
Retrieves 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 {
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TopLocationTargetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TopLocationTargetParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (AttackLayer7TopLocationTargetParams) URLQuery ¶
func (r AttackLayer7TopLocationTargetParams) URLQuery() (v url.Values)
URLQuery serializes AttackLayer7TopLocationTargetParams's query parameters as `url.Values`.
type AttackLayer7TopLocationTargetParamsFormat ¶
type AttackLayer7TopLocationTargetParamsFormat string
Format in which results will be returned.
const ( AttackLayer7TopLocationTargetParamsFormatJson AttackLayer7TopLocationTargetParamsFormat = "JSON" AttackLayer7TopLocationTargetParamsFormatCsv AttackLayer7TopLocationTargetParamsFormat = "CSV" )
func (AttackLayer7TopLocationTargetParamsFormat) IsKnown ¶
func (r AttackLayer7TopLocationTargetParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TopLocationTargetParamsMitigationProduct) IsKnown() bool
type AttackLayer7TopLocationTargetResponse ¶
type AttackLayer7TopLocationTargetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7TopLocationTargetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer7TopLocationTargetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TopLocationTargetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TopLocationTargetResponseMetaUnit `json:"units,required"`
JSON attackLayer7TopLocationTargetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TopLocationTargetResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationTargetResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopLocationTargetResponseMetaConfidenceInfo ¶
type AttackLayer7TopLocationTargetResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON attackLayer7TopLocationTargetResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*AttackLayer7TopLocationTargetResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationTargetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation ¶
type AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationTargetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7TopLocationTargetResponseMetaNormalization ¶
type AttackLayer7TopLocationTargetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TopLocationTargetResponseMetaNormalizationPercentage AttackLayer7TopLocationTargetResponseMetaNormalization = "PERCENTAGE" AttackLayer7TopLocationTargetResponseMetaNormalizationMin0Max AttackLayer7TopLocationTargetResponseMetaNormalization = "MIN0_MAX" AttackLayer7TopLocationTargetResponseMetaNormalizationMinMax AttackLayer7TopLocationTargetResponseMetaNormalization = "MIN_MAX" AttackLayer7TopLocationTargetResponseMetaNormalizationRawValues AttackLayer7TopLocationTargetResponseMetaNormalization = "RAW_VALUES" AttackLayer7TopLocationTargetResponseMetaNormalizationPercentageChange AttackLayer7TopLocationTargetResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TopLocationTargetResponseMetaNormalizationRollingAverage AttackLayer7TopLocationTargetResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TopLocationTargetResponseMetaNormalizationOverlappedPercentage AttackLayer7TopLocationTargetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TopLocationTargetResponseMetaNormalizationRatio AttackLayer7TopLocationTargetResponseMetaNormalization = "RATIO" )
func (AttackLayer7TopLocationTargetResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TopLocationTargetResponseMetaNormalization) IsKnown() bool
type AttackLayer7TopLocationTargetResponseMetaUnit ¶
type AttackLayer7TopLocationTargetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TopLocationTargetResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TopLocationTargetResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TopLocationTargetResponseMetaUnit) 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 ¶
func (r *AttackLayer7TopService) Attacks(ctx context.Context, query AttackLayer7TopAttacksParams, opts ...option.RequestOption) (res *AttackLayer7TopAttacksResponse, err error)
Retrieves the top attacks from origin to target location. Values are percentages 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
deprecated
func (r *AttackLayer7TopService) Industry(ctx context.Context, query AttackLayer7TopIndustryParams, opts ...option.RequestOption) (res *AttackLayer7TopIndustryResponse, err error)
This endpoint is deprecated. To continue getting this data, switch to the summary by industry endpoint.
Deprecated: deprecated
func (*AttackLayer7TopService) Vertical
deprecated
func (r *AttackLayer7TopService) Vertical(ctx context.Context, query AttackLayer7TopVerticalParams, opts ...option.RequestOption) (res *AttackLayer7TopVerticalResponse, err error)
This endpoint is deprecated. To continue getting this data, switch to the summary by vertical endpoint.
Deprecated: deprecated
type AttackLayer7TopVerticalParams ¶
type AttackLayer7TopVerticalParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[AttackLayer7TopVerticalParamsFormat] `query:"format"`
// Filters results by HTTP method.
HTTPMethod param.Field[[]AttackLayer7TopVerticalParamsHTTPMethod] `query:"httpMethod"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]AttackLayer7TopVerticalParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]AttackLayer7TopVerticalParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations from results. For example, `-US,PT`
// excludes results from the US, but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Filters the results by layer 7 mitigation product.
MitigationProduct param.Field[[]AttackLayer7TopVerticalParamsMitigationProduct] `query:"mitigationProduct"`
// Array of names used to label the series in the response.
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 in which results will be returned.
const ( AttackLayer7TopVerticalParamsFormatJson AttackLayer7TopVerticalParamsFormat = "JSON" AttackLayer7TopVerticalParamsFormatCsv AttackLayer7TopVerticalParamsFormat = "CSV" )
func (AttackLayer7TopVerticalParamsFormat) IsKnown ¶
func (r AttackLayer7TopVerticalParamsFormat) IsKnown() bool
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 ¶
func (r AttackLayer7TopVerticalParamsHTTPMethod) IsKnown() bool
type AttackLayer7TopVerticalParamsHTTPVersion ¶
type AttackLayer7TopVerticalParamsHTTPVersion string
const ( AttackLayer7TopVerticalParamsHTTPVersionHttPv1 AttackLayer7TopVerticalParamsHTTPVersion = "HTTPv1" AttackLayer7TopVerticalParamsHTTPVersionHttPv2 AttackLayer7TopVerticalParamsHTTPVersion = "HTTPv2" AttackLayer7TopVerticalParamsHTTPVersionHttPv3 AttackLayer7TopVerticalParamsHTTPVersion = "HTTPv3" )
func (AttackLayer7TopVerticalParamsHTTPVersion) IsKnown ¶
func (r AttackLayer7TopVerticalParamsHTTPVersion) IsKnown() bool
type AttackLayer7TopVerticalParamsIPVersion ¶
type AttackLayer7TopVerticalParamsIPVersion string
const ( AttackLayer7TopVerticalParamsIPVersionIPv4 AttackLayer7TopVerticalParamsIPVersion = "IPv4" AttackLayer7TopVerticalParamsIPVersionIPv6 AttackLayer7TopVerticalParamsIPVersion = "IPv6" )
func (AttackLayer7TopVerticalParamsIPVersion) IsKnown ¶
func (r AttackLayer7TopVerticalParamsIPVersion) IsKnown() bool
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 ¶
func (r AttackLayer7TopVerticalParamsMitigationProduct) IsKnown() bool
type AttackLayer7TopVerticalResponse ¶
type AttackLayer7TopVerticalResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo AttackLayer7TopVerticalResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []AttackLayer7TopVerticalResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization AttackLayer7TopVerticalResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []AttackLayer7TopVerticalResponseMetaUnit `json:"units,required"`
JSON attackLayer7TopVerticalResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*AttackLayer7TopVerticalResponseMeta) UnmarshalJSON ¶
func (r *AttackLayer7TopVerticalResponseMeta) UnmarshalJSON(data []byte) (err error)
type AttackLayer7TopVerticalResponseMetaConfidenceInfo ¶
type AttackLayer7TopVerticalResponseMetaConfidenceInfo struct {
Annotations []AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON attackLayer7TopVerticalResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *AttackLayer7TopVerticalResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 AttackLayer7TopVerticalResponseMetaNormalization ¶
type AttackLayer7TopVerticalResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( AttackLayer7TopVerticalResponseMetaNormalizationPercentage AttackLayer7TopVerticalResponseMetaNormalization = "PERCENTAGE" AttackLayer7TopVerticalResponseMetaNormalizationMin0Max AttackLayer7TopVerticalResponseMetaNormalization = "MIN0_MAX" AttackLayer7TopVerticalResponseMetaNormalizationMinMax AttackLayer7TopVerticalResponseMetaNormalization = "MIN_MAX" AttackLayer7TopVerticalResponseMetaNormalizationRawValues AttackLayer7TopVerticalResponseMetaNormalization = "RAW_VALUES" AttackLayer7TopVerticalResponseMetaNormalizationPercentageChange AttackLayer7TopVerticalResponseMetaNormalization = "PERCENTAGE_CHANGE" AttackLayer7TopVerticalResponseMetaNormalizationRollingAverage AttackLayer7TopVerticalResponseMetaNormalization = "ROLLING_AVERAGE" AttackLayer7TopVerticalResponseMetaNormalizationOverlappedPercentage AttackLayer7TopVerticalResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" AttackLayer7TopVerticalResponseMetaNormalizationRatio AttackLayer7TopVerticalResponseMetaNormalization = "RATIO" )
func (AttackLayer7TopVerticalResponseMetaNormalization) IsKnown ¶
func (r AttackLayer7TopVerticalResponseMetaNormalization) IsKnown() bool
type AttackLayer7TopVerticalResponseMetaUnit ¶
type AttackLayer7TopVerticalResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON attackLayer7TopVerticalResponseMetaUnitJSON `json:"-"`
}
func (*AttackLayer7TopVerticalResponseMetaUnit) UnmarshalJSON ¶
func (r *AttackLayer7TopVerticalResponseMetaUnit) 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 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"`
// Filters results by date range.
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 in which results will be returned.
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"`
// Filters events by maximum confidence score (1-4 low, 5-7 mid, 8+ high).
MaxConfidence param.Field[int64] `query:"maxConfidence"`
// Filters events by minimum confidence score (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"`
// Sorts results by the specified 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 in which results will be returned.
const ( BGPHijackEventListParamsFormatJson BGPHijackEventListParamsFormat = "JSON" BGPHijackEventListParamsFormatCsv BGPHijackEventListParamsFormat = "CSV" )
func (BGPHijackEventListParamsFormat) IsKnown ¶
func (r BGPHijackEventListParamsFormat) IsKnown() bool
type BGPHijackEventListParamsSortBy ¶
type BGPHijackEventListParamsSortBy string
Sorts results by the specified field.
const ( BGPHijackEventListParamsSortByID BGPHijackEventListParamsSortBy = "ID" BGPHijackEventListParamsSortByTime BGPHijackEventListParamsSortBy = "TIME" BGPHijackEventListParamsSortByConfidence BGPHijackEventListParamsSortBy = "CONFIDENCE" )
func (BGPHijackEventListParamsSortBy) IsKnown ¶
func (r BGPHijackEventListParamsSortBy) IsKnown() bool
type BGPHijackEventListParamsSortOrder ¶
type BGPHijackEventListParamsSortOrder string
Sort order.
const ( BGPHijackEventListParamsSortOrderAsc BGPHijackEventListParamsSortOrder = "ASC" BGPHijackEventListParamsSortOrderDesc BGPHijackEventListParamsSortOrder = "DESC" )
func (BGPHijackEventListParamsSortOrder) IsKnown ¶
func (r BGPHijackEventListParamsSortOrder) IsKnown() bool
type BGPHijackEventListResponse ¶
type BGPHijackEventListResponse struct {
ASNInfo []BGPHijackEventListResponseASNInfo `json:"asn_info,required"`
Events []BGPHijackEventListResponseEvent `json:"events,required"`
TotalMonitors int64 `json:"total_monitors,required"`
JSON bgpHijackEventListResponseJSON `json:"-"`
}
func (*BGPHijackEventListResponse) UnmarshalJSON ¶
func (r *BGPHijackEventListResponse) UnmarshalJSON(data []byte) (err error)
type BGPHijackEventListResponseASNInfo ¶
type BGPHijackEventListResponseASNInfo struct {
ASN int64 `json:"asn,required"`
CountryCode string `json:"country_code,required"`
OrgName string `json:"org_name,required"`
JSON bgpHijackEventListResponseASNInfoJSON `json:"-"`
}
func (*BGPHijackEventListResponseASNInfo) UnmarshalJSON ¶
func (r *BGPHijackEventListResponseASNInfo) UnmarshalJSON(data []byte) (err error)
type BGPHijackEventListResponseEvent ¶
type BGPHijackEventListResponseEvent 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 []BGPHijackEventListResponseEventsTag `json:"tags,required"`
VictimASNs []int64 `json:"victim_asns,required"`
VictimCountries []string `json:"victim_countries,required"`
JSON bgpHijackEventListResponseEventJSON `json:"-"`
}
func (*BGPHijackEventListResponseEvent) UnmarshalJSON ¶
func (r *BGPHijackEventListResponseEvent) UnmarshalJSON(data []byte) (err error)
type BGPHijackEventListResponseEventsTag ¶
type BGPHijackEventListResponseEventsTag struct {
Name string `json:"name,required"`
Score int64 `json:"score,required"`
JSON bgpHijackEventListResponseEventsTagJSON `json:"-"`
}
func (*BGPHijackEventListResponseEventsTag) UnmarshalJSON ¶
func (r *BGPHijackEventListResponseEventsTag) 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 ¶
func (r *BGPHijackEventService) List(ctx context.Context, query BGPHijackEventListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[BGPHijackEventListResponse], err error)
Retrieves the BGP hijack events.
func (*BGPHijackEventService) ListAutoPaging ¶
func (r *BGPHijackEventService) ListAutoPaging(ctx context.Context, query BGPHijackEventListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[BGPHijackEventListResponse]
Retrieves the BGP hijack events.
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)
Retrieves 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BgpipTimeseriesParamsFormat] `query:"format"`
// Includes data delay meta information.
IncludeDelay param.Field[bool] `query:"includeDelay"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]BgpipTimeseriesParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 location
// codes.
Location param.Field[[]string] `query:"location"`
// Array of names used to label the series in the response.
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"`
// Filters results by date range.
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 in which results will be returned.
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"`
// Sorts results by the specified 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 in which results will be returned.
const ( BGPLeakEventListParamsFormatJson BGPLeakEventListParamsFormat = "JSON" BGPLeakEventListParamsFormatCsv BGPLeakEventListParamsFormat = "CSV" )
func (BGPLeakEventListParamsFormat) IsKnown ¶
func (r BGPLeakEventListParamsFormat) IsKnown() bool
type BGPLeakEventListParamsSortBy ¶
type BGPLeakEventListParamsSortBy string
Sorts results by the specified 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 ¶
func (r BGPLeakEventListParamsSortOrder) IsKnown() bool
type BGPLeakEventListResponse ¶
type BGPLeakEventListResponse struct {
ASNInfo []BGPLeakEventListResponseASNInfo `json:"asn_info,required"`
Events []BGPLeakEventListResponseEvent `json:"events,required"`
JSON bgpLeakEventListResponseJSON `json:"-"`
}
func (*BGPLeakEventListResponse) UnmarshalJSON ¶
func (r *BGPLeakEventListResponse) UnmarshalJSON(data []byte) (err error)
type BGPLeakEventListResponseASNInfo ¶
type BGPLeakEventListResponseASNInfo struct {
ASN int64 `json:"asn,required"`
CountryCode string `json:"country_code,required"`
OrgName string `json:"org_name,required"`
JSON bgpLeakEventListResponseASNInfoJSON `json:"-"`
}
func (*BGPLeakEventListResponseASNInfo) UnmarshalJSON ¶
func (r *BGPLeakEventListResponseASNInfo) UnmarshalJSON(data []byte) (err error)
type BGPLeakEventListResponseEvent ¶
type BGPLeakEventListResponseEvent 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 bgpLeakEventListResponseEventJSON `json:"-"`
}
func (*BGPLeakEventListResponseEvent) UnmarshalJSON ¶
func (r *BGPLeakEventListResponseEvent) 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 ¶
func (r *BGPLeakEventService) List(ctx context.Context, query BGPLeakEventListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[BGPLeakEventListResponse], err error)
Retrieves the BGP route leak events.
func (*BGPLeakEventService) ListAutoPaging ¶
func (r *BGPLeakEventService) ListAutoPaging(ctx context.Context, query BGPLeakEventListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[BGPLeakEventListResponse]
Retrieves the BGP route leak events.
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 in which results will be returned.
Format param.Field[BGPRouteAsesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify an alpha-2 location code.
Location param.Field[string] `query:"location"`
// Sorts results by the specified field.
SortBy param.Field[BGPRouteAsesParamsSortBy] `query:"sortBy"`
// Sort order.
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 in which results will be returned.
const ( BGPRouteAsesParamsFormatJson BGPRouteAsesParamsFormat = "JSON" BGPRouteAsesParamsFormatCsv BGPRouteAsesParamsFormat = "CSV" )
func (BGPRouteAsesParamsFormat) IsKnown ¶
func (r BGPRouteAsesParamsFormat) IsKnown() bool
type BGPRouteAsesParamsSortBy ¶
type BGPRouteAsesParamsSortBy string
Sorts results by the specified field.
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 order.
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"`
// Alpha-2 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 in which results will be returned.
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 in which results will be returned.
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 in which results will be returned.
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 in which results will be returned.
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 ¶
func (r BGPRoutePfx2asParamsRPKIStatus) IsKnown() bool
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 BGPRouteRealtimeParams ¶
type BGPRouteRealtimeParams struct {
// Format in which results will be returned.
Format param.Field[BGPRouteRealtimeParamsFormat] `query:"format"`
// Network prefix, IPv4 or IPv6.
Prefix param.Field[string] `query:"prefix"`
}
func (BGPRouteRealtimeParams) URLQuery ¶
func (r BGPRouteRealtimeParams) URLQuery() (v url.Values)
URLQuery serializes BGPRouteRealtimeParams's query parameters as `url.Values`.
type BGPRouteRealtimeParamsFormat ¶
type BGPRouteRealtimeParamsFormat string
Format in which results will be returned.
const ( BGPRouteRealtimeParamsFormatJson BGPRouteRealtimeParamsFormat = "JSON" BGPRouteRealtimeParamsFormatCsv BGPRouteRealtimeParamsFormat = "CSV" )
func (BGPRouteRealtimeParamsFormat) IsKnown ¶
func (r BGPRouteRealtimeParamsFormat) IsKnown() bool
type BGPRouteRealtimeResponse ¶
type BGPRouteRealtimeResponse struct {
Meta BGPRouteRealtimeResponseMeta `json:"meta,required"`
Routes []BGPRouteRealtimeResponseRoute `json:"routes,required"`
JSON bgpRouteRealtimeResponseJSON `json:"-"`
}
func (*BGPRouteRealtimeResponse) UnmarshalJSON ¶
func (r *BGPRouteRealtimeResponse) UnmarshalJSON(data []byte) (err error)
type BGPRouteRealtimeResponseEnvelope ¶
type BGPRouteRealtimeResponseEnvelope struct {
Result BGPRouteRealtimeResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON bgpRouteRealtimeResponseEnvelopeJSON `json:"-"`
}
func (*BGPRouteRealtimeResponseEnvelope) UnmarshalJSON ¶
func (r *BGPRouteRealtimeResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BGPRouteRealtimeResponseMeta ¶
type BGPRouteRealtimeResponseMeta struct {
ASNInfo []BGPRouteRealtimeResponseMetaASNInfo `json:"asn_info,required"`
Collectors []BGPRouteRealtimeResponseMetaCollector `json:"collectors,required"`
// The most recent data timestamp for from the real-time sources.
DataTime string `json:"data_time,required"`
PrefixOrigins []BGPRouteRealtimeResponseMetaPrefixOrigin `json:"prefix_origins,required"`
// The timestamp of this query.
QueryTime string `json:"query_time,required"`
JSON bgpRouteRealtimeResponseMetaJSON `json:"-"`
}
func (*BGPRouteRealtimeResponseMeta) UnmarshalJSON ¶
func (r *BGPRouteRealtimeResponseMeta) UnmarshalJSON(data []byte) (err error)
type BGPRouteRealtimeResponseMetaASNInfo ¶
type BGPRouteRealtimeResponseMetaASNInfo struct {
// Name of the autonomous system.
AsName string `json:"as_name,required"`
// AS number.
ASN int64 `json:"asn,required"`
// Alpha-2 code for the AS's registration country.
CountryCode string `json:"country_code,required"`
// Organization ID.
OrgID string `json:"org_id,required"`
// Organization name.
OrgName string `json:"org_name,required"`
JSON bgpRouteRealtimeResponseMetaASNInfoJSON `json:"-"`
}
func (*BGPRouteRealtimeResponseMetaASNInfo) UnmarshalJSON ¶
func (r *BGPRouteRealtimeResponseMetaASNInfo) UnmarshalJSON(data []byte) (err error)
type BGPRouteRealtimeResponseMetaCollector ¶
type BGPRouteRealtimeResponseMetaCollector struct {
// Public route collector ID.
Collector string `json:"collector,required"`
// Latest real-time stream timestamp for this collector.
LatestRealtimeTs string `json:"latest_realtime_ts,required"`
// Latest RIB dump MRT file timestamp for this collector.
LatestRibTs string `json:"latest_rib_ts,required"`
// Latest BGP updates MRT file timestamp for this collector.
LatestUpdatesTs string `json:"latest_updates_ts,required"`
// Total number of collector peers used from this collector.
PeersCount int64 `json:"peers_count,required"`
// Total number of collector peers used from this collector for IPv4 prefixes.
PeersV4Count int64 `json:"peers_v4_count,required"`
// Total number of collector peers used from this collector for IPv6 prefixes.
PeersV6Count int64 `json:"peers_v6_count,required"`
JSON bgpRouteRealtimeResponseMetaCollectorJSON `json:"-"`
}
func (*BGPRouteRealtimeResponseMetaCollector) UnmarshalJSON ¶
func (r *BGPRouteRealtimeResponseMetaCollector) UnmarshalJSON(data []byte) (err error)
type BGPRouteRealtimeResponseMetaPrefixOrigin ¶
type BGPRouteRealtimeResponseMetaPrefixOrigin struct {
// Origin ASN.
Origin int64 `json:"origin,required"`
// IP prefix of this query.
Prefix string `json:"prefix,required"`
// Prefix-origin RPKI validation: valid, invalid, unknown.
RPKIValidation string `json:"rpki_validation,required"`
// Total number of peers.
TotalPeers int64 `json:"total_peers,required"`
// Total number of peers seeing this prefix.
TotalVisible int64 `json:"total_visible,required"`
// Ratio of peers seeing this prefix to total number of peers.
Visibility float64 `json:"visibility,required"`
JSON bgpRouteRealtimeResponseMetaPrefixOriginJSON `json:"-"`
}
func (*BGPRouteRealtimeResponseMetaPrefixOrigin) UnmarshalJSON ¶
func (r *BGPRouteRealtimeResponseMetaPrefixOrigin) UnmarshalJSON(data []byte) (err error)
type BGPRouteRealtimeResponseRoute ¶
type BGPRouteRealtimeResponseRoute struct {
// AS-level path for this route, from collector to origin.
AsPath []int64 `json:"as_path,required"`
// Public collector ID for this route.
Collector string `json:"collector,required"`
// BGP community values.
Communities []string `json:"communities,required"`
// IP prefix of this query.
Prefix string `json:"prefix,required"`
// Latest timestamp of change for this route.
Timestamp string `json:"timestamp,required"`
JSON bgpRouteRealtimeResponseRouteJSON `json:"-"`
}
func (*BGPRouteRealtimeResponseRoute) UnmarshalJSON ¶
func (r *BGPRouteRealtimeResponseRoute) 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 ¶
func (r *BGPRouteService) Ases(ctx context.Context, query BGPRouteAsesParams, opts ...option.RequestOption) (res *BGPRouteAsesResponse, err error)
Retrieves all ASes in the current global routing tables with routing statistics.
func (*BGPRouteService) Moas ¶
func (r *BGPRouteService) Moas(ctx context.Context, query BGPRouteMoasParams, opts ...option.RequestOption) (res *BGPRouteMoasResponse, err error)
Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables.
func (*BGPRouteService) Pfx2as ¶
func (r *BGPRouteService) Pfx2as(ctx context.Context, query BGPRoutePfx2asParams, opts ...option.RequestOption) (res *BGPRoutePfx2asResponse, err error)
Retrieves the prefix-to-ASN mapping from global routing tables.
func (*BGPRouteService) Realtime ¶
func (r *BGPRouteService) Realtime(ctx context.Context, query BGPRouteRealtimeParams, opts ...option.RequestOption) (res *BGPRouteRealtimeResponse, err error)
Retrieves real-time BGP routes for a prefix, using public real-time data collectors (RouteViews and RIPE RIS).
func (*BGPRouteService) Stats ¶
func (r *BGPRouteService) Stats(ctx context.Context, query BGPRouteStatsParams, opts ...option.RequestOption) (res *BGPRouteStatsResponse, err error)
Retrieves the BGP routing table stats.
type BGPRouteStatsParams ¶
type BGPRouteStatsParams struct {
// Filters results by Autonomous System. Specify a single Autonomous System Number
// (ASN) as integer.
ASN param.Field[int64] `query:"asn"`
// Format in which results will be returned.
Format param.Field[BGPRouteStatsParamsFormat] `query:"format"`
// Filters results by location. Specify an alpha-2 location 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 in which results will be returned.
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)
Retrieves BGP updates over time. When requesting updates for an autonomous system, only BGP updates of type announcement are returned.
type BGPTimeseriesParams ¶
type BGPTimeseriesParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BGPTimeseriesParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by BGP network prefix.
Prefix param.Field[[]string] `query:"prefix"`
// Filters results by BGP update type.
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 of the results (e.g., 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 ¶
func (r BGPTimeseriesParamsAggInterval) IsKnown() bool
type BGPTimeseriesParamsFormat ¶
type BGPTimeseriesParamsFormat string
Format in which results will be returned.
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 BGPTimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo BGPTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []BGPTimeseriesResponseMetaDateRange `json:"dateRange,required"`
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
JSON bgpTimeseriesResponseMetaJSON `json:"-"`
}
func (*BGPTimeseriesResponseMeta) UnmarshalJSON ¶
func (r *BGPTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type BGPTimeseriesResponseMetaAggInterval ¶
type BGPTimeseriesResponseMetaAggInterval string
const ( BGPTimeseriesResponseMetaAggInterval15m BGPTimeseriesResponseMetaAggInterval = "15m" BGPTimeseriesResponseMetaAggInterval1h BGPTimeseriesResponseMetaAggInterval = "1h" BGPTimeseriesResponseMetaAggInterval1d BGPTimeseriesResponseMetaAggInterval = "1d" BGPTimeseriesResponseMetaAggInterval1w BGPTimeseriesResponseMetaAggInterval = "1w" )
func (BGPTimeseriesResponseMetaAggInterval) IsKnown ¶
func (r BGPTimeseriesResponseMetaAggInterval) IsKnown() bool
type BGPTimeseriesResponseMetaConfidenceInfo ¶
type BGPTimeseriesResponseMetaConfidenceInfo struct {
Annotations []BGPTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON bgpTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BGPTopAseGetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by BGP network prefix.
Prefix param.Field[[]string] `query:"prefix"`
// Filters results by BGP update type.
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 in which results will be returned.
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 in which results will be returned.
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 in which results will be returned.
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 ¶
func (r *BGPTopAseService) Get(ctx context.Context, query BGPTopAseGetParams, opts ...option.RequestOption) (res *BGPTopAseGetResponse, err error)
Retrieves the top autonomous systems by BGP updates (announcements only).
func (*BGPTopAseService) Prefixes ¶
func (r *BGPTopAseService) Prefixes(ctx context.Context, query BGPTopAsePrefixesParams, opts ...option.RequestOption) (res *BGPTopAsePrefixesResponse, err error)
Retrieves 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BGPTopPrefixesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by BGP update type.
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 in which results will be returned.
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 ¶
func (r BGPTopPrefixesParamsUpdateType) IsKnown() bool
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"`
// A numeric string.
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 ¶
func (r *BGPTopService) Prefixes(ctx context.Context, query BGPTopPrefixesParams, opts ...option.RequestOption) (res *BGPTopPrefixesResponse, err error)
Retrieves the top network prefixes by BGP updates.
type BgpipTimeseriesParamsFormat ¶
type BgpipTimeseriesParamsFormat string
Format in which results will be returned.
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 ¶
func (r BgpipTimeseriesParamsIPVersion) IsKnown() bool
type BgpipTimeseriesResponse ¶
type BgpipTimeseriesResponse struct {
// Metadata for the results.
Meta BgpipTimeseriesResponseMeta `json:"meta,required"`
Serie0 BgpipTimeseriesResponseSerie0 `json:"serie_0,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 {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval BgpipTimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo BgpipTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []BgpipTimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization BgpipTimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []BgpipTimeseriesResponseMetaUnit `json:"units,required"`
Delay BgpipTimeseriesResponseMetaDelay `json:"delay"`
JSON bgpipTimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*BgpipTimeseriesResponseMeta) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaAggInterval ¶
type BgpipTimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( BgpipTimeseriesResponseMetaAggIntervalFifteenMinutes BgpipTimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" BgpipTimeseriesResponseMetaAggIntervalOneHour BgpipTimeseriesResponseMetaAggInterval = "ONE_HOUR" BgpipTimeseriesResponseMetaAggIntervalOneDay BgpipTimeseriesResponseMetaAggInterval = "ONE_DAY" BgpipTimeseriesResponseMetaAggIntervalOneWeek BgpipTimeseriesResponseMetaAggInterval = "ONE_WEEK" BgpipTimeseriesResponseMetaAggIntervalOneMonth BgpipTimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (BgpipTimeseriesResponseMetaAggInterval) IsKnown ¶
func (r BgpipTimeseriesResponseMetaAggInterval) IsKnown() bool
type BgpipTimeseriesResponseMetaConfidenceInfo ¶
type BgpipTimeseriesResponseMetaConfidenceInfo struct {
Annotations []BgpipTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON bgpipTimeseriesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaConfidenceInfoAnnotation ¶
type BgpipTimeseriesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON bgpipTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*BgpipTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaDateRange ¶
type BgpipTimeseriesResponseMetaDateRange 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 bgpipTimeseriesResponseMetaDateRangeJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaDateRange) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaDelay ¶
type BgpipTimeseriesResponseMetaDelay struct {
ASNData BgpipTimeseriesResponseMetaDelayASNData `json:"asn_data,required"`
CountryData BgpipTimeseriesResponseMetaDelayCountryData `json:"country_data,required"`
Healthy bool `json:"healthy,required"`
NowTs float64 `json:"nowTs,required"`
JSON bgpipTimeseriesResponseMetaDelayJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaDelay) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaDelay) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaDelayASNData ¶
type BgpipTimeseriesResponseMetaDelayASNData struct {
DelaySecs float64 `json:"delaySecs,required"`
DelayStr string `json:"delayStr,required"`
Healthy bool `json:"healthy,required"`
Latest BgpipTimeseriesResponseMetaDelayASNDataLatest `json:"latest,required"`
JSON bgpipTimeseriesResponseMetaDelayASNDataJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaDelayASNData) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaDelayASNData) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaDelayASNDataLatest ¶
type BgpipTimeseriesResponseMetaDelayASNDataLatest struct {
EntriesCount float64 `json:"entries_count,required"`
Path string `json:"path,required"`
Timestamp float64 `json:"timestamp,required"`
JSON bgpipTimeseriesResponseMetaDelayASNDataLatestJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaDelayASNDataLatest) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaDelayASNDataLatest) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaDelayCountryData ¶
type BgpipTimeseriesResponseMetaDelayCountryData struct {
DelaySecs float64 `json:"delaySecs,required"`
DelayStr string `json:"delayStr,required"`
Healthy bool `json:"healthy,required"`
Latest BgpipTimeseriesResponseMetaDelayCountryDataLatest `json:"latest,required"`
JSON bgpipTimeseriesResponseMetaDelayCountryDataJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaDelayCountryData) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaDelayCountryData) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaDelayCountryDataLatest ¶
type BgpipTimeseriesResponseMetaDelayCountryDataLatest struct {
Count float64 `json:"count,required"`
Timestamp float64 `json:"timestamp,required"`
JSON bgpipTimeseriesResponseMetaDelayCountryDataLatestJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaDelayCountryDataLatest) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaDelayCountryDataLatest) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseMetaNormalization ¶
type BgpipTimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( BgpipTimeseriesResponseMetaNormalizationPercentage BgpipTimeseriesResponseMetaNormalization = "PERCENTAGE" BgpipTimeseriesResponseMetaNormalizationMin0Max BgpipTimeseriesResponseMetaNormalization = "MIN0_MAX" BgpipTimeseriesResponseMetaNormalizationMinMax BgpipTimeseriesResponseMetaNormalization = "MIN_MAX" BgpipTimeseriesResponseMetaNormalizationRawValues BgpipTimeseriesResponseMetaNormalization = "RAW_VALUES" BgpipTimeseriesResponseMetaNormalizationPercentageChange BgpipTimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" BgpipTimeseriesResponseMetaNormalizationRollingAverage BgpipTimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" BgpipTimeseriesResponseMetaNormalizationOverlappedPercentage BgpipTimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" BgpipTimeseriesResponseMetaNormalizationRatio BgpipTimeseriesResponseMetaNormalization = "RATIO" )
func (BgpipTimeseriesResponseMetaNormalization) IsKnown ¶
func (r BgpipTimeseriesResponseMetaNormalization) IsKnown() bool
type BgpipTimeseriesResponseMetaUnit ¶
type BgpipTimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON bgpipTimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*BgpipTimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type BgpipTimeseriesResponseSerie0 ¶
type BgpipTimeseriesResponseSerie0 struct {
IPV4 []string `json:"ipv4,required"`
IPV6 []string `json:"ipv6,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON bgpipTimeseriesResponseSerie0JSON `json:"-"`
}
func (*BgpipTimeseriesResponseSerie0) UnmarshalJSON ¶
func (r *BgpipTimeseriesResponseSerie0) UnmarshalJSON(data []byte) (err error)
type BotGetParams ¶
type BotGetParams struct {
// Format in which results will be returned.
Format param.Field[BotGetParamsFormat] `query:"format"`
}
func (BotGetParams) URLQuery ¶
func (r BotGetParams) URLQuery() (v url.Values)
URLQuery serializes BotGetParams's query parameters as `url.Values`.
type BotGetParamsFormat ¶
type BotGetParamsFormat string
Format in which results will be returned.
const ( BotGetParamsFormatJson BotGetParamsFormat = "JSON" BotGetParamsFormatCsv BotGetParamsFormat = "CSV" )
func (BotGetParamsFormat) IsKnown ¶
func (r BotGetParamsFormat) IsKnown() bool
type BotGetResponse ¶
type BotGetResponse struct {
Bot BotGetResponseBot `json:"bot,required"`
JSON botGetResponseJSON `json:"-"`
}
func (*BotGetResponse) UnmarshalJSON ¶
func (r *BotGetResponse) UnmarshalJSON(data []byte) (err error)
type BotGetResponseBot ¶
type BotGetResponseBot struct {
// The category of the bot.
Category string `json:"category,required"`
// A summary for the bot (e.g., purpose).
Description string `json:"description,required"`
// The name of the bot.
Name string `json:"name,required"`
// The organization that owns and operates the bot.
Operator string `json:"operator,required"`
// The link to the bot documentation.
OperatorURL string `json:"operatorUrl,required"`
// A kebab-case identifier derived from the bot name.
Slug string `json:"slug,required"`
UserAgentPatterns []string `json:"userAgentPatterns,required"`
UserAgents []string `json:"userAgents,required"`
JSON botGetResponseBotJSON `json:"-"`
}
func (*BotGetResponseBot) UnmarshalJSON ¶
func (r *BotGetResponseBot) UnmarshalJSON(data []byte) (err error)
type BotGetResponseEnvelope ¶
type BotGetResponseEnvelope struct {
Result BotGetResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON botGetResponseEnvelopeJSON `json:"-"`
}
func (*BotGetResponseEnvelope) UnmarshalJSON ¶
func (r *BotGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BotListParams ¶
type BotListParams struct {
// Filters results by bot category.
BotCategory param.Field[BotListParamsBotCategory] `query:"botCategory"`
// Filters results by bot operator.
BotOperator param.Field[string] `query:"botOperator"`
// Filters results by bot verification status.
BotVerificationStatus param.Field[BotListParamsBotVerificationStatus] `query:"botVerificationStatus"`
// Format in which results will be returned.
Format param.Field[BotListParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Skips the specified number of objects before fetching the results.
Offset param.Field[int64] `query:"offset"`
}
func (BotListParams) URLQuery ¶
func (r BotListParams) URLQuery() (v url.Values)
URLQuery serializes BotListParams's query parameters as `url.Values`.
type BotListParamsBotCategory ¶
type BotListParamsBotCategory string
Filters results by bot category.
const ( BotListParamsBotCategorySearchEngineCrawler BotListParamsBotCategory = "SEARCH_ENGINE_CRAWLER" BotListParamsBotCategorySearchEngineOptimization BotListParamsBotCategory = "SEARCH_ENGINE_OPTIMIZATION" BotListParamsBotCategoryMonitoringAndAnalytics BotListParamsBotCategory = "MONITORING_AND_ANALYTICS" BotListParamsBotCategoryAdvertisingAndMarketing BotListParamsBotCategory = "ADVERTISING_AND_MARKETING" BotListParamsBotCategorySocialMediaMarketing BotListParamsBotCategory = "SOCIAL_MEDIA_MARKETING" BotListParamsBotCategoryPagePreview BotListParamsBotCategory = "PAGE_PREVIEW" BotListParamsBotCategoryAcademicResearch BotListParamsBotCategory = "ACADEMIC_RESEARCH" BotListParamsBotCategorySecurity BotListParamsBotCategory = "SECURITY" BotListParamsBotCategoryAccessibility BotListParamsBotCategory = "ACCESSIBILITY" BotListParamsBotCategoryWebhooks BotListParamsBotCategory = "WEBHOOKS" BotListParamsBotCategoryFeedFetcher BotListParamsBotCategory = "FEED_FETCHER" BotListParamsBotCategoryAICrawler BotListParamsBotCategory = "AI_CRAWLER" BotListParamsBotCategoryAggregator BotListParamsBotCategory = "AGGREGATOR" BotListParamsBotCategoryAIAssistant BotListParamsBotCategory = "AI_ASSISTANT" BotListParamsBotCategoryAISearch BotListParamsBotCategory = "AI_SEARCH" BotListParamsBotCategoryArchiver BotListParamsBotCategory = "ARCHIVER" )
func (BotListParamsBotCategory) IsKnown ¶
func (r BotListParamsBotCategory) IsKnown() bool
type BotListParamsBotVerificationStatus ¶
type BotListParamsBotVerificationStatus string
Filters results by bot verification status.
const (
BotListParamsBotVerificationStatusVerified BotListParamsBotVerificationStatus = "VERIFIED"
)
func (BotListParamsBotVerificationStatus) IsKnown ¶
func (r BotListParamsBotVerificationStatus) IsKnown() bool
type BotListParamsFormat ¶
type BotListParamsFormat string
Format in which results will be returned.
const ( BotListParamsFormatJson BotListParamsFormat = "JSON" BotListParamsFormatCsv BotListParamsFormat = "CSV" )
func (BotListParamsFormat) IsKnown ¶
func (r BotListParamsFormat) IsKnown() bool
type BotListResponse ¶
type BotListResponse struct {
Bots []BotListResponseBot `json:"bots,required"`
JSON botListResponseJSON `json:"-"`
}
func (*BotListResponse) UnmarshalJSON ¶
func (r *BotListResponse) UnmarshalJSON(data []byte) (err error)
type BotListResponseBot ¶
type BotListResponseBot struct {
// The category of the bot.
Category string `json:"category,required"`
// A summary for the bot (e.g., purpose).
Description string `json:"description,required"`
// The name of the bot.
Name string `json:"name,required"`
// The organization that owns and operates the bot.
Operator string `json:"operator,required"`
// A kebab-case identifier derived from the bot name.
Slug string `json:"slug,required"`
JSON botListResponseBotJSON `json:"-"`
}
func (*BotListResponseBot) UnmarshalJSON ¶
func (r *BotListResponseBot) UnmarshalJSON(data []byte) (err error)
type BotListResponseEnvelope ¶
type BotListResponseEnvelope struct {
Result BotListResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON botListResponseEnvelopeJSON `json:"-"`
}
func (*BotListResponseEnvelope) UnmarshalJSON ¶
func (r *BotListResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BotService ¶
type BotService struct {
Options []option.RequestOption
WebCrawlers *BotWebCrawlerService
}
BotService 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 NewBotService method instead.
func NewBotService ¶
func NewBotService(opts ...option.RequestOption) (r *BotService)
NewBotService 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 (*BotService) Get ¶
func (r *BotService) Get(ctx context.Context, botSlug string, query BotGetParams, opts ...option.RequestOption) (res *BotGetResponse, err error)
Retrieves the requested bot information.
func (*BotService) List ¶
func (r *BotService) List(ctx context.Context, query BotListParams, opts ...option.RequestOption) (res *BotListResponse, err error)
Retrieves a list of bots.
func (*BotService) Summary ¶
func (r *BotService) Summary(ctx context.Context, dimension BotSummaryParamsDimension, query BotSummaryParams, opts ...option.RequestOption) (res *BotSummaryResponse, err error)
Retrieves an aggregated summary of bots HTTP requests grouped by the specified dimension.
func (*BotService) Timeseries ¶
func (r *BotService) Timeseries(ctx context.Context, query BotTimeseriesParams, opts ...option.RequestOption) (res *BotTimeseriesResponse, err error)
Retrieves bots HTTP request volume over time.
func (*BotService) TimeseriesGroups ¶
func (r *BotService) TimeseriesGroups(ctx context.Context, dimension BotTimeseriesGroupsParamsDimension, query BotTimeseriesGroupsParams, opts ...option.RequestOption) (res *BotTimeseriesGroupsResponse, err error)
Retrieves the distribution of HTTP requests from bots, grouped by chosen the specified dimension over time.
type BotSummaryParams ¶
type BotSummaryParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot name.
Bot param.Field[[]string] `query:"bot"`
// Filters results by bot category.
BotCategory param.Field[[]BotSummaryParamsBotCategory] `query:"botCategory"`
// Filters results by bot operator.
BotOperator param.Field[[]string] `query:"botOperator"`
// Filters results by bot verification status (Verified vs. Unverified).
BotVerificationStatus param.Field[[]BotSummaryParamsBotVerificationStatus] `query:"botVerificationStatus"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BotSummaryParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (BotSummaryParams) URLQuery ¶
func (r BotSummaryParams) URLQuery() (v url.Values)
URLQuery serializes BotSummaryParams's query parameters as `url.Values`.
type BotSummaryParamsBotCategory ¶
type BotSummaryParamsBotCategory string
The category of the bot.
const ( BotSummaryParamsBotCategorySearchEngineCrawler BotSummaryParamsBotCategory = "SEARCH_ENGINE_CRAWLER" BotSummaryParamsBotCategorySearchEngineOptimization BotSummaryParamsBotCategory = "SEARCH_ENGINE_OPTIMIZATION" BotSummaryParamsBotCategoryMonitoringAndAnalytics BotSummaryParamsBotCategory = "MONITORING_AND_ANALYTICS" BotSummaryParamsBotCategoryAdvertisingAndMarketing BotSummaryParamsBotCategory = "ADVERTISING_AND_MARKETING" BotSummaryParamsBotCategorySocialMediaMarketing BotSummaryParamsBotCategory = "SOCIAL_MEDIA_MARKETING" BotSummaryParamsBotCategoryPagePreview BotSummaryParamsBotCategory = "PAGE_PREVIEW" BotSummaryParamsBotCategoryAcademicResearch BotSummaryParamsBotCategory = "ACADEMIC_RESEARCH" BotSummaryParamsBotCategorySecurity BotSummaryParamsBotCategory = "SECURITY" BotSummaryParamsBotCategoryAccessibility BotSummaryParamsBotCategory = "ACCESSIBILITY" BotSummaryParamsBotCategoryWebhooks BotSummaryParamsBotCategory = "WEBHOOKS" BotSummaryParamsBotCategoryFeedFetcher BotSummaryParamsBotCategory = "FEED_FETCHER" BotSummaryParamsBotCategoryAICrawler BotSummaryParamsBotCategory = "AI_CRAWLER" BotSummaryParamsBotCategoryAggregator BotSummaryParamsBotCategory = "AGGREGATOR" BotSummaryParamsBotCategoryAIAssistant BotSummaryParamsBotCategory = "AI_ASSISTANT" BotSummaryParamsBotCategoryAISearch BotSummaryParamsBotCategory = "AI_SEARCH" BotSummaryParamsBotCategoryArchiver BotSummaryParamsBotCategory = "ARCHIVER" )
func (BotSummaryParamsBotCategory) IsKnown ¶
func (r BotSummaryParamsBotCategory) IsKnown() bool
type BotSummaryParamsBotVerificationStatus ¶
type BotSummaryParamsBotVerificationStatus string
The category of the bot.
const (
BotSummaryParamsBotVerificationStatusVerified BotSummaryParamsBotVerificationStatus = "VERIFIED"
)
func (BotSummaryParamsBotVerificationStatus) IsKnown ¶
func (r BotSummaryParamsBotVerificationStatus) IsKnown() bool
type BotSummaryParamsDimension ¶
type BotSummaryParamsDimension string
Specifies the attribute by which to group the results.
const ( BotSummaryParamsDimensionBot BotSummaryParamsDimension = "BOT" BotSummaryParamsDimensionBotOperator BotSummaryParamsDimension = "BOT_OPERATOR" BotSummaryParamsDimensionBotCategory BotSummaryParamsDimension = "BOT_CATEGORY" )
func (BotSummaryParamsDimension) IsKnown ¶
func (r BotSummaryParamsDimension) IsKnown() bool
type BotSummaryParamsFormat ¶
type BotSummaryParamsFormat string
Format in which results will be returned.
const ( BotSummaryParamsFormatJson BotSummaryParamsFormat = "JSON" BotSummaryParamsFormatCsv BotSummaryParamsFormat = "CSV" )
func (BotSummaryParamsFormat) IsKnown ¶
func (r BotSummaryParamsFormat) IsKnown() bool
type BotSummaryResponse ¶
type BotSummaryResponse struct {
// Metadata for the results.
Meta BotSummaryResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON botSummaryResponseJSON `json:"-"`
}
func (*BotSummaryResponse) UnmarshalJSON ¶
func (r *BotSummaryResponse) UnmarshalJSON(data []byte) (err error)
type BotSummaryResponseEnvelope ¶
type BotSummaryResponseEnvelope struct {
Result BotSummaryResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON botSummaryResponseEnvelopeJSON `json:"-"`
}
func (*BotSummaryResponseEnvelope) UnmarshalJSON ¶
func (r *BotSummaryResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BotSummaryResponseMeta ¶
type BotSummaryResponseMeta struct {
ConfidenceInfo BotSummaryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []BotSummaryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization BotSummaryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []BotSummaryResponseMetaUnit `json:"units,required"`
JSON botSummaryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*BotSummaryResponseMeta) UnmarshalJSON ¶
func (r *BotSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)
type BotSummaryResponseMetaConfidenceInfo ¶
type BotSummaryResponseMetaConfidenceInfo struct {
Annotations []BotSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON botSummaryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*BotSummaryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *BotSummaryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type BotSummaryResponseMetaConfidenceInfoAnnotation ¶
type BotSummaryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON botSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*BotSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *BotSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type BotSummaryResponseMetaDateRange ¶
type BotSummaryResponseMetaDateRange 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 botSummaryResponseMetaDateRangeJSON `json:"-"`
}
func (*BotSummaryResponseMetaDateRange) UnmarshalJSON ¶
func (r *BotSummaryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type BotSummaryResponseMetaNormalization ¶
type BotSummaryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( BotSummaryResponseMetaNormalizationPercentage BotSummaryResponseMetaNormalization = "PERCENTAGE" BotSummaryResponseMetaNormalizationMin0Max BotSummaryResponseMetaNormalization = "MIN0_MAX" BotSummaryResponseMetaNormalizationMinMax BotSummaryResponseMetaNormalization = "MIN_MAX" BotSummaryResponseMetaNormalizationRawValues BotSummaryResponseMetaNormalization = "RAW_VALUES" BotSummaryResponseMetaNormalizationPercentageChange BotSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE" BotSummaryResponseMetaNormalizationRollingAverage BotSummaryResponseMetaNormalization = "ROLLING_AVERAGE" BotSummaryResponseMetaNormalizationOverlappedPercentage BotSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" BotSummaryResponseMetaNormalizationRatio BotSummaryResponseMetaNormalization = "RATIO" )
func (BotSummaryResponseMetaNormalization) IsKnown ¶
func (r BotSummaryResponseMetaNormalization) IsKnown() bool
type BotSummaryResponseMetaUnit ¶
type BotSummaryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON botSummaryResponseMetaUnitJSON `json:"-"`
}
func (*BotSummaryResponseMetaUnit) UnmarshalJSON ¶
func (r *BotSummaryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsParams ¶
type BotTimeseriesGroupsParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[BotTimeseriesGroupsParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot name.
Bot param.Field[[]string] `query:"bot"`
// Filters results by bot category.
BotCategory param.Field[[]BotTimeseriesGroupsParamsBotCategory] `query:"botCategory"`
// Filters results by bot operator.
BotOperator param.Field[[]string] `query:"botOperator"`
// Filters results by bot verification status (Verified vs. Unverified).
BotVerificationStatus param.Field[[]BotTimeseriesGroupsParamsBotVerificationStatus] `query:"botVerificationStatus"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BotTimeseriesGroupsParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (BotTimeseriesGroupsParams) URLQuery ¶
func (r BotTimeseriesGroupsParams) URLQuery() (v url.Values)
URLQuery serializes BotTimeseriesGroupsParams's query parameters as `url.Values`.
type BotTimeseriesGroupsParamsAggInterval ¶
type BotTimeseriesGroupsParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( BotTimeseriesGroupsParamsAggInterval15m BotTimeseriesGroupsParamsAggInterval = "15m" BotTimeseriesGroupsParamsAggInterval1h BotTimeseriesGroupsParamsAggInterval = "1h" BotTimeseriesGroupsParamsAggInterval1d BotTimeseriesGroupsParamsAggInterval = "1d" BotTimeseriesGroupsParamsAggInterval1w BotTimeseriesGroupsParamsAggInterval = "1w" )
func (BotTimeseriesGroupsParamsAggInterval) IsKnown ¶
func (r BotTimeseriesGroupsParamsAggInterval) IsKnown() bool
type BotTimeseriesGroupsParamsBotCategory ¶
type BotTimeseriesGroupsParamsBotCategory string
The category of the bot.
const ( BotTimeseriesGroupsParamsBotCategorySearchEngineCrawler BotTimeseriesGroupsParamsBotCategory = "SEARCH_ENGINE_CRAWLER" BotTimeseriesGroupsParamsBotCategorySearchEngineOptimization BotTimeseriesGroupsParamsBotCategory = "SEARCH_ENGINE_OPTIMIZATION" BotTimeseriesGroupsParamsBotCategoryMonitoringAndAnalytics BotTimeseriesGroupsParamsBotCategory = "MONITORING_AND_ANALYTICS" BotTimeseriesGroupsParamsBotCategoryAdvertisingAndMarketing BotTimeseriesGroupsParamsBotCategory = "ADVERTISING_AND_MARKETING" BotTimeseriesGroupsParamsBotCategorySocialMediaMarketing BotTimeseriesGroupsParamsBotCategory = "SOCIAL_MEDIA_MARKETING" BotTimeseriesGroupsParamsBotCategoryPagePreview BotTimeseriesGroupsParamsBotCategory = "PAGE_PREVIEW" BotTimeseriesGroupsParamsBotCategoryAcademicResearch BotTimeseriesGroupsParamsBotCategory = "ACADEMIC_RESEARCH" BotTimeseriesGroupsParamsBotCategorySecurity BotTimeseriesGroupsParamsBotCategory = "SECURITY" BotTimeseriesGroupsParamsBotCategoryAccessibility BotTimeseriesGroupsParamsBotCategory = "ACCESSIBILITY" BotTimeseriesGroupsParamsBotCategoryWebhooks BotTimeseriesGroupsParamsBotCategory = "WEBHOOKS" BotTimeseriesGroupsParamsBotCategoryFeedFetcher BotTimeseriesGroupsParamsBotCategory = "FEED_FETCHER" BotTimeseriesGroupsParamsBotCategoryAICrawler BotTimeseriesGroupsParamsBotCategory = "AI_CRAWLER" BotTimeseriesGroupsParamsBotCategoryAggregator BotTimeseriesGroupsParamsBotCategory = "AGGREGATOR" BotTimeseriesGroupsParamsBotCategoryAIAssistant BotTimeseriesGroupsParamsBotCategory = "AI_ASSISTANT" BotTimeseriesGroupsParamsBotCategoryAISearch BotTimeseriesGroupsParamsBotCategory = "AI_SEARCH" BotTimeseriesGroupsParamsBotCategoryArchiver BotTimeseriesGroupsParamsBotCategory = "ARCHIVER" )
func (BotTimeseriesGroupsParamsBotCategory) IsKnown ¶
func (r BotTimeseriesGroupsParamsBotCategory) IsKnown() bool
type BotTimeseriesGroupsParamsBotVerificationStatus ¶
type BotTimeseriesGroupsParamsBotVerificationStatus string
The category of the bot.
const (
BotTimeseriesGroupsParamsBotVerificationStatusVerified BotTimeseriesGroupsParamsBotVerificationStatus = "VERIFIED"
)
func (BotTimeseriesGroupsParamsBotVerificationStatus) IsKnown ¶
func (r BotTimeseriesGroupsParamsBotVerificationStatus) IsKnown() bool
type BotTimeseriesGroupsParamsDimension ¶
type BotTimeseriesGroupsParamsDimension string
Specifies the attribute by which to group the results.
const ( BotTimeseriesGroupsParamsDimensionBot BotTimeseriesGroupsParamsDimension = "BOT" BotTimeseriesGroupsParamsDimensionBotOperator BotTimeseriesGroupsParamsDimension = "BOT_OPERATOR" BotTimeseriesGroupsParamsDimensionBotCategory BotTimeseriesGroupsParamsDimension = "BOT_CATEGORY" )
func (BotTimeseriesGroupsParamsDimension) IsKnown ¶
func (r BotTimeseriesGroupsParamsDimension) IsKnown() bool
type BotTimeseriesGroupsParamsFormat ¶
type BotTimeseriesGroupsParamsFormat string
Format in which results will be returned.
const ( BotTimeseriesGroupsParamsFormatJson BotTimeseriesGroupsParamsFormat = "JSON" BotTimeseriesGroupsParamsFormatCsv BotTimeseriesGroupsParamsFormat = "CSV" )
func (BotTimeseriesGroupsParamsFormat) IsKnown ¶
func (r BotTimeseriesGroupsParamsFormat) IsKnown() bool
type BotTimeseriesGroupsResponse ¶
type BotTimeseriesGroupsResponse struct {
// Metadata for the results.
Meta BotTimeseriesGroupsResponseMeta `json:"meta,required"`
Serie0 BotTimeseriesGroupsResponseSerie0 `json:"serie_0,required"`
JSON botTimeseriesGroupsResponseJSON `json:"-"`
}
func (*BotTimeseriesGroupsResponse) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponse) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsResponseEnvelope ¶
type BotTimeseriesGroupsResponseEnvelope struct {
Result BotTimeseriesGroupsResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON botTimeseriesGroupsResponseEnvelopeJSON `json:"-"`
}
func (*BotTimeseriesGroupsResponseEnvelope) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsResponseMeta ¶
type BotTimeseriesGroupsResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval BotTimeseriesGroupsResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo BotTimeseriesGroupsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []BotTimeseriesGroupsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization BotTimeseriesGroupsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []BotTimeseriesGroupsResponseMetaUnit `json:"units,required"`
JSON botTimeseriesGroupsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*BotTimeseriesGroupsResponseMeta) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsResponseMetaAggInterval ¶
type BotTimeseriesGroupsResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( BotTimeseriesGroupsResponseMetaAggIntervalFifteenMinutes BotTimeseriesGroupsResponseMetaAggInterval = "FIFTEEN_MINUTES" BotTimeseriesGroupsResponseMetaAggIntervalOneHour BotTimeseriesGroupsResponseMetaAggInterval = "ONE_HOUR" BotTimeseriesGroupsResponseMetaAggIntervalOneDay BotTimeseriesGroupsResponseMetaAggInterval = "ONE_DAY" BotTimeseriesGroupsResponseMetaAggIntervalOneWeek BotTimeseriesGroupsResponseMetaAggInterval = "ONE_WEEK" BotTimeseriesGroupsResponseMetaAggIntervalOneMonth BotTimeseriesGroupsResponseMetaAggInterval = "ONE_MONTH" )
func (BotTimeseriesGroupsResponseMetaAggInterval) IsKnown ¶
func (r BotTimeseriesGroupsResponseMetaAggInterval) IsKnown() bool
type BotTimeseriesGroupsResponseMetaConfidenceInfo ¶
type BotTimeseriesGroupsResponseMetaConfidenceInfo struct {
Annotations []BotTimeseriesGroupsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON botTimeseriesGroupsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*BotTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsResponseMetaConfidenceInfoAnnotation ¶
type BotTimeseriesGroupsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON botTimeseriesGroupsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*BotTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsResponseMetaDateRange ¶
type BotTimeseriesGroupsResponseMetaDateRange 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 botTimeseriesGroupsResponseMetaDateRangeJSON `json:"-"`
}
func (*BotTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsResponseMetaNormalization ¶
type BotTimeseriesGroupsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( BotTimeseriesGroupsResponseMetaNormalizationPercentage BotTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE" BotTimeseriesGroupsResponseMetaNormalizationMin0Max BotTimeseriesGroupsResponseMetaNormalization = "MIN0_MAX" BotTimeseriesGroupsResponseMetaNormalizationMinMax BotTimeseriesGroupsResponseMetaNormalization = "MIN_MAX" BotTimeseriesGroupsResponseMetaNormalizationRawValues BotTimeseriesGroupsResponseMetaNormalization = "RAW_VALUES" BotTimeseriesGroupsResponseMetaNormalizationPercentageChange BotTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE_CHANGE" BotTimeseriesGroupsResponseMetaNormalizationRollingAverage BotTimeseriesGroupsResponseMetaNormalization = "ROLLING_AVERAGE" BotTimeseriesGroupsResponseMetaNormalizationOverlappedPercentage BotTimeseriesGroupsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" BotTimeseriesGroupsResponseMetaNormalizationRatio BotTimeseriesGroupsResponseMetaNormalization = "RATIO" )
func (BotTimeseriesGroupsResponseMetaNormalization) IsKnown ¶
func (r BotTimeseriesGroupsResponseMetaNormalization) IsKnown() bool
type BotTimeseriesGroupsResponseMetaUnit ¶
type BotTimeseriesGroupsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON botTimeseriesGroupsResponseMetaUnitJSON `json:"-"`
}
func (*BotTimeseriesGroupsResponseMetaUnit) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesGroupsResponseSerie0 ¶
type BotTimeseriesGroupsResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON botTimeseriesGroupsResponseSerie0JSON `json:"-"`
}
func (*BotTimeseriesGroupsResponseSerie0) UnmarshalJSON ¶
func (r *BotTimeseriesGroupsResponseSerie0) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesParams ¶
type BotTimeseriesParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[BotTimeseriesParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot name.
Bot param.Field[[]string] `query:"bot"`
// Filters results by bot category.
BotCategory param.Field[[]BotTimeseriesParamsBotCategory] `query:"botCategory"`
// Filters results by bot operator.
BotOperator param.Field[[]string] `query:"botOperator"`
// Filters results by bot verification status (Verified vs. Unverified).
BotVerificationStatus param.Field[[]BotTimeseriesParamsBotVerificationStatus] `query:"botVerificationStatus"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BotTimeseriesParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (BotTimeseriesParams) URLQuery ¶
func (r BotTimeseriesParams) URLQuery() (v url.Values)
URLQuery serializes BotTimeseriesParams's query parameters as `url.Values`.
type BotTimeseriesParamsAggInterval ¶
type BotTimeseriesParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( BotTimeseriesParamsAggInterval15m BotTimeseriesParamsAggInterval = "15m" BotTimeseriesParamsAggInterval1h BotTimeseriesParamsAggInterval = "1h" BotTimeseriesParamsAggInterval1d BotTimeseriesParamsAggInterval = "1d" BotTimeseriesParamsAggInterval1w BotTimeseriesParamsAggInterval = "1w" )
func (BotTimeseriesParamsAggInterval) IsKnown ¶
func (r BotTimeseriesParamsAggInterval) IsKnown() bool
type BotTimeseriesParamsBotCategory ¶
type BotTimeseriesParamsBotCategory string
The category of the bot.
const ( BotTimeseriesParamsBotCategorySearchEngineCrawler BotTimeseriesParamsBotCategory = "SEARCH_ENGINE_CRAWLER" BotTimeseriesParamsBotCategorySearchEngineOptimization BotTimeseriesParamsBotCategory = "SEARCH_ENGINE_OPTIMIZATION" BotTimeseriesParamsBotCategoryMonitoringAndAnalytics BotTimeseriesParamsBotCategory = "MONITORING_AND_ANALYTICS" BotTimeseriesParamsBotCategoryAdvertisingAndMarketing BotTimeseriesParamsBotCategory = "ADVERTISING_AND_MARKETING" BotTimeseriesParamsBotCategorySocialMediaMarketing BotTimeseriesParamsBotCategory = "SOCIAL_MEDIA_MARKETING" BotTimeseriesParamsBotCategoryPagePreview BotTimeseriesParamsBotCategory = "PAGE_PREVIEW" BotTimeseriesParamsBotCategoryAcademicResearch BotTimeseriesParamsBotCategory = "ACADEMIC_RESEARCH" BotTimeseriesParamsBotCategorySecurity BotTimeseriesParamsBotCategory = "SECURITY" BotTimeseriesParamsBotCategoryAccessibility BotTimeseriesParamsBotCategory = "ACCESSIBILITY" BotTimeseriesParamsBotCategoryWebhooks BotTimeseriesParamsBotCategory = "WEBHOOKS" BotTimeseriesParamsBotCategoryFeedFetcher BotTimeseriesParamsBotCategory = "FEED_FETCHER" BotTimeseriesParamsBotCategoryAICrawler BotTimeseriesParamsBotCategory = "AI_CRAWLER" BotTimeseriesParamsBotCategoryAggregator BotTimeseriesParamsBotCategory = "AGGREGATOR" BotTimeseriesParamsBotCategoryAIAssistant BotTimeseriesParamsBotCategory = "AI_ASSISTANT" BotTimeseriesParamsBotCategoryAISearch BotTimeseriesParamsBotCategory = "AI_SEARCH" BotTimeseriesParamsBotCategoryArchiver BotTimeseriesParamsBotCategory = "ARCHIVER" )
func (BotTimeseriesParamsBotCategory) IsKnown ¶
func (r BotTimeseriesParamsBotCategory) IsKnown() bool
type BotTimeseriesParamsBotVerificationStatus ¶
type BotTimeseriesParamsBotVerificationStatus string
The category of the bot.
const (
BotTimeseriesParamsBotVerificationStatusVerified BotTimeseriesParamsBotVerificationStatus = "VERIFIED"
)
func (BotTimeseriesParamsBotVerificationStatus) IsKnown ¶
func (r BotTimeseriesParamsBotVerificationStatus) IsKnown() bool
type BotTimeseriesParamsFormat ¶
type BotTimeseriesParamsFormat string
Format in which results will be returned.
const ( BotTimeseriesParamsFormatJson BotTimeseriesParamsFormat = "JSON" BotTimeseriesParamsFormatCsv BotTimeseriesParamsFormat = "CSV" )
func (BotTimeseriesParamsFormat) IsKnown ¶
func (r BotTimeseriesParamsFormat) IsKnown() bool
type BotTimeseriesResponse ¶
type BotTimeseriesResponse struct {
// Metadata for the results.
Meta BotTimeseriesResponseMeta `json:"meta,required"`
ExtraFields map[string]BotTimeseriesResponse `json:"-,extras"`
JSON botTimeseriesResponseJSON `json:"-"`
}
func (*BotTimeseriesResponse) UnmarshalJSON ¶
func (r *BotTimeseriesResponse) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesResponseEnvelope ¶
type BotTimeseriesResponseEnvelope struct {
Result BotTimeseriesResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON botTimeseriesResponseEnvelopeJSON `json:"-"`
}
func (*BotTimeseriesResponseEnvelope) UnmarshalJSON ¶
func (r *BotTimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesResponseMeta ¶
type BotTimeseriesResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval BotTimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo BotTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []BotTimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization BotTimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []BotTimeseriesResponseMetaUnit `json:"units,required"`
JSON botTimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*BotTimeseriesResponseMeta) UnmarshalJSON ¶
func (r *BotTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesResponseMetaAggInterval ¶
type BotTimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( BotTimeseriesResponseMetaAggIntervalFifteenMinutes BotTimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" BotTimeseriesResponseMetaAggIntervalOneHour BotTimeseriesResponseMetaAggInterval = "ONE_HOUR" BotTimeseriesResponseMetaAggIntervalOneDay BotTimeseriesResponseMetaAggInterval = "ONE_DAY" BotTimeseriesResponseMetaAggIntervalOneWeek BotTimeseriesResponseMetaAggInterval = "ONE_WEEK" BotTimeseriesResponseMetaAggIntervalOneMonth BotTimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (BotTimeseriesResponseMetaAggInterval) IsKnown ¶
func (r BotTimeseriesResponseMetaAggInterval) IsKnown() bool
type BotTimeseriesResponseMetaConfidenceInfo ¶
type BotTimeseriesResponseMetaConfidenceInfo struct {
Annotations []BotTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON botTimeseriesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*BotTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *BotTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesResponseMetaConfidenceInfoAnnotation ¶
type BotTimeseriesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON botTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*BotTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *BotTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesResponseMetaDateRange ¶
type BotTimeseriesResponseMetaDateRange 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 botTimeseriesResponseMetaDateRangeJSON `json:"-"`
}
func (*BotTimeseriesResponseMetaDateRange) UnmarshalJSON ¶
func (r *BotTimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type BotTimeseriesResponseMetaNormalization ¶
type BotTimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( BotTimeseriesResponseMetaNormalizationPercentage BotTimeseriesResponseMetaNormalization = "PERCENTAGE" BotTimeseriesResponseMetaNormalizationMin0Max BotTimeseriesResponseMetaNormalization = "MIN0_MAX" BotTimeseriesResponseMetaNormalizationMinMax BotTimeseriesResponseMetaNormalization = "MIN_MAX" BotTimeseriesResponseMetaNormalizationRawValues BotTimeseriesResponseMetaNormalization = "RAW_VALUES" BotTimeseriesResponseMetaNormalizationPercentageChange BotTimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" BotTimeseriesResponseMetaNormalizationRollingAverage BotTimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" BotTimeseriesResponseMetaNormalizationOverlappedPercentage BotTimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" BotTimeseriesResponseMetaNormalizationRatio BotTimeseriesResponseMetaNormalization = "RATIO" )
func (BotTimeseriesResponseMetaNormalization) IsKnown ¶
func (r BotTimeseriesResponseMetaNormalization) IsKnown() bool
type BotTimeseriesResponseMetaUnit ¶
type BotTimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON botTimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*BotTimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *BotTimeseriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerService ¶
type BotWebCrawlerService struct {
Options []option.RequestOption
}
BotWebCrawlerService 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 NewBotWebCrawlerService method instead.
func NewBotWebCrawlerService ¶
func NewBotWebCrawlerService(opts ...option.RequestOption) (r *BotWebCrawlerService)
NewBotWebCrawlerService 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 (*BotWebCrawlerService) Summary ¶
func (r *BotWebCrawlerService) Summary(ctx context.Context, dimension BotWebCrawlerSummaryParamsDimension, query BotWebCrawlerSummaryParams, opts ...option.RequestOption) (res *BotWebCrawlerSummaryResponse, err error)
Retrieves an aggregated summary of HTTP requests from crawlers, grouped by the specified dimension.
func (*BotWebCrawlerService) TimeseriesGroups ¶
func (r *BotWebCrawlerService) TimeseriesGroups(ctx context.Context, dimension BotWebCrawlerTimeseriesGroupsParamsDimension, query BotWebCrawlerTimeseriesGroupsParams, opts ...option.RequestOption) (res *BotWebCrawlerTimeseriesGroupsResponse, err error)
Retrieves the distribution of HTTP requests from crawlers, grouped by chosen the specified dimension over time.
type BotWebCrawlerSummaryParams ¶
type BotWebCrawlerSummaryParams struct {
// Filters results by bot operator.
BotOperator param.Field[[]string] `query:"botOperator"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BotWebCrawlerSummaryParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (BotWebCrawlerSummaryParams) URLQuery ¶
func (r BotWebCrawlerSummaryParams) URLQuery() (v url.Values)
URLQuery serializes BotWebCrawlerSummaryParams's query parameters as `url.Values`.
type BotWebCrawlerSummaryParamsDimension ¶
type BotWebCrawlerSummaryParamsDimension string
Specifies the attribute by which to group the results.
const ( BotWebCrawlerSummaryParamsDimensionUserAgent BotWebCrawlerSummaryParamsDimension = "USER_AGENT" BotWebCrawlerSummaryParamsDimensionReferer BotWebCrawlerSummaryParamsDimension = "REFERER" BotWebCrawlerSummaryParamsDimensionCrawlReferRatio BotWebCrawlerSummaryParamsDimension = "CRAWL_REFER_RATIO" )
func (BotWebCrawlerSummaryParamsDimension) IsKnown ¶
func (r BotWebCrawlerSummaryParamsDimension) IsKnown() bool
type BotWebCrawlerSummaryParamsFormat ¶
type BotWebCrawlerSummaryParamsFormat string
Format in which results will be returned.
const ( BotWebCrawlerSummaryParamsFormatJson BotWebCrawlerSummaryParamsFormat = "JSON" BotWebCrawlerSummaryParamsFormatCsv BotWebCrawlerSummaryParamsFormat = "CSV" )
func (BotWebCrawlerSummaryParamsFormat) IsKnown ¶
func (r BotWebCrawlerSummaryParamsFormat) IsKnown() bool
type BotWebCrawlerSummaryResponse ¶
type BotWebCrawlerSummaryResponse struct {
// Metadata for the results.
Meta BotWebCrawlerSummaryResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON botWebCrawlerSummaryResponseJSON `json:"-"`
}
func (*BotWebCrawlerSummaryResponse) UnmarshalJSON ¶
func (r *BotWebCrawlerSummaryResponse) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerSummaryResponseEnvelope ¶
type BotWebCrawlerSummaryResponseEnvelope struct {
Result BotWebCrawlerSummaryResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON botWebCrawlerSummaryResponseEnvelopeJSON `json:"-"`
}
func (*BotWebCrawlerSummaryResponseEnvelope) UnmarshalJSON ¶
func (r *BotWebCrawlerSummaryResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerSummaryResponseMeta ¶
type BotWebCrawlerSummaryResponseMeta struct {
ConfidenceInfo BotWebCrawlerSummaryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []BotWebCrawlerSummaryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization BotWebCrawlerSummaryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []BotWebCrawlerSummaryResponseMetaUnit `json:"units,required"`
JSON botWebCrawlerSummaryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*BotWebCrawlerSummaryResponseMeta) UnmarshalJSON ¶
func (r *BotWebCrawlerSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerSummaryResponseMetaConfidenceInfo ¶
type BotWebCrawlerSummaryResponseMetaConfidenceInfo struct {
Annotations []BotWebCrawlerSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON botWebCrawlerSummaryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*BotWebCrawlerSummaryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *BotWebCrawlerSummaryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerSummaryResponseMetaConfidenceInfoAnnotation ¶
type BotWebCrawlerSummaryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON botWebCrawlerSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*BotWebCrawlerSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *BotWebCrawlerSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerSummaryResponseMetaDateRange ¶
type BotWebCrawlerSummaryResponseMetaDateRange 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 botWebCrawlerSummaryResponseMetaDateRangeJSON `json:"-"`
}
func (*BotWebCrawlerSummaryResponseMetaDateRange) UnmarshalJSON ¶
func (r *BotWebCrawlerSummaryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerSummaryResponseMetaNormalization ¶
type BotWebCrawlerSummaryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( BotWebCrawlerSummaryResponseMetaNormalizationPercentage BotWebCrawlerSummaryResponseMetaNormalization = "PERCENTAGE" BotWebCrawlerSummaryResponseMetaNormalizationMin0Max BotWebCrawlerSummaryResponseMetaNormalization = "MIN0_MAX" BotWebCrawlerSummaryResponseMetaNormalizationMinMax BotWebCrawlerSummaryResponseMetaNormalization = "MIN_MAX" BotWebCrawlerSummaryResponseMetaNormalizationRawValues BotWebCrawlerSummaryResponseMetaNormalization = "RAW_VALUES" BotWebCrawlerSummaryResponseMetaNormalizationPercentageChange BotWebCrawlerSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE" BotWebCrawlerSummaryResponseMetaNormalizationRollingAverage BotWebCrawlerSummaryResponseMetaNormalization = "ROLLING_AVERAGE" BotWebCrawlerSummaryResponseMetaNormalizationOverlappedPercentage BotWebCrawlerSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" BotWebCrawlerSummaryResponseMetaNormalizationRatio BotWebCrawlerSummaryResponseMetaNormalization = "RATIO" )
func (BotWebCrawlerSummaryResponseMetaNormalization) IsKnown ¶
func (r BotWebCrawlerSummaryResponseMetaNormalization) IsKnown() bool
type BotWebCrawlerSummaryResponseMetaUnit ¶
type BotWebCrawlerSummaryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON botWebCrawlerSummaryResponseMetaUnitJSON `json:"-"`
}
func (*BotWebCrawlerSummaryResponseMetaUnit) UnmarshalJSON ¶
func (r *BotWebCrawlerSummaryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsParams ¶
type BotWebCrawlerTimeseriesGroupsParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[BotWebCrawlerTimeseriesGroupsParamsAggInterval] `query:"aggInterval"`
// Filters results by bot operator.
BotOperator param.Field[[]string] `query:"botOperator"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[BotWebCrawlerTimeseriesGroupsParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (BotWebCrawlerTimeseriesGroupsParams) URLQuery ¶
func (r BotWebCrawlerTimeseriesGroupsParams) URLQuery() (v url.Values)
URLQuery serializes BotWebCrawlerTimeseriesGroupsParams's query parameters as `url.Values`.
type BotWebCrawlerTimeseriesGroupsParamsAggInterval ¶
type BotWebCrawlerTimeseriesGroupsParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( BotWebCrawlerTimeseriesGroupsParamsAggInterval15m BotWebCrawlerTimeseriesGroupsParamsAggInterval = "15m" BotWebCrawlerTimeseriesGroupsParamsAggInterval1h BotWebCrawlerTimeseriesGroupsParamsAggInterval = "1h" BotWebCrawlerTimeseriesGroupsParamsAggInterval1d BotWebCrawlerTimeseriesGroupsParamsAggInterval = "1d" BotWebCrawlerTimeseriesGroupsParamsAggInterval1w BotWebCrawlerTimeseriesGroupsParamsAggInterval = "1w" )
func (BotWebCrawlerTimeseriesGroupsParamsAggInterval) IsKnown ¶
func (r BotWebCrawlerTimeseriesGroupsParamsAggInterval) IsKnown() bool
type BotWebCrawlerTimeseriesGroupsParamsDimension ¶
type BotWebCrawlerTimeseriesGroupsParamsDimension string
Specifies the attribute by which to group the results.
const ( BotWebCrawlerTimeseriesGroupsParamsDimensionUserAgent BotWebCrawlerTimeseriesGroupsParamsDimension = "USER_AGENT" BotWebCrawlerTimeseriesGroupsParamsDimensionReferer BotWebCrawlerTimeseriesGroupsParamsDimension = "REFERER" BotWebCrawlerTimeseriesGroupsParamsDimensionCrawlReferRatio BotWebCrawlerTimeseriesGroupsParamsDimension = "CRAWL_REFER_RATIO" )
func (BotWebCrawlerTimeseriesGroupsParamsDimension) IsKnown ¶
func (r BotWebCrawlerTimeseriesGroupsParamsDimension) IsKnown() bool
type BotWebCrawlerTimeseriesGroupsParamsFormat ¶
type BotWebCrawlerTimeseriesGroupsParamsFormat string
Format in which results will be returned.
const ( BotWebCrawlerTimeseriesGroupsParamsFormatJson BotWebCrawlerTimeseriesGroupsParamsFormat = "JSON" BotWebCrawlerTimeseriesGroupsParamsFormatCsv BotWebCrawlerTimeseriesGroupsParamsFormat = "CSV" )
func (BotWebCrawlerTimeseriesGroupsParamsFormat) IsKnown ¶
func (r BotWebCrawlerTimeseriesGroupsParamsFormat) IsKnown() bool
type BotWebCrawlerTimeseriesGroupsResponse ¶
type BotWebCrawlerTimeseriesGroupsResponse struct {
// Metadata for the results.
Meta BotWebCrawlerTimeseriesGroupsResponseMeta `json:"meta,required"`
Serie0 BotWebCrawlerTimeseriesGroupsResponseSerie0 `json:"serie_0,required"`
JSON botWebCrawlerTimeseriesGroupsResponseJSON `json:"-"`
}
func (*BotWebCrawlerTimeseriesGroupsResponse) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponse) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsResponseEnvelope ¶
type BotWebCrawlerTimeseriesGroupsResponseEnvelope struct {
Result BotWebCrawlerTimeseriesGroupsResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON botWebCrawlerTimeseriesGroupsResponseEnvelopeJSON `json:"-"`
}
func (*BotWebCrawlerTimeseriesGroupsResponseEnvelope) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsResponseMeta ¶
type BotWebCrawlerTimeseriesGroupsResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []BotWebCrawlerTimeseriesGroupsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization BotWebCrawlerTimeseriesGroupsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []BotWebCrawlerTimeseriesGroupsResponseMetaUnit `json:"units,required"`
JSON botWebCrawlerTimeseriesGroupsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*BotWebCrawlerTimeseriesGroupsResponseMeta) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval ¶
type BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( BotWebCrawlerTimeseriesGroupsResponseMetaAggIntervalFifteenMinutes BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval = "FIFTEEN_MINUTES" BotWebCrawlerTimeseriesGroupsResponseMetaAggIntervalOneHour BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval = "ONE_HOUR" BotWebCrawlerTimeseriesGroupsResponseMetaAggIntervalOneDay BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval = "ONE_DAY" BotWebCrawlerTimeseriesGroupsResponseMetaAggIntervalOneWeek BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval = "ONE_WEEK" BotWebCrawlerTimeseriesGroupsResponseMetaAggIntervalOneMonth BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval = "ONE_MONTH" )
func (BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval) IsKnown ¶
func (r BotWebCrawlerTimeseriesGroupsResponseMetaAggInterval) IsKnown() bool
type BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfo ¶
type BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfo struct {
Annotations []BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON botWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoAnnotation ¶
type BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON botWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsResponseMetaDateRange ¶
type BotWebCrawlerTimeseriesGroupsResponseMetaDateRange 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 botWebCrawlerTimeseriesGroupsResponseMetaDateRangeJSON `json:"-"`
}
func (*BotWebCrawlerTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsResponseMetaNormalization ¶
type BotWebCrawlerTimeseriesGroupsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationPercentage BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE" BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationMin0Max BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "MIN0_MAX" BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationMinMax BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "MIN_MAX" BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationRawValues BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "RAW_VALUES" BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationPercentageChange BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE_CHANGE" BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationRollingAverage BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "ROLLING_AVERAGE" BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationOverlappedPercentage BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" BotWebCrawlerTimeseriesGroupsResponseMetaNormalizationRatio BotWebCrawlerTimeseriesGroupsResponseMetaNormalization = "RATIO" )
func (BotWebCrawlerTimeseriesGroupsResponseMetaNormalization) IsKnown ¶
func (r BotWebCrawlerTimeseriesGroupsResponseMetaNormalization) IsKnown() bool
type BotWebCrawlerTimeseriesGroupsResponseMetaUnit ¶
type BotWebCrawlerTimeseriesGroupsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON botWebCrawlerTimeseriesGroupsResponseMetaUnitJSON `json:"-"`
}
func (*BotWebCrawlerTimeseriesGroupsResponseMetaUnit) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type BotWebCrawlerTimeseriesGroupsResponseSerie0 ¶
type BotWebCrawlerTimeseriesGroupsResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON botWebCrawlerTimeseriesGroupsResponseSerie0JSON `json:"-"`
}
func (*BotWebCrawlerTimeseriesGroupsResponseSerie0) UnmarshalJSON ¶
func (r *BotWebCrawlerTimeseriesGroupsResponseSerie0) 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
Summary *DNSSummaryService
TimeseriesGroups *DNSTimeseriesGroupService
}
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.
func (*DNSService) Timeseries ¶
func (r *DNSService) Timeseries(ctx context.Context, query DNSTimeseriesParams, opts ...option.RequestOption) (res *DNSTimeseriesResponse, err error)
Retrieves normalized query volume to the 1.1.1.1 DNS resolver over time.
type DNSSummaryCacheHitParams ¶
type DNSSummaryCacheHitParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryCacheHitParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryCacheHitParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryCacheHitParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryCacheHitParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryCacheHitParams) URLQuery ¶
func (r DNSSummaryCacheHitParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryCacheHitParams's query parameters as `url.Values`.
type DNSSummaryCacheHitParamsFormat ¶
type DNSSummaryCacheHitParamsFormat string
Format in which results will be returned.
const ( DNSSummaryCacheHitParamsFormatJson DNSSummaryCacheHitParamsFormat = "JSON" DNSSummaryCacheHitParamsFormatCsv DNSSummaryCacheHitParamsFormat = "CSV" )
func (DNSSummaryCacheHitParamsFormat) IsKnown ¶
func (r DNSSummaryCacheHitParamsFormat) IsKnown() bool
type DNSSummaryCacheHitParamsProtocol ¶
type DNSSummaryCacheHitParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryCacheHitParamsProtocolUdp DNSSummaryCacheHitParamsProtocol = "UDP" DNSSummaryCacheHitParamsProtocolTCP DNSSummaryCacheHitParamsProtocol = "TCP" DNSSummaryCacheHitParamsProtocolHTTPS DNSSummaryCacheHitParamsProtocol = "HTTPS" DNSSummaryCacheHitParamsProtocolTLS DNSSummaryCacheHitParamsProtocol = "TLS" )
func (DNSSummaryCacheHitParamsProtocol) IsKnown ¶
func (r DNSSummaryCacheHitParamsProtocol) IsKnown() bool
type DNSSummaryCacheHitParamsQueryType ¶
type DNSSummaryCacheHitParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryCacheHitParamsQueryTypeA DNSSummaryCacheHitParamsQueryType = "A" DNSSummaryCacheHitParamsQueryTypeAAAA DNSSummaryCacheHitParamsQueryType = "AAAA" DNSSummaryCacheHitParamsQueryTypeA6 DNSSummaryCacheHitParamsQueryType = "A6" DNSSummaryCacheHitParamsQueryTypeAfsdb DNSSummaryCacheHitParamsQueryType = "AFSDB" DNSSummaryCacheHitParamsQueryTypeAny DNSSummaryCacheHitParamsQueryType = "ANY" DNSSummaryCacheHitParamsQueryTypeApl DNSSummaryCacheHitParamsQueryType = "APL" DNSSummaryCacheHitParamsQueryTypeAtma DNSSummaryCacheHitParamsQueryType = "ATMA" DNSSummaryCacheHitParamsQueryTypeAXFR DNSSummaryCacheHitParamsQueryType = "AXFR" DNSSummaryCacheHitParamsQueryTypeCAA DNSSummaryCacheHitParamsQueryType = "CAA" DNSSummaryCacheHitParamsQueryTypeCdnskey DNSSummaryCacheHitParamsQueryType = "CDNSKEY" DNSSummaryCacheHitParamsQueryTypeCds DNSSummaryCacheHitParamsQueryType = "CDS" DNSSummaryCacheHitParamsQueryTypeCERT DNSSummaryCacheHitParamsQueryType = "CERT" DNSSummaryCacheHitParamsQueryTypeCNAME DNSSummaryCacheHitParamsQueryType = "CNAME" DNSSummaryCacheHitParamsQueryTypeCsync DNSSummaryCacheHitParamsQueryType = "CSYNC" DNSSummaryCacheHitParamsQueryTypeDhcid DNSSummaryCacheHitParamsQueryType = "DHCID" DNSSummaryCacheHitParamsQueryTypeDlv DNSSummaryCacheHitParamsQueryType = "DLV" DNSSummaryCacheHitParamsQueryTypeDname DNSSummaryCacheHitParamsQueryType = "DNAME" DNSSummaryCacheHitParamsQueryTypeDNSKEY DNSSummaryCacheHitParamsQueryType = "DNSKEY" DNSSummaryCacheHitParamsQueryTypeDoa DNSSummaryCacheHitParamsQueryType = "DOA" DNSSummaryCacheHitParamsQueryTypeDS DNSSummaryCacheHitParamsQueryType = "DS" DNSSummaryCacheHitParamsQueryTypeEid DNSSummaryCacheHitParamsQueryType = "EID" DNSSummaryCacheHitParamsQueryTypeEui48 DNSSummaryCacheHitParamsQueryType = "EUI48" DNSSummaryCacheHitParamsQueryTypeEui64 DNSSummaryCacheHitParamsQueryType = "EUI64" DNSSummaryCacheHitParamsQueryTypeGpos DNSSummaryCacheHitParamsQueryType = "GPOS" DNSSummaryCacheHitParamsQueryTypeGid DNSSummaryCacheHitParamsQueryType = "GID" DNSSummaryCacheHitParamsQueryTypeHinfo DNSSummaryCacheHitParamsQueryType = "HINFO" DNSSummaryCacheHitParamsQueryTypeHip DNSSummaryCacheHitParamsQueryType = "HIP" DNSSummaryCacheHitParamsQueryTypeHTTPS DNSSummaryCacheHitParamsQueryType = "HTTPS" DNSSummaryCacheHitParamsQueryTypeIpseckey DNSSummaryCacheHitParamsQueryType = "IPSECKEY" DNSSummaryCacheHitParamsQueryTypeIsdn DNSSummaryCacheHitParamsQueryType = "ISDN" DNSSummaryCacheHitParamsQueryTypeIxfr DNSSummaryCacheHitParamsQueryType = "IXFR" DNSSummaryCacheHitParamsQueryTypeKey DNSSummaryCacheHitParamsQueryType = "KEY" DNSSummaryCacheHitParamsQueryTypeKx DNSSummaryCacheHitParamsQueryType = "KX" DNSSummaryCacheHitParamsQueryTypeL32 DNSSummaryCacheHitParamsQueryType = "L32" DNSSummaryCacheHitParamsQueryTypeL64 DNSSummaryCacheHitParamsQueryType = "L64" DNSSummaryCacheHitParamsQueryTypeLOC DNSSummaryCacheHitParamsQueryType = "LOC" DNSSummaryCacheHitParamsQueryTypeLp DNSSummaryCacheHitParamsQueryType = "LP" DNSSummaryCacheHitParamsQueryTypeMaila DNSSummaryCacheHitParamsQueryType = "MAILA" DNSSummaryCacheHitParamsQueryTypeMailb DNSSummaryCacheHitParamsQueryType = "MAILB" DNSSummaryCacheHitParamsQueryTypeMB DNSSummaryCacheHitParamsQueryType = "MB" DNSSummaryCacheHitParamsQueryTypeMd DNSSummaryCacheHitParamsQueryType = "MD" DNSSummaryCacheHitParamsQueryTypeMf DNSSummaryCacheHitParamsQueryType = "MF" DNSSummaryCacheHitParamsQueryTypeMg DNSSummaryCacheHitParamsQueryType = "MG" DNSSummaryCacheHitParamsQueryTypeMinfo DNSSummaryCacheHitParamsQueryType = "MINFO" DNSSummaryCacheHitParamsQueryTypeMr DNSSummaryCacheHitParamsQueryType = "MR" DNSSummaryCacheHitParamsQueryTypeMX DNSSummaryCacheHitParamsQueryType = "MX" DNSSummaryCacheHitParamsQueryTypeNAPTR DNSSummaryCacheHitParamsQueryType = "NAPTR" DNSSummaryCacheHitParamsQueryTypeNb DNSSummaryCacheHitParamsQueryType = "NB" DNSSummaryCacheHitParamsQueryTypeNbstat DNSSummaryCacheHitParamsQueryType = "NBSTAT" DNSSummaryCacheHitParamsQueryTypeNid DNSSummaryCacheHitParamsQueryType = "NID" DNSSummaryCacheHitParamsQueryTypeNimloc DNSSummaryCacheHitParamsQueryType = "NIMLOC" DNSSummaryCacheHitParamsQueryTypeNinfo DNSSummaryCacheHitParamsQueryType = "NINFO" DNSSummaryCacheHitParamsQueryTypeNS DNSSummaryCacheHitParamsQueryType = "NS" DNSSummaryCacheHitParamsQueryTypeNsap DNSSummaryCacheHitParamsQueryType = "NSAP" DNSSummaryCacheHitParamsQueryTypeNsec DNSSummaryCacheHitParamsQueryType = "NSEC" DNSSummaryCacheHitParamsQueryTypeNsec3 DNSSummaryCacheHitParamsQueryType = "NSEC3" DNSSummaryCacheHitParamsQueryTypeNsec3Param DNSSummaryCacheHitParamsQueryType = "NSEC3PARAM" DNSSummaryCacheHitParamsQueryTypeNull DNSSummaryCacheHitParamsQueryType = "NULL" DNSSummaryCacheHitParamsQueryTypeNxt DNSSummaryCacheHitParamsQueryType = "NXT" DNSSummaryCacheHitParamsQueryTypeOpenpgpkey DNSSummaryCacheHitParamsQueryType = "OPENPGPKEY" DNSSummaryCacheHitParamsQueryTypeOpt DNSSummaryCacheHitParamsQueryType = "OPT" DNSSummaryCacheHitParamsQueryTypePTR DNSSummaryCacheHitParamsQueryType = "PTR" DNSSummaryCacheHitParamsQueryTypePx DNSSummaryCacheHitParamsQueryType = "PX" DNSSummaryCacheHitParamsQueryTypeRkey DNSSummaryCacheHitParamsQueryType = "RKEY" DNSSummaryCacheHitParamsQueryTypeRp DNSSummaryCacheHitParamsQueryType = "RP" DNSSummaryCacheHitParamsQueryTypeRrsig DNSSummaryCacheHitParamsQueryType = "RRSIG" DNSSummaryCacheHitParamsQueryTypeRt DNSSummaryCacheHitParamsQueryType = "RT" DNSSummaryCacheHitParamsQueryTypeSig DNSSummaryCacheHitParamsQueryType = "SIG" DNSSummaryCacheHitParamsQueryTypeSink DNSSummaryCacheHitParamsQueryType = "SINK" DNSSummaryCacheHitParamsQueryTypeSMIMEA DNSSummaryCacheHitParamsQueryType = "SMIMEA" DNSSummaryCacheHitParamsQueryTypeSOA DNSSummaryCacheHitParamsQueryType = "SOA" DNSSummaryCacheHitParamsQueryTypeSPF DNSSummaryCacheHitParamsQueryType = "SPF" DNSSummaryCacheHitParamsQueryTypeSRV DNSSummaryCacheHitParamsQueryType = "SRV" DNSSummaryCacheHitParamsQueryTypeSSHFP DNSSummaryCacheHitParamsQueryType = "SSHFP" DNSSummaryCacheHitParamsQueryTypeSVCB DNSSummaryCacheHitParamsQueryType = "SVCB" DNSSummaryCacheHitParamsQueryTypeTa DNSSummaryCacheHitParamsQueryType = "TA" DNSSummaryCacheHitParamsQueryTypeTalink DNSSummaryCacheHitParamsQueryType = "TALINK" DNSSummaryCacheHitParamsQueryTypeTkey DNSSummaryCacheHitParamsQueryType = "TKEY" DNSSummaryCacheHitParamsQueryTypeTLSA DNSSummaryCacheHitParamsQueryType = "TLSA" DNSSummaryCacheHitParamsQueryTypeTSIG DNSSummaryCacheHitParamsQueryType = "TSIG" DNSSummaryCacheHitParamsQueryTypeTXT DNSSummaryCacheHitParamsQueryType = "TXT" DNSSummaryCacheHitParamsQueryTypeUinfo DNSSummaryCacheHitParamsQueryType = "UINFO" DNSSummaryCacheHitParamsQueryTypeUID DNSSummaryCacheHitParamsQueryType = "UID" DNSSummaryCacheHitParamsQueryTypeUnspec DNSSummaryCacheHitParamsQueryType = "UNSPEC" DNSSummaryCacheHitParamsQueryTypeURI DNSSummaryCacheHitParamsQueryType = "URI" DNSSummaryCacheHitParamsQueryTypeWks DNSSummaryCacheHitParamsQueryType = "WKS" DNSSummaryCacheHitParamsQueryTypeX25 DNSSummaryCacheHitParamsQueryType = "X25" DNSSummaryCacheHitParamsQueryTypeZonemd DNSSummaryCacheHitParamsQueryType = "ZONEMD" )
func (DNSSummaryCacheHitParamsQueryType) IsKnown ¶
func (r DNSSummaryCacheHitParamsQueryType) IsKnown() bool
type DNSSummaryCacheHitParamsResponseCode ¶
type DNSSummaryCacheHitParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryCacheHitParamsResponseCodeNoerror DNSSummaryCacheHitParamsResponseCode = "NOERROR" DNSSummaryCacheHitParamsResponseCodeFormerr DNSSummaryCacheHitParamsResponseCode = "FORMERR" DNSSummaryCacheHitParamsResponseCodeServfail DNSSummaryCacheHitParamsResponseCode = "SERVFAIL" DNSSummaryCacheHitParamsResponseCodeNxdomain DNSSummaryCacheHitParamsResponseCode = "NXDOMAIN" DNSSummaryCacheHitParamsResponseCodeNotimp DNSSummaryCacheHitParamsResponseCode = "NOTIMP" DNSSummaryCacheHitParamsResponseCodeRefused DNSSummaryCacheHitParamsResponseCode = "REFUSED" DNSSummaryCacheHitParamsResponseCodeYxdomain DNSSummaryCacheHitParamsResponseCode = "YXDOMAIN" DNSSummaryCacheHitParamsResponseCodeYxrrset DNSSummaryCacheHitParamsResponseCode = "YXRRSET" DNSSummaryCacheHitParamsResponseCodeNxrrset DNSSummaryCacheHitParamsResponseCode = "NXRRSET" DNSSummaryCacheHitParamsResponseCodeNotauth DNSSummaryCacheHitParamsResponseCode = "NOTAUTH" DNSSummaryCacheHitParamsResponseCodeNotzone DNSSummaryCacheHitParamsResponseCode = "NOTZONE" DNSSummaryCacheHitParamsResponseCodeBadsig DNSSummaryCacheHitParamsResponseCode = "BADSIG" DNSSummaryCacheHitParamsResponseCodeBadkey DNSSummaryCacheHitParamsResponseCode = "BADKEY" DNSSummaryCacheHitParamsResponseCodeBadtime DNSSummaryCacheHitParamsResponseCode = "BADTIME" DNSSummaryCacheHitParamsResponseCodeBadmode DNSSummaryCacheHitParamsResponseCode = "BADMODE" DNSSummaryCacheHitParamsResponseCodeBadname DNSSummaryCacheHitParamsResponseCode = "BADNAME" DNSSummaryCacheHitParamsResponseCodeBadalg DNSSummaryCacheHitParamsResponseCode = "BADALG" DNSSummaryCacheHitParamsResponseCodeBadtrunc DNSSummaryCacheHitParamsResponseCode = "BADTRUNC" )
func (DNSSummaryCacheHitParamsResponseCode) IsKnown ¶
func (r DNSSummaryCacheHitParamsResponseCode) IsKnown() bool
type DNSSummaryCacheHitResponse ¶
type DNSSummaryCacheHitResponse struct {
// Metadata for the results.
Meta DNSSummaryCacheHitResponseMeta `json:"meta,required"`
Summary0 DNSSummaryCacheHitResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryCacheHitResponseJSON `json:"-"`
}
func (*DNSSummaryCacheHitResponse) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryCacheHitResponseEnvelope ¶
type DNSSummaryCacheHitResponseEnvelope struct {
Result DNSSummaryCacheHitResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryCacheHitResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryCacheHitResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryCacheHitResponseMeta ¶
type DNSSummaryCacheHitResponseMeta struct {
ConfidenceInfo DNSSummaryCacheHitResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryCacheHitResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryCacheHitResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryCacheHitResponseMetaUnit `json:"units,required"`
JSON dnsSummaryCacheHitResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryCacheHitResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryCacheHitResponseMetaConfidenceInfo ¶
type DNSSummaryCacheHitResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryCacheHitResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryCacheHitResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryCacheHitResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryCacheHitResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryCacheHitResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryCacheHitResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryCacheHitResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryCacheHitResponseMetaDateRange ¶
type DNSSummaryCacheHitResponseMetaDateRange 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 dnsSummaryCacheHitResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryCacheHitResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryCacheHitResponseMetaNormalization ¶
type DNSSummaryCacheHitResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryCacheHitResponseMetaNormalizationPercentage DNSSummaryCacheHitResponseMetaNormalization = "PERCENTAGE" DNSSummaryCacheHitResponseMetaNormalizationMin0Max DNSSummaryCacheHitResponseMetaNormalization = "MIN0_MAX" DNSSummaryCacheHitResponseMetaNormalizationMinMax DNSSummaryCacheHitResponseMetaNormalization = "MIN_MAX" DNSSummaryCacheHitResponseMetaNormalizationRawValues DNSSummaryCacheHitResponseMetaNormalization = "RAW_VALUES" DNSSummaryCacheHitResponseMetaNormalizationPercentageChange DNSSummaryCacheHitResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryCacheHitResponseMetaNormalizationRollingAverage DNSSummaryCacheHitResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryCacheHitResponseMetaNormalizationOverlappedPercentage DNSSummaryCacheHitResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryCacheHitResponseMetaNormalizationRatio DNSSummaryCacheHitResponseMetaNormalization = "RATIO" )
func (DNSSummaryCacheHitResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryCacheHitResponseMetaNormalization) IsKnown() bool
type DNSSummaryCacheHitResponseMetaUnit ¶
type DNSSummaryCacheHitResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryCacheHitResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryCacheHitResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryCacheHitResponseSummary0 ¶
type DNSSummaryCacheHitResponseSummary0 struct {
// A numeric string.
Negative string `json:"NEGATIVE,required"`
// A numeric string.
Positive string `json:"POSITIVE,required"`
JSON dnsSummaryCacheHitResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryCacheHitResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryCacheHitResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareParams ¶
type DNSSummaryDNSSECAwareParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryDNSSECAwareParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryDNSSECAwareParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryDNSSECAwareParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryDNSSECAwareParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryDNSSECAwareParams) URLQuery ¶
func (r DNSSummaryDNSSECAwareParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryDNSSECAwareParams's query parameters as `url.Values`.
type DNSSummaryDNSSECAwareParamsFormat ¶
type DNSSummaryDNSSECAwareParamsFormat string
Format in which results will be returned.
const ( DNSSummaryDNSSECAwareParamsFormatJson DNSSummaryDNSSECAwareParamsFormat = "JSON" DNSSummaryDNSSECAwareParamsFormatCsv DNSSummaryDNSSECAwareParamsFormat = "CSV" )
func (DNSSummaryDNSSECAwareParamsFormat) IsKnown ¶
func (r DNSSummaryDNSSECAwareParamsFormat) IsKnown() bool
type DNSSummaryDNSSECAwareParamsProtocol ¶
type DNSSummaryDNSSECAwareParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryDNSSECAwareParamsProtocolUdp DNSSummaryDNSSECAwareParamsProtocol = "UDP" DNSSummaryDNSSECAwareParamsProtocolTCP DNSSummaryDNSSECAwareParamsProtocol = "TCP" DNSSummaryDNSSECAwareParamsProtocolHTTPS DNSSummaryDNSSECAwareParamsProtocol = "HTTPS" DNSSummaryDNSSECAwareParamsProtocolTLS DNSSummaryDNSSECAwareParamsProtocol = "TLS" )
func (DNSSummaryDNSSECAwareParamsProtocol) IsKnown ¶
func (r DNSSummaryDNSSECAwareParamsProtocol) IsKnown() bool
type DNSSummaryDNSSECAwareParamsQueryType ¶
type DNSSummaryDNSSECAwareParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryDNSSECAwareParamsQueryTypeA DNSSummaryDNSSECAwareParamsQueryType = "A" DNSSummaryDNSSECAwareParamsQueryTypeAAAA DNSSummaryDNSSECAwareParamsQueryType = "AAAA" DNSSummaryDNSSECAwareParamsQueryTypeA6 DNSSummaryDNSSECAwareParamsQueryType = "A6" DNSSummaryDNSSECAwareParamsQueryTypeAfsdb DNSSummaryDNSSECAwareParamsQueryType = "AFSDB" DNSSummaryDNSSECAwareParamsQueryTypeAny DNSSummaryDNSSECAwareParamsQueryType = "ANY" DNSSummaryDNSSECAwareParamsQueryTypeApl DNSSummaryDNSSECAwareParamsQueryType = "APL" DNSSummaryDNSSECAwareParamsQueryTypeAtma DNSSummaryDNSSECAwareParamsQueryType = "ATMA" DNSSummaryDNSSECAwareParamsQueryTypeAXFR DNSSummaryDNSSECAwareParamsQueryType = "AXFR" DNSSummaryDNSSECAwareParamsQueryTypeCAA DNSSummaryDNSSECAwareParamsQueryType = "CAA" DNSSummaryDNSSECAwareParamsQueryTypeCdnskey DNSSummaryDNSSECAwareParamsQueryType = "CDNSKEY" DNSSummaryDNSSECAwareParamsQueryTypeCds DNSSummaryDNSSECAwareParamsQueryType = "CDS" DNSSummaryDNSSECAwareParamsQueryTypeCERT DNSSummaryDNSSECAwareParamsQueryType = "CERT" DNSSummaryDNSSECAwareParamsQueryTypeCNAME DNSSummaryDNSSECAwareParamsQueryType = "CNAME" DNSSummaryDNSSECAwareParamsQueryTypeCsync DNSSummaryDNSSECAwareParamsQueryType = "CSYNC" DNSSummaryDNSSECAwareParamsQueryTypeDhcid DNSSummaryDNSSECAwareParamsQueryType = "DHCID" DNSSummaryDNSSECAwareParamsQueryTypeDlv DNSSummaryDNSSECAwareParamsQueryType = "DLV" DNSSummaryDNSSECAwareParamsQueryTypeDname DNSSummaryDNSSECAwareParamsQueryType = "DNAME" DNSSummaryDNSSECAwareParamsQueryTypeDNSKEY DNSSummaryDNSSECAwareParamsQueryType = "DNSKEY" DNSSummaryDNSSECAwareParamsQueryTypeDoa DNSSummaryDNSSECAwareParamsQueryType = "DOA" DNSSummaryDNSSECAwareParamsQueryTypeDS DNSSummaryDNSSECAwareParamsQueryType = "DS" DNSSummaryDNSSECAwareParamsQueryTypeEid DNSSummaryDNSSECAwareParamsQueryType = "EID" DNSSummaryDNSSECAwareParamsQueryTypeEui48 DNSSummaryDNSSECAwareParamsQueryType = "EUI48" DNSSummaryDNSSECAwareParamsQueryTypeEui64 DNSSummaryDNSSECAwareParamsQueryType = "EUI64" DNSSummaryDNSSECAwareParamsQueryTypeGpos DNSSummaryDNSSECAwareParamsQueryType = "GPOS" DNSSummaryDNSSECAwareParamsQueryTypeGid DNSSummaryDNSSECAwareParamsQueryType = "GID" DNSSummaryDNSSECAwareParamsQueryTypeHinfo DNSSummaryDNSSECAwareParamsQueryType = "HINFO" DNSSummaryDNSSECAwareParamsQueryTypeHip DNSSummaryDNSSECAwareParamsQueryType = "HIP" DNSSummaryDNSSECAwareParamsQueryTypeHTTPS DNSSummaryDNSSECAwareParamsQueryType = "HTTPS" DNSSummaryDNSSECAwareParamsQueryTypeIpseckey DNSSummaryDNSSECAwareParamsQueryType = "IPSECKEY" DNSSummaryDNSSECAwareParamsQueryTypeIsdn DNSSummaryDNSSECAwareParamsQueryType = "ISDN" DNSSummaryDNSSECAwareParamsQueryTypeIxfr DNSSummaryDNSSECAwareParamsQueryType = "IXFR" DNSSummaryDNSSECAwareParamsQueryTypeKey DNSSummaryDNSSECAwareParamsQueryType = "KEY" DNSSummaryDNSSECAwareParamsQueryTypeKx DNSSummaryDNSSECAwareParamsQueryType = "KX" DNSSummaryDNSSECAwareParamsQueryTypeL32 DNSSummaryDNSSECAwareParamsQueryType = "L32" DNSSummaryDNSSECAwareParamsQueryTypeL64 DNSSummaryDNSSECAwareParamsQueryType = "L64" DNSSummaryDNSSECAwareParamsQueryTypeLOC DNSSummaryDNSSECAwareParamsQueryType = "LOC" DNSSummaryDNSSECAwareParamsQueryTypeLp DNSSummaryDNSSECAwareParamsQueryType = "LP" DNSSummaryDNSSECAwareParamsQueryTypeMaila DNSSummaryDNSSECAwareParamsQueryType = "MAILA" DNSSummaryDNSSECAwareParamsQueryTypeMailb DNSSummaryDNSSECAwareParamsQueryType = "MAILB" DNSSummaryDNSSECAwareParamsQueryTypeMB DNSSummaryDNSSECAwareParamsQueryType = "MB" DNSSummaryDNSSECAwareParamsQueryTypeMd DNSSummaryDNSSECAwareParamsQueryType = "MD" DNSSummaryDNSSECAwareParamsQueryTypeMf DNSSummaryDNSSECAwareParamsQueryType = "MF" DNSSummaryDNSSECAwareParamsQueryTypeMg DNSSummaryDNSSECAwareParamsQueryType = "MG" DNSSummaryDNSSECAwareParamsQueryTypeMinfo DNSSummaryDNSSECAwareParamsQueryType = "MINFO" DNSSummaryDNSSECAwareParamsQueryTypeMr DNSSummaryDNSSECAwareParamsQueryType = "MR" DNSSummaryDNSSECAwareParamsQueryTypeMX DNSSummaryDNSSECAwareParamsQueryType = "MX" DNSSummaryDNSSECAwareParamsQueryTypeNAPTR DNSSummaryDNSSECAwareParamsQueryType = "NAPTR" DNSSummaryDNSSECAwareParamsQueryTypeNb DNSSummaryDNSSECAwareParamsQueryType = "NB" DNSSummaryDNSSECAwareParamsQueryTypeNbstat DNSSummaryDNSSECAwareParamsQueryType = "NBSTAT" DNSSummaryDNSSECAwareParamsQueryTypeNid DNSSummaryDNSSECAwareParamsQueryType = "NID" DNSSummaryDNSSECAwareParamsQueryTypeNimloc DNSSummaryDNSSECAwareParamsQueryType = "NIMLOC" DNSSummaryDNSSECAwareParamsQueryTypeNinfo DNSSummaryDNSSECAwareParamsQueryType = "NINFO" DNSSummaryDNSSECAwareParamsQueryTypeNS DNSSummaryDNSSECAwareParamsQueryType = "NS" DNSSummaryDNSSECAwareParamsQueryTypeNsap DNSSummaryDNSSECAwareParamsQueryType = "NSAP" DNSSummaryDNSSECAwareParamsQueryTypeNsec DNSSummaryDNSSECAwareParamsQueryType = "NSEC" DNSSummaryDNSSECAwareParamsQueryTypeNsec3 DNSSummaryDNSSECAwareParamsQueryType = "NSEC3" DNSSummaryDNSSECAwareParamsQueryTypeNsec3Param DNSSummaryDNSSECAwareParamsQueryType = "NSEC3PARAM" DNSSummaryDNSSECAwareParamsQueryTypeNull DNSSummaryDNSSECAwareParamsQueryType = "NULL" DNSSummaryDNSSECAwareParamsQueryTypeNxt DNSSummaryDNSSECAwareParamsQueryType = "NXT" DNSSummaryDNSSECAwareParamsQueryTypeOpenpgpkey DNSSummaryDNSSECAwareParamsQueryType = "OPENPGPKEY" DNSSummaryDNSSECAwareParamsQueryTypeOpt DNSSummaryDNSSECAwareParamsQueryType = "OPT" DNSSummaryDNSSECAwareParamsQueryTypePTR DNSSummaryDNSSECAwareParamsQueryType = "PTR" DNSSummaryDNSSECAwareParamsQueryTypePx DNSSummaryDNSSECAwareParamsQueryType = "PX" DNSSummaryDNSSECAwareParamsQueryTypeRkey DNSSummaryDNSSECAwareParamsQueryType = "RKEY" DNSSummaryDNSSECAwareParamsQueryTypeRp DNSSummaryDNSSECAwareParamsQueryType = "RP" DNSSummaryDNSSECAwareParamsQueryTypeRrsig DNSSummaryDNSSECAwareParamsQueryType = "RRSIG" DNSSummaryDNSSECAwareParamsQueryTypeRt DNSSummaryDNSSECAwareParamsQueryType = "RT" DNSSummaryDNSSECAwareParamsQueryTypeSig DNSSummaryDNSSECAwareParamsQueryType = "SIG" DNSSummaryDNSSECAwareParamsQueryTypeSink DNSSummaryDNSSECAwareParamsQueryType = "SINK" DNSSummaryDNSSECAwareParamsQueryTypeSMIMEA DNSSummaryDNSSECAwareParamsQueryType = "SMIMEA" DNSSummaryDNSSECAwareParamsQueryTypeSOA DNSSummaryDNSSECAwareParamsQueryType = "SOA" DNSSummaryDNSSECAwareParamsQueryTypeSPF DNSSummaryDNSSECAwareParamsQueryType = "SPF" DNSSummaryDNSSECAwareParamsQueryTypeSRV DNSSummaryDNSSECAwareParamsQueryType = "SRV" DNSSummaryDNSSECAwareParamsQueryTypeSSHFP DNSSummaryDNSSECAwareParamsQueryType = "SSHFP" DNSSummaryDNSSECAwareParamsQueryTypeSVCB DNSSummaryDNSSECAwareParamsQueryType = "SVCB" DNSSummaryDNSSECAwareParamsQueryTypeTa DNSSummaryDNSSECAwareParamsQueryType = "TA" DNSSummaryDNSSECAwareParamsQueryTypeTalink DNSSummaryDNSSECAwareParamsQueryType = "TALINK" DNSSummaryDNSSECAwareParamsQueryTypeTkey DNSSummaryDNSSECAwareParamsQueryType = "TKEY" DNSSummaryDNSSECAwareParamsQueryTypeTLSA DNSSummaryDNSSECAwareParamsQueryType = "TLSA" DNSSummaryDNSSECAwareParamsQueryTypeTSIG DNSSummaryDNSSECAwareParamsQueryType = "TSIG" DNSSummaryDNSSECAwareParamsQueryTypeTXT DNSSummaryDNSSECAwareParamsQueryType = "TXT" DNSSummaryDNSSECAwareParamsQueryTypeUinfo DNSSummaryDNSSECAwareParamsQueryType = "UINFO" DNSSummaryDNSSECAwareParamsQueryTypeUID DNSSummaryDNSSECAwareParamsQueryType = "UID" DNSSummaryDNSSECAwareParamsQueryTypeUnspec DNSSummaryDNSSECAwareParamsQueryType = "UNSPEC" DNSSummaryDNSSECAwareParamsQueryTypeURI DNSSummaryDNSSECAwareParamsQueryType = "URI" DNSSummaryDNSSECAwareParamsQueryTypeWks DNSSummaryDNSSECAwareParamsQueryType = "WKS" DNSSummaryDNSSECAwareParamsQueryTypeX25 DNSSummaryDNSSECAwareParamsQueryType = "X25" DNSSummaryDNSSECAwareParamsQueryTypeZonemd DNSSummaryDNSSECAwareParamsQueryType = "ZONEMD" )
func (DNSSummaryDNSSECAwareParamsQueryType) IsKnown ¶
func (r DNSSummaryDNSSECAwareParamsQueryType) IsKnown() bool
type DNSSummaryDNSSECAwareParamsResponseCode ¶
type DNSSummaryDNSSECAwareParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryDNSSECAwareParamsResponseCodeNoerror DNSSummaryDNSSECAwareParamsResponseCode = "NOERROR" DNSSummaryDNSSECAwareParamsResponseCodeFormerr DNSSummaryDNSSECAwareParamsResponseCode = "FORMERR" DNSSummaryDNSSECAwareParamsResponseCodeServfail DNSSummaryDNSSECAwareParamsResponseCode = "SERVFAIL" DNSSummaryDNSSECAwareParamsResponseCodeNxdomain DNSSummaryDNSSECAwareParamsResponseCode = "NXDOMAIN" DNSSummaryDNSSECAwareParamsResponseCodeNotimp DNSSummaryDNSSECAwareParamsResponseCode = "NOTIMP" DNSSummaryDNSSECAwareParamsResponseCodeRefused DNSSummaryDNSSECAwareParamsResponseCode = "REFUSED" DNSSummaryDNSSECAwareParamsResponseCodeYxdomain DNSSummaryDNSSECAwareParamsResponseCode = "YXDOMAIN" DNSSummaryDNSSECAwareParamsResponseCodeYxrrset DNSSummaryDNSSECAwareParamsResponseCode = "YXRRSET" DNSSummaryDNSSECAwareParamsResponseCodeNxrrset DNSSummaryDNSSECAwareParamsResponseCode = "NXRRSET" DNSSummaryDNSSECAwareParamsResponseCodeNotauth DNSSummaryDNSSECAwareParamsResponseCode = "NOTAUTH" DNSSummaryDNSSECAwareParamsResponseCodeNotzone DNSSummaryDNSSECAwareParamsResponseCode = "NOTZONE" DNSSummaryDNSSECAwareParamsResponseCodeBadsig DNSSummaryDNSSECAwareParamsResponseCode = "BADSIG" DNSSummaryDNSSECAwareParamsResponseCodeBadkey DNSSummaryDNSSECAwareParamsResponseCode = "BADKEY" DNSSummaryDNSSECAwareParamsResponseCodeBadtime DNSSummaryDNSSECAwareParamsResponseCode = "BADTIME" DNSSummaryDNSSECAwareParamsResponseCodeBadmode DNSSummaryDNSSECAwareParamsResponseCode = "BADMODE" DNSSummaryDNSSECAwareParamsResponseCodeBadname DNSSummaryDNSSECAwareParamsResponseCode = "BADNAME" DNSSummaryDNSSECAwareParamsResponseCodeBadalg DNSSummaryDNSSECAwareParamsResponseCode = "BADALG" DNSSummaryDNSSECAwareParamsResponseCodeBadtrunc DNSSummaryDNSSECAwareParamsResponseCode = "BADTRUNC" )
func (DNSSummaryDNSSECAwareParamsResponseCode) IsKnown ¶
func (r DNSSummaryDNSSECAwareParamsResponseCode) IsKnown() bool
type DNSSummaryDNSSECAwareResponse ¶
type DNSSummaryDNSSECAwareResponse struct {
// Metadata for the results.
Meta DNSSummaryDNSSECAwareResponseMeta `json:"meta,required"`
Summary0 DNSSummaryDNSSECAwareResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryDNSSECAwareResponseJSON `json:"-"`
}
func (*DNSSummaryDNSSECAwareResponse) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareResponseEnvelope ¶
type DNSSummaryDNSSECAwareResponseEnvelope struct {
Result DNSSummaryDNSSECAwareResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryDNSSECAwareResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryDNSSECAwareResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareResponseMeta ¶
type DNSSummaryDNSSECAwareResponseMeta struct {
ConfidenceInfo DNSSummaryDNSSECAwareResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryDNSSECAwareResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryDNSSECAwareResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryDNSSECAwareResponseMetaUnit `json:"units,required"`
JSON dnsSummaryDNSSECAwareResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryDNSSECAwareResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareResponseMetaConfidenceInfo ¶
type DNSSummaryDNSSECAwareResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryDNSSECAwareResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryDNSSECAwareResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryDNSSECAwareResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryDNSSECAwareResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryDNSSECAwareResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryDNSSECAwareResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareResponseMetaDateRange ¶
type DNSSummaryDNSSECAwareResponseMetaDateRange 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 dnsSummaryDNSSECAwareResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryDNSSECAwareResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareResponseMetaNormalization ¶
type DNSSummaryDNSSECAwareResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryDNSSECAwareResponseMetaNormalizationPercentage DNSSummaryDNSSECAwareResponseMetaNormalization = "PERCENTAGE" DNSSummaryDNSSECAwareResponseMetaNormalizationMin0Max DNSSummaryDNSSECAwareResponseMetaNormalization = "MIN0_MAX" DNSSummaryDNSSECAwareResponseMetaNormalizationMinMax DNSSummaryDNSSECAwareResponseMetaNormalization = "MIN_MAX" DNSSummaryDNSSECAwareResponseMetaNormalizationRawValues DNSSummaryDNSSECAwareResponseMetaNormalization = "RAW_VALUES" DNSSummaryDNSSECAwareResponseMetaNormalizationPercentageChange DNSSummaryDNSSECAwareResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryDNSSECAwareResponseMetaNormalizationRollingAverage DNSSummaryDNSSECAwareResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryDNSSECAwareResponseMetaNormalizationOverlappedPercentage DNSSummaryDNSSECAwareResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryDNSSECAwareResponseMetaNormalizationRatio DNSSummaryDNSSECAwareResponseMetaNormalization = "RATIO" )
func (DNSSummaryDNSSECAwareResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryDNSSECAwareResponseMetaNormalization) IsKnown() bool
type DNSSummaryDNSSECAwareResponseMetaUnit ¶
type DNSSummaryDNSSECAwareResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryDNSSECAwareResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryDNSSECAwareResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECAwareResponseSummary0 ¶
type DNSSummaryDNSSECAwareResponseSummary0 struct {
// A numeric string.
NotSupported string `json:"NOT_SUPPORTED,required"`
// A numeric string.
Supported string `json:"SUPPORTED,required"`
JSON dnsSummaryDNSSECAwareResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryDNSSECAwareResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECAwareResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECE2EParams ¶
type DNSSummaryDNSSECE2EParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryDnssece2EParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryDnssece2EParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryDnssece2EParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryDnssece2EParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryDNSSECE2EParams) URLQuery ¶
func (r DNSSummaryDNSSECE2EParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryDNSSECE2EParams's query parameters as `url.Values`.
type DNSSummaryDNSSECParams ¶
type DNSSummaryDNSSECParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryDNSSECParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryDNSSECParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryDNSSECParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryDNSSECParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryDNSSECParams) URLQuery ¶
func (r DNSSummaryDNSSECParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryDNSSECParams's query parameters as `url.Values`.
type DNSSummaryDNSSECParamsFormat ¶
type DNSSummaryDNSSECParamsFormat string
Format in which results will be returned.
const ( DNSSummaryDNSSECParamsFormatJson DNSSummaryDNSSECParamsFormat = "JSON" DNSSummaryDNSSECParamsFormatCsv DNSSummaryDNSSECParamsFormat = "CSV" )
func (DNSSummaryDNSSECParamsFormat) IsKnown ¶
func (r DNSSummaryDNSSECParamsFormat) IsKnown() bool
type DNSSummaryDNSSECParamsProtocol ¶
type DNSSummaryDNSSECParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryDNSSECParamsProtocolUdp DNSSummaryDNSSECParamsProtocol = "UDP" DNSSummaryDNSSECParamsProtocolTCP DNSSummaryDNSSECParamsProtocol = "TCP" DNSSummaryDNSSECParamsProtocolHTTPS DNSSummaryDNSSECParamsProtocol = "HTTPS" DNSSummaryDNSSECParamsProtocolTLS DNSSummaryDNSSECParamsProtocol = "TLS" )
func (DNSSummaryDNSSECParamsProtocol) IsKnown ¶
func (r DNSSummaryDNSSECParamsProtocol) IsKnown() bool
type DNSSummaryDNSSECParamsQueryType ¶
type DNSSummaryDNSSECParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryDNSSECParamsQueryTypeA DNSSummaryDNSSECParamsQueryType = "A" DNSSummaryDNSSECParamsQueryTypeAAAA DNSSummaryDNSSECParamsQueryType = "AAAA" DNSSummaryDNSSECParamsQueryTypeA6 DNSSummaryDNSSECParamsQueryType = "A6" DNSSummaryDNSSECParamsQueryTypeAfsdb DNSSummaryDNSSECParamsQueryType = "AFSDB" DNSSummaryDNSSECParamsQueryTypeAny DNSSummaryDNSSECParamsQueryType = "ANY" DNSSummaryDNSSECParamsQueryTypeApl DNSSummaryDNSSECParamsQueryType = "APL" DNSSummaryDNSSECParamsQueryTypeAtma DNSSummaryDNSSECParamsQueryType = "ATMA" DNSSummaryDNSSECParamsQueryTypeAXFR DNSSummaryDNSSECParamsQueryType = "AXFR" DNSSummaryDNSSECParamsQueryTypeCAA DNSSummaryDNSSECParamsQueryType = "CAA" DNSSummaryDNSSECParamsQueryTypeCdnskey DNSSummaryDNSSECParamsQueryType = "CDNSKEY" DNSSummaryDNSSECParamsQueryTypeCds DNSSummaryDNSSECParamsQueryType = "CDS" DNSSummaryDNSSECParamsQueryTypeCERT DNSSummaryDNSSECParamsQueryType = "CERT" DNSSummaryDNSSECParamsQueryTypeCNAME DNSSummaryDNSSECParamsQueryType = "CNAME" DNSSummaryDNSSECParamsQueryTypeCsync DNSSummaryDNSSECParamsQueryType = "CSYNC" DNSSummaryDNSSECParamsQueryTypeDhcid DNSSummaryDNSSECParamsQueryType = "DHCID" DNSSummaryDNSSECParamsQueryTypeDlv DNSSummaryDNSSECParamsQueryType = "DLV" DNSSummaryDNSSECParamsQueryTypeDname DNSSummaryDNSSECParamsQueryType = "DNAME" DNSSummaryDNSSECParamsQueryTypeDNSKEY DNSSummaryDNSSECParamsQueryType = "DNSKEY" DNSSummaryDNSSECParamsQueryTypeDoa DNSSummaryDNSSECParamsQueryType = "DOA" DNSSummaryDNSSECParamsQueryTypeDS DNSSummaryDNSSECParamsQueryType = "DS" DNSSummaryDNSSECParamsQueryTypeEid DNSSummaryDNSSECParamsQueryType = "EID" DNSSummaryDNSSECParamsQueryTypeEui48 DNSSummaryDNSSECParamsQueryType = "EUI48" DNSSummaryDNSSECParamsQueryTypeEui64 DNSSummaryDNSSECParamsQueryType = "EUI64" DNSSummaryDNSSECParamsQueryTypeGpos DNSSummaryDNSSECParamsQueryType = "GPOS" DNSSummaryDNSSECParamsQueryTypeGid DNSSummaryDNSSECParamsQueryType = "GID" DNSSummaryDNSSECParamsQueryTypeHinfo DNSSummaryDNSSECParamsQueryType = "HINFO" DNSSummaryDNSSECParamsQueryTypeHip DNSSummaryDNSSECParamsQueryType = "HIP" DNSSummaryDNSSECParamsQueryTypeHTTPS DNSSummaryDNSSECParamsQueryType = "HTTPS" DNSSummaryDNSSECParamsQueryTypeIpseckey DNSSummaryDNSSECParamsQueryType = "IPSECKEY" DNSSummaryDNSSECParamsQueryTypeIsdn DNSSummaryDNSSECParamsQueryType = "ISDN" DNSSummaryDNSSECParamsQueryTypeIxfr DNSSummaryDNSSECParamsQueryType = "IXFR" DNSSummaryDNSSECParamsQueryTypeKey DNSSummaryDNSSECParamsQueryType = "KEY" DNSSummaryDNSSECParamsQueryTypeKx DNSSummaryDNSSECParamsQueryType = "KX" DNSSummaryDNSSECParamsQueryTypeL32 DNSSummaryDNSSECParamsQueryType = "L32" DNSSummaryDNSSECParamsQueryTypeL64 DNSSummaryDNSSECParamsQueryType = "L64" DNSSummaryDNSSECParamsQueryTypeLOC DNSSummaryDNSSECParamsQueryType = "LOC" DNSSummaryDNSSECParamsQueryTypeLp DNSSummaryDNSSECParamsQueryType = "LP" DNSSummaryDNSSECParamsQueryTypeMaila DNSSummaryDNSSECParamsQueryType = "MAILA" DNSSummaryDNSSECParamsQueryTypeMailb DNSSummaryDNSSECParamsQueryType = "MAILB" DNSSummaryDNSSECParamsQueryTypeMB DNSSummaryDNSSECParamsQueryType = "MB" DNSSummaryDNSSECParamsQueryTypeMd DNSSummaryDNSSECParamsQueryType = "MD" DNSSummaryDNSSECParamsQueryTypeMf DNSSummaryDNSSECParamsQueryType = "MF" DNSSummaryDNSSECParamsQueryTypeMg DNSSummaryDNSSECParamsQueryType = "MG" DNSSummaryDNSSECParamsQueryTypeMinfo DNSSummaryDNSSECParamsQueryType = "MINFO" DNSSummaryDNSSECParamsQueryTypeMr DNSSummaryDNSSECParamsQueryType = "MR" DNSSummaryDNSSECParamsQueryTypeMX DNSSummaryDNSSECParamsQueryType = "MX" DNSSummaryDNSSECParamsQueryTypeNAPTR DNSSummaryDNSSECParamsQueryType = "NAPTR" DNSSummaryDNSSECParamsQueryTypeNb DNSSummaryDNSSECParamsQueryType = "NB" DNSSummaryDNSSECParamsQueryTypeNbstat DNSSummaryDNSSECParamsQueryType = "NBSTAT" DNSSummaryDNSSECParamsQueryTypeNid DNSSummaryDNSSECParamsQueryType = "NID" DNSSummaryDNSSECParamsQueryTypeNimloc DNSSummaryDNSSECParamsQueryType = "NIMLOC" DNSSummaryDNSSECParamsQueryTypeNinfo DNSSummaryDNSSECParamsQueryType = "NINFO" DNSSummaryDNSSECParamsQueryTypeNS DNSSummaryDNSSECParamsQueryType = "NS" DNSSummaryDNSSECParamsQueryTypeNsap DNSSummaryDNSSECParamsQueryType = "NSAP" DNSSummaryDNSSECParamsQueryTypeNsec DNSSummaryDNSSECParamsQueryType = "NSEC" DNSSummaryDNSSECParamsQueryTypeNsec3 DNSSummaryDNSSECParamsQueryType = "NSEC3" DNSSummaryDNSSECParamsQueryTypeNsec3Param DNSSummaryDNSSECParamsQueryType = "NSEC3PARAM" DNSSummaryDNSSECParamsQueryTypeNull DNSSummaryDNSSECParamsQueryType = "NULL" DNSSummaryDNSSECParamsQueryTypeNxt DNSSummaryDNSSECParamsQueryType = "NXT" DNSSummaryDNSSECParamsQueryTypeOpenpgpkey DNSSummaryDNSSECParamsQueryType = "OPENPGPKEY" DNSSummaryDNSSECParamsQueryTypeOpt DNSSummaryDNSSECParamsQueryType = "OPT" DNSSummaryDNSSECParamsQueryTypePTR DNSSummaryDNSSECParamsQueryType = "PTR" DNSSummaryDNSSECParamsQueryTypePx DNSSummaryDNSSECParamsQueryType = "PX" DNSSummaryDNSSECParamsQueryTypeRkey DNSSummaryDNSSECParamsQueryType = "RKEY" DNSSummaryDNSSECParamsQueryTypeRp DNSSummaryDNSSECParamsQueryType = "RP" DNSSummaryDNSSECParamsQueryTypeRrsig DNSSummaryDNSSECParamsQueryType = "RRSIG" DNSSummaryDNSSECParamsQueryTypeRt DNSSummaryDNSSECParamsQueryType = "RT" DNSSummaryDNSSECParamsQueryTypeSig DNSSummaryDNSSECParamsQueryType = "SIG" DNSSummaryDNSSECParamsQueryTypeSink DNSSummaryDNSSECParamsQueryType = "SINK" DNSSummaryDNSSECParamsQueryTypeSMIMEA DNSSummaryDNSSECParamsQueryType = "SMIMEA" DNSSummaryDNSSECParamsQueryTypeSOA DNSSummaryDNSSECParamsQueryType = "SOA" DNSSummaryDNSSECParamsQueryTypeSPF DNSSummaryDNSSECParamsQueryType = "SPF" DNSSummaryDNSSECParamsQueryTypeSRV DNSSummaryDNSSECParamsQueryType = "SRV" DNSSummaryDNSSECParamsQueryTypeSSHFP DNSSummaryDNSSECParamsQueryType = "SSHFP" DNSSummaryDNSSECParamsQueryTypeSVCB DNSSummaryDNSSECParamsQueryType = "SVCB" DNSSummaryDNSSECParamsQueryTypeTa DNSSummaryDNSSECParamsQueryType = "TA" DNSSummaryDNSSECParamsQueryTypeTalink DNSSummaryDNSSECParamsQueryType = "TALINK" DNSSummaryDNSSECParamsQueryTypeTkey DNSSummaryDNSSECParamsQueryType = "TKEY" DNSSummaryDNSSECParamsQueryTypeTLSA DNSSummaryDNSSECParamsQueryType = "TLSA" DNSSummaryDNSSECParamsQueryTypeTSIG DNSSummaryDNSSECParamsQueryType = "TSIG" DNSSummaryDNSSECParamsQueryTypeTXT DNSSummaryDNSSECParamsQueryType = "TXT" DNSSummaryDNSSECParamsQueryTypeUinfo DNSSummaryDNSSECParamsQueryType = "UINFO" DNSSummaryDNSSECParamsQueryTypeUID DNSSummaryDNSSECParamsQueryType = "UID" DNSSummaryDNSSECParamsQueryTypeUnspec DNSSummaryDNSSECParamsQueryType = "UNSPEC" DNSSummaryDNSSECParamsQueryTypeURI DNSSummaryDNSSECParamsQueryType = "URI" DNSSummaryDNSSECParamsQueryTypeWks DNSSummaryDNSSECParamsQueryType = "WKS" DNSSummaryDNSSECParamsQueryTypeX25 DNSSummaryDNSSECParamsQueryType = "X25" DNSSummaryDNSSECParamsQueryTypeZonemd DNSSummaryDNSSECParamsQueryType = "ZONEMD" )
func (DNSSummaryDNSSECParamsQueryType) IsKnown ¶
func (r DNSSummaryDNSSECParamsQueryType) IsKnown() bool
type DNSSummaryDNSSECParamsResponseCode ¶
type DNSSummaryDNSSECParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryDNSSECParamsResponseCodeNoerror DNSSummaryDNSSECParamsResponseCode = "NOERROR" DNSSummaryDNSSECParamsResponseCodeFormerr DNSSummaryDNSSECParamsResponseCode = "FORMERR" DNSSummaryDNSSECParamsResponseCodeServfail DNSSummaryDNSSECParamsResponseCode = "SERVFAIL" DNSSummaryDNSSECParamsResponseCodeNxdomain DNSSummaryDNSSECParamsResponseCode = "NXDOMAIN" DNSSummaryDNSSECParamsResponseCodeNotimp DNSSummaryDNSSECParamsResponseCode = "NOTIMP" DNSSummaryDNSSECParamsResponseCodeRefused DNSSummaryDNSSECParamsResponseCode = "REFUSED" DNSSummaryDNSSECParamsResponseCodeYxdomain DNSSummaryDNSSECParamsResponseCode = "YXDOMAIN" DNSSummaryDNSSECParamsResponseCodeYxrrset DNSSummaryDNSSECParamsResponseCode = "YXRRSET" DNSSummaryDNSSECParamsResponseCodeNxrrset DNSSummaryDNSSECParamsResponseCode = "NXRRSET" DNSSummaryDNSSECParamsResponseCodeNotauth DNSSummaryDNSSECParamsResponseCode = "NOTAUTH" DNSSummaryDNSSECParamsResponseCodeNotzone DNSSummaryDNSSECParamsResponseCode = "NOTZONE" DNSSummaryDNSSECParamsResponseCodeBadsig DNSSummaryDNSSECParamsResponseCode = "BADSIG" DNSSummaryDNSSECParamsResponseCodeBadkey DNSSummaryDNSSECParamsResponseCode = "BADKEY" DNSSummaryDNSSECParamsResponseCodeBadtime DNSSummaryDNSSECParamsResponseCode = "BADTIME" DNSSummaryDNSSECParamsResponseCodeBadmode DNSSummaryDNSSECParamsResponseCode = "BADMODE" DNSSummaryDNSSECParamsResponseCodeBadname DNSSummaryDNSSECParamsResponseCode = "BADNAME" DNSSummaryDNSSECParamsResponseCodeBadalg DNSSummaryDNSSECParamsResponseCode = "BADALG" DNSSummaryDNSSECParamsResponseCodeBadtrunc DNSSummaryDNSSECParamsResponseCode = "BADTRUNC" )
func (DNSSummaryDNSSECParamsResponseCode) IsKnown ¶
func (r DNSSummaryDNSSECParamsResponseCode) IsKnown() bool
type DNSSummaryDNSSECResponse ¶
type DNSSummaryDNSSECResponse struct {
// Metadata for the results.
Meta DNSSummaryDNSSECResponseMeta `json:"meta,required"`
Summary0 DNSSummaryDNSSECResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryDNSSECResponseJSON `json:"-"`
}
func (*DNSSummaryDNSSECResponse) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECResponseEnvelope ¶
type DNSSummaryDNSSECResponseEnvelope struct {
Result DNSSummaryDNSSECResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryDNSSECResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryDNSSECResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECResponseMeta ¶
type DNSSummaryDNSSECResponseMeta struct {
ConfidenceInfo DNSSummaryDNSSECResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryDNSSECResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryDNSSECResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryDNSSECResponseMetaUnit `json:"units,required"`
JSON dnsSummaryDNSSECResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryDNSSECResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECResponseMetaConfidenceInfo ¶
type DNSSummaryDNSSECResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryDNSSECResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryDNSSECResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryDNSSECResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryDNSSECResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryDNSSECResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECResponseMetaDateRange ¶
type DNSSummaryDNSSECResponseMetaDateRange 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 dnsSummaryDNSSECResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryDNSSECResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECResponseMetaNormalization ¶
type DNSSummaryDNSSECResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryDNSSECResponseMetaNormalizationPercentage DNSSummaryDNSSECResponseMetaNormalization = "PERCENTAGE" DNSSummaryDNSSECResponseMetaNormalizationMin0Max DNSSummaryDNSSECResponseMetaNormalization = "MIN0_MAX" DNSSummaryDNSSECResponseMetaNormalizationMinMax DNSSummaryDNSSECResponseMetaNormalization = "MIN_MAX" DNSSummaryDNSSECResponseMetaNormalizationRawValues DNSSummaryDNSSECResponseMetaNormalization = "RAW_VALUES" DNSSummaryDNSSECResponseMetaNormalizationPercentageChange DNSSummaryDNSSECResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryDNSSECResponseMetaNormalizationRollingAverage DNSSummaryDNSSECResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryDNSSECResponseMetaNormalizationOverlappedPercentage DNSSummaryDNSSECResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryDNSSECResponseMetaNormalizationRatio DNSSummaryDNSSECResponseMetaNormalization = "RATIO" )
func (DNSSummaryDNSSECResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryDNSSECResponseMetaNormalization) IsKnown() bool
type DNSSummaryDNSSECResponseMetaUnit ¶
type DNSSummaryDNSSECResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryDNSSECResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryDNSSECResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDNSSECResponseSummary0 ¶
type DNSSummaryDNSSECResponseSummary0 struct {
// A numeric string.
Insecure string `json:"INSECURE,required"`
// A numeric string.
Invalid string `json:"INVALID,required"`
// A numeric string.
Other string `json:"OTHER,required"`
// A numeric string.
Secure string `json:"SECURE,required"`
JSON dnsSummaryDNSSECResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryDNSSECResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryDNSSECResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EParamsFormat ¶
type DNSSummaryDnssece2EParamsFormat string
Format in which results will be returned.
const ( DNSSummaryDnssece2EParamsFormatJson DNSSummaryDnssece2EParamsFormat = "JSON" DNSSummaryDnssece2EParamsFormatCsv DNSSummaryDnssece2EParamsFormat = "CSV" )
func (DNSSummaryDnssece2EParamsFormat) IsKnown ¶
func (r DNSSummaryDnssece2EParamsFormat) IsKnown() bool
type DNSSummaryDnssece2EParamsProtocol ¶
type DNSSummaryDnssece2EParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryDnssece2EParamsProtocolUdp DNSSummaryDnssece2EParamsProtocol = "UDP" DNSSummaryDnssece2EParamsProtocolTCP DNSSummaryDnssece2EParamsProtocol = "TCP" DNSSummaryDnssece2EParamsProtocolHTTPS DNSSummaryDnssece2EParamsProtocol = "HTTPS" DNSSummaryDnssece2EParamsProtocolTLS DNSSummaryDnssece2EParamsProtocol = "TLS" )
func (DNSSummaryDnssece2EParamsProtocol) IsKnown ¶
func (r DNSSummaryDnssece2EParamsProtocol) IsKnown() bool
type DNSSummaryDnssece2EParamsQueryType ¶
type DNSSummaryDnssece2EParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryDnssece2EParamsQueryTypeA DNSSummaryDnssece2EParamsQueryType = "A" DNSSummaryDnssece2EParamsQueryTypeAAAA DNSSummaryDnssece2EParamsQueryType = "AAAA" DNSSummaryDnssece2EParamsQueryTypeA6 DNSSummaryDnssece2EParamsQueryType = "A6" DNSSummaryDnssece2EParamsQueryTypeAfsdb DNSSummaryDnssece2EParamsQueryType = "AFSDB" DNSSummaryDnssece2EParamsQueryTypeAny DNSSummaryDnssece2EParamsQueryType = "ANY" DNSSummaryDnssece2EParamsQueryTypeApl DNSSummaryDnssece2EParamsQueryType = "APL" DNSSummaryDnssece2EParamsQueryTypeAtma DNSSummaryDnssece2EParamsQueryType = "ATMA" DNSSummaryDnssece2EParamsQueryTypeAXFR DNSSummaryDnssece2EParamsQueryType = "AXFR" DNSSummaryDnssece2EParamsQueryTypeCAA DNSSummaryDnssece2EParamsQueryType = "CAA" DNSSummaryDnssece2EParamsQueryTypeCdnskey DNSSummaryDnssece2EParamsQueryType = "CDNSKEY" DNSSummaryDnssece2EParamsQueryTypeCds DNSSummaryDnssece2EParamsQueryType = "CDS" DNSSummaryDnssece2EParamsQueryTypeCERT DNSSummaryDnssece2EParamsQueryType = "CERT" DNSSummaryDnssece2EParamsQueryTypeCNAME DNSSummaryDnssece2EParamsQueryType = "CNAME" DNSSummaryDnssece2EParamsQueryTypeCsync DNSSummaryDnssece2EParamsQueryType = "CSYNC" DNSSummaryDnssece2EParamsQueryTypeDhcid DNSSummaryDnssece2EParamsQueryType = "DHCID" DNSSummaryDnssece2EParamsQueryTypeDlv DNSSummaryDnssece2EParamsQueryType = "DLV" DNSSummaryDnssece2EParamsQueryTypeDname DNSSummaryDnssece2EParamsQueryType = "DNAME" DNSSummaryDnssece2EParamsQueryTypeDNSKEY DNSSummaryDnssece2EParamsQueryType = "DNSKEY" DNSSummaryDnssece2EParamsQueryTypeDoa DNSSummaryDnssece2EParamsQueryType = "DOA" DNSSummaryDnssece2EParamsQueryTypeDS DNSSummaryDnssece2EParamsQueryType = "DS" DNSSummaryDnssece2EParamsQueryTypeEid DNSSummaryDnssece2EParamsQueryType = "EID" DNSSummaryDnssece2EParamsQueryTypeEui48 DNSSummaryDnssece2EParamsQueryType = "EUI48" DNSSummaryDnssece2EParamsQueryTypeEui64 DNSSummaryDnssece2EParamsQueryType = "EUI64" DNSSummaryDnssece2EParamsQueryTypeGpos DNSSummaryDnssece2EParamsQueryType = "GPOS" DNSSummaryDnssece2EParamsQueryTypeGid DNSSummaryDnssece2EParamsQueryType = "GID" DNSSummaryDnssece2EParamsQueryTypeHinfo DNSSummaryDnssece2EParamsQueryType = "HINFO" DNSSummaryDnssece2EParamsQueryTypeHip DNSSummaryDnssece2EParamsQueryType = "HIP" DNSSummaryDnssece2EParamsQueryTypeHTTPS DNSSummaryDnssece2EParamsQueryType = "HTTPS" DNSSummaryDnssece2EParamsQueryTypeIpseckey DNSSummaryDnssece2EParamsQueryType = "IPSECKEY" DNSSummaryDnssece2EParamsQueryTypeIsdn DNSSummaryDnssece2EParamsQueryType = "ISDN" DNSSummaryDnssece2EParamsQueryTypeIxfr DNSSummaryDnssece2EParamsQueryType = "IXFR" DNSSummaryDnssece2EParamsQueryTypeKey DNSSummaryDnssece2EParamsQueryType = "KEY" DNSSummaryDnssece2EParamsQueryTypeKx DNSSummaryDnssece2EParamsQueryType = "KX" DNSSummaryDnssece2EParamsQueryTypeL32 DNSSummaryDnssece2EParamsQueryType = "L32" DNSSummaryDnssece2EParamsQueryTypeL64 DNSSummaryDnssece2EParamsQueryType = "L64" DNSSummaryDnssece2EParamsQueryTypeLOC DNSSummaryDnssece2EParamsQueryType = "LOC" DNSSummaryDnssece2EParamsQueryTypeLp DNSSummaryDnssece2EParamsQueryType = "LP" DNSSummaryDnssece2EParamsQueryTypeMaila DNSSummaryDnssece2EParamsQueryType = "MAILA" DNSSummaryDnssece2EParamsQueryTypeMailb DNSSummaryDnssece2EParamsQueryType = "MAILB" DNSSummaryDnssece2EParamsQueryTypeMB DNSSummaryDnssece2EParamsQueryType = "MB" DNSSummaryDnssece2EParamsQueryTypeMd DNSSummaryDnssece2EParamsQueryType = "MD" DNSSummaryDnssece2EParamsQueryTypeMf DNSSummaryDnssece2EParamsQueryType = "MF" DNSSummaryDnssece2EParamsQueryTypeMg DNSSummaryDnssece2EParamsQueryType = "MG" DNSSummaryDnssece2EParamsQueryTypeMinfo DNSSummaryDnssece2EParamsQueryType = "MINFO" DNSSummaryDnssece2EParamsQueryTypeMr DNSSummaryDnssece2EParamsQueryType = "MR" DNSSummaryDnssece2EParamsQueryTypeMX DNSSummaryDnssece2EParamsQueryType = "MX" DNSSummaryDnssece2EParamsQueryTypeNAPTR DNSSummaryDnssece2EParamsQueryType = "NAPTR" DNSSummaryDnssece2EParamsQueryTypeNb DNSSummaryDnssece2EParamsQueryType = "NB" DNSSummaryDnssece2EParamsQueryTypeNbstat DNSSummaryDnssece2EParamsQueryType = "NBSTAT" DNSSummaryDnssece2EParamsQueryTypeNid DNSSummaryDnssece2EParamsQueryType = "NID" DNSSummaryDnssece2EParamsQueryTypeNimloc DNSSummaryDnssece2EParamsQueryType = "NIMLOC" DNSSummaryDnssece2EParamsQueryTypeNinfo DNSSummaryDnssece2EParamsQueryType = "NINFO" DNSSummaryDnssece2EParamsQueryTypeNS DNSSummaryDnssece2EParamsQueryType = "NS" DNSSummaryDnssece2EParamsQueryTypeNsap DNSSummaryDnssece2EParamsQueryType = "NSAP" DNSSummaryDnssece2EParamsQueryTypeNsec DNSSummaryDnssece2EParamsQueryType = "NSEC" DNSSummaryDnssece2EParamsQueryTypeNsec3 DNSSummaryDnssece2EParamsQueryType = "NSEC3" DNSSummaryDnssece2EParamsQueryTypeNsec3Param DNSSummaryDnssece2EParamsQueryType = "NSEC3PARAM" DNSSummaryDnssece2EParamsQueryTypeNull DNSSummaryDnssece2EParamsQueryType = "NULL" DNSSummaryDnssece2EParamsQueryTypeNxt DNSSummaryDnssece2EParamsQueryType = "NXT" DNSSummaryDnssece2EParamsQueryTypeOpenpgpkey DNSSummaryDnssece2EParamsQueryType = "OPENPGPKEY" DNSSummaryDnssece2EParamsQueryTypeOpt DNSSummaryDnssece2EParamsQueryType = "OPT" DNSSummaryDnssece2EParamsQueryTypePTR DNSSummaryDnssece2EParamsQueryType = "PTR" DNSSummaryDnssece2EParamsQueryTypePx DNSSummaryDnssece2EParamsQueryType = "PX" DNSSummaryDnssece2EParamsQueryTypeRkey DNSSummaryDnssece2EParamsQueryType = "RKEY" DNSSummaryDnssece2EParamsQueryTypeRp DNSSummaryDnssece2EParamsQueryType = "RP" DNSSummaryDnssece2EParamsQueryTypeRrsig DNSSummaryDnssece2EParamsQueryType = "RRSIG" DNSSummaryDnssece2EParamsQueryTypeRt DNSSummaryDnssece2EParamsQueryType = "RT" DNSSummaryDnssece2EParamsQueryTypeSig DNSSummaryDnssece2EParamsQueryType = "SIG" DNSSummaryDnssece2EParamsQueryTypeSink DNSSummaryDnssece2EParamsQueryType = "SINK" DNSSummaryDnssece2EParamsQueryTypeSMIMEA DNSSummaryDnssece2EParamsQueryType = "SMIMEA" DNSSummaryDnssece2EParamsQueryTypeSOA DNSSummaryDnssece2EParamsQueryType = "SOA" DNSSummaryDnssece2EParamsQueryTypeSPF DNSSummaryDnssece2EParamsQueryType = "SPF" DNSSummaryDnssece2EParamsQueryTypeSRV DNSSummaryDnssece2EParamsQueryType = "SRV" DNSSummaryDnssece2EParamsQueryTypeSSHFP DNSSummaryDnssece2EParamsQueryType = "SSHFP" DNSSummaryDnssece2EParamsQueryTypeSVCB DNSSummaryDnssece2EParamsQueryType = "SVCB" DNSSummaryDnssece2EParamsQueryTypeTa DNSSummaryDnssece2EParamsQueryType = "TA" DNSSummaryDnssece2EParamsQueryTypeTalink DNSSummaryDnssece2EParamsQueryType = "TALINK" DNSSummaryDnssece2EParamsQueryTypeTkey DNSSummaryDnssece2EParamsQueryType = "TKEY" DNSSummaryDnssece2EParamsQueryTypeTLSA DNSSummaryDnssece2EParamsQueryType = "TLSA" DNSSummaryDnssece2EParamsQueryTypeTSIG DNSSummaryDnssece2EParamsQueryType = "TSIG" DNSSummaryDnssece2EParamsQueryTypeTXT DNSSummaryDnssece2EParamsQueryType = "TXT" DNSSummaryDnssece2EParamsQueryTypeUinfo DNSSummaryDnssece2EParamsQueryType = "UINFO" DNSSummaryDnssece2EParamsQueryTypeUID DNSSummaryDnssece2EParamsQueryType = "UID" DNSSummaryDnssece2EParamsQueryTypeUnspec DNSSummaryDnssece2EParamsQueryType = "UNSPEC" DNSSummaryDnssece2EParamsQueryTypeURI DNSSummaryDnssece2EParamsQueryType = "URI" DNSSummaryDnssece2EParamsQueryTypeWks DNSSummaryDnssece2EParamsQueryType = "WKS" DNSSummaryDnssece2EParamsQueryTypeX25 DNSSummaryDnssece2EParamsQueryType = "X25" DNSSummaryDnssece2EParamsQueryTypeZonemd DNSSummaryDnssece2EParamsQueryType = "ZONEMD" )
func (DNSSummaryDnssece2EParamsQueryType) IsKnown ¶
func (r DNSSummaryDnssece2EParamsQueryType) IsKnown() bool
type DNSSummaryDnssece2EParamsResponseCode ¶
type DNSSummaryDnssece2EParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryDnssece2EParamsResponseCodeNoerror DNSSummaryDnssece2EParamsResponseCode = "NOERROR" DNSSummaryDnssece2EParamsResponseCodeFormerr DNSSummaryDnssece2EParamsResponseCode = "FORMERR" DNSSummaryDnssece2EParamsResponseCodeServfail DNSSummaryDnssece2EParamsResponseCode = "SERVFAIL" DNSSummaryDnssece2EParamsResponseCodeNxdomain DNSSummaryDnssece2EParamsResponseCode = "NXDOMAIN" DNSSummaryDnssece2EParamsResponseCodeNotimp DNSSummaryDnssece2EParamsResponseCode = "NOTIMP" DNSSummaryDnssece2EParamsResponseCodeRefused DNSSummaryDnssece2EParamsResponseCode = "REFUSED" DNSSummaryDnssece2EParamsResponseCodeYxdomain DNSSummaryDnssece2EParamsResponseCode = "YXDOMAIN" DNSSummaryDnssece2EParamsResponseCodeYxrrset DNSSummaryDnssece2EParamsResponseCode = "YXRRSET" DNSSummaryDnssece2EParamsResponseCodeNxrrset DNSSummaryDnssece2EParamsResponseCode = "NXRRSET" DNSSummaryDnssece2EParamsResponseCodeNotauth DNSSummaryDnssece2EParamsResponseCode = "NOTAUTH" DNSSummaryDnssece2EParamsResponseCodeNotzone DNSSummaryDnssece2EParamsResponseCode = "NOTZONE" DNSSummaryDnssece2EParamsResponseCodeBadsig DNSSummaryDnssece2EParamsResponseCode = "BADSIG" DNSSummaryDnssece2EParamsResponseCodeBadkey DNSSummaryDnssece2EParamsResponseCode = "BADKEY" DNSSummaryDnssece2EParamsResponseCodeBadtime DNSSummaryDnssece2EParamsResponseCode = "BADTIME" DNSSummaryDnssece2EParamsResponseCodeBadmode DNSSummaryDnssece2EParamsResponseCode = "BADMODE" DNSSummaryDnssece2EParamsResponseCodeBadname DNSSummaryDnssece2EParamsResponseCode = "BADNAME" DNSSummaryDnssece2EParamsResponseCodeBadalg DNSSummaryDnssece2EParamsResponseCode = "BADALG" DNSSummaryDnssece2EParamsResponseCodeBadtrunc DNSSummaryDnssece2EParamsResponseCode = "BADTRUNC" )
func (DNSSummaryDnssece2EParamsResponseCode) IsKnown ¶
func (r DNSSummaryDnssece2EParamsResponseCode) IsKnown() bool
type DNSSummaryDnssece2EResponse ¶
type DNSSummaryDnssece2EResponse struct {
// Metadata for the results.
Meta DNSSummaryDnssece2EResponseMeta `json:"meta,required"`
Summary0 DNSSummaryDnssece2EResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryDnssece2EResponseJSON `json:"-"`
}
func (*DNSSummaryDnssece2EResponse) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EResponseEnvelope ¶
type DNSSummaryDnssece2EResponseEnvelope struct {
Result DNSSummaryDnssece2EResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryDnssece2EResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryDnssece2EResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EResponseMeta ¶
type DNSSummaryDnssece2EResponseMeta struct {
ConfidenceInfo DNSSummaryDnssece2EResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryDnssece2EResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryDnssece2EResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryDnssece2EResponseMetaUnit `json:"units,required"`
JSON dnsSummaryDnssece2EResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryDnssece2EResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EResponseMetaConfidenceInfo ¶
type DNSSummaryDnssece2EResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryDnssece2EResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryDnssece2EResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryDnssece2EResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryDnssece2EResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryDnssece2EResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryDnssece2EResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EResponseMetaDateRange ¶
type DNSSummaryDnssece2EResponseMetaDateRange 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 dnsSummaryDnssece2EResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryDnssece2EResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EResponseMetaNormalization ¶
type DNSSummaryDnssece2EResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryDnssece2EResponseMetaNormalizationPercentage DNSSummaryDnssece2EResponseMetaNormalization = "PERCENTAGE" DNSSummaryDnssece2EResponseMetaNormalizationMin0Max DNSSummaryDnssece2EResponseMetaNormalization = "MIN0_MAX" DNSSummaryDnssece2EResponseMetaNormalizationMinMax DNSSummaryDnssece2EResponseMetaNormalization = "MIN_MAX" DNSSummaryDnssece2EResponseMetaNormalizationRawValues DNSSummaryDnssece2EResponseMetaNormalization = "RAW_VALUES" DNSSummaryDnssece2EResponseMetaNormalizationPercentageChange DNSSummaryDnssece2EResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryDnssece2EResponseMetaNormalizationRollingAverage DNSSummaryDnssece2EResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryDnssece2EResponseMetaNormalizationOverlappedPercentage DNSSummaryDnssece2EResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryDnssece2EResponseMetaNormalizationRatio DNSSummaryDnssece2EResponseMetaNormalization = "RATIO" )
func (DNSSummaryDnssece2EResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryDnssece2EResponseMetaNormalization) IsKnown() bool
type DNSSummaryDnssece2EResponseMetaUnit ¶
type DNSSummaryDnssece2EResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryDnssece2EResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryDnssece2EResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryDnssece2EResponseSummary0 ¶
type DNSSummaryDnssece2EResponseSummary0 struct {
// A numeric string.
Negative string `json:"NEGATIVE,required"`
// A numeric string.
Positive string `json:"POSITIVE,required"`
JSON dnsSummaryDnssece2EResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryDnssece2EResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryDnssece2EResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionParams ¶
type DNSSummaryIPVersionParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryIPVersionParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryIPVersionParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryIPVersionParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryIPVersionParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryIPVersionParams) URLQuery ¶
func (r DNSSummaryIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryIPVersionParams's query parameters as `url.Values`.
type DNSSummaryIPVersionParamsFormat ¶
type DNSSummaryIPVersionParamsFormat string
Format in which results will be returned.
const ( DNSSummaryIPVersionParamsFormatJson DNSSummaryIPVersionParamsFormat = "JSON" DNSSummaryIPVersionParamsFormatCsv DNSSummaryIPVersionParamsFormat = "CSV" )
func (DNSSummaryIPVersionParamsFormat) IsKnown ¶
func (r DNSSummaryIPVersionParamsFormat) IsKnown() bool
type DNSSummaryIPVersionParamsProtocol ¶
type DNSSummaryIPVersionParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryIPVersionParamsProtocolUdp DNSSummaryIPVersionParamsProtocol = "UDP" DNSSummaryIPVersionParamsProtocolTCP DNSSummaryIPVersionParamsProtocol = "TCP" DNSSummaryIPVersionParamsProtocolHTTPS DNSSummaryIPVersionParamsProtocol = "HTTPS" DNSSummaryIPVersionParamsProtocolTLS DNSSummaryIPVersionParamsProtocol = "TLS" )
func (DNSSummaryIPVersionParamsProtocol) IsKnown ¶
func (r DNSSummaryIPVersionParamsProtocol) IsKnown() bool
type DNSSummaryIPVersionParamsQueryType ¶
type DNSSummaryIPVersionParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryIPVersionParamsQueryTypeA DNSSummaryIPVersionParamsQueryType = "A" DNSSummaryIPVersionParamsQueryTypeAAAA DNSSummaryIPVersionParamsQueryType = "AAAA" DNSSummaryIPVersionParamsQueryTypeA6 DNSSummaryIPVersionParamsQueryType = "A6" DNSSummaryIPVersionParamsQueryTypeAfsdb DNSSummaryIPVersionParamsQueryType = "AFSDB" DNSSummaryIPVersionParamsQueryTypeAny DNSSummaryIPVersionParamsQueryType = "ANY" DNSSummaryIPVersionParamsQueryTypeApl DNSSummaryIPVersionParamsQueryType = "APL" DNSSummaryIPVersionParamsQueryTypeAtma DNSSummaryIPVersionParamsQueryType = "ATMA" DNSSummaryIPVersionParamsQueryTypeAXFR DNSSummaryIPVersionParamsQueryType = "AXFR" DNSSummaryIPVersionParamsQueryTypeCAA DNSSummaryIPVersionParamsQueryType = "CAA" DNSSummaryIPVersionParamsQueryTypeCdnskey DNSSummaryIPVersionParamsQueryType = "CDNSKEY" DNSSummaryIPVersionParamsQueryTypeCds DNSSummaryIPVersionParamsQueryType = "CDS" DNSSummaryIPVersionParamsQueryTypeCERT DNSSummaryIPVersionParamsQueryType = "CERT" DNSSummaryIPVersionParamsQueryTypeCNAME DNSSummaryIPVersionParamsQueryType = "CNAME" DNSSummaryIPVersionParamsQueryTypeCsync DNSSummaryIPVersionParamsQueryType = "CSYNC" DNSSummaryIPVersionParamsQueryTypeDhcid DNSSummaryIPVersionParamsQueryType = "DHCID" DNSSummaryIPVersionParamsQueryTypeDlv DNSSummaryIPVersionParamsQueryType = "DLV" DNSSummaryIPVersionParamsQueryTypeDname DNSSummaryIPVersionParamsQueryType = "DNAME" DNSSummaryIPVersionParamsQueryTypeDNSKEY DNSSummaryIPVersionParamsQueryType = "DNSKEY" DNSSummaryIPVersionParamsQueryTypeDoa DNSSummaryIPVersionParamsQueryType = "DOA" DNSSummaryIPVersionParamsQueryTypeDS DNSSummaryIPVersionParamsQueryType = "DS" DNSSummaryIPVersionParamsQueryTypeEid DNSSummaryIPVersionParamsQueryType = "EID" DNSSummaryIPVersionParamsQueryTypeEui48 DNSSummaryIPVersionParamsQueryType = "EUI48" DNSSummaryIPVersionParamsQueryTypeEui64 DNSSummaryIPVersionParamsQueryType = "EUI64" DNSSummaryIPVersionParamsQueryTypeGpos DNSSummaryIPVersionParamsQueryType = "GPOS" DNSSummaryIPVersionParamsQueryTypeGid DNSSummaryIPVersionParamsQueryType = "GID" DNSSummaryIPVersionParamsQueryTypeHinfo DNSSummaryIPVersionParamsQueryType = "HINFO" DNSSummaryIPVersionParamsQueryTypeHip DNSSummaryIPVersionParamsQueryType = "HIP" DNSSummaryIPVersionParamsQueryTypeHTTPS DNSSummaryIPVersionParamsQueryType = "HTTPS" DNSSummaryIPVersionParamsQueryTypeIpseckey DNSSummaryIPVersionParamsQueryType = "IPSECKEY" DNSSummaryIPVersionParamsQueryTypeIsdn DNSSummaryIPVersionParamsQueryType = "ISDN" DNSSummaryIPVersionParamsQueryTypeIxfr DNSSummaryIPVersionParamsQueryType = "IXFR" DNSSummaryIPVersionParamsQueryTypeKey DNSSummaryIPVersionParamsQueryType = "KEY" DNSSummaryIPVersionParamsQueryTypeKx DNSSummaryIPVersionParamsQueryType = "KX" DNSSummaryIPVersionParamsQueryTypeL32 DNSSummaryIPVersionParamsQueryType = "L32" DNSSummaryIPVersionParamsQueryTypeL64 DNSSummaryIPVersionParamsQueryType = "L64" DNSSummaryIPVersionParamsQueryTypeLOC DNSSummaryIPVersionParamsQueryType = "LOC" DNSSummaryIPVersionParamsQueryTypeLp DNSSummaryIPVersionParamsQueryType = "LP" DNSSummaryIPVersionParamsQueryTypeMaila DNSSummaryIPVersionParamsQueryType = "MAILA" DNSSummaryIPVersionParamsQueryTypeMailb DNSSummaryIPVersionParamsQueryType = "MAILB" DNSSummaryIPVersionParamsQueryTypeMB DNSSummaryIPVersionParamsQueryType = "MB" DNSSummaryIPVersionParamsQueryTypeMd DNSSummaryIPVersionParamsQueryType = "MD" DNSSummaryIPVersionParamsQueryTypeMf DNSSummaryIPVersionParamsQueryType = "MF" DNSSummaryIPVersionParamsQueryTypeMg DNSSummaryIPVersionParamsQueryType = "MG" DNSSummaryIPVersionParamsQueryTypeMinfo DNSSummaryIPVersionParamsQueryType = "MINFO" DNSSummaryIPVersionParamsQueryTypeMr DNSSummaryIPVersionParamsQueryType = "MR" DNSSummaryIPVersionParamsQueryTypeMX DNSSummaryIPVersionParamsQueryType = "MX" DNSSummaryIPVersionParamsQueryTypeNAPTR DNSSummaryIPVersionParamsQueryType = "NAPTR" DNSSummaryIPVersionParamsQueryTypeNb DNSSummaryIPVersionParamsQueryType = "NB" DNSSummaryIPVersionParamsQueryTypeNbstat DNSSummaryIPVersionParamsQueryType = "NBSTAT" DNSSummaryIPVersionParamsQueryTypeNid DNSSummaryIPVersionParamsQueryType = "NID" DNSSummaryIPVersionParamsQueryTypeNimloc DNSSummaryIPVersionParamsQueryType = "NIMLOC" DNSSummaryIPVersionParamsQueryTypeNinfo DNSSummaryIPVersionParamsQueryType = "NINFO" DNSSummaryIPVersionParamsQueryTypeNS DNSSummaryIPVersionParamsQueryType = "NS" DNSSummaryIPVersionParamsQueryTypeNsap DNSSummaryIPVersionParamsQueryType = "NSAP" DNSSummaryIPVersionParamsQueryTypeNsec DNSSummaryIPVersionParamsQueryType = "NSEC" DNSSummaryIPVersionParamsQueryTypeNsec3 DNSSummaryIPVersionParamsQueryType = "NSEC3" DNSSummaryIPVersionParamsQueryTypeNsec3Param DNSSummaryIPVersionParamsQueryType = "NSEC3PARAM" DNSSummaryIPVersionParamsQueryTypeNull DNSSummaryIPVersionParamsQueryType = "NULL" DNSSummaryIPVersionParamsQueryTypeNxt DNSSummaryIPVersionParamsQueryType = "NXT" DNSSummaryIPVersionParamsQueryTypeOpenpgpkey DNSSummaryIPVersionParamsQueryType = "OPENPGPKEY" DNSSummaryIPVersionParamsQueryTypeOpt DNSSummaryIPVersionParamsQueryType = "OPT" DNSSummaryIPVersionParamsQueryTypePTR DNSSummaryIPVersionParamsQueryType = "PTR" DNSSummaryIPVersionParamsQueryTypePx DNSSummaryIPVersionParamsQueryType = "PX" DNSSummaryIPVersionParamsQueryTypeRkey DNSSummaryIPVersionParamsQueryType = "RKEY" DNSSummaryIPVersionParamsQueryTypeRp DNSSummaryIPVersionParamsQueryType = "RP" DNSSummaryIPVersionParamsQueryTypeRrsig DNSSummaryIPVersionParamsQueryType = "RRSIG" DNSSummaryIPVersionParamsQueryTypeRt DNSSummaryIPVersionParamsQueryType = "RT" DNSSummaryIPVersionParamsQueryTypeSig DNSSummaryIPVersionParamsQueryType = "SIG" DNSSummaryIPVersionParamsQueryTypeSink DNSSummaryIPVersionParamsQueryType = "SINK" DNSSummaryIPVersionParamsQueryTypeSMIMEA DNSSummaryIPVersionParamsQueryType = "SMIMEA" DNSSummaryIPVersionParamsQueryTypeSOA DNSSummaryIPVersionParamsQueryType = "SOA" DNSSummaryIPVersionParamsQueryTypeSPF DNSSummaryIPVersionParamsQueryType = "SPF" DNSSummaryIPVersionParamsQueryTypeSRV DNSSummaryIPVersionParamsQueryType = "SRV" DNSSummaryIPVersionParamsQueryTypeSSHFP DNSSummaryIPVersionParamsQueryType = "SSHFP" DNSSummaryIPVersionParamsQueryTypeSVCB DNSSummaryIPVersionParamsQueryType = "SVCB" DNSSummaryIPVersionParamsQueryTypeTa DNSSummaryIPVersionParamsQueryType = "TA" DNSSummaryIPVersionParamsQueryTypeTalink DNSSummaryIPVersionParamsQueryType = "TALINK" DNSSummaryIPVersionParamsQueryTypeTkey DNSSummaryIPVersionParamsQueryType = "TKEY" DNSSummaryIPVersionParamsQueryTypeTLSA DNSSummaryIPVersionParamsQueryType = "TLSA" DNSSummaryIPVersionParamsQueryTypeTSIG DNSSummaryIPVersionParamsQueryType = "TSIG" DNSSummaryIPVersionParamsQueryTypeTXT DNSSummaryIPVersionParamsQueryType = "TXT" DNSSummaryIPVersionParamsQueryTypeUinfo DNSSummaryIPVersionParamsQueryType = "UINFO" DNSSummaryIPVersionParamsQueryTypeUID DNSSummaryIPVersionParamsQueryType = "UID" DNSSummaryIPVersionParamsQueryTypeUnspec DNSSummaryIPVersionParamsQueryType = "UNSPEC" DNSSummaryIPVersionParamsQueryTypeURI DNSSummaryIPVersionParamsQueryType = "URI" DNSSummaryIPVersionParamsQueryTypeWks DNSSummaryIPVersionParamsQueryType = "WKS" DNSSummaryIPVersionParamsQueryTypeX25 DNSSummaryIPVersionParamsQueryType = "X25" DNSSummaryIPVersionParamsQueryTypeZonemd DNSSummaryIPVersionParamsQueryType = "ZONEMD" )
func (DNSSummaryIPVersionParamsQueryType) IsKnown ¶
func (r DNSSummaryIPVersionParamsQueryType) IsKnown() bool
type DNSSummaryIPVersionParamsResponseCode ¶
type DNSSummaryIPVersionParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryIPVersionParamsResponseCodeNoerror DNSSummaryIPVersionParamsResponseCode = "NOERROR" DNSSummaryIPVersionParamsResponseCodeFormerr DNSSummaryIPVersionParamsResponseCode = "FORMERR" DNSSummaryIPVersionParamsResponseCodeServfail DNSSummaryIPVersionParamsResponseCode = "SERVFAIL" DNSSummaryIPVersionParamsResponseCodeNxdomain DNSSummaryIPVersionParamsResponseCode = "NXDOMAIN" DNSSummaryIPVersionParamsResponseCodeNotimp DNSSummaryIPVersionParamsResponseCode = "NOTIMP" DNSSummaryIPVersionParamsResponseCodeRefused DNSSummaryIPVersionParamsResponseCode = "REFUSED" DNSSummaryIPVersionParamsResponseCodeYxdomain DNSSummaryIPVersionParamsResponseCode = "YXDOMAIN" DNSSummaryIPVersionParamsResponseCodeYxrrset DNSSummaryIPVersionParamsResponseCode = "YXRRSET" DNSSummaryIPVersionParamsResponseCodeNxrrset DNSSummaryIPVersionParamsResponseCode = "NXRRSET" DNSSummaryIPVersionParamsResponseCodeNotauth DNSSummaryIPVersionParamsResponseCode = "NOTAUTH" DNSSummaryIPVersionParamsResponseCodeNotzone DNSSummaryIPVersionParamsResponseCode = "NOTZONE" DNSSummaryIPVersionParamsResponseCodeBadsig DNSSummaryIPVersionParamsResponseCode = "BADSIG" DNSSummaryIPVersionParamsResponseCodeBadkey DNSSummaryIPVersionParamsResponseCode = "BADKEY" DNSSummaryIPVersionParamsResponseCodeBadtime DNSSummaryIPVersionParamsResponseCode = "BADTIME" DNSSummaryIPVersionParamsResponseCodeBadmode DNSSummaryIPVersionParamsResponseCode = "BADMODE" DNSSummaryIPVersionParamsResponseCodeBadname DNSSummaryIPVersionParamsResponseCode = "BADNAME" DNSSummaryIPVersionParamsResponseCodeBadalg DNSSummaryIPVersionParamsResponseCode = "BADALG" DNSSummaryIPVersionParamsResponseCodeBadtrunc DNSSummaryIPVersionParamsResponseCode = "BADTRUNC" )
func (DNSSummaryIPVersionParamsResponseCode) IsKnown ¶
func (r DNSSummaryIPVersionParamsResponseCode) IsKnown() bool
type DNSSummaryIPVersionResponse ¶
type DNSSummaryIPVersionResponse struct {
// Metadata for the results.
Meta DNSSummaryIPVersionResponseMeta `json:"meta,required"`
Summary0 DNSSummaryIPVersionResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryIPVersionResponseJSON `json:"-"`
}
func (*DNSSummaryIPVersionResponse) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionResponseEnvelope ¶
type DNSSummaryIPVersionResponseEnvelope struct {
Result DNSSummaryIPVersionResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryIPVersionResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryIPVersionResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionResponseMeta ¶
type DNSSummaryIPVersionResponseMeta struct {
ConfidenceInfo DNSSummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryIPVersionResponseMetaUnit `json:"units,required"`
JSON dnsSummaryIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryIPVersionResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionResponseMetaConfidenceInfo ¶
type DNSSummaryIPVersionResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryIPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryIPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionResponseMetaDateRange ¶
type DNSSummaryIPVersionResponseMetaDateRange 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 dnsSummaryIPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryIPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionResponseMetaNormalization ¶
type DNSSummaryIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryIPVersionResponseMetaNormalizationPercentage DNSSummaryIPVersionResponseMetaNormalization = "PERCENTAGE" DNSSummaryIPVersionResponseMetaNormalizationMin0Max DNSSummaryIPVersionResponseMetaNormalization = "MIN0_MAX" DNSSummaryIPVersionResponseMetaNormalizationMinMax DNSSummaryIPVersionResponseMetaNormalization = "MIN_MAX" DNSSummaryIPVersionResponseMetaNormalizationRawValues DNSSummaryIPVersionResponseMetaNormalization = "RAW_VALUES" DNSSummaryIPVersionResponseMetaNormalizationPercentageChange DNSSummaryIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryIPVersionResponseMetaNormalizationRollingAverage DNSSummaryIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryIPVersionResponseMetaNormalizationOverlappedPercentage DNSSummaryIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryIPVersionResponseMetaNormalizationRatio DNSSummaryIPVersionResponseMetaNormalization = "RATIO" )
func (DNSSummaryIPVersionResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryIPVersionResponseMetaNormalization) IsKnown() bool
type DNSSummaryIPVersionResponseMetaUnit ¶
type DNSSummaryIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryIPVersionResponseSummary0 ¶
type DNSSummaryIPVersionResponseSummary0 struct {
// A numeric string.
IPv4 string `json:"IPv4,required"`
// A numeric string.
IPv6 string `json:"IPv6,required"`
JSON dnsSummaryIPVersionResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryIPVersionResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerParams ¶
type DNSSummaryMatchingAnswerParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryMatchingAnswerParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryMatchingAnswerParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryMatchingAnswerParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryMatchingAnswerParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryMatchingAnswerParams) URLQuery ¶
func (r DNSSummaryMatchingAnswerParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryMatchingAnswerParams's query parameters as `url.Values`.
type DNSSummaryMatchingAnswerParamsFormat ¶
type DNSSummaryMatchingAnswerParamsFormat string
Format in which results will be returned.
const ( DNSSummaryMatchingAnswerParamsFormatJson DNSSummaryMatchingAnswerParamsFormat = "JSON" DNSSummaryMatchingAnswerParamsFormatCsv DNSSummaryMatchingAnswerParamsFormat = "CSV" )
func (DNSSummaryMatchingAnswerParamsFormat) IsKnown ¶
func (r DNSSummaryMatchingAnswerParamsFormat) IsKnown() bool
type DNSSummaryMatchingAnswerParamsProtocol ¶
type DNSSummaryMatchingAnswerParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryMatchingAnswerParamsProtocolUdp DNSSummaryMatchingAnswerParamsProtocol = "UDP" DNSSummaryMatchingAnswerParamsProtocolTCP DNSSummaryMatchingAnswerParamsProtocol = "TCP" DNSSummaryMatchingAnswerParamsProtocolHTTPS DNSSummaryMatchingAnswerParamsProtocol = "HTTPS" DNSSummaryMatchingAnswerParamsProtocolTLS DNSSummaryMatchingAnswerParamsProtocol = "TLS" )
func (DNSSummaryMatchingAnswerParamsProtocol) IsKnown ¶
func (r DNSSummaryMatchingAnswerParamsProtocol) IsKnown() bool
type DNSSummaryMatchingAnswerParamsQueryType ¶
type DNSSummaryMatchingAnswerParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryMatchingAnswerParamsQueryTypeA DNSSummaryMatchingAnswerParamsQueryType = "A" DNSSummaryMatchingAnswerParamsQueryTypeAAAA DNSSummaryMatchingAnswerParamsQueryType = "AAAA" DNSSummaryMatchingAnswerParamsQueryTypeA6 DNSSummaryMatchingAnswerParamsQueryType = "A6" DNSSummaryMatchingAnswerParamsQueryTypeAfsdb DNSSummaryMatchingAnswerParamsQueryType = "AFSDB" DNSSummaryMatchingAnswerParamsQueryTypeAny DNSSummaryMatchingAnswerParamsQueryType = "ANY" DNSSummaryMatchingAnswerParamsQueryTypeApl DNSSummaryMatchingAnswerParamsQueryType = "APL" DNSSummaryMatchingAnswerParamsQueryTypeAtma DNSSummaryMatchingAnswerParamsQueryType = "ATMA" DNSSummaryMatchingAnswerParamsQueryTypeAXFR DNSSummaryMatchingAnswerParamsQueryType = "AXFR" DNSSummaryMatchingAnswerParamsQueryTypeCAA DNSSummaryMatchingAnswerParamsQueryType = "CAA" DNSSummaryMatchingAnswerParamsQueryTypeCdnskey DNSSummaryMatchingAnswerParamsQueryType = "CDNSKEY" DNSSummaryMatchingAnswerParamsQueryTypeCds DNSSummaryMatchingAnswerParamsQueryType = "CDS" DNSSummaryMatchingAnswerParamsQueryTypeCERT DNSSummaryMatchingAnswerParamsQueryType = "CERT" DNSSummaryMatchingAnswerParamsQueryTypeCNAME DNSSummaryMatchingAnswerParamsQueryType = "CNAME" DNSSummaryMatchingAnswerParamsQueryTypeCsync DNSSummaryMatchingAnswerParamsQueryType = "CSYNC" DNSSummaryMatchingAnswerParamsQueryTypeDhcid DNSSummaryMatchingAnswerParamsQueryType = "DHCID" DNSSummaryMatchingAnswerParamsQueryTypeDlv DNSSummaryMatchingAnswerParamsQueryType = "DLV" DNSSummaryMatchingAnswerParamsQueryTypeDname DNSSummaryMatchingAnswerParamsQueryType = "DNAME" DNSSummaryMatchingAnswerParamsQueryTypeDNSKEY DNSSummaryMatchingAnswerParamsQueryType = "DNSKEY" DNSSummaryMatchingAnswerParamsQueryTypeDoa DNSSummaryMatchingAnswerParamsQueryType = "DOA" DNSSummaryMatchingAnswerParamsQueryTypeDS DNSSummaryMatchingAnswerParamsQueryType = "DS" DNSSummaryMatchingAnswerParamsQueryTypeEid DNSSummaryMatchingAnswerParamsQueryType = "EID" DNSSummaryMatchingAnswerParamsQueryTypeEui48 DNSSummaryMatchingAnswerParamsQueryType = "EUI48" DNSSummaryMatchingAnswerParamsQueryTypeEui64 DNSSummaryMatchingAnswerParamsQueryType = "EUI64" DNSSummaryMatchingAnswerParamsQueryTypeGpos DNSSummaryMatchingAnswerParamsQueryType = "GPOS" DNSSummaryMatchingAnswerParamsQueryTypeGid DNSSummaryMatchingAnswerParamsQueryType = "GID" DNSSummaryMatchingAnswerParamsQueryTypeHinfo DNSSummaryMatchingAnswerParamsQueryType = "HINFO" DNSSummaryMatchingAnswerParamsQueryTypeHip DNSSummaryMatchingAnswerParamsQueryType = "HIP" DNSSummaryMatchingAnswerParamsQueryTypeHTTPS DNSSummaryMatchingAnswerParamsQueryType = "HTTPS" DNSSummaryMatchingAnswerParamsQueryTypeIpseckey DNSSummaryMatchingAnswerParamsQueryType = "IPSECKEY" DNSSummaryMatchingAnswerParamsQueryTypeIsdn DNSSummaryMatchingAnswerParamsQueryType = "ISDN" DNSSummaryMatchingAnswerParamsQueryTypeIxfr DNSSummaryMatchingAnswerParamsQueryType = "IXFR" DNSSummaryMatchingAnswerParamsQueryTypeKey DNSSummaryMatchingAnswerParamsQueryType = "KEY" DNSSummaryMatchingAnswerParamsQueryTypeKx DNSSummaryMatchingAnswerParamsQueryType = "KX" DNSSummaryMatchingAnswerParamsQueryTypeL32 DNSSummaryMatchingAnswerParamsQueryType = "L32" DNSSummaryMatchingAnswerParamsQueryTypeL64 DNSSummaryMatchingAnswerParamsQueryType = "L64" DNSSummaryMatchingAnswerParamsQueryTypeLOC DNSSummaryMatchingAnswerParamsQueryType = "LOC" DNSSummaryMatchingAnswerParamsQueryTypeLp DNSSummaryMatchingAnswerParamsQueryType = "LP" DNSSummaryMatchingAnswerParamsQueryTypeMaila DNSSummaryMatchingAnswerParamsQueryType = "MAILA" DNSSummaryMatchingAnswerParamsQueryTypeMailb DNSSummaryMatchingAnswerParamsQueryType = "MAILB" DNSSummaryMatchingAnswerParamsQueryTypeMB DNSSummaryMatchingAnswerParamsQueryType = "MB" DNSSummaryMatchingAnswerParamsQueryTypeMd DNSSummaryMatchingAnswerParamsQueryType = "MD" DNSSummaryMatchingAnswerParamsQueryTypeMf DNSSummaryMatchingAnswerParamsQueryType = "MF" DNSSummaryMatchingAnswerParamsQueryTypeMg DNSSummaryMatchingAnswerParamsQueryType = "MG" DNSSummaryMatchingAnswerParamsQueryTypeMinfo DNSSummaryMatchingAnswerParamsQueryType = "MINFO" DNSSummaryMatchingAnswerParamsQueryTypeMr DNSSummaryMatchingAnswerParamsQueryType = "MR" DNSSummaryMatchingAnswerParamsQueryTypeMX DNSSummaryMatchingAnswerParamsQueryType = "MX" DNSSummaryMatchingAnswerParamsQueryTypeNAPTR DNSSummaryMatchingAnswerParamsQueryType = "NAPTR" DNSSummaryMatchingAnswerParamsQueryTypeNb DNSSummaryMatchingAnswerParamsQueryType = "NB" DNSSummaryMatchingAnswerParamsQueryTypeNbstat DNSSummaryMatchingAnswerParamsQueryType = "NBSTAT" DNSSummaryMatchingAnswerParamsQueryTypeNid DNSSummaryMatchingAnswerParamsQueryType = "NID" DNSSummaryMatchingAnswerParamsQueryTypeNimloc DNSSummaryMatchingAnswerParamsQueryType = "NIMLOC" DNSSummaryMatchingAnswerParamsQueryTypeNinfo DNSSummaryMatchingAnswerParamsQueryType = "NINFO" DNSSummaryMatchingAnswerParamsQueryTypeNS DNSSummaryMatchingAnswerParamsQueryType = "NS" DNSSummaryMatchingAnswerParamsQueryTypeNsap DNSSummaryMatchingAnswerParamsQueryType = "NSAP" DNSSummaryMatchingAnswerParamsQueryTypeNsec DNSSummaryMatchingAnswerParamsQueryType = "NSEC" DNSSummaryMatchingAnswerParamsQueryTypeNsec3 DNSSummaryMatchingAnswerParamsQueryType = "NSEC3" DNSSummaryMatchingAnswerParamsQueryTypeNsec3Param DNSSummaryMatchingAnswerParamsQueryType = "NSEC3PARAM" DNSSummaryMatchingAnswerParamsQueryTypeNull DNSSummaryMatchingAnswerParamsQueryType = "NULL" DNSSummaryMatchingAnswerParamsQueryTypeNxt DNSSummaryMatchingAnswerParamsQueryType = "NXT" DNSSummaryMatchingAnswerParamsQueryTypeOpenpgpkey DNSSummaryMatchingAnswerParamsQueryType = "OPENPGPKEY" DNSSummaryMatchingAnswerParamsQueryTypeOpt DNSSummaryMatchingAnswerParamsQueryType = "OPT" DNSSummaryMatchingAnswerParamsQueryTypePTR DNSSummaryMatchingAnswerParamsQueryType = "PTR" DNSSummaryMatchingAnswerParamsQueryTypePx DNSSummaryMatchingAnswerParamsQueryType = "PX" DNSSummaryMatchingAnswerParamsQueryTypeRkey DNSSummaryMatchingAnswerParamsQueryType = "RKEY" DNSSummaryMatchingAnswerParamsQueryTypeRp DNSSummaryMatchingAnswerParamsQueryType = "RP" DNSSummaryMatchingAnswerParamsQueryTypeRrsig DNSSummaryMatchingAnswerParamsQueryType = "RRSIG" DNSSummaryMatchingAnswerParamsQueryTypeRt DNSSummaryMatchingAnswerParamsQueryType = "RT" DNSSummaryMatchingAnswerParamsQueryTypeSig DNSSummaryMatchingAnswerParamsQueryType = "SIG" DNSSummaryMatchingAnswerParamsQueryTypeSink DNSSummaryMatchingAnswerParamsQueryType = "SINK" DNSSummaryMatchingAnswerParamsQueryTypeSMIMEA DNSSummaryMatchingAnswerParamsQueryType = "SMIMEA" DNSSummaryMatchingAnswerParamsQueryTypeSOA DNSSummaryMatchingAnswerParamsQueryType = "SOA" DNSSummaryMatchingAnswerParamsQueryTypeSPF DNSSummaryMatchingAnswerParamsQueryType = "SPF" DNSSummaryMatchingAnswerParamsQueryTypeSRV DNSSummaryMatchingAnswerParamsQueryType = "SRV" DNSSummaryMatchingAnswerParamsQueryTypeSSHFP DNSSummaryMatchingAnswerParamsQueryType = "SSHFP" DNSSummaryMatchingAnswerParamsQueryTypeSVCB DNSSummaryMatchingAnswerParamsQueryType = "SVCB" DNSSummaryMatchingAnswerParamsQueryTypeTa DNSSummaryMatchingAnswerParamsQueryType = "TA" DNSSummaryMatchingAnswerParamsQueryTypeTalink DNSSummaryMatchingAnswerParamsQueryType = "TALINK" DNSSummaryMatchingAnswerParamsQueryTypeTkey DNSSummaryMatchingAnswerParamsQueryType = "TKEY" DNSSummaryMatchingAnswerParamsQueryTypeTLSA DNSSummaryMatchingAnswerParamsQueryType = "TLSA" DNSSummaryMatchingAnswerParamsQueryTypeTSIG DNSSummaryMatchingAnswerParamsQueryType = "TSIG" DNSSummaryMatchingAnswerParamsQueryTypeTXT DNSSummaryMatchingAnswerParamsQueryType = "TXT" DNSSummaryMatchingAnswerParamsQueryTypeUinfo DNSSummaryMatchingAnswerParamsQueryType = "UINFO" DNSSummaryMatchingAnswerParamsQueryTypeUID DNSSummaryMatchingAnswerParamsQueryType = "UID" DNSSummaryMatchingAnswerParamsQueryTypeUnspec DNSSummaryMatchingAnswerParamsQueryType = "UNSPEC" DNSSummaryMatchingAnswerParamsQueryTypeURI DNSSummaryMatchingAnswerParamsQueryType = "URI" DNSSummaryMatchingAnswerParamsQueryTypeWks DNSSummaryMatchingAnswerParamsQueryType = "WKS" DNSSummaryMatchingAnswerParamsQueryTypeX25 DNSSummaryMatchingAnswerParamsQueryType = "X25" DNSSummaryMatchingAnswerParamsQueryTypeZonemd DNSSummaryMatchingAnswerParamsQueryType = "ZONEMD" )
func (DNSSummaryMatchingAnswerParamsQueryType) IsKnown ¶
func (r DNSSummaryMatchingAnswerParamsQueryType) IsKnown() bool
type DNSSummaryMatchingAnswerParamsResponseCode ¶
type DNSSummaryMatchingAnswerParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryMatchingAnswerParamsResponseCodeNoerror DNSSummaryMatchingAnswerParamsResponseCode = "NOERROR" DNSSummaryMatchingAnswerParamsResponseCodeFormerr DNSSummaryMatchingAnswerParamsResponseCode = "FORMERR" DNSSummaryMatchingAnswerParamsResponseCodeServfail DNSSummaryMatchingAnswerParamsResponseCode = "SERVFAIL" DNSSummaryMatchingAnswerParamsResponseCodeNxdomain DNSSummaryMatchingAnswerParamsResponseCode = "NXDOMAIN" DNSSummaryMatchingAnswerParamsResponseCodeNotimp DNSSummaryMatchingAnswerParamsResponseCode = "NOTIMP" DNSSummaryMatchingAnswerParamsResponseCodeRefused DNSSummaryMatchingAnswerParamsResponseCode = "REFUSED" DNSSummaryMatchingAnswerParamsResponseCodeYxdomain DNSSummaryMatchingAnswerParamsResponseCode = "YXDOMAIN" DNSSummaryMatchingAnswerParamsResponseCodeYxrrset DNSSummaryMatchingAnswerParamsResponseCode = "YXRRSET" DNSSummaryMatchingAnswerParamsResponseCodeNxrrset DNSSummaryMatchingAnswerParamsResponseCode = "NXRRSET" DNSSummaryMatchingAnswerParamsResponseCodeNotauth DNSSummaryMatchingAnswerParamsResponseCode = "NOTAUTH" DNSSummaryMatchingAnswerParamsResponseCodeNotzone DNSSummaryMatchingAnswerParamsResponseCode = "NOTZONE" DNSSummaryMatchingAnswerParamsResponseCodeBadsig DNSSummaryMatchingAnswerParamsResponseCode = "BADSIG" DNSSummaryMatchingAnswerParamsResponseCodeBadkey DNSSummaryMatchingAnswerParamsResponseCode = "BADKEY" DNSSummaryMatchingAnswerParamsResponseCodeBadtime DNSSummaryMatchingAnswerParamsResponseCode = "BADTIME" DNSSummaryMatchingAnswerParamsResponseCodeBadmode DNSSummaryMatchingAnswerParamsResponseCode = "BADMODE" DNSSummaryMatchingAnswerParamsResponseCodeBadname DNSSummaryMatchingAnswerParamsResponseCode = "BADNAME" DNSSummaryMatchingAnswerParamsResponseCodeBadalg DNSSummaryMatchingAnswerParamsResponseCode = "BADALG" DNSSummaryMatchingAnswerParamsResponseCodeBadtrunc DNSSummaryMatchingAnswerParamsResponseCode = "BADTRUNC" )
func (DNSSummaryMatchingAnswerParamsResponseCode) IsKnown ¶
func (r DNSSummaryMatchingAnswerParamsResponseCode) IsKnown() bool
type DNSSummaryMatchingAnswerResponse ¶
type DNSSummaryMatchingAnswerResponse struct {
// Metadata for the results.
Meta DNSSummaryMatchingAnswerResponseMeta `json:"meta,required"`
Summary0 DNSSummaryMatchingAnswerResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryMatchingAnswerResponseJSON `json:"-"`
}
func (*DNSSummaryMatchingAnswerResponse) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerResponseEnvelope ¶
type DNSSummaryMatchingAnswerResponseEnvelope struct {
Result DNSSummaryMatchingAnswerResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryMatchingAnswerResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryMatchingAnswerResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerResponseMeta ¶
type DNSSummaryMatchingAnswerResponseMeta struct {
ConfidenceInfo DNSSummaryMatchingAnswerResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryMatchingAnswerResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryMatchingAnswerResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryMatchingAnswerResponseMetaUnit `json:"units,required"`
JSON dnsSummaryMatchingAnswerResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryMatchingAnswerResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerResponseMetaConfidenceInfo ¶
type DNSSummaryMatchingAnswerResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryMatchingAnswerResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryMatchingAnswerResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryMatchingAnswerResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryMatchingAnswerResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryMatchingAnswerResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryMatchingAnswerResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerResponseMetaDateRange ¶
type DNSSummaryMatchingAnswerResponseMetaDateRange 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 dnsSummaryMatchingAnswerResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryMatchingAnswerResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerResponseMetaNormalization ¶
type DNSSummaryMatchingAnswerResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryMatchingAnswerResponseMetaNormalizationPercentage DNSSummaryMatchingAnswerResponseMetaNormalization = "PERCENTAGE" DNSSummaryMatchingAnswerResponseMetaNormalizationMin0Max DNSSummaryMatchingAnswerResponseMetaNormalization = "MIN0_MAX" DNSSummaryMatchingAnswerResponseMetaNormalizationMinMax DNSSummaryMatchingAnswerResponseMetaNormalization = "MIN_MAX" DNSSummaryMatchingAnswerResponseMetaNormalizationRawValues DNSSummaryMatchingAnswerResponseMetaNormalization = "RAW_VALUES" DNSSummaryMatchingAnswerResponseMetaNormalizationPercentageChange DNSSummaryMatchingAnswerResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryMatchingAnswerResponseMetaNormalizationRollingAverage DNSSummaryMatchingAnswerResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryMatchingAnswerResponseMetaNormalizationOverlappedPercentage DNSSummaryMatchingAnswerResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryMatchingAnswerResponseMetaNormalizationRatio DNSSummaryMatchingAnswerResponseMetaNormalization = "RATIO" )
func (DNSSummaryMatchingAnswerResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryMatchingAnswerResponseMetaNormalization) IsKnown() bool
type DNSSummaryMatchingAnswerResponseMetaUnit ¶
type DNSSummaryMatchingAnswerResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryMatchingAnswerResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryMatchingAnswerResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryMatchingAnswerResponseSummary0 ¶
type DNSSummaryMatchingAnswerResponseSummary0 struct {
// A numeric string.
Negative string `json:"NEGATIVE,required"`
// A numeric string.
Positive string `json:"POSITIVE,required"`
JSON dnsSummaryMatchingAnswerResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryMatchingAnswerResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryMatchingAnswerResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolParams ¶
type DNSSummaryProtocolParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryProtocolParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryProtocolParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryProtocolParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryProtocolParams) URLQuery ¶
func (r DNSSummaryProtocolParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryProtocolParams's query parameters as `url.Values`.
type DNSSummaryProtocolParamsFormat ¶
type DNSSummaryProtocolParamsFormat string
Format in which results will be returned.
const ( DNSSummaryProtocolParamsFormatJson DNSSummaryProtocolParamsFormat = "JSON" DNSSummaryProtocolParamsFormatCsv DNSSummaryProtocolParamsFormat = "CSV" )
func (DNSSummaryProtocolParamsFormat) IsKnown ¶
func (r DNSSummaryProtocolParamsFormat) IsKnown() bool
type DNSSummaryProtocolParamsQueryType ¶
type DNSSummaryProtocolParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryProtocolParamsQueryTypeA DNSSummaryProtocolParamsQueryType = "A" DNSSummaryProtocolParamsQueryTypeAAAA DNSSummaryProtocolParamsQueryType = "AAAA" DNSSummaryProtocolParamsQueryTypeA6 DNSSummaryProtocolParamsQueryType = "A6" DNSSummaryProtocolParamsQueryTypeAfsdb DNSSummaryProtocolParamsQueryType = "AFSDB" DNSSummaryProtocolParamsQueryTypeAny DNSSummaryProtocolParamsQueryType = "ANY" DNSSummaryProtocolParamsQueryTypeApl DNSSummaryProtocolParamsQueryType = "APL" DNSSummaryProtocolParamsQueryTypeAtma DNSSummaryProtocolParamsQueryType = "ATMA" DNSSummaryProtocolParamsQueryTypeAXFR DNSSummaryProtocolParamsQueryType = "AXFR" DNSSummaryProtocolParamsQueryTypeCAA DNSSummaryProtocolParamsQueryType = "CAA" DNSSummaryProtocolParamsQueryTypeCdnskey DNSSummaryProtocolParamsQueryType = "CDNSKEY" DNSSummaryProtocolParamsQueryTypeCds DNSSummaryProtocolParamsQueryType = "CDS" DNSSummaryProtocolParamsQueryTypeCERT DNSSummaryProtocolParamsQueryType = "CERT" DNSSummaryProtocolParamsQueryTypeCNAME DNSSummaryProtocolParamsQueryType = "CNAME" DNSSummaryProtocolParamsQueryTypeCsync DNSSummaryProtocolParamsQueryType = "CSYNC" DNSSummaryProtocolParamsQueryTypeDhcid DNSSummaryProtocolParamsQueryType = "DHCID" DNSSummaryProtocolParamsQueryTypeDlv DNSSummaryProtocolParamsQueryType = "DLV" DNSSummaryProtocolParamsQueryTypeDname DNSSummaryProtocolParamsQueryType = "DNAME" DNSSummaryProtocolParamsQueryTypeDNSKEY DNSSummaryProtocolParamsQueryType = "DNSKEY" DNSSummaryProtocolParamsQueryTypeDoa DNSSummaryProtocolParamsQueryType = "DOA" DNSSummaryProtocolParamsQueryTypeDS DNSSummaryProtocolParamsQueryType = "DS" DNSSummaryProtocolParamsQueryTypeEid DNSSummaryProtocolParamsQueryType = "EID" DNSSummaryProtocolParamsQueryTypeEui48 DNSSummaryProtocolParamsQueryType = "EUI48" DNSSummaryProtocolParamsQueryTypeEui64 DNSSummaryProtocolParamsQueryType = "EUI64" DNSSummaryProtocolParamsQueryTypeGpos DNSSummaryProtocolParamsQueryType = "GPOS" DNSSummaryProtocolParamsQueryTypeGid DNSSummaryProtocolParamsQueryType = "GID" DNSSummaryProtocolParamsQueryTypeHinfo DNSSummaryProtocolParamsQueryType = "HINFO" DNSSummaryProtocolParamsQueryTypeHip DNSSummaryProtocolParamsQueryType = "HIP" DNSSummaryProtocolParamsQueryTypeHTTPS DNSSummaryProtocolParamsQueryType = "HTTPS" DNSSummaryProtocolParamsQueryTypeIpseckey DNSSummaryProtocolParamsQueryType = "IPSECKEY" DNSSummaryProtocolParamsQueryTypeIsdn DNSSummaryProtocolParamsQueryType = "ISDN" DNSSummaryProtocolParamsQueryTypeIxfr DNSSummaryProtocolParamsQueryType = "IXFR" DNSSummaryProtocolParamsQueryTypeKey DNSSummaryProtocolParamsQueryType = "KEY" DNSSummaryProtocolParamsQueryTypeKx DNSSummaryProtocolParamsQueryType = "KX" DNSSummaryProtocolParamsQueryTypeL32 DNSSummaryProtocolParamsQueryType = "L32" DNSSummaryProtocolParamsQueryTypeL64 DNSSummaryProtocolParamsQueryType = "L64" DNSSummaryProtocolParamsQueryTypeLOC DNSSummaryProtocolParamsQueryType = "LOC" DNSSummaryProtocolParamsQueryTypeLp DNSSummaryProtocolParamsQueryType = "LP" DNSSummaryProtocolParamsQueryTypeMaila DNSSummaryProtocolParamsQueryType = "MAILA" DNSSummaryProtocolParamsQueryTypeMailb DNSSummaryProtocolParamsQueryType = "MAILB" DNSSummaryProtocolParamsQueryTypeMB DNSSummaryProtocolParamsQueryType = "MB" DNSSummaryProtocolParamsQueryTypeMd DNSSummaryProtocolParamsQueryType = "MD" DNSSummaryProtocolParamsQueryTypeMf DNSSummaryProtocolParamsQueryType = "MF" DNSSummaryProtocolParamsQueryTypeMg DNSSummaryProtocolParamsQueryType = "MG" DNSSummaryProtocolParamsQueryTypeMinfo DNSSummaryProtocolParamsQueryType = "MINFO" DNSSummaryProtocolParamsQueryTypeMr DNSSummaryProtocolParamsQueryType = "MR" DNSSummaryProtocolParamsQueryTypeMX DNSSummaryProtocolParamsQueryType = "MX" DNSSummaryProtocolParamsQueryTypeNAPTR DNSSummaryProtocolParamsQueryType = "NAPTR" DNSSummaryProtocolParamsQueryTypeNb DNSSummaryProtocolParamsQueryType = "NB" DNSSummaryProtocolParamsQueryTypeNbstat DNSSummaryProtocolParamsQueryType = "NBSTAT" DNSSummaryProtocolParamsQueryTypeNid DNSSummaryProtocolParamsQueryType = "NID" DNSSummaryProtocolParamsQueryTypeNimloc DNSSummaryProtocolParamsQueryType = "NIMLOC" DNSSummaryProtocolParamsQueryTypeNinfo DNSSummaryProtocolParamsQueryType = "NINFO" DNSSummaryProtocolParamsQueryTypeNS DNSSummaryProtocolParamsQueryType = "NS" DNSSummaryProtocolParamsQueryTypeNsap DNSSummaryProtocolParamsQueryType = "NSAP" DNSSummaryProtocolParamsQueryTypeNsec DNSSummaryProtocolParamsQueryType = "NSEC" DNSSummaryProtocolParamsQueryTypeNsec3 DNSSummaryProtocolParamsQueryType = "NSEC3" DNSSummaryProtocolParamsQueryTypeNsec3Param DNSSummaryProtocolParamsQueryType = "NSEC3PARAM" DNSSummaryProtocolParamsQueryTypeNull DNSSummaryProtocolParamsQueryType = "NULL" DNSSummaryProtocolParamsQueryTypeNxt DNSSummaryProtocolParamsQueryType = "NXT" DNSSummaryProtocolParamsQueryTypeOpenpgpkey DNSSummaryProtocolParamsQueryType = "OPENPGPKEY" DNSSummaryProtocolParamsQueryTypeOpt DNSSummaryProtocolParamsQueryType = "OPT" DNSSummaryProtocolParamsQueryTypePTR DNSSummaryProtocolParamsQueryType = "PTR" DNSSummaryProtocolParamsQueryTypePx DNSSummaryProtocolParamsQueryType = "PX" DNSSummaryProtocolParamsQueryTypeRkey DNSSummaryProtocolParamsQueryType = "RKEY" DNSSummaryProtocolParamsQueryTypeRp DNSSummaryProtocolParamsQueryType = "RP" DNSSummaryProtocolParamsQueryTypeRrsig DNSSummaryProtocolParamsQueryType = "RRSIG" DNSSummaryProtocolParamsQueryTypeRt DNSSummaryProtocolParamsQueryType = "RT" DNSSummaryProtocolParamsQueryTypeSig DNSSummaryProtocolParamsQueryType = "SIG" DNSSummaryProtocolParamsQueryTypeSink DNSSummaryProtocolParamsQueryType = "SINK" DNSSummaryProtocolParamsQueryTypeSMIMEA DNSSummaryProtocolParamsQueryType = "SMIMEA" DNSSummaryProtocolParamsQueryTypeSOA DNSSummaryProtocolParamsQueryType = "SOA" DNSSummaryProtocolParamsQueryTypeSPF DNSSummaryProtocolParamsQueryType = "SPF" DNSSummaryProtocolParamsQueryTypeSRV DNSSummaryProtocolParamsQueryType = "SRV" DNSSummaryProtocolParamsQueryTypeSSHFP DNSSummaryProtocolParamsQueryType = "SSHFP" DNSSummaryProtocolParamsQueryTypeSVCB DNSSummaryProtocolParamsQueryType = "SVCB" DNSSummaryProtocolParamsQueryTypeTa DNSSummaryProtocolParamsQueryType = "TA" DNSSummaryProtocolParamsQueryTypeTalink DNSSummaryProtocolParamsQueryType = "TALINK" DNSSummaryProtocolParamsQueryTypeTkey DNSSummaryProtocolParamsQueryType = "TKEY" DNSSummaryProtocolParamsQueryTypeTLSA DNSSummaryProtocolParamsQueryType = "TLSA" DNSSummaryProtocolParamsQueryTypeTSIG DNSSummaryProtocolParamsQueryType = "TSIG" DNSSummaryProtocolParamsQueryTypeTXT DNSSummaryProtocolParamsQueryType = "TXT" DNSSummaryProtocolParamsQueryTypeUinfo DNSSummaryProtocolParamsQueryType = "UINFO" DNSSummaryProtocolParamsQueryTypeUID DNSSummaryProtocolParamsQueryType = "UID" DNSSummaryProtocolParamsQueryTypeUnspec DNSSummaryProtocolParamsQueryType = "UNSPEC" DNSSummaryProtocolParamsQueryTypeURI DNSSummaryProtocolParamsQueryType = "URI" DNSSummaryProtocolParamsQueryTypeWks DNSSummaryProtocolParamsQueryType = "WKS" DNSSummaryProtocolParamsQueryTypeX25 DNSSummaryProtocolParamsQueryType = "X25" DNSSummaryProtocolParamsQueryTypeZonemd DNSSummaryProtocolParamsQueryType = "ZONEMD" )
func (DNSSummaryProtocolParamsQueryType) IsKnown ¶
func (r DNSSummaryProtocolParamsQueryType) IsKnown() bool
type DNSSummaryProtocolParamsResponseCode ¶
type DNSSummaryProtocolParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryProtocolParamsResponseCodeNoerror DNSSummaryProtocolParamsResponseCode = "NOERROR" DNSSummaryProtocolParamsResponseCodeFormerr DNSSummaryProtocolParamsResponseCode = "FORMERR" DNSSummaryProtocolParamsResponseCodeServfail DNSSummaryProtocolParamsResponseCode = "SERVFAIL" DNSSummaryProtocolParamsResponseCodeNxdomain DNSSummaryProtocolParamsResponseCode = "NXDOMAIN" DNSSummaryProtocolParamsResponseCodeNotimp DNSSummaryProtocolParamsResponseCode = "NOTIMP" DNSSummaryProtocolParamsResponseCodeRefused DNSSummaryProtocolParamsResponseCode = "REFUSED" DNSSummaryProtocolParamsResponseCodeYxdomain DNSSummaryProtocolParamsResponseCode = "YXDOMAIN" DNSSummaryProtocolParamsResponseCodeYxrrset DNSSummaryProtocolParamsResponseCode = "YXRRSET" DNSSummaryProtocolParamsResponseCodeNxrrset DNSSummaryProtocolParamsResponseCode = "NXRRSET" DNSSummaryProtocolParamsResponseCodeNotauth DNSSummaryProtocolParamsResponseCode = "NOTAUTH" DNSSummaryProtocolParamsResponseCodeNotzone DNSSummaryProtocolParamsResponseCode = "NOTZONE" DNSSummaryProtocolParamsResponseCodeBadsig DNSSummaryProtocolParamsResponseCode = "BADSIG" DNSSummaryProtocolParamsResponseCodeBadkey DNSSummaryProtocolParamsResponseCode = "BADKEY" DNSSummaryProtocolParamsResponseCodeBadtime DNSSummaryProtocolParamsResponseCode = "BADTIME" DNSSummaryProtocolParamsResponseCodeBadmode DNSSummaryProtocolParamsResponseCode = "BADMODE" DNSSummaryProtocolParamsResponseCodeBadname DNSSummaryProtocolParamsResponseCode = "BADNAME" DNSSummaryProtocolParamsResponseCodeBadalg DNSSummaryProtocolParamsResponseCode = "BADALG" DNSSummaryProtocolParamsResponseCodeBadtrunc DNSSummaryProtocolParamsResponseCode = "BADTRUNC" )
func (DNSSummaryProtocolParamsResponseCode) IsKnown ¶
func (r DNSSummaryProtocolParamsResponseCode) IsKnown() bool
type DNSSummaryProtocolResponse ¶
type DNSSummaryProtocolResponse struct {
// Metadata for the results.
Meta DNSSummaryProtocolResponseMeta `json:"meta,required"`
Summary0 DNSSummaryProtocolResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryProtocolResponseJSON `json:"-"`
}
func (*DNSSummaryProtocolResponse) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolResponseEnvelope ¶
type DNSSummaryProtocolResponseEnvelope struct {
Result DNSSummaryProtocolResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryProtocolResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryProtocolResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolResponseMeta ¶
type DNSSummaryProtocolResponseMeta struct {
ConfidenceInfo DNSSummaryProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryProtocolResponseMetaUnit `json:"units,required"`
JSON dnsSummaryProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryProtocolResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolResponseMetaConfidenceInfo ¶
type DNSSummaryProtocolResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryProtocolResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryProtocolResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryProtocolResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolResponseMetaDateRange ¶
type DNSSummaryProtocolResponseMetaDateRange 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 dnsSummaryProtocolResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryProtocolResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolResponseMetaNormalization ¶
type DNSSummaryProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryProtocolResponseMetaNormalizationPercentage DNSSummaryProtocolResponseMetaNormalization = "PERCENTAGE" DNSSummaryProtocolResponseMetaNormalizationMin0Max DNSSummaryProtocolResponseMetaNormalization = "MIN0_MAX" DNSSummaryProtocolResponseMetaNormalizationMinMax DNSSummaryProtocolResponseMetaNormalization = "MIN_MAX" DNSSummaryProtocolResponseMetaNormalizationRawValues DNSSummaryProtocolResponseMetaNormalization = "RAW_VALUES" DNSSummaryProtocolResponseMetaNormalizationPercentageChange DNSSummaryProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryProtocolResponseMetaNormalizationRollingAverage DNSSummaryProtocolResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryProtocolResponseMetaNormalizationOverlappedPercentage DNSSummaryProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryProtocolResponseMetaNormalizationRatio DNSSummaryProtocolResponseMetaNormalization = "RATIO" )
func (DNSSummaryProtocolResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryProtocolResponseMetaNormalization) IsKnown() bool
type DNSSummaryProtocolResponseMetaUnit ¶
type DNSSummaryProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryProtocolResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryProtocolResponseSummary0 ¶
type DNSSummaryProtocolResponseSummary0 struct {
// A numeric string.
HTTPS string `json:"HTTPS,required"`
// A numeric string.
TCP string `json:"TCP,required"`
// A numeric string.
TLS string `json:"TLS,required"`
// A numeric string.
Udp string `json:"UDP,required"`
JSON dnsSummaryProtocolResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryProtocolResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryProtocolResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryQueryTypeParams ¶
type DNSSummaryQueryTypeParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryQueryTypeParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryQueryTypeParamsProtocol] `query:"protocol"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryQueryTypeParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryQueryTypeParams) URLQuery ¶
func (r DNSSummaryQueryTypeParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryQueryTypeParams's query parameters as `url.Values`.
type DNSSummaryQueryTypeParamsFormat ¶
type DNSSummaryQueryTypeParamsFormat string
Format in which results will be returned.
const ( DNSSummaryQueryTypeParamsFormatJson DNSSummaryQueryTypeParamsFormat = "JSON" DNSSummaryQueryTypeParamsFormatCsv DNSSummaryQueryTypeParamsFormat = "CSV" )
func (DNSSummaryQueryTypeParamsFormat) IsKnown ¶
func (r DNSSummaryQueryTypeParamsFormat) IsKnown() bool
type DNSSummaryQueryTypeParamsProtocol ¶
type DNSSummaryQueryTypeParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryQueryTypeParamsProtocolUdp DNSSummaryQueryTypeParamsProtocol = "UDP" DNSSummaryQueryTypeParamsProtocolTCP DNSSummaryQueryTypeParamsProtocol = "TCP" DNSSummaryQueryTypeParamsProtocolHTTPS DNSSummaryQueryTypeParamsProtocol = "HTTPS" DNSSummaryQueryTypeParamsProtocolTLS DNSSummaryQueryTypeParamsProtocol = "TLS" )
func (DNSSummaryQueryTypeParamsProtocol) IsKnown ¶
func (r DNSSummaryQueryTypeParamsProtocol) IsKnown() bool
type DNSSummaryQueryTypeParamsResponseCode ¶
type DNSSummaryQueryTypeParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryQueryTypeParamsResponseCodeNoerror DNSSummaryQueryTypeParamsResponseCode = "NOERROR" DNSSummaryQueryTypeParamsResponseCodeFormerr DNSSummaryQueryTypeParamsResponseCode = "FORMERR" DNSSummaryQueryTypeParamsResponseCodeServfail DNSSummaryQueryTypeParamsResponseCode = "SERVFAIL" DNSSummaryQueryTypeParamsResponseCodeNxdomain DNSSummaryQueryTypeParamsResponseCode = "NXDOMAIN" DNSSummaryQueryTypeParamsResponseCodeNotimp DNSSummaryQueryTypeParamsResponseCode = "NOTIMP" DNSSummaryQueryTypeParamsResponseCodeRefused DNSSummaryQueryTypeParamsResponseCode = "REFUSED" DNSSummaryQueryTypeParamsResponseCodeYxdomain DNSSummaryQueryTypeParamsResponseCode = "YXDOMAIN" DNSSummaryQueryTypeParamsResponseCodeYxrrset DNSSummaryQueryTypeParamsResponseCode = "YXRRSET" DNSSummaryQueryTypeParamsResponseCodeNxrrset DNSSummaryQueryTypeParamsResponseCode = "NXRRSET" DNSSummaryQueryTypeParamsResponseCodeNotauth DNSSummaryQueryTypeParamsResponseCode = "NOTAUTH" DNSSummaryQueryTypeParamsResponseCodeNotzone DNSSummaryQueryTypeParamsResponseCode = "NOTZONE" DNSSummaryQueryTypeParamsResponseCodeBadsig DNSSummaryQueryTypeParamsResponseCode = "BADSIG" DNSSummaryQueryTypeParamsResponseCodeBadkey DNSSummaryQueryTypeParamsResponseCode = "BADKEY" DNSSummaryQueryTypeParamsResponseCodeBadtime DNSSummaryQueryTypeParamsResponseCode = "BADTIME" DNSSummaryQueryTypeParamsResponseCodeBadmode DNSSummaryQueryTypeParamsResponseCode = "BADMODE" DNSSummaryQueryTypeParamsResponseCodeBadname DNSSummaryQueryTypeParamsResponseCode = "BADNAME" DNSSummaryQueryTypeParamsResponseCodeBadalg DNSSummaryQueryTypeParamsResponseCode = "BADALG" DNSSummaryQueryTypeParamsResponseCodeBadtrunc DNSSummaryQueryTypeParamsResponseCode = "BADTRUNC" )
func (DNSSummaryQueryTypeParamsResponseCode) IsKnown ¶
func (r DNSSummaryQueryTypeParamsResponseCode) IsKnown() bool
type DNSSummaryQueryTypeResponse ¶
type DNSSummaryQueryTypeResponse struct {
// Metadata for the results.
Meta DNSSummaryQueryTypeResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON dnsSummaryQueryTypeResponseJSON `json:"-"`
}
func (*DNSSummaryQueryTypeResponse) UnmarshalJSON ¶
func (r *DNSSummaryQueryTypeResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryQueryTypeResponseEnvelope ¶
type DNSSummaryQueryTypeResponseEnvelope struct {
Result DNSSummaryQueryTypeResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryQueryTypeResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryQueryTypeResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryQueryTypeResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryQueryTypeResponseMeta ¶
type DNSSummaryQueryTypeResponseMeta struct {
ConfidenceInfo DNSSummaryQueryTypeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryQueryTypeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryQueryTypeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryQueryTypeResponseMetaUnit `json:"units,required"`
JSON dnsSummaryQueryTypeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryQueryTypeResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryQueryTypeResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryQueryTypeResponseMetaConfidenceInfo ¶
type DNSSummaryQueryTypeResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryQueryTypeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryQueryTypeResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryQueryTypeResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryQueryTypeResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryQueryTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryQueryTypeResponseMetaDateRange ¶
type DNSSummaryQueryTypeResponseMetaDateRange 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 dnsSummaryQueryTypeResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryQueryTypeResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryQueryTypeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryQueryTypeResponseMetaNormalization ¶
type DNSSummaryQueryTypeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryQueryTypeResponseMetaNormalizationPercentage DNSSummaryQueryTypeResponseMetaNormalization = "PERCENTAGE" DNSSummaryQueryTypeResponseMetaNormalizationMin0Max DNSSummaryQueryTypeResponseMetaNormalization = "MIN0_MAX" DNSSummaryQueryTypeResponseMetaNormalizationMinMax DNSSummaryQueryTypeResponseMetaNormalization = "MIN_MAX" DNSSummaryQueryTypeResponseMetaNormalizationRawValues DNSSummaryQueryTypeResponseMetaNormalization = "RAW_VALUES" DNSSummaryQueryTypeResponseMetaNormalizationPercentageChange DNSSummaryQueryTypeResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryQueryTypeResponseMetaNormalizationRollingAverage DNSSummaryQueryTypeResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryQueryTypeResponseMetaNormalizationOverlappedPercentage DNSSummaryQueryTypeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryQueryTypeResponseMetaNormalizationRatio DNSSummaryQueryTypeResponseMetaNormalization = "RATIO" )
func (DNSSummaryQueryTypeResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryQueryTypeResponseMetaNormalization) IsKnown() bool
type DNSSummaryQueryTypeResponseMetaUnit ¶
type DNSSummaryQueryTypeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryQueryTypeResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryQueryTypeResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryQueryTypeResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseCodeParams ¶
type DNSSummaryResponseCodeParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryResponseCodeParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryResponseCodeParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryResponseCodeParamsQueryType] `query:"queryType"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryResponseCodeParams) URLQuery ¶
func (r DNSSummaryResponseCodeParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryResponseCodeParams's query parameters as `url.Values`.
type DNSSummaryResponseCodeParamsFormat ¶
type DNSSummaryResponseCodeParamsFormat string
Format in which results will be returned.
const ( DNSSummaryResponseCodeParamsFormatJson DNSSummaryResponseCodeParamsFormat = "JSON" DNSSummaryResponseCodeParamsFormatCsv DNSSummaryResponseCodeParamsFormat = "CSV" )
func (DNSSummaryResponseCodeParamsFormat) IsKnown ¶
func (r DNSSummaryResponseCodeParamsFormat) IsKnown() bool
type DNSSummaryResponseCodeParamsProtocol ¶
type DNSSummaryResponseCodeParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryResponseCodeParamsProtocolUdp DNSSummaryResponseCodeParamsProtocol = "UDP" DNSSummaryResponseCodeParamsProtocolTCP DNSSummaryResponseCodeParamsProtocol = "TCP" DNSSummaryResponseCodeParamsProtocolHTTPS DNSSummaryResponseCodeParamsProtocol = "HTTPS" DNSSummaryResponseCodeParamsProtocolTLS DNSSummaryResponseCodeParamsProtocol = "TLS" )
func (DNSSummaryResponseCodeParamsProtocol) IsKnown ¶
func (r DNSSummaryResponseCodeParamsProtocol) IsKnown() bool
type DNSSummaryResponseCodeParamsQueryType ¶
type DNSSummaryResponseCodeParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryResponseCodeParamsQueryTypeA DNSSummaryResponseCodeParamsQueryType = "A" DNSSummaryResponseCodeParamsQueryTypeAAAA DNSSummaryResponseCodeParamsQueryType = "AAAA" DNSSummaryResponseCodeParamsQueryTypeA6 DNSSummaryResponseCodeParamsQueryType = "A6" DNSSummaryResponseCodeParamsQueryTypeAfsdb DNSSummaryResponseCodeParamsQueryType = "AFSDB" DNSSummaryResponseCodeParamsQueryTypeAny DNSSummaryResponseCodeParamsQueryType = "ANY" DNSSummaryResponseCodeParamsQueryTypeApl DNSSummaryResponseCodeParamsQueryType = "APL" DNSSummaryResponseCodeParamsQueryTypeAtma DNSSummaryResponseCodeParamsQueryType = "ATMA" DNSSummaryResponseCodeParamsQueryTypeAXFR DNSSummaryResponseCodeParamsQueryType = "AXFR" DNSSummaryResponseCodeParamsQueryTypeCAA DNSSummaryResponseCodeParamsQueryType = "CAA" DNSSummaryResponseCodeParamsQueryTypeCdnskey DNSSummaryResponseCodeParamsQueryType = "CDNSKEY" DNSSummaryResponseCodeParamsQueryTypeCds DNSSummaryResponseCodeParamsQueryType = "CDS" DNSSummaryResponseCodeParamsQueryTypeCERT DNSSummaryResponseCodeParamsQueryType = "CERT" DNSSummaryResponseCodeParamsQueryTypeCNAME DNSSummaryResponseCodeParamsQueryType = "CNAME" DNSSummaryResponseCodeParamsQueryTypeCsync DNSSummaryResponseCodeParamsQueryType = "CSYNC" DNSSummaryResponseCodeParamsQueryTypeDhcid DNSSummaryResponseCodeParamsQueryType = "DHCID" DNSSummaryResponseCodeParamsQueryTypeDlv DNSSummaryResponseCodeParamsQueryType = "DLV" DNSSummaryResponseCodeParamsQueryTypeDname DNSSummaryResponseCodeParamsQueryType = "DNAME" DNSSummaryResponseCodeParamsQueryTypeDNSKEY DNSSummaryResponseCodeParamsQueryType = "DNSKEY" DNSSummaryResponseCodeParamsQueryTypeDoa DNSSummaryResponseCodeParamsQueryType = "DOA" DNSSummaryResponseCodeParamsQueryTypeDS DNSSummaryResponseCodeParamsQueryType = "DS" DNSSummaryResponseCodeParamsQueryTypeEid DNSSummaryResponseCodeParamsQueryType = "EID" DNSSummaryResponseCodeParamsQueryTypeEui48 DNSSummaryResponseCodeParamsQueryType = "EUI48" DNSSummaryResponseCodeParamsQueryTypeEui64 DNSSummaryResponseCodeParamsQueryType = "EUI64" DNSSummaryResponseCodeParamsQueryTypeGpos DNSSummaryResponseCodeParamsQueryType = "GPOS" DNSSummaryResponseCodeParamsQueryTypeGid DNSSummaryResponseCodeParamsQueryType = "GID" DNSSummaryResponseCodeParamsQueryTypeHinfo DNSSummaryResponseCodeParamsQueryType = "HINFO" DNSSummaryResponseCodeParamsQueryTypeHip DNSSummaryResponseCodeParamsQueryType = "HIP" DNSSummaryResponseCodeParamsQueryTypeHTTPS DNSSummaryResponseCodeParamsQueryType = "HTTPS" DNSSummaryResponseCodeParamsQueryTypeIpseckey DNSSummaryResponseCodeParamsQueryType = "IPSECKEY" DNSSummaryResponseCodeParamsQueryTypeIsdn DNSSummaryResponseCodeParamsQueryType = "ISDN" DNSSummaryResponseCodeParamsQueryTypeIxfr DNSSummaryResponseCodeParamsQueryType = "IXFR" DNSSummaryResponseCodeParamsQueryTypeKey DNSSummaryResponseCodeParamsQueryType = "KEY" DNSSummaryResponseCodeParamsQueryTypeKx DNSSummaryResponseCodeParamsQueryType = "KX" DNSSummaryResponseCodeParamsQueryTypeL32 DNSSummaryResponseCodeParamsQueryType = "L32" DNSSummaryResponseCodeParamsQueryTypeL64 DNSSummaryResponseCodeParamsQueryType = "L64" DNSSummaryResponseCodeParamsQueryTypeLOC DNSSummaryResponseCodeParamsQueryType = "LOC" DNSSummaryResponseCodeParamsQueryTypeLp DNSSummaryResponseCodeParamsQueryType = "LP" DNSSummaryResponseCodeParamsQueryTypeMaila DNSSummaryResponseCodeParamsQueryType = "MAILA" DNSSummaryResponseCodeParamsQueryTypeMailb DNSSummaryResponseCodeParamsQueryType = "MAILB" DNSSummaryResponseCodeParamsQueryTypeMB DNSSummaryResponseCodeParamsQueryType = "MB" DNSSummaryResponseCodeParamsQueryTypeMd DNSSummaryResponseCodeParamsQueryType = "MD" DNSSummaryResponseCodeParamsQueryTypeMf DNSSummaryResponseCodeParamsQueryType = "MF" DNSSummaryResponseCodeParamsQueryTypeMg DNSSummaryResponseCodeParamsQueryType = "MG" DNSSummaryResponseCodeParamsQueryTypeMinfo DNSSummaryResponseCodeParamsQueryType = "MINFO" DNSSummaryResponseCodeParamsQueryTypeMr DNSSummaryResponseCodeParamsQueryType = "MR" DNSSummaryResponseCodeParamsQueryTypeMX DNSSummaryResponseCodeParamsQueryType = "MX" DNSSummaryResponseCodeParamsQueryTypeNAPTR DNSSummaryResponseCodeParamsQueryType = "NAPTR" DNSSummaryResponseCodeParamsQueryTypeNb DNSSummaryResponseCodeParamsQueryType = "NB" DNSSummaryResponseCodeParamsQueryTypeNbstat DNSSummaryResponseCodeParamsQueryType = "NBSTAT" DNSSummaryResponseCodeParamsQueryTypeNid DNSSummaryResponseCodeParamsQueryType = "NID" DNSSummaryResponseCodeParamsQueryTypeNimloc DNSSummaryResponseCodeParamsQueryType = "NIMLOC" DNSSummaryResponseCodeParamsQueryTypeNinfo DNSSummaryResponseCodeParamsQueryType = "NINFO" DNSSummaryResponseCodeParamsQueryTypeNS DNSSummaryResponseCodeParamsQueryType = "NS" DNSSummaryResponseCodeParamsQueryTypeNsap DNSSummaryResponseCodeParamsQueryType = "NSAP" DNSSummaryResponseCodeParamsQueryTypeNsec DNSSummaryResponseCodeParamsQueryType = "NSEC" DNSSummaryResponseCodeParamsQueryTypeNsec3 DNSSummaryResponseCodeParamsQueryType = "NSEC3" DNSSummaryResponseCodeParamsQueryTypeNsec3Param DNSSummaryResponseCodeParamsQueryType = "NSEC3PARAM" DNSSummaryResponseCodeParamsQueryTypeNull DNSSummaryResponseCodeParamsQueryType = "NULL" DNSSummaryResponseCodeParamsQueryTypeNxt DNSSummaryResponseCodeParamsQueryType = "NXT" DNSSummaryResponseCodeParamsQueryTypeOpenpgpkey DNSSummaryResponseCodeParamsQueryType = "OPENPGPKEY" DNSSummaryResponseCodeParamsQueryTypeOpt DNSSummaryResponseCodeParamsQueryType = "OPT" DNSSummaryResponseCodeParamsQueryTypePTR DNSSummaryResponseCodeParamsQueryType = "PTR" DNSSummaryResponseCodeParamsQueryTypePx DNSSummaryResponseCodeParamsQueryType = "PX" DNSSummaryResponseCodeParamsQueryTypeRkey DNSSummaryResponseCodeParamsQueryType = "RKEY" DNSSummaryResponseCodeParamsQueryTypeRp DNSSummaryResponseCodeParamsQueryType = "RP" DNSSummaryResponseCodeParamsQueryTypeRrsig DNSSummaryResponseCodeParamsQueryType = "RRSIG" DNSSummaryResponseCodeParamsQueryTypeRt DNSSummaryResponseCodeParamsQueryType = "RT" DNSSummaryResponseCodeParamsQueryTypeSig DNSSummaryResponseCodeParamsQueryType = "SIG" DNSSummaryResponseCodeParamsQueryTypeSink DNSSummaryResponseCodeParamsQueryType = "SINK" DNSSummaryResponseCodeParamsQueryTypeSMIMEA DNSSummaryResponseCodeParamsQueryType = "SMIMEA" DNSSummaryResponseCodeParamsQueryTypeSOA DNSSummaryResponseCodeParamsQueryType = "SOA" DNSSummaryResponseCodeParamsQueryTypeSPF DNSSummaryResponseCodeParamsQueryType = "SPF" DNSSummaryResponseCodeParamsQueryTypeSRV DNSSummaryResponseCodeParamsQueryType = "SRV" DNSSummaryResponseCodeParamsQueryTypeSSHFP DNSSummaryResponseCodeParamsQueryType = "SSHFP" DNSSummaryResponseCodeParamsQueryTypeSVCB DNSSummaryResponseCodeParamsQueryType = "SVCB" DNSSummaryResponseCodeParamsQueryTypeTa DNSSummaryResponseCodeParamsQueryType = "TA" DNSSummaryResponseCodeParamsQueryTypeTalink DNSSummaryResponseCodeParamsQueryType = "TALINK" DNSSummaryResponseCodeParamsQueryTypeTkey DNSSummaryResponseCodeParamsQueryType = "TKEY" DNSSummaryResponseCodeParamsQueryTypeTLSA DNSSummaryResponseCodeParamsQueryType = "TLSA" DNSSummaryResponseCodeParamsQueryTypeTSIG DNSSummaryResponseCodeParamsQueryType = "TSIG" DNSSummaryResponseCodeParamsQueryTypeTXT DNSSummaryResponseCodeParamsQueryType = "TXT" DNSSummaryResponseCodeParamsQueryTypeUinfo DNSSummaryResponseCodeParamsQueryType = "UINFO" DNSSummaryResponseCodeParamsQueryTypeUID DNSSummaryResponseCodeParamsQueryType = "UID" DNSSummaryResponseCodeParamsQueryTypeUnspec DNSSummaryResponseCodeParamsQueryType = "UNSPEC" DNSSummaryResponseCodeParamsQueryTypeURI DNSSummaryResponseCodeParamsQueryType = "URI" DNSSummaryResponseCodeParamsQueryTypeWks DNSSummaryResponseCodeParamsQueryType = "WKS" DNSSummaryResponseCodeParamsQueryTypeX25 DNSSummaryResponseCodeParamsQueryType = "X25" DNSSummaryResponseCodeParamsQueryTypeZonemd DNSSummaryResponseCodeParamsQueryType = "ZONEMD" )
func (DNSSummaryResponseCodeParamsQueryType) IsKnown ¶
func (r DNSSummaryResponseCodeParamsQueryType) IsKnown() bool
type DNSSummaryResponseCodeResponse ¶
type DNSSummaryResponseCodeResponse struct {
// Metadata for the results.
Meta DNSSummaryResponseCodeResponseMeta `json:"meta,required"`
Summary0 map[string]string `json:"summary_0,required"`
JSON dnsSummaryResponseCodeResponseJSON `json:"-"`
}
func (*DNSSummaryResponseCodeResponse) UnmarshalJSON ¶
func (r *DNSSummaryResponseCodeResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseCodeResponseEnvelope ¶
type DNSSummaryResponseCodeResponseEnvelope struct {
Result DNSSummaryResponseCodeResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryResponseCodeResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryResponseCodeResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryResponseCodeResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseCodeResponseMeta ¶
type DNSSummaryResponseCodeResponseMeta struct {
ConfidenceInfo DNSSummaryResponseCodeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryResponseCodeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryResponseCodeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryResponseCodeResponseMetaUnit `json:"units,required"`
JSON dnsSummaryResponseCodeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryResponseCodeResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryResponseCodeResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseCodeResponseMetaConfidenceInfo ¶
type DNSSummaryResponseCodeResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryResponseCodeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryResponseCodeResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryResponseCodeResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryResponseCodeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseCodeResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryResponseCodeResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryResponseCodeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryResponseCodeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryResponseCodeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseCodeResponseMetaDateRange ¶
type DNSSummaryResponseCodeResponseMetaDateRange 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 dnsSummaryResponseCodeResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryResponseCodeResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryResponseCodeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseCodeResponseMetaNormalization ¶
type DNSSummaryResponseCodeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryResponseCodeResponseMetaNormalizationPercentage DNSSummaryResponseCodeResponseMetaNormalization = "PERCENTAGE" DNSSummaryResponseCodeResponseMetaNormalizationMin0Max DNSSummaryResponseCodeResponseMetaNormalization = "MIN0_MAX" DNSSummaryResponseCodeResponseMetaNormalizationMinMax DNSSummaryResponseCodeResponseMetaNormalization = "MIN_MAX" DNSSummaryResponseCodeResponseMetaNormalizationRawValues DNSSummaryResponseCodeResponseMetaNormalization = "RAW_VALUES" DNSSummaryResponseCodeResponseMetaNormalizationPercentageChange DNSSummaryResponseCodeResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryResponseCodeResponseMetaNormalizationRollingAverage DNSSummaryResponseCodeResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryResponseCodeResponseMetaNormalizationOverlappedPercentage DNSSummaryResponseCodeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryResponseCodeResponseMetaNormalizationRatio DNSSummaryResponseCodeResponseMetaNormalization = "RATIO" )
func (DNSSummaryResponseCodeResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryResponseCodeResponseMetaNormalization) IsKnown() bool
type DNSSummaryResponseCodeResponseMetaUnit ¶
type DNSSummaryResponseCodeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryResponseCodeResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryResponseCodeResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryResponseCodeResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLParams ¶
type DNSSummaryResponseTTLParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSSummaryResponseTTLParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSSummaryResponseTTLParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSSummaryResponseTTLParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSSummaryResponseTTLParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSSummaryResponseTTLParams) URLQuery ¶
func (r DNSSummaryResponseTTLParams) URLQuery() (v url.Values)
URLQuery serializes DNSSummaryResponseTTLParams's query parameters as `url.Values`.
type DNSSummaryResponseTTLParamsFormat ¶
type DNSSummaryResponseTTLParamsFormat string
Format in which results will be returned.
const ( DNSSummaryResponseTTLParamsFormatJson DNSSummaryResponseTTLParamsFormat = "JSON" DNSSummaryResponseTTLParamsFormatCsv DNSSummaryResponseTTLParamsFormat = "CSV" )
func (DNSSummaryResponseTTLParamsFormat) IsKnown ¶
func (r DNSSummaryResponseTTLParamsFormat) IsKnown() bool
type DNSSummaryResponseTTLParamsProtocol ¶
type DNSSummaryResponseTTLParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSSummaryResponseTTLParamsProtocolUdp DNSSummaryResponseTTLParamsProtocol = "UDP" DNSSummaryResponseTTLParamsProtocolTCP DNSSummaryResponseTTLParamsProtocol = "TCP" DNSSummaryResponseTTLParamsProtocolHTTPS DNSSummaryResponseTTLParamsProtocol = "HTTPS" DNSSummaryResponseTTLParamsProtocolTLS DNSSummaryResponseTTLParamsProtocol = "TLS" )
func (DNSSummaryResponseTTLParamsProtocol) IsKnown ¶
func (r DNSSummaryResponseTTLParamsProtocol) IsKnown() bool
type DNSSummaryResponseTTLParamsQueryType ¶
type DNSSummaryResponseTTLParamsQueryType string
Filters results by DNS query type.
const ( DNSSummaryResponseTTLParamsQueryTypeA DNSSummaryResponseTTLParamsQueryType = "A" DNSSummaryResponseTTLParamsQueryTypeAAAA DNSSummaryResponseTTLParamsQueryType = "AAAA" DNSSummaryResponseTTLParamsQueryTypeA6 DNSSummaryResponseTTLParamsQueryType = "A6" DNSSummaryResponseTTLParamsQueryTypeAfsdb DNSSummaryResponseTTLParamsQueryType = "AFSDB" DNSSummaryResponseTTLParamsQueryTypeAny DNSSummaryResponseTTLParamsQueryType = "ANY" DNSSummaryResponseTTLParamsQueryTypeApl DNSSummaryResponseTTLParamsQueryType = "APL" DNSSummaryResponseTTLParamsQueryTypeAtma DNSSummaryResponseTTLParamsQueryType = "ATMA" DNSSummaryResponseTTLParamsQueryTypeAXFR DNSSummaryResponseTTLParamsQueryType = "AXFR" DNSSummaryResponseTTLParamsQueryTypeCAA DNSSummaryResponseTTLParamsQueryType = "CAA" DNSSummaryResponseTTLParamsQueryTypeCdnskey DNSSummaryResponseTTLParamsQueryType = "CDNSKEY" DNSSummaryResponseTTLParamsQueryTypeCds DNSSummaryResponseTTLParamsQueryType = "CDS" DNSSummaryResponseTTLParamsQueryTypeCERT DNSSummaryResponseTTLParamsQueryType = "CERT" DNSSummaryResponseTTLParamsQueryTypeCNAME DNSSummaryResponseTTLParamsQueryType = "CNAME" DNSSummaryResponseTTLParamsQueryTypeCsync DNSSummaryResponseTTLParamsQueryType = "CSYNC" DNSSummaryResponseTTLParamsQueryTypeDhcid DNSSummaryResponseTTLParamsQueryType = "DHCID" DNSSummaryResponseTTLParamsQueryTypeDlv DNSSummaryResponseTTLParamsQueryType = "DLV" DNSSummaryResponseTTLParamsQueryTypeDname DNSSummaryResponseTTLParamsQueryType = "DNAME" DNSSummaryResponseTTLParamsQueryTypeDNSKEY DNSSummaryResponseTTLParamsQueryType = "DNSKEY" DNSSummaryResponseTTLParamsQueryTypeDoa DNSSummaryResponseTTLParamsQueryType = "DOA" DNSSummaryResponseTTLParamsQueryTypeDS DNSSummaryResponseTTLParamsQueryType = "DS" DNSSummaryResponseTTLParamsQueryTypeEid DNSSummaryResponseTTLParamsQueryType = "EID" DNSSummaryResponseTTLParamsQueryTypeEui48 DNSSummaryResponseTTLParamsQueryType = "EUI48" DNSSummaryResponseTTLParamsQueryTypeEui64 DNSSummaryResponseTTLParamsQueryType = "EUI64" DNSSummaryResponseTTLParamsQueryTypeGpos DNSSummaryResponseTTLParamsQueryType = "GPOS" DNSSummaryResponseTTLParamsQueryTypeGid DNSSummaryResponseTTLParamsQueryType = "GID" DNSSummaryResponseTTLParamsQueryTypeHinfo DNSSummaryResponseTTLParamsQueryType = "HINFO" DNSSummaryResponseTTLParamsQueryTypeHip DNSSummaryResponseTTLParamsQueryType = "HIP" DNSSummaryResponseTTLParamsQueryTypeHTTPS DNSSummaryResponseTTLParamsQueryType = "HTTPS" DNSSummaryResponseTTLParamsQueryTypeIpseckey DNSSummaryResponseTTLParamsQueryType = "IPSECKEY" DNSSummaryResponseTTLParamsQueryTypeIsdn DNSSummaryResponseTTLParamsQueryType = "ISDN" DNSSummaryResponseTTLParamsQueryTypeIxfr DNSSummaryResponseTTLParamsQueryType = "IXFR" DNSSummaryResponseTTLParamsQueryTypeKey DNSSummaryResponseTTLParamsQueryType = "KEY" DNSSummaryResponseTTLParamsQueryTypeKx DNSSummaryResponseTTLParamsQueryType = "KX" DNSSummaryResponseTTLParamsQueryTypeL32 DNSSummaryResponseTTLParamsQueryType = "L32" DNSSummaryResponseTTLParamsQueryTypeL64 DNSSummaryResponseTTLParamsQueryType = "L64" DNSSummaryResponseTTLParamsQueryTypeLOC DNSSummaryResponseTTLParamsQueryType = "LOC" DNSSummaryResponseTTLParamsQueryTypeLp DNSSummaryResponseTTLParamsQueryType = "LP" DNSSummaryResponseTTLParamsQueryTypeMaila DNSSummaryResponseTTLParamsQueryType = "MAILA" DNSSummaryResponseTTLParamsQueryTypeMailb DNSSummaryResponseTTLParamsQueryType = "MAILB" DNSSummaryResponseTTLParamsQueryTypeMB DNSSummaryResponseTTLParamsQueryType = "MB" DNSSummaryResponseTTLParamsQueryTypeMd DNSSummaryResponseTTLParamsQueryType = "MD" DNSSummaryResponseTTLParamsQueryTypeMf DNSSummaryResponseTTLParamsQueryType = "MF" DNSSummaryResponseTTLParamsQueryTypeMg DNSSummaryResponseTTLParamsQueryType = "MG" DNSSummaryResponseTTLParamsQueryTypeMinfo DNSSummaryResponseTTLParamsQueryType = "MINFO" DNSSummaryResponseTTLParamsQueryTypeMr DNSSummaryResponseTTLParamsQueryType = "MR" DNSSummaryResponseTTLParamsQueryTypeMX DNSSummaryResponseTTLParamsQueryType = "MX" DNSSummaryResponseTTLParamsQueryTypeNAPTR DNSSummaryResponseTTLParamsQueryType = "NAPTR" DNSSummaryResponseTTLParamsQueryTypeNb DNSSummaryResponseTTLParamsQueryType = "NB" DNSSummaryResponseTTLParamsQueryTypeNbstat DNSSummaryResponseTTLParamsQueryType = "NBSTAT" DNSSummaryResponseTTLParamsQueryTypeNid DNSSummaryResponseTTLParamsQueryType = "NID" DNSSummaryResponseTTLParamsQueryTypeNimloc DNSSummaryResponseTTLParamsQueryType = "NIMLOC" DNSSummaryResponseTTLParamsQueryTypeNinfo DNSSummaryResponseTTLParamsQueryType = "NINFO" DNSSummaryResponseTTLParamsQueryTypeNS DNSSummaryResponseTTLParamsQueryType = "NS" DNSSummaryResponseTTLParamsQueryTypeNsap DNSSummaryResponseTTLParamsQueryType = "NSAP" DNSSummaryResponseTTLParamsQueryTypeNsec DNSSummaryResponseTTLParamsQueryType = "NSEC" DNSSummaryResponseTTLParamsQueryTypeNsec3 DNSSummaryResponseTTLParamsQueryType = "NSEC3" DNSSummaryResponseTTLParamsQueryTypeNsec3Param DNSSummaryResponseTTLParamsQueryType = "NSEC3PARAM" DNSSummaryResponseTTLParamsQueryTypeNull DNSSummaryResponseTTLParamsQueryType = "NULL" DNSSummaryResponseTTLParamsQueryTypeNxt DNSSummaryResponseTTLParamsQueryType = "NXT" DNSSummaryResponseTTLParamsQueryTypeOpenpgpkey DNSSummaryResponseTTLParamsQueryType = "OPENPGPKEY" DNSSummaryResponseTTLParamsQueryTypeOpt DNSSummaryResponseTTLParamsQueryType = "OPT" DNSSummaryResponseTTLParamsQueryTypePTR DNSSummaryResponseTTLParamsQueryType = "PTR" DNSSummaryResponseTTLParamsQueryTypePx DNSSummaryResponseTTLParamsQueryType = "PX" DNSSummaryResponseTTLParamsQueryTypeRkey DNSSummaryResponseTTLParamsQueryType = "RKEY" DNSSummaryResponseTTLParamsQueryTypeRp DNSSummaryResponseTTLParamsQueryType = "RP" DNSSummaryResponseTTLParamsQueryTypeRrsig DNSSummaryResponseTTLParamsQueryType = "RRSIG" DNSSummaryResponseTTLParamsQueryTypeRt DNSSummaryResponseTTLParamsQueryType = "RT" DNSSummaryResponseTTLParamsQueryTypeSig DNSSummaryResponseTTLParamsQueryType = "SIG" DNSSummaryResponseTTLParamsQueryTypeSink DNSSummaryResponseTTLParamsQueryType = "SINK" DNSSummaryResponseTTLParamsQueryTypeSMIMEA DNSSummaryResponseTTLParamsQueryType = "SMIMEA" DNSSummaryResponseTTLParamsQueryTypeSOA DNSSummaryResponseTTLParamsQueryType = "SOA" DNSSummaryResponseTTLParamsQueryTypeSPF DNSSummaryResponseTTLParamsQueryType = "SPF" DNSSummaryResponseTTLParamsQueryTypeSRV DNSSummaryResponseTTLParamsQueryType = "SRV" DNSSummaryResponseTTLParamsQueryTypeSSHFP DNSSummaryResponseTTLParamsQueryType = "SSHFP" DNSSummaryResponseTTLParamsQueryTypeSVCB DNSSummaryResponseTTLParamsQueryType = "SVCB" DNSSummaryResponseTTLParamsQueryTypeTa DNSSummaryResponseTTLParamsQueryType = "TA" DNSSummaryResponseTTLParamsQueryTypeTalink DNSSummaryResponseTTLParamsQueryType = "TALINK" DNSSummaryResponseTTLParamsQueryTypeTkey DNSSummaryResponseTTLParamsQueryType = "TKEY" DNSSummaryResponseTTLParamsQueryTypeTLSA DNSSummaryResponseTTLParamsQueryType = "TLSA" DNSSummaryResponseTTLParamsQueryTypeTSIG DNSSummaryResponseTTLParamsQueryType = "TSIG" DNSSummaryResponseTTLParamsQueryTypeTXT DNSSummaryResponseTTLParamsQueryType = "TXT" DNSSummaryResponseTTLParamsQueryTypeUinfo DNSSummaryResponseTTLParamsQueryType = "UINFO" DNSSummaryResponseTTLParamsQueryTypeUID DNSSummaryResponseTTLParamsQueryType = "UID" DNSSummaryResponseTTLParamsQueryTypeUnspec DNSSummaryResponseTTLParamsQueryType = "UNSPEC" DNSSummaryResponseTTLParamsQueryTypeURI DNSSummaryResponseTTLParamsQueryType = "URI" DNSSummaryResponseTTLParamsQueryTypeWks DNSSummaryResponseTTLParamsQueryType = "WKS" DNSSummaryResponseTTLParamsQueryTypeX25 DNSSummaryResponseTTLParamsQueryType = "X25" DNSSummaryResponseTTLParamsQueryTypeZonemd DNSSummaryResponseTTLParamsQueryType = "ZONEMD" )
func (DNSSummaryResponseTTLParamsQueryType) IsKnown ¶
func (r DNSSummaryResponseTTLParamsQueryType) IsKnown() bool
type DNSSummaryResponseTTLParamsResponseCode ¶
type DNSSummaryResponseTTLParamsResponseCode string
Filters results by DNS response code.
const ( DNSSummaryResponseTTLParamsResponseCodeNoerror DNSSummaryResponseTTLParamsResponseCode = "NOERROR" DNSSummaryResponseTTLParamsResponseCodeFormerr DNSSummaryResponseTTLParamsResponseCode = "FORMERR" DNSSummaryResponseTTLParamsResponseCodeServfail DNSSummaryResponseTTLParamsResponseCode = "SERVFAIL" DNSSummaryResponseTTLParamsResponseCodeNxdomain DNSSummaryResponseTTLParamsResponseCode = "NXDOMAIN" DNSSummaryResponseTTLParamsResponseCodeNotimp DNSSummaryResponseTTLParamsResponseCode = "NOTIMP" DNSSummaryResponseTTLParamsResponseCodeRefused DNSSummaryResponseTTLParamsResponseCode = "REFUSED" DNSSummaryResponseTTLParamsResponseCodeYxdomain DNSSummaryResponseTTLParamsResponseCode = "YXDOMAIN" DNSSummaryResponseTTLParamsResponseCodeYxrrset DNSSummaryResponseTTLParamsResponseCode = "YXRRSET" DNSSummaryResponseTTLParamsResponseCodeNxrrset DNSSummaryResponseTTLParamsResponseCode = "NXRRSET" DNSSummaryResponseTTLParamsResponseCodeNotauth DNSSummaryResponseTTLParamsResponseCode = "NOTAUTH" DNSSummaryResponseTTLParamsResponseCodeNotzone DNSSummaryResponseTTLParamsResponseCode = "NOTZONE" DNSSummaryResponseTTLParamsResponseCodeBadsig DNSSummaryResponseTTLParamsResponseCode = "BADSIG" DNSSummaryResponseTTLParamsResponseCodeBadkey DNSSummaryResponseTTLParamsResponseCode = "BADKEY" DNSSummaryResponseTTLParamsResponseCodeBadtime DNSSummaryResponseTTLParamsResponseCode = "BADTIME" DNSSummaryResponseTTLParamsResponseCodeBadmode DNSSummaryResponseTTLParamsResponseCode = "BADMODE" DNSSummaryResponseTTLParamsResponseCodeBadname DNSSummaryResponseTTLParamsResponseCode = "BADNAME" DNSSummaryResponseTTLParamsResponseCodeBadalg DNSSummaryResponseTTLParamsResponseCode = "BADALG" DNSSummaryResponseTTLParamsResponseCodeBadtrunc DNSSummaryResponseTTLParamsResponseCode = "BADTRUNC" )
func (DNSSummaryResponseTTLParamsResponseCode) IsKnown ¶
func (r DNSSummaryResponseTTLParamsResponseCode) IsKnown() bool
type DNSSummaryResponseTTLResponse ¶
type DNSSummaryResponseTTLResponse struct {
// Metadata for the results.
Meta DNSSummaryResponseTTLResponseMeta `json:"meta,required"`
Summary0 DNSSummaryResponseTTLResponseSummary0 `json:"summary_0,required"`
JSON dnsSummaryResponseTTLResponseJSON `json:"-"`
}
func (*DNSSummaryResponseTTLResponse) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponse) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLResponseEnvelope ¶
type DNSSummaryResponseTTLResponseEnvelope struct {
Result DNSSummaryResponseTTLResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsSummaryResponseTTLResponseEnvelopeJSON `json:"-"`
}
func (*DNSSummaryResponseTTLResponseEnvelope) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLResponseMeta ¶
type DNSSummaryResponseTTLResponseMeta struct {
ConfidenceInfo DNSSummaryResponseTTLResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSSummaryResponseTTLResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSSummaryResponseTTLResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSSummaryResponseTTLResponseMetaUnit `json:"units,required"`
JSON dnsSummaryResponseTTLResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSSummaryResponseTTLResponseMeta) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLResponseMetaConfidenceInfo ¶
type DNSSummaryResponseTTLResponseMetaConfidenceInfo struct {
Annotations []DNSSummaryResponseTTLResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsSummaryResponseTTLResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSSummaryResponseTTLResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLResponseMetaConfidenceInfoAnnotation ¶
type DNSSummaryResponseTTLResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsSummaryResponseTTLResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSSummaryResponseTTLResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLResponseMetaDateRange ¶
type DNSSummaryResponseTTLResponseMetaDateRange 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 dnsSummaryResponseTTLResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSSummaryResponseTTLResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLResponseMetaNormalization ¶
type DNSSummaryResponseTTLResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSSummaryResponseTTLResponseMetaNormalizationPercentage DNSSummaryResponseTTLResponseMetaNormalization = "PERCENTAGE" DNSSummaryResponseTTLResponseMetaNormalizationMin0Max DNSSummaryResponseTTLResponseMetaNormalization = "MIN0_MAX" DNSSummaryResponseTTLResponseMetaNormalizationMinMax DNSSummaryResponseTTLResponseMetaNormalization = "MIN_MAX" DNSSummaryResponseTTLResponseMetaNormalizationRawValues DNSSummaryResponseTTLResponseMetaNormalization = "RAW_VALUES" DNSSummaryResponseTTLResponseMetaNormalizationPercentageChange DNSSummaryResponseTTLResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSSummaryResponseTTLResponseMetaNormalizationRollingAverage DNSSummaryResponseTTLResponseMetaNormalization = "ROLLING_AVERAGE" DNSSummaryResponseTTLResponseMetaNormalizationOverlappedPercentage DNSSummaryResponseTTLResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSSummaryResponseTTLResponseMetaNormalizationRatio DNSSummaryResponseTTLResponseMetaNormalization = "RATIO" )
func (DNSSummaryResponseTTLResponseMetaNormalization) IsKnown ¶
func (r DNSSummaryResponseTTLResponseMetaNormalization) IsKnown() bool
type DNSSummaryResponseTTLResponseMetaUnit ¶
type DNSSummaryResponseTTLResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsSummaryResponseTTLResponseMetaUnitJSON `json:"-"`
}
func (*DNSSummaryResponseTTLResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSSummaryResponseTTLResponseSummary0 ¶
type DNSSummaryResponseTTLResponseSummary0 struct {
// A numeric string.
Gt15mLte1h string `json:"gt_15m_lte_1h,required"`
// A numeric string.
Gt1dLte1w string `json:"gt_1d_lte_1w,required"`
// A numeric string.
Gt1hLte1d string `json:"gt_1h_lte_1d,required"`
// A numeric string.
Gt1mLte5m string `json:"gt_1m_lte_5m,required"`
// A numeric string.
Gt1w string `json:"gt_1w,required"`
// A numeric string.
Gt5mLte15m string `json:"gt_5m_lte_15m,required"`
// A numeric string.
Lte1m string `json:"lte_1m,required"`
JSON dnsSummaryResponseTTLResponseSummary0JSON `json:"-"`
}
func (*DNSSummaryResponseTTLResponseSummary0) UnmarshalJSON ¶
func (r *DNSSummaryResponseTTLResponseSummary0) UnmarshalJSON(data []byte) (err error)
type DNSSummaryService ¶
type DNSSummaryService struct {
Options []option.RequestOption
}
DNSSummaryService 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 NewDNSSummaryService method instead.
func NewDNSSummaryService ¶
func NewDNSSummaryService(opts ...option.RequestOption) (r *DNSSummaryService)
NewDNSSummaryService 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 (*DNSSummaryService) CacheHit ¶
func (r *DNSSummaryService) CacheHit(ctx context.Context, query DNSSummaryCacheHitParams, opts ...option.RequestOption) (res *DNSSummaryCacheHitResponse, err error)
Retrieves the distribution of DNS queries by cache status.
func (*DNSSummaryService) DNSSEC ¶
func (r *DNSSummaryService) DNSSEC(ctx context.Context, query DNSSummaryDNSSECParams, opts ...option.RequestOption) (res *DNSSummaryDNSSECResponse, err error)
Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support.
func (*DNSSummaryService) DNSSECAware ¶
func (r *DNSSummaryService) DNSSECAware(ctx context.Context, query DNSSummaryDNSSECAwareParams, opts ...option.RequestOption) (res *DNSSummaryDNSSECAwareResponse, err error)
Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness.
func (*DNSSummaryService) DNSSECE2E ¶
func (r *DNSSummaryService) DNSSECE2E(ctx context.Context, query DNSSummaryDNSSECE2EParams, opts ...option.RequestOption) (res *DNSSummaryDnssece2EResponse, err error)
Retrieves the distribution of DNSSEC-validated answers by end-to-end security status.
func (*DNSSummaryService) IPVersion ¶
func (r *DNSSummaryService) IPVersion(ctx context.Context, query DNSSummaryIPVersionParams, opts ...option.RequestOption) (res *DNSSummaryIPVersionResponse, err error)
Retrieves the distribution of DNS queries by IP version.
func (*DNSSummaryService) MatchingAnswer ¶
func (r *DNSSummaryService) MatchingAnswer(ctx context.Context, query DNSSummaryMatchingAnswerParams, opts ...option.RequestOption) (res *DNSSummaryMatchingAnswerResponse, err error)
Retrieves the distribution of DNS queries by matching answers.
func (*DNSSummaryService) Protocol ¶
func (r *DNSSummaryService) Protocol(ctx context.Context, query DNSSummaryProtocolParams, opts ...option.RequestOption) (res *DNSSummaryProtocolResponse, err error)
Retrieves the distribution of DNS queries by DNS transport protocol.
func (*DNSSummaryService) QueryType ¶
func (r *DNSSummaryService) QueryType(ctx context.Context, query DNSSummaryQueryTypeParams, opts ...option.RequestOption) (res *DNSSummaryQueryTypeResponse, err error)
Retrieves the distribution of DNS queries by type.
func (*DNSSummaryService) ResponseCode ¶
func (r *DNSSummaryService) ResponseCode(ctx context.Context, query DNSSummaryResponseCodeParams, opts ...option.RequestOption) (res *DNSSummaryResponseCodeResponse, err error)
Retrieves the distribution of DNS queries by response code.
func (*DNSSummaryService) ResponseTTL ¶
func (r *DNSSummaryService) ResponseTTL(ctx context.Context, query DNSSummaryResponseTTLParams, opts ...option.RequestOption) (res *DNSSummaryResponseTTLResponse, err error)
Retrieves the distribution of DNS queries by minimum response TTL.
type DNSTimeseriesGroupCacheHitParams ¶
type DNSTimeseriesGroupCacheHitParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupCacheHitParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupCacheHitParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupCacheHitParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupCacheHitParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupCacheHitParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupCacheHitParams) URLQuery ¶
func (r DNSTimeseriesGroupCacheHitParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupCacheHitParams's query parameters as `url.Values`.
type DNSTimeseriesGroupCacheHitParamsAggInterval ¶
type DNSTimeseriesGroupCacheHitParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupCacheHitParamsAggInterval15m DNSTimeseriesGroupCacheHitParamsAggInterval = "15m" DNSTimeseriesGroupCacheHitParamsAggInterval1h DNSTimeseriesGroupCacheHitParamsAggInterval = "1h" DNSTimeseriesGroupCacheHitParamsAggInterval1d DNSTimeseriesGroupCacheHitParamsAggInterval = "1d" DNSTimeseriesGroupCacheHitParamsAggInterval1w DNSTimeseriesGroupCacheHitParamsAggInterval = "1w" )
func (DNSTimeseriesGroupCacheHitParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupCacheHitParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupCacheHitParamsFormat ¶
type DNSTimeseriesGroupCacheHitParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupCacheHitParamsFormatJson DNSTimeseriesGroupCacheHitParamsFormat = "JSON" DNSTimeseriesGroupCacheHitParamsFormatCsv DNSTimeseriesGroupCacheHitParamsFormat = "CSV" )
func (DNSTimeseriesGroupCacheHitParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupCacheHitParamsFormat) IsKnown() bool
type DNSTimeseriesGroupCacheHitParamsProtocol ¶
type DNSTimeseriesGroupCacheHitParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupCacheHitParamsProtocolUdp DNSTimeseriesGroupCacheHitParamsProtocol = "UDP" DNSTimeseriesGroupCacheHitParamsProtocolTCP DNSTimeseriesGroupCacheHitParamsProtocol = "TCP" DNSTimeseriesGroupCacheHitParamsProtocolHTTPS DNSTimeseriesGroupCacheHitParamsProtocol = "HTTPS" DNSTimeseriesGroupCacheHitParamsProtocolTLS DNSTimeseriesGroupCacheHitParamsProtocol = "TLS" )
func (DNSTimeseriesGroupCacheHitParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupCacheHitParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupCacheHitParamsQueryType ¶
type DNSTimeseriesGroupCacheHitParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupCacheHitParamsQueryTypeA DNSTimeseriesGroupCacheHitParamsQueryType = "A" DNSTimeseriesGroupCacheHitParamsQueryTypeAAAA DNSTimeseriesGroupCacheHitParamsQueryType = "AAAA" DNSTimeseriesGroupCacheHitParamsQueryTypeA6 DNSTimeseriesGroupCacheHitParamsQueryType = "A6" DNSTimeseriesGroupCacheHitParamsQueryTypeAfsdb DNSTimeseriesGroupCacheHitParamsQueryType = "AFSDB" DNSTimeseriesGroupCacheHitParamsQueryTypeAny DNSTimeseriesGroupCacheHitParamsQueryType = "ANY" DNSTimeseriesGroupCacheHitParamsQueryTypeApl DNSTimeseriesGroupCacheHitParamsQueryType = "APL" DNSTimeseriesGroupCacheHitParamsQueryTypeAtma DNSTimeseriesGroupCacheHitParamsQueryType = "ATMA" DNSTimeseriesGroupCacheHitParamsQueryTypeAXFR DNSTimeseriesGroupCacheHitParamsQueryType = "AXFR" DNSTimeseriesGroupCacheHitParamsQueryTypeCAA DNSTimeseriesGroupCacheHitParamsQueryType = "CAA" DNSTimeseriesGroupCacheHitParamsQueryTypeCdnskey DNSTimeseriesGroupCacheHitParamsQueryType = "CDNSKEY" DNSTimeseriesGroupCacheHitParamsQueryTypeCds DNSTimeseriesGroupCacheHitParamsQueryType = "CDS" DNSTimeseriesGroupCacheHitParamsQueryTypeCERT DNSTimeseriesGroupCacheHitParamsQueryType = "CERT" DNSTimeseriesGroupCacheHitParamsQueryTypeCNAME DNSTimeseriesGroupCacheHitParamsQueryType = "CNAME" DNSTimeseriesGroupCacheHitParamsQueryTypeCsync DNSTimeseriesGroupCacheHitParamsQueryType = "CSYNC" DNSTimeseriesGroupCacheHitParamsQueryTypeDhcid DNSTimeseriesGroupCacheHitParamsQueryType = "DHCID" DNSTimeseriesGroupCacheHitParamsQueryTypeDlv DNSTimeseriesGroupCacheHitParamsQueryType = "DLV" DNSTimeseriesGroupCacheHitParamsQueryTypeDname DNSTimeseriesGroupCacheHitParamsQueryType = "DNAME" DNSTimeseriesGroupCacheHitParamsQueryTypeDNSKEY DNSTimeseriesGroupCacheHitParamsQueryType = "DNSKEY" DNSTimeseriesGroupCacheHitParamsQueryTypeDoa DNSTimeseriesGroupCacheHitParamsQueryType = "DOA" DNSTimeseriesGroupCacheHitParamsQueryTypeDS DNSTimeseriesGroupCacheHitParamsQueryType = "DS" DNSTimeseriesGroupCacheHitParamsQueryTypeEid DNSTimeseriesGroupCacheHitParamsQueryType = "EID" DNSTimeseriesGroupCacheHitParamsQueryTypeEui48 DNSTimeseriesGroupCacheHitParamsQueryType = "EUI48" DNSTimeseriesGroupCacheHitParamsQueryTypeEui64 DNSTimeseriesGroupCacheHitParamsQueryType = "EUI64" DNSTimeseriesGroupCacheHitParamsQueryTypeGpos DNSTimeseriesGroupCacheHitParamsQueryType = "GPOS" DNSTimeseriesGroupCacheHitParamsQueryTypeGid DNSTimeseriesGroupCacheHitParamsQueryType = "GID" DNSTimeseriesGroupCacheHitParamsQueryTypeHinfo DNSTimeseriesGroupCacheHitParamsQueryType = "HINFO" DNSTimeseriesGroupCacheHitParamsQueryTypeHip DNSTimeseriesGroupCacheHitParamsQueryType = "HIP" DNSTimeseriesGroupCacheHitParamsQueryTypeHTTPS DNSTimeseriesGroupCacheHitParamsQueryType = "HTTPS" DNSTimeseriesGroupCacheHitParamsQueryTypeIpseckey DNSTimeseriesGroupCacheHitParamsQueryType = "IPSECKEY" DNSTimeseriesGroupCacheHitParamsQueryTypeIsdn DNSTimeseriesGroupCacheHitParamsQueryType = "ISDN" DNSTimeseriesGroupCacheHitParamsQueryTypeIxfr DNSTimeseriesGroupCacheHitParamsQueryType = "IXFR" DNSTimeseriesGroupCacheHitParamsQueryTypeKey DNSTimeseriesGroupCacheHitParamsQueryType = "KEY" DNSTimeseriesGroupCacheHitParamsQueryTypeKx DNSTimeseriesGroupCacheHitParamsQueryType = "KX" DNSTimeseriesGroupCacheHitParamsQueryTypeL32 DNSTimeseriesGroupCacheHitParamsQueryType = "L32" DNSTimeseriesGroupCacheHitParamsQueryTypeL64 DNSTimeseriesGroupCacheHitParamsQueryType = "L64" DNSTimeseriesGroupCacheHitParamsQueryTypeLOC DNSTimeseriesGroupCacheHitParamsQueryType = "LOC" DNSTimeseriesGroupCacheHitParamsQueryTypeLp DNSTimeseriesGroupCacheHitParamsQueryType = "LP" DNSTimeseriesGroupCacheHitParamsQueryTypeMaila DNSTimeseriesGroupCacheHitParamsQueryType = "MAILA" DNSTimeseriesGroupCacheHitParamsQueryTypeMailb DNSTimeseriesGroupCacheHitParamsQueryType = "MAILB" DNSTimeseriesGroupCacheHitParamsQueryTypeMB DNSTimeseriesGroupCacheHitParamsQueryType = "MB" DNSTimeseriesGroupCacheHitParamsQueryTypeMd DNSTimeseriesGroupCacheHitParamsQueryType = "MD" DNSTimeseriesGroupCacheHitParamsQueryTypeMf DNSTimeseriesGroupCacheHitParamsQueryType = "MF" DNSTimeseriesGroupCacheHitParamsQueryTypeMg DNSTimeseriesGroupCacheHitParamsQueryType = "MG" DNSTimeseriesGroupCacheHitParamsQueryTypeMinfo DNSTimeseriesGroupCacheHitParamsQueryType = "MINFO" DNSTimeseriesGroupCacheHitParamsQueryTypeMr DNSTimeseriesGroupCacheHitParamsQueryType = "MR" DNSTimeseriesGroupCacheHitParamsQueryTypeMX DNSTimeseriesGroupCacheHitParamsQueryType = "MX" DNSTimeseriesGroupCacheHitParamsQueryTypeNAPTR DNSTimeseriesGroupCacheHitParamsQueryType = "NAPTR" DNSTimeseriesGroupCacheHitParamsQueryTypeNb DNSTimeseriesGroupCacheHitParamsQueryType = "NB" DNSTimeseriesGroupCacheHitParamsQueryTypeNbstat DNSTimeseriesGroupCacheHitParamsQueryType = "NBSTAT" DNSTimeseriesGroupCacheHitParamsQueryTypeNid DNSTimeseriesGroupCacheHitParamsQueryType = "NID" DNSTimeseriesGroupCacheHitParamsQueryTypeNimloc DNSTimeseriesGroupCacheHitParamsQueryType = "NIMLOC" DNSTimeseriesGroupCacheHitParamsQueryTypeNinfo DNSTimeseriesGroupCacheHitParamsQueryType = "NINFO" DNSTimeseriesGroupCacheHitParamsQueryTypeNS DNSTimeseriesGroupCacheHitParamsQueryType = "NS" DNSTimeseriesGroupCacheHitParamsQueryTypeNsap DNSTimeseriesGroupCacheHitParamsQueryType = "NSAP" DNSTimeseriesGroupCacheHitParamsQueryTypeNsec DNSTimeseriesGroupCacheHitParamsQueryType = "NSEC" DNSTimeseriesGroupCacheHitParamsQueryTypeNsec3 DNSTimeseriesGroupCacheHitParamsQueryType = "NSEC3" DNSTimeseriesGroupCacheHitParamsQueryTypeNsec3Param DNSTimeseriesGroupCacheHitParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupCacheHitParamsQueryTypeNull DNSTimeseriesGroupCacheHitParamsQueryType = "NULL" DNSTimeseriesGroupCacheHitParamsQueryTypeNxt DNSTimeseriesGroupCacheHitParamsQueryType = "NXT" DNSTimeseriesGroupCacheHitParamsQueryTypeOpenpgpkey DNSTimeseriesGroupCacheHitParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupCacheHitParamsQueryTypeOpt DNSTimeseriesGroupCacheHitParamsQueryType = "OPT" DNSTimeseriesGroupCacheHitParamsQueryTypePTR DNSTimeseriesGroupCacheHitParamsQueryType = "PTR" DNSTimeseriesGroupCacheHitParamsQueryTypePx DNSTimeseriesGroupCacheHitParamsQueryType = "PX" DNSTimeseriesGroupCacheHitParamsQueryTypeRkey DNSTimeseriesGroupCacheHitParamsQueryType = "RKEY" DNSTimeseriesGroupCacheHitParamsQueryTypeRp DNSTimeseriesGroupCacheHitParamsQueryType = "RP" DNSTimeseriesGroupCacheHitParamsQueryTypeRrsig DNSTimeseriesGroupCacheHitParamsQueryType = "RRSIG" DNSTimeseriesGroupCacheHitParamsQueryTypeRt DNSTimeseriesGroupCacheHitParamsQueryType = "RT" DNSTimeseriesGroupCacheHitParamsQueryTypeSig DNSTimeseriesGroupCacheHitParamsQueryType = "SIG" DNSTimeseriesGroupCacheHitParamsQueryTypeSink DNSTimeseriesGroupCacheHitParamsQueryType = "SINK" DNSTimeseriesGroupCacheHitParamsQueryTypeSMIMEA DNSTimeseriesGroupCacheHitParamsQueryType = "SMIMEA" DNSTimeseriesGroupCacheHitParamsQueryTypeSOA DNSTimeseriesGroupCacheHitParamsQueryType = "SOA" DNSTimeseriesGroupCacheHitParamsQueryTypeSPF DNSTimeseriesGroupCacheHitParamsQueryType = "SPF" DNSTimeseriesGroupCacheHitParamsQueryTypeSRV DNSTimeseriesGroupCacheHitParamsQueryType = "SRV" DNSTimeseriesGroupCacheHitParamsQueryTypeSSHFP DNSTimeseriesGroupCacheHitParamsQueryType = "SSHFP" DNSTimeseriesGroupCacheHitParamsQueryTypeSVCB DNSTimeseriesGroupCacheHitParamsQueryType = "SVCB" DNSTimeseriesGroupCacheHitParamsQueryTypeTa DNSTimeseriesGroupCacheHitParamsQueryType = "TA" DNSTimeseriesGroupCacheHitParamsQueryTypeTalink DNSTimeseriesGroupCacheHitParamsQueryType = "TALINK" DNSTimeseriesGroupCacheHitParamsQueryTypeTkey DNSTimeseriesGroupCacheHitParamsQueryType = "TKEY" DNSTimeseriesGroupCacheHitParamsQueryTypeTLSA DNSTimeseriesGroupCacheHitParamsQueryType = "TLSA" DNSTimeseriesGroupCacheHitParamsQueryTypeTSIG DNSTimeseriesGroupCacheHitParamsQueryType = "TSIG" DNSTimeseriesGroupCacheHitParamsQueryTypeTXT DNSTimeseriesGroupCacheHitParamsQueryType = "TXT" DNSTimeseriesGroupCacheHitParamsQueryTypeUinfo DNSTimeseriesGroupCacheHitParamsQueryType = "UINFO" DNSTimeseriesGroupCacheHitParamsQueryTypeUID DNSTimeseriesGroupCacheHitParamsQueryType = "UID" DNSTimeseriesGroupCacheHitParamsQueryTypeUnspec DNSTimeseriesGroupCacheHitParamsQueryType = "UNSPEC" DNSTimeseriesGroupCacheHitParamsQueryTypeURI DNSTimeseriesGroupCacheHitParamsQueryType = "URI" DNSTimeseriesGroupCacheHitParamsQueryTypeWks DNSTimeseriesGroupCacheHitParamsQueryType = "WKS" DNSTimeseriesGroupCacheHitParamsQueryTypeX25 DNSTimeseriesGroupCacheHitParamsQueryType = "X25" DNSTimeseriesGroupCacheHitParamsQueryTypeZonemd DNSTimeseriesGroupCacheHitParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupCacheHitParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupCacheHitParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupCacheHitParamsResponseCode ¶
type DNSTimeseriesGroupCacheHitParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupCacheHitParamsResponseCodeNoerror DNSTimeseriesGroupCacheHitParamsResponseCode = "NOERROR" DNSTimeseriesGroupCacheHitParamsResponseCodeFormerr DNSTimeseriesGroupCacheHitParamsResponseCode = "FORMERR" DNSTimeseriesGroupCacheHitParamsResponseCodeServfail DNSTimeseriesGroupCacheHitParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupCacheHitParamsResponseCodeNxdomain DNSTimeseriesGroupCacheHitParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupCacheHitParamsResponseCodeNotimp DNSTimeseriesGroupCacheHitParamsResponseCode = "NOTIMP" DNSTimeseriesGroupCacheHitParamsResponseCodeRefused DNSTimeseriesGroupCacheHitParamsResponseCode = "REFUSED" DNSTimeseriesGroupCacheHitParamsResponseCodeYxdomain DNSTimeseriesGroupCacheHitParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupCacheHitParamsResponseCodeYxrrset DNSTimeseriesGroupCacheHitParamsResponseCode = "YXRRSET" DNSTimeseriesGroupCacheHitParamsResponseCodeNxrrset DNSTimeseriesGroupCacheHitParamsResponseCode = "NXRRSET" DNSTimeseriesGroupCacheHitParamsResponseCodeNotauth DNSTimeseriesGroupCacheHitParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupCacheHitParamsResponseCodeNotzone DNSTimeseriesGroupCacheHitParamsResponseCode = "NOTZONE" DNSTimeseriesGroupCacheHitParamsResponseCodeBadsig DNSTimeseriesGroupCacheHitParamsResponseCode = "BADSIG" DNSTimeseriesGroupCacheHitParamsResponseCodeBadkey DNSTimeseriesGroupCacheHitParamsResponseCode = "BADKEY" DNSTimeseriesGroupCacheHitParamsResponseCodeBadtime DNSTimeseriesGroupCacheHitParamsResponseCode = "BADTIME" DNSTimeseriesGroupCacheHitParamsResponseCodeBadmode DNSTimeseriesGroupCacheHitParamsResponseCode = "BADMODE" DNSTimeseriesGroupCacheHitParamsResponseCodeBadname DNSTimeseriesGroupCacheHitParamsResponseCode = "BADNAME" DNSTimeseriesGroupCacheHitParamsResponseCodeBadalg DNSTimeseriesGroupCacheHitParamsResponseCode = "BADALG" DNSTimeseriesGroupCacheHitParamsResponseCodeBadtrunc DNSTimeseriesGroupCacheHitParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupCacheHitParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupCacheHitParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupCacheHitResponse ¶
type DNSTimeseriesGroupCacheHitResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupCacheHitResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupCacheHitResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupCacheHitResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupCacheHitResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupCacheHitResponseEnvelope ¶
type DNSTimeseriesGroupCacheHitResponseEnvelope struct {
Result DNSTimeseriesGroupCacheHitResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupCacheHitResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupCacheHitResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupCacheHitResponseMeta ¶
type DNSTimeseriesGroupCacheHitResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupCacheHitResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupCacheHitResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupCacheHitResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupCacheHitResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupCacheHitResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupCacheHitResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupCacheHitResponseMetaAggInterval ¶
type DNSTimeseriesGroupCacheHitResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupCacheHitResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupCacheHitResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupCacheHitResponseMetaAggIntervalOneHour DNSTimeseriesGroupCacheHitResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupCacheHitResponseMetaAggIntervalOneDay DNSTimeseriesGroupCacheHitResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupCacheHitResponseMetaAggIntervalOneWeek DNSTimeseriesGroupCacheHitResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupCacheHitResponseMetaAggIntervalOneMonth DNSTimeseriesGroupCacheHitResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupCacheHitResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupCacheHitResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupCacheHitResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupCacheHitResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupCacheHitResponseMetaDateRange ¶
type DNSTimeseriesGroupCacheHitResponseMetaDateRange 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 dnsTimeseriesGroupCacheHitResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupCacheHitResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupCacheHitResponseMetaNormalization ¶
type DNSTimeseriesGroupCacheHitResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupCacheHitResponseMetaNormalizationPercentage DNSTimeseriesGroupCacheHitResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupCacheHitResponseMetaNormalizationMin0Max DNSTimeseriesGroupCacheHitResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupCacheHitResponseMetaNormalizationMinMax DNSTimeseriesGroupCacheHitResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupCacheHitResponseMetaNormalizationRawValues DNSTimeseriesGroupCacheHitResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupCacheHitResponseMetaNormalizationPercentageChange DNSTimeseriesGroupCacheHitResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupCacheHitResponseMetaNormalizationRollingAverage DNSTimeseriesGroupCacheHitResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupCacheHitResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupCacheHitResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupCacheHitResponseMetaNormalizationRatio DNSTimeseriesGroupCacheHitResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupCacheHitResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupCacheHitResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupCacheHitResponseMetaUnit ¶
type DNSTimeseriesGroupCacheHitResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupCacheHitResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupCacheHitResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupCacheHitResponseSerie0 ¶
type DNSTimeseriesGroupCacheHitResponseSerie0 struct {
Negative []string `json:"NEGATIVE,required"`
Positive []string `json:"POSITIVE,required"`
JSON dnsTimeseriesGroupCacheHitResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupCacheHitResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupCacheHitResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareParams ¶
type DNSTimeseriesGroupDNSSECAwareParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupDNSSECAwareParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupDNSSECAwareParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupDNSSECAwareParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupDNSSECAwareParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupDNSSECAwareParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupDNSSECAwareParams) URLQuery ¶
func (r DNSTimeseriesGroupDNSSECAwareParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupDNSSECAwareParams's query parameters as `url.Values`.
type DNSTimeseriesGroupDNSSECAwareParamsAggInterval ¶
type DNSTimeseriesGroupDNSSECAwareParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupDNSSECAwareParamsAggInterval15m DNSTimeseriesGroupDNSSECAwareParamsAggInterval = "15m" DNSTimeseriesGroupDNSSECAwareParamsAggInterval1h DNSTimeseriesGroupDNSSECAwareParamsAggInterval = "1h" DNSTimeseriesGroupDNSSECAwareParamsAggInterval1d DNSTimeseriesGroupDNSSECAwareParamsAggInterval = "1d" DNSTimeseriesGroupDNSSECAwareParamsAggInterval1w DNSTimeseriesGroupDNSSECAwareParamsAggInterval = "1w" )
func (DNSTimeseriesGroupDNSSECAwareParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECAwareParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupDNSSECAwareParamsFormat ¶
type DNSTimeseriesGroupDNSSECAwareParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupDNSSECAwareParamsFormatJson DNSTimeseriesGroupDNSSECAwareParamsFormat = "JSON" DNSTimeseriesGroupDNSSECAwareParamsFormatCsv DNSTimeseriesGroupDNSSECAwareParamsFormat = "CSV" )
func (DNSTimeseriesGroupDNSSECAwareParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECAwareParamsFormat) IsKnown() bool
type DNSTimeseriesGroupDNSSECAwareParamsProtocol ¶
type DNSTimeseriesGroupDNSSECAwareParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupDNSSECAwareParamsProtocolUdp DNSTimeseriesGroupDNSSECAwareParamsProtocol = "UDP" DNSTimeseriesGroupDNSSECAwareParamsProtocolTCP DNSTimeseriesGroupDNSSECAwareParamsProtocol = "TCP" DNSTimeseriesGroupDNSSECAwareParamsProtocolHTTPS DNSTimeseriesGroupDNSSECAwareParamsProtocol = "HTTPS" DNSTimeseriesGroupDNSSECAwareParamsProtocolTLS DNSTimeseriesGroupDNSSECAwareParamsProtocol = "TLS" )
func (DNSTimeseriesGroupDNSSECAwareParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECAwareParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupDNSSECAwareParamsQueryType ¶
type DNSTimeseriesGroupDNSSECAwareParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupDNSSECAwareParamsQueryTypeA DNSTimeseriesGroupDNSSECAwareParamsQueryType = "A" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeAAAA DNSTimeseriesGroupDNSSECAwareParamsQueryType = "AAAA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeA6 DNSTimeseriesGroupDNSSECAwareParamsQueryType = "A6" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeAfsdb DNSTimeseriesGroupDNSSECAwareParamsQueryType = "AFSDB" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeAny DNSTimeseriesGroupDNSSECAwareParamsQueryType = "ANY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeApl DNSTimeseriesGroupDNSSECAwareParamsQueryType = "APL" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeAtma DNSTimeseriesGroupDNSSECAwareParamsQueryType = "ATMA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeAXFR DNSTimeseriesGroupDNSSECAwareParamsQueryType = "AXFR" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeCAA DNSTimeseriesGroupDNSSECAwareParamsQueryType = "CAA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeCdnskey DNSTimeseriesGroupDNSSECAwareParamsQueryType = "CDNSKEY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeCds DNSTimeseriesGroupDNSSECAwareParamsQueryType = "CDS" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeCERT DNSTimeseriesGroupDNSSECAwareParamsQueryType = "CERT" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeCNAME DNSTimeseriesGroupDNSSECAwareParamsQueryType = "CNAME" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeCsync DNSTimeseriesGroupDNSSECAwareParamsQueryType = "CSYNC" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeDhcid DNSTimeseriesGroupDNSSECAwareParamsQueryType = "DHCID" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeDlv DNSTimeseriesGroupDNSSECAwareParamsQueryType = "DLV" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeDname DNSTimeseriesGroupDNSSECAwareParamsQueryType = "DNAME" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeDNSKEY DNSTimeseriesGroupDNSSECAwareParamsQueryType = "DNSKEY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeDoa DNSTimeseriesGroupDNSSECAwareParamsQueryType = "DOA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeDS DNSTimeseriesGroupDNSSECAwareParamsQueryType = "DS" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeEid DNSTimeseriesGroupDNSSECAwareParamsQueryType = "EID" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeEui48 DNSTimeseriesGroupDNSSECAwareParamsQueryType = "EUI48" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeEui64 DNSTimeseriesGroupDNSSECAwareParamsQueryType = "EUI64" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeGpos DNSTimeseriesGroupDNSSECAwareParamsQueryType = "GPOS" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeGid DNSTimeseriesGroupDNSSECAwareParamsQueryType = "GID" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeHinfo DNSTimeseriesGroupDNSSECAwareParamsQueryType = "HINFO" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeHip DNSTimeseriesGroupDNSSECAwareParamsQueryType = "HIP" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeHTTPS DNSTimeseriesGroupDNSSECAwareParamsQueryType = "HTTPS" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeIpseckey DNSTimeseriesGroupDNSSECAwareParamsQueryType = "IPSECKEY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeIsdn DNSTimeseriesGroupDNSSECAwareParamsQueryType = "ISDN" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeIxfr DNSTimeseriesGroupDNSSECAwareParamsQueryType = "IXFR" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeKey DNSTimeseriesGroupDNSSECAwareParamsQueryType = "KEY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeKx DNSTimeseriesGroupDNSSECAwareParamsQueryType = "KX" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeL32 DNSTimeseriesGroupDNSSECAwareParamsQueryType = "L32" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeL64 DNSTimeseriesGroupDNSSECAwareParamsQueryType = "L64" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeLOC DNSTimeseriesGroupDNSSECAwareParamsQueryType = "LOC" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeLp DNSTimeseriesGroupDNSSECAwareParamsQueryType = "LP" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMaila DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MAILA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMailb DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MAILB" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMB DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MB" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMd DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MD" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMf DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MF" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMg DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MG" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMinfo DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MINFO" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMr DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MR" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeMX DNSTimeseriesGroupDNSSECAwareParamsQueryType = "MX" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNAPTR DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NAPTR" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNb DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NB" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNbstat DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NBSTAT" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNid DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NID" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNimloc DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NIMLOC" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNinfo DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NINFO" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNS DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NS" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNsap DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NSAP" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNsec DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NSEC" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNsec3 DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NSEC3" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNsec3Param DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNull DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NULL" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeNxt DNSTimeseriesGroupDNSSECAwareParamsQueryType = "NXT" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeOpenpgpkey DNSTimeseriesGroupDNSSECAwareParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeOpt DNSTimeseriesGroupDNSSECAwareParamsQueryType = "OPT" DNSTimeseriesGroupDNSSECAwareParamsQueryTypePTR DNSTimeseriesGroupDNSSECAwareParamsQueryType = "PTR" DNSTimeseriesGroupDNSSECAwareParamsQueryTypePx DNSTimeseriesGroupDNSSECAwareParamsQueryType = "PX" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeRkey DNSTimeseriesGroupDNSSECAwareParamsQueryType = "RKEY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeRp DNSTimeseriesGroupDNSSECAwareParamsQueryType = "RP" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeRrsig DNSTimeseriesGroupDNSSECAwareParamsQueryType = "RRSIG" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeRt DNSTimeseriesGroupDNSSECAwareParamsQueryType = "RT" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSig DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SIG" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSink DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SINK" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSMIMEA DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SMIMEA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSOA DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SOA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSPF DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SPF" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSRV DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SRV" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSSHFP DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SSHFP" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeSVCB DNSTimeseriesGroupDNSSECAwareParamsQueryType = "SVCB" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeTa DNSTimeseriesGroupDNSSECAwareParamsQueryType = "TA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeTalink DNSTimeseriesGroupDNSSECAwareParamsQueryType = "TALINK" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeTkey DNSTimeseriesGroupDNSSECAwareParamsQueryType = "TKEY" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeTLSA DNSTimeseriesGroupDNSSECAwareParamsQueryType = "TLSA" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeTSIG DNSTimeseriesGroupDNSSECAwareParamsQueryType = "TSIG" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeTXT DNSTimeseriesGroupDNSSECAwareParamsQueryType = "TXT" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeUinfo DNSTimeseriesGroupDNSSECAwareParamsQueryType = "UINFO" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeUID DNSTimeseriesGroupDNSSECAwareParamsQueryType = "UID" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeUnspec DNSTimeseriesGroupDNSSECAwareParamsQueryType = "UNSPEC" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeURI DNSTimeseriesGroupDNSSECAwareParamsQueryType = "URI" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeWks DNSTimeseriesGroupDNSSECAwareParamsQueryType = "WKS" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeX25 DNSTimeseriesGroupDNSSECAwareParamsQueryType = "X25" DNSTimeseriesGroupDNSSECAwareParamsQueryTypeZonemd DNSTimeseriesGroupDNSSECAwareParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupDNSSECAwareParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECAwareParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupDNSSECAwareParamsResponseCode ¶
type DNSTimeseriesGroupDNSSECAwareParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupDNSSECAwareParamsResponseCodeNoerror DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "NOERROR" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeFormerr DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "FORMERR" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeServfail DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeNxdomain DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeNotimp DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "NOTIMP" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeRefused DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "REFUSED" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeYxdomain DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeYxrrset DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "YXRRSET" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeNxrrset DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "NXRRSET" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeNotauth DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeNotzone DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "NOTZONE" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeBadsig DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "BADSIG" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeBadkey DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "BADKEY" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeBadtime DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "BADTIME" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeBadmode DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "BADMODE" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeBadname DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "BADNAME" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeBadalg DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "BADALG" DNSTimeseriesGroupDNSSECAwareParamsResponseCodeBadtrunc DNSTimeseriesGroupDNSSECAwareParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupDNSSECAwareParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECAwareParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupDNSSECAwareResponse ¶
type DNSTimeseriesGroupDNSSECAwareResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupDNSSECAwareResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupDNSSECAwareResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupDNSSECAwareResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECAwareResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareResponseEnvelope ¶
type DNSTimeseriesGroupDNSSECAwareResponseEnvelope struct {
Result DNSTimeseriesGroupDNSSECAwareResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupDNSSECAwareResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECAwareResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareResponseMeta ¶
type DNSTimeseriesGroupDNSSECAwareResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupDNSSECAwareResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupDNSSECAwareResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupDNSSECAwareResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupDNSSECAwareResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval ¶
type DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupDNSSECAwareResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupDNSSECAwareResponseMetaAggIntervalOneHour DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupDNSSECAwareResponseMetaAggIntervalOneDay DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupDNSSECAwareResponseMetaAggIntervalOneWeek DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupDNSSECAwareResponseMetaAggIntervalOneMonth DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECAwareResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareResponseMetaDateRange ¶
type DNSTimeseriesGroupDNSSECAwareResponseMetaDateRange 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 dnsTimeseriesGroupDNSSECAwareResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECAwareResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization ¶
type DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationPercentage DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationMin0Max DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationMinMax DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationRawValues DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationPercentageChange DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationRollingAverage DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupDNSSECAwareResponseMetaNormalizationRatio DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECAwareResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupDNSSECAwareResponseMetaUnit ¶
type DNSTimeseriesGroupDNSSECAwareResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupDNSSECAwareResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECAwareResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECAwareResponseSerie0 ¶
type DNSTimeseriesGroupDNSSECAwareResponseSerie0 struct {
NotSupported []string `json:"NOT_SUPPORTED,required"`
Supported []string `json:"SUPPORTED,required"`
JSON dnsTimeseriesGroupDNSSECAwareResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECAwareResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECAwareResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECE2EParams ¶
type DNSTimeseriesGroupDNSSECE2EParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupDnssece2EParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupDnssece2EParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupDnssece2EParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupDnssece2EParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupDnssece2EParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupDNSSECE2EParams) URLQuery ¶
func (r DNSTimeseriesGroupDNSSECE2EParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupDNSSECE2EParams's query parameters as `url.Values`.
type DNSTimeseriesGroupDNSSECParams ¶
type DNSTimeseriesGroupDNSSECParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupDNSSECParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupDNSSECParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupDNSSECParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupDNSSECParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupDNSSECParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupDNSSECParams) URLQuery ¶
func (r DNSTimeseriesGroupDNSSECParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupDNSSECParams's query parameters as `url.Values`.
type DNSTimeseriesGroupDNSSECParamsAggInterval ¶
type DNSTimeseriesGroupDNSSECParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupDNSSECParamsAggInterval15m DNSTimeseriesGroupDNSSECParamsAggInterval = "15m" DNSTimeseriesGroupDNSSECParamsAggInterval1h DNSTimeseriesGroupDNSSECParamsAggInterval = "1h" DNSTimeseriesGroupDNSSECParamsAggInterval1d DNSTimeseriesGroupDNSSECParamsAggInterval = "1d" DNSTimeseriesGroupDNSSECParamsAggInterval1w DNSTimeseriesGroupDNSSECParamsAggInterval = "1w" )
func (DNSTimeseriesGroupDNSSECParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupDNSSECParamsFormat ¶
type DNSTimeseriesGroupDNSSECParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupDNSSECParamsFormatJson DNSTimeseriesGroupDNSSECParamsFormat = "JSON" DNSTimeseriesGroupDNSSECParamsFormatCsv DNSTimeseriesGroupDNSSECParamsFormat = "CSV" )
func (DNSTimeseriesGroupDNSSECParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECParamsFormat) IsKnown() bool
type DNSTimeseriesGroupDNSSECParamsProtocol ¶
type DNSTimeseriesGroupDNSSECParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupDNSSECParamsProtocolUdp DNSTimeseriesGroupDNSSECParamsProtocol = "UDP" DNSTimeseriesGroupDNSSECParamsProtocolTCP DNSTimeseriesGroupDNSSECParamsProtocol = "TCP" DNSTimeseriesGroupDNSSECParamsProtocolHTTPS DNSTimeseriesGroupDNSSECParamsProtocol = "HTTPS" DNSTimeseriesGroupDNSSECParamsProtocolTLS DNSTimeseriesGroupDNSSECParamsProtocol = "TLS" )
func (DNSTimeseriesGroupDNSSECParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupDNSSECParamsQueryType ¶
type DNSTimeseriesGroupDNSSECParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupDNSSECParamsQueryTypeA DNSTimeseriesGroupDNSSECParamsQueryType = "A" DNSTimeseriesGroupDNSSECParamsQueryTypeAAAA DNSTimeseriesGroupDNSSECParamsQueryType = "AAAA" DNSTimeseriesGroupDNSSECParamsQueryTypeA6 DNSTimeseriesGroupDNSSECParamsQueryType = "A6" DNSTimeseriesGroupDNSSECParamsQueryTypeAfsdb DNSTimeseriesGroupDNSSECParamsQueryType = "AFSDB" DNSTimeseriesGroupDNSSECParamsQueryTypeAny DNSTimeseriesGroupDNSSECParamsQueryType = "ANY" DNSTimeseriesGroupDNSSECParamsQueryTypeApl DNSTimeseriesGroupDNSSECParamsQueryType = "APL" DNSTimeseriesGroupDNSSECParamsQueryTypeAtma DNSTimeseriesGroupDNSSECParamsQueryType = "ATMA" DNSTimeseriesGroupDNSSECParamsQueryTypeAXFR DNSTimeseriesGroupDNSSECParamsQueryType = "AXFR" DNSTimeseriesGroupDNSSECParamsQueryTypeCAA DNSTimeseriesGroupDNSSECParamsQueryType = "CAA" DNSTimeseriesGroupDNSSECParamsQueryTypeCdnskey DNSTimeseriesGroupDNSSECParamsQueryType = "CDNSKEY" DNSTimeseriesGroupDNSSECParamsQueryTypeCds DNSTimeseriesGroupDNSSECParamsQueryType = "CDS" DNSTimeseriesGroupDNSSECParamsQueryTypeCERT DNSTimeseriesGroupDNSSECParamsQueryType = "CERT" DNSTimeseriesGroupDNSSECParamsQueryTypeCNAME DNSTimeseriesGroupDNSSECParamsQueryType = "CNAME" DNSTimeseriesGroupDNSSECParamsQueryTypeCsync DNSTimeseriesGroupDNSSECParamsQueryType = "CSYNC" DNSTimeseriesGroupDNSSECParamsQueryTypeDhcid DNSTimeseriesGroupDNSSECParamsQueryType = "DHCID" DNSTimeseriesGroupDNSSECParamsQueryTypeDlv DNSTimeseriesGroupDNSSECParamsQueryType = "DLV" DNSTimeseriesGroupDNSSECParamsQueryTypeDname DNSTimeseriesGroupDNSSECParamsQueryType = "DNAME" DNSTimeseriesGroupDNSSECParamsQueryTypeDNSKEY DNSTimeseriesGroupDNSSECParamsQueryType = "DNSKEY" DNSTimeseriesGroupDNSSECParamsQueryTypeDoa DNSTimeseriesGroupDNSSECParamsQueryType = "DOA" DNSTimeseriesGroupDNSSECParamsQueryTypeDS DNSTimeseriesGroupDNSSECParamsQueryType = "DS" DNSTimeseriesGroupDNSSECParamsQueryTypeEid DNSTimeseriesGroupDNSSECParamsQueryType = "EID" DNSTimeseriesGroupDNSSECParamsQueryTypeEui48 DNSTimeseriesGroupDNSSECParamsQueryType = "EUI48" DNSTimeseriesGroupDNSSECParamsQueryTypeEui64 DNSTimeseriesGroupDNSSECParamsQueryType = "EUI64" DNSTimeseriesGroupDNSSECParamsQueryTypeGpos DNSTimeseriesGroupDNSSECParamsQueryType = "GPOS" DNSTimeseriesGroupDNSSECParamsQueryTypeGid DNSTimeseriesGroupDNSSECParamsQueryType = "GID" DNSTimeseriesGroupDNSSECParamsQueryTypeHinfo DNSTimeseriesGroupDNSSECParamsQueryType = "HINFO" DNSTimeseriesGroupDNSSECParamsQueryTypeHip DNSTimeseriesGroupDNSSECParamsQueryType = "HIP" DNSTimeseriesGroupDNSSECParamsQueryTypeHTTPS DNSTimeseriesGroupDNSSECParamsQueryType = "HTTPS" DNSTimeseriesGroupDNSSECParamsQueryTypeIpseckey DNSTimeseriesGroupDNSSECParamsQueryType = "IPSECKEY" DNSTimeseriesGroupDNSSECParamsQueryTypeIsdn DNSTimeseriesGroupDNSSECParamsQueryType = "ISDN" DNSTimeseriesGroupDNSSECParamsQueryTypeIxfr DNSTimeseriesGroupDNSSECParamsQueryType = "IXFR" DNSTimeseriesGroupDNSSECParamsQueryTypeKey DNSTimeseriesGroupDNSSECParamsQueryType = "KEY" DNSTimeseriesGroupDNSSECParamsQueryTypeKx DNSTimeseriesGroupDNSSECParamsQueryType = "KX" DNSTimeseriesGroupDNSSECParamsQueryTypeL32 DNSTimeseriesGroupDNSSECParamsQueryType = "L32" DNSTimeseriesGroupDNSSECParamsQueryTypeL64 DNSTimeseriesGroupDNSSECParamsQueryType = "L64" DNSTimeseriesGroupDNSSECParamsQueryTypeLOC DNSTimeseriesGroupDNSSECParamsQueryType = "LOC" DNSTimeseriesGroupDNSSECParamsQueryTypeLp DNSTimeseriesGroupDNSSECParamsQueryType = "LP" DNSTimeseriesGroupDNSSECParamsQueryTypeMaila DNSTimeseriesGroupDNSSECParamsQueryType = "MAILA" DNSTimeseriesGroupDNSSECParamsQueryTypeMailb DNSTimeseriesGroupDNSSECParamsQueryType = "MAILB" DNSTimeseriesGroupDNSSECParamsQueryTypeMB DNSTimeseriesGroupDNSSECParamsQueryType = "MB" DNSTimeseriesGroupDNSSECParamsQueryTypeMd DNSTimeseriesGroupDNSSECParamsQueryType = "MD" DNSTimeseriesGroupDNSSECParamsQueryTypeMf DNSTimeseriesGroupDNSSECParamsQueryType = "MF" DNSTimeseriesGroupDNSSECParamsQueryTypeMg DNSTimeseriesGroupDNSSECParamsQueryType = "MG" DNSTimeseriesGroupDNSSECParamsQueryTypeMinfo DNSTimeseriesGroupDNSSECParamsQueryType = "MINFO" DNSTimeseriesGroupDNSSECParamsQueryTypeMr DNSTimeseriesGroupDNSSECParamsQueryType = "MR" DNSTimeseriesGroupDNSSECParamsQueryTypeMX DNSTimeseriesGroupDNSSECParamsQueryType = "MX" DNSTimeseriesGroupDNSSECParamsQueryTypeNAPTR DNSTimeseriesGroupDNSSECParamsQueryType = "NAPTR" DNSTimeseriesGroupDNSSECParamsQueryTypeNb DNSTimeseriesGroupDNSSECParamsQueryType = "NB" DNSTimeseriesGroupDNSSECParamsQueryTypeNbstat DNSTimeseriesGroupDNSSECParamsQueryType = "NBSTAT" DNSTimeseriesGroupDNSSECParamsQueryTypeNid DNSTimeseriesGroupDNSSECParamsQueryType = "NID" DNSTimeseriesGroupDNSSECParamsQueryTypeNimloc DNSTimeseriesGroupDNSSECParamsQueryType = "NIMLOC" DNSTimeseriesGroupDNSSECParamsQueryTypeNinfo DNSTimeseriesGroupDNSSECParamsQueryType = "NINFO" DNSTimeseriesGroupDNSSECParamsQueryTypeNS DNSTimeseriesGroupDNSSECParamsQueryType = "NS" DNSTimeseriesGroupDNSSECParamsQueryTypeNsap DNSTimeseriesGroupDNSSECParamsQueryType = "NSAP" DNSTimeseriesGroupDNSSECParamsQueryTypeNsec DNSTimeseriesGroupDNSSECParamsQueryType = "NSEC" DNSTimeseriesGroupDNSSECParamsQueryTypeNsec3 DNSTimeseriesGroupDNSSECParamsQueryType = "NSEC3" DNSTimeseriesGroupDNSSECParamsQueryTypeNsec3Param DNSTimeseriesGroupDNSSECParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupDNSSECParamsQueryTypeNull DNSTimeseriesGroupDNSSECParamsQueryType = "NULL" DNSTimeseriesGroupDNSSECParamsQueryTypeNxt DNSTimeseriesGroupDNSSECParamsQueryType = "NXT" DNSTimeseriesGroupDNSSECParamsQueryTypeOpenpgpkey DNSTimeseriesGroupDNSSECParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupDNSSECParamsQueryTypeOpt DNSTimeseriesGroupDNSSECParamsQueryType = "OPT" DNSTimeseriesGroupDNSSECParamsQueryTypePTR DNSTimeseriesGroupDNSSECParamsQueryType = "PTR" DNSTimeseriesGroupDNSSECParamsQueryTypePx DNSTimeseriesGroupDNSSECParamsQueryType = "PX" DNSTimeseriesGroupDNSSECParamsQueryTypeRkey DNSTimeseriesGroupDNSSECParamsQueryType = "RKEY" DNSTimeseriesGroupDNSSECParamsQueryTypeRp DNSTimeseriesGroupDNSSECParamsQueryType = "RP" DNSTimeseriesGroupDNSSECParamsQueryTypeRrsig DNSTimeseriesGroupDNSSECParamsQueryType = "RRSIG" DNSTimeseriesGroupDNSSECParamsQueryTypeRt DNSTimeseriesGroupDNSSECParamsQueryType = "RT" DNSTimeseriesGroupDNSSECParamsQueryTypeSig DNSTimeseriesGroupDNSSECParamsQueryType = "SIG" DNSTimeseriesGroupDNSSECParamsQueryTypeSink DNSTimeseriesGroupDNSSECParamsQueryType = "SINK" DNSTimeseriesGroupDNSSECParamsQueryTypeSMIMEA DNSTimeseriesGroupDNSSECParamsQueryType = "SMIMEA" DNSTimeseriesGroupDNSSECParamsQueryTypeSOA DNSTimeseriesGroupDNSSECParamsQueryType = "SOA" DNSTimeseriesGroupDNSSECParamsQueryTypeSPF DNSTimeseriesGroupDNSSECParamsQueryType = "SPF" DNSTimeseriesGroupDNSSECParamsQueryTypeSRV DNSTimeseriesGroupDNSSECParamsQueryType = "SRV" DNSTimeseriesGroupDNSSECParamsQueryTypeSSHFP DNSTimeseriesGroupDNSSECParamsQueryType = "SSHFP" DNSTimeseriesGroupDNSSECParamsQueryTypeSVCB DNSTimeseriesGroupDNSSECParamsQueryType = "SVCB" DNSTimeseriesGroupDNSSECParamsQueryTypeTa DNSTimeseriesGroupDNSSECParamsQueryType = "TA" DNSTimeseriesGroupDNSSECParamsQueryTypeTalink DNSTimeseriesGroupDNSSECParamsQueryType = "TALINK" DNSTimeseriesGroupDNSSECParamsQueryTypeTkey DNSTimeseriesGroupDNSSECParamsQueryType = "TKEY" DNSTimeseriesGroupDNSSECParamsQueryTypeTLSA DNSTimeseriesGroupDNSSECParamsQueryType = "TLSA" DNSTimeseriesGroupDNSSECParamsQueryTypeTSIG DNSTimeseriesGroupDNSSECParamsQueryType = "TSIG" DNSTimeseriesGroupDNSSECParamsQueryTypeTXT DNSTimeseriesGroupDNSSECParamsQueryType = "TXT" DNSTimeseriesGroupDNSSECParamsQueryTypeUinfo DNSTimeseriesGroupDNSSECParamsQueryType = "UINFO" DNSTimeseriesGroupDNSSECParamsQueryTypeUID DNSTimeseriesGroupDNSSECParamsQueryType = "UID" DNSTimeseriesGroupDNSSECParamsQueryTypeUnspec DNSTimeseriesGroupDNSSECParamsQueryType = "UNSPEC" DNSTimeseriesGroupDNSSECParamsQueryTypeURI DNSTimeseriesGroupDNSSECParamsQueryType = "URI" DNSTimeseriesGroupDNSSECParamsQueryTypeWks DNSTimeseriesGroupDNSSECParamsQueryType = "WKS" DNSTimeseriesGroupDNSSECParamsQueryTypeX25 DNSTimeseriesGroupDNSSECParamsQueryType = "X25" DNSTimeseriesGroupDNSSECParamsQueryTypeZonemd DNSTimeseriesGroupDNSSECParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupDNSSECParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupDNSSECParamsResponseCode ¶
type DNSTimeseriesGroupDNSSECParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupDNSSECParamsResponseCodeNoerror DNSTimeseriesGroupDNSSECParamsResponseCode = "NOERROR" DNSTimeseriesGroupDNSSECParamsResponseCodeFormerr DNSTimeseriesGroupDNSSECParamsResponseCode = "FORMERR" DNSTimeseriesGroupDNSSECParamsResponseCodeServfail DNSTimeseriesGroupDNSSECParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupDNSSECParamsResponseCodeNxdomain DNSTimeseriesGroupDNSSECParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupDNSSECParamsResponseCodeNotimp DNSTimeseriesGroupDNSSECParamsResponseCode = "NOTIMP" DNSTimeseriesGroupDNSSECParamsResponseCodeRefused DNSTimeseriesGroupDNSSECParamsResponseCode = "REFUSED" DNSTimeseriesGroupDNSSECParamsResponseCodeYxdomain DNSTimeseriesGroupDNSSECParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupDNSSECParamsResponseCodeYxrrset DNSTimeseriesGroupDNSSECParamsResponseCode = "YXRRSET" DNSTimeseriesGroupDNSSECParamsResponseCodeNxrrset DNSTimeseriesGroupDNSSECParamsResponseCode = "NXRRSET" DNSTimeseriesGroupDNSSECParamsResponseCodeNotauth DNSTimeseriesGroupDNSSECParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupDNSSECParamsResponseCodeNotzone DNSTimeseriesGroupDNSSECParamsResponseCode = "NOTZONE" DNSTimeseriesGroupDNSSECParamsResponseCodeBadsig DNSTimeseriesGroupDNSSECParamsResponseCode = "BADSIG" DNSTimeseriesGroupDNSSECParamsResponseCodeBadkey DNSTimeseriesGroupDNSSECParamsResponseCode = "BADKEY" DNSTimeseriesGroupDNSSECParamsResponseCodeBadtime DNSTimeseriesGroupDNSSECParamsResponseCode = "BADTIME" DNSTimeseriesGroupDNSSECParamsResponseCodeBadmode DNSTimeseriesGroupDNSSECParamsResponseCode = "BADMODE" DNSTimeseriesGroupDNSSECParamsResponseCodeBadname DNSTimeseriesGroupDNSSECParamsResponseCode = "BADNAME" DNSTimeseriesGroupDNSSECParamsResponseCodeBadalg DNSTimeseriesGroupDNSSECParamsResponseCode = "BADALG" DNSTimeseriesGroupDNSSECParamsResponseCodeBadtrunc DNSTimeseriesGroupDNSSECParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupDNSSECParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupDNSSECResponse ¶
type DNSTimeseriesGroupDNSSECResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupDNSSECResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupDNSSECResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupDNSSECResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECResponseEnvelope ¶
type DNSTimeseriesGroupDNSSECResponseEnvelope struct {
Result DNSTimeseriesGroupDNSSECResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupDNSSECResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECResponseMeta ¶
type DNSTimeseriesGroupDNSSECResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupDNSSECResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupDNSSECResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupDNSSECResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupDNSSECResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupDNSSECResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupDNSSECResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECResponseMetaAggInterval ¶
type DNSTimeseriesGroupDNSSECResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupDNSSECResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupDNSSECResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupDNSSECResponseMetaAggIntervalOneHour DNSTimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupDNSSECResponseMetaAggIntervalOneDay DNSTimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupDNSSECResponseMetaAggIntervalOneWeek DNSTimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupDNSSECResponseMetaAggIntervalOneMonth DNSTimeseriesGroupDNSSECResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupDNSSECResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupDNSSECResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECResponseMetaDateRange ¶
type DNSTimeseriesGroupDNSSECResponseMetaDateRange 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 dnsTimeseriesGroupDNSSECResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECResponseMetaNormalization ¶
type DNSTimeseriesGroupDNSSECResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupDNSSECResponseMetaNormalizationPercentage DNSTimeseriesGroupDNSSECResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupDNSSECResponseMetaNormalizationMin0Max DNSTimeseriesGroupDNSSECResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupDNSSECResponseMetaNormalizationMinMax DNSTimeseriesGroupDNSSECResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupDNSSECResponseMetaNormalizationRawValues DNSTimeseriesGroupDNSSECResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupDNSSECResponseMetaNormalizationPercentageChange DNSTimeseriesGroupDNSSECResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupDNSSECResponseMetaNormalizationRollingAverage DNSTimeseriesGroupDNSSECResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupDNSSECResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupDNSSECResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupDNSSECResponseMetaNormalizationRatio DNSTimeseriesGroupDNSSECResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupDNSSECResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupDNSSECResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupDNSSECResponseMetaUnit ¶
type DNSTimeseriesGroupDNSSECResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupDNSSECResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDNSSECResponseSerie0 ¶
type DNSTimeseriesGroupDNSSECResponseSerie0 struct {
Insecure []string `json:"INSECURE,required"`
Invalid []string `json:"INVALID,required"`
Other []string `json:"OTHER,required"`
Secure []string `json:"SECURE,required"`
JSON dnsTimeseriesGroupDNSSECResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupDNSSECResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDNSSECResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EParamsAggInterval ¶
type DNSTimeseriesGroupDnssece2EParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupDnssece2EParamsAggInterval15m DNSTimeseriesGroupDnssece2EParamsAggInterval = "15m" DNSTimeseriesGroupDnssece2EParamsAggInterval1h DNSTimeseriesGroupDnssece2EParamsAggInterval = "1h" DNSTimeseriesGroupDnssece2EParamsAggInterval1d DNSTimeseriesGroupDnssece2EParamsAggInterval = "1d" DNSTimeseriesGroupDnssece2EParamsAggInterval1w DNSTimeseriesGroupDnssece2EParamsAggInterval = "1w" )
func (DNSTimeseriesGroupDnssece2EParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupDnssece2EParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupDnssece2EParamsFormat ¶
type DNSTimeseriesGroupDnssece2EParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupDnssece2EParamsFormatJson DNSTimeseriesGroupDnssece2EParamsFormat = "JSON" DNSTimeseriesGroupDnssece2EParamsFormatCsv DNSTimeseriesGroupDnssece2EParamsFormat = "CSV" )
func (DNSTimeseriesGroupDnssece2EParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupDnssece2EParamsFormat) IsKnown() bool
type DNSTimeseriesGroupDnssece2EParamsProtocol ¶
type DNSTimeseriesGroupDnssece2EParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupDnssece2EParamsProtocolUdp DNSTimeseriesGroupDnssece2EParamsProtocol = "UDP" DNSTimeseriesGroupDnssece2EParamsProtocolTCP DNSTimeseriesGroupDnssece2EParamsProtocol = "TCP" DNSTimeseriesGroupDnssece2EParamsProtocolHTTPS DNSTimeseriesGroupDnssece2EParamsProtocol = "HTTPS" DNSTimeseriesGroupDnssece2EParamsProtocolTLS DNSTimeseriesGroupDnssece2EParamsProtocol = "TLS" )
func (DNSTimeseriesGroupDnssece2EParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupDnssece2EParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupDnssece2EParamsQueryType ¶
type DNSTimeseriesGroupDnssece2EParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupDnssece2EParamsQueryTypeA DNSTimeseriesGroupDnssece2EParamsQueryType = "A" DNSTimeseriesGroupDnssece2EParamsQueryTypeAAAA DNSTimeseriesGroupDnssece2EParamsQueryType = "AAAA" DNSTimeseriesGroupDnssece2EParamsQueryTypeA6 DNSTimeseriesGroupDnssece2EParamsQueryType = "A6" DNSTimeseriesGroupDnssece2EParamsQueryTypeAfsdb DNSTimeseriesGroupDnssece2EParamsQueryType = "AFSDB" DNSTimeseriesGroupDnssece2EParamsQueryTypeAny DNSTimeseriesGroupDnssece2EParamsQueryType = "ANY" DNSTimeseriesGroupDnssece2EParamsQueryTypeApl DNSTimeseriesGroupDnssece2EParamsQueryType = "APL" DNSTimeseriesGroupDnssece2EParamsQueryTypeAtma DNSTimeseriesGroupDnssece2EParamsQueryType = "ATMA" DNSTimeseriesGroupDnssece2EParamsQueryTypeAXFR DNSTimeseriesGroupDnssece2EParamsQueryType = "AXFR" DNSTimeseriesGroupDnssece2EParamsQueryTypeCAA DNSTimeseriesGroupDnssece2EParamsQueryType = "CAA" DNSTimeseriesGroupDnssece2EParamsQueryTypeCdnskey DNSTimeseriesGroupDnssece2EParamsQueryType = "CDNSKEY" DNSTimeseriesGroupDnssece2EParamsQueryTypeCds DNSTimeseriesGroupDnssece2EParamsQueryType = "CDS" DNSTimeseriesGroupDnssece2EParamsQueryTypeCERT DNSTimeseriesGroupDnssece2EParamsQueryType = "CERT" DNSTimeseriesGroupDnssece2EParamsQueryTypeCNAME DNSTimeseriesGroupDnssece2EParamsQueryType = "CNAME" DNSTimeseriesGroupDnssece2EParamsQueryTypeCsync DNSTimeseriesGroupDnssece2EParamsQueryType = "CSYNC" DNSTimeseriesGroupDnssece2EParamsQueryTypeDhcid DNSTimeseriesGroupDnssece2EParamsQueryType = "DHCID" DNSTimeseriesGroupDnssece2EParamsQueryTypeDlv DNSTimeseriesGroupDnssece2EParamsQueryType = "DLV" DNSTimeseriesGroupDnssece2EParamsQueryTypeDname DNSTimeseriesGroupDnssece2EParamsQueryType = "DNAME" DNSTimeseriesGroupDnssece2EParamsQueryTypeDNSKEY DNSTimeseriesGroupDnssece2EParamsQueryType = "DNSKEY" DNSTimeseriesGroupDnssece2EParamsQueryTypeDoa DNSTimeseriesGroupDnssece2EParamsQueryType = "DOA" DNSTimeseriesGroupDnssece2EParamsQueryTypeDS DNSTimeseriesGroupDnssece2EParamsQueryType = "DS" DNSTimeseriesGroupDnssece2EParamsQueryTypeEid DNSTimeseriesGroupDnssece2EParamsQueryType = "EID" DNSTimeseriesGroupDnssece2EParamsQueryTypeEui48 DNSTimeseriesGroupDnssece2EParamsQueryType = "EUI48" DNSTimeseriesGroupDnssece2EParamsQueryTypeEui64 DNSTimeseriesGroupDnssece2EParamsQueryType = "EUI64" DNSTimeseriesGroupDnssece2EParamsQueryTypeGpos DNSTimeseriesGroupDnssece2EParamsQueryType = "GPOS" DNSTimeseriesGroupDnssece2EParamsQueryTypeGid DNSTimeseriesGroupDnssece2EParamsQueryType = "GID" DNSTimeseriesGroupDnssece2EParamsQueryTypeHinfo DNSTimeseriesGroupDnssece2EParamsQueryType = "HINFO" DNSTimeseriesGroupDnssece2EParamsQueryTypeHip DNSTimeseriesGroupDnssece2EParamsQueryType = "HIP" DNSTimeseriesGroupDnssece2EParamsQueryTypeHTTPS DNSTimeseriesGroupDnssece2EParamsQueryType = "HTTPS" DNSTimeseriesGroupDnssece2EParamsQueryTypeIpseckey DNSTimeseriesGroupDnssece2EParamsQueryType = "IPSECKEY" DNSTimeseriesGroupDnssece2EParamsQueryTypeIsdn DNSTimeseriesGroupDnssece2EParamsQueryType = "ISDN" DNSTimeseriesGroupDnssece2EParamsQueryTypeIxfr DNSTimeseriesGroupDnssece2EParamsQueryType = "IXFR" DNSTimeseriesGroupDnssece2EParamsQueryTypeKey DNSTimeseriesGroupDnssece2EParamsQueryType = "KEY" DNSTimeseriesGroupDnssece2EParamsQueryTypeKx DNSTimeseriesGroupDnssece2EParamsQueryType = "KX" DNSTimeseriesGroupDnssece2EParamsQueryTypeL32 DNSTimeseriesGroupDnssece2EParamsQueryType = "L32" DNSTimeseriesGroupDnssece2EParamsQueryTypeL64 DNSTimeseriesGroupDnssece2EParamsQueryType = "L64" DNSTimeseriesGroupDnssece2EParamsQueryTypeLOC DNSTimeseriesGroupDnssece2EParamsQueryType = "LOC" DNSTimeseriesGroupDnssece2EParamsQueryTypeLp DNSTimeseriesGroupDnssece2EParamsQueryType = "LP" DNSTimeseriesGroupDnssece2EParamsQueryTypeMaila DNSTimeseriesGroupDnssece2EParamsQueryType = "MAILA" DNSTimeseriesGroupDnssece2EParamsQueryTypeMailb DNSTimeseriesGroupDnssece2EParamsQueryType = "MAILB" DNSTimeseriesGroupDnssece2EParamsQueryTypeMB DNSTimeseriesGroupDnssece2EParamsQueryType = "MB" DNSTimeseriesGroupDnssece2EParamsQueryTypeMd DNSTimeseriesGroupDnssece2EParamsQueryType = "MD" DNSTimeseriesGroupDnssece2EParamsQueryTypeMf DNSTimeseriesGroupDnssece2EParamsQueryType = "MF" DNSTimeseriesGroupDnssece2EParamsQueryTypeMg DNSTimeseriesGroupDnssece2EParamsQueryType = "MG" DNSTimeseriesGroupDnssece2EParamsQueryTypeMinfo DNSTimeseriesGroupDnssece2EParamsQueryType = "MINFO" DNSTimeseriesGroupDnssece2EParamsQueryTypeMr DNSTimeseriesGroupDnssece2EParamsQueryType = "MR" DNSTimeseriesGroupDnssece2EParamsQueryTypeMX DNSTimeseriesGroupDnssece2EParamsQueryType = "MX" DNSTimeseriesGroupDnssece2EParamsQueryTypeNAPTR DNSTimeseriesGroupDnssece2EParamsQueryType = "NAPTR" DNSTimeseriesGroupDnssece2EParamsQueryTypeNb DNSTimeseriesGroupDnssece2EParamsQueryType = "NB" DNSTimeseriesGroupDnssece2EParamsQueryTypeNbstat DNSTimeseriesGroupDnssece2EParamsQueryType = "NBSTAT" DNSTimeseriesGroupDnssece2EParamsQueryTypeNid DNSTimeseriesGroupDnssece2EParamsQueryType = "NID" DNSTimeseriesGroupDnssece2EParamsQueryTypeNimloc DNSTimeseriesGroupDnssece2EParamsQueryType = "NIMLOC" DNSTimeseriesGroupDnssece2EParamsQueryTypeNinfo DNSTimeseriesGroupDnssece2EParamsQueryType = "NINFO" DNSTimeseriesGroupDnssece2EParamsQueryTypeNS DNSTimeseriesGroupDnssece2EParamsQueryType = "NS" DNSTimeseriesGroupDnssece2EParamsQueryTypeNsap DNSTimeseriesGroupDnssece2EParamsQueryType = "NSAP" DNSTimeseriesGroupDnssece2EParamsQueryTypeNsec DNSTimeseriesGroupDnssece2EParamsQueryType = "NSEC" DNSTimeseriesGroupDnssece2EParamsQueryTypeNsec3 DNSTimeseriesGroupDnssece2EParamsQueryType = "NSEC3" DNSTimeseriesGroupDnssece2EParamsQueryTypeNsec3Param DNSTimeseriesGroupDnssece2EParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupDnssece2EParamsQueryTypeNull DNSTimeseriesGroupDnssece2EParamsQueryType = "NULL" DNSTimeseriesGroupDnssece2EParamsQueryTypeNxt DNSTimeseriesGroupDnssece2EParamsQueryType = "NXT" DNSTimeseriesGroupDnssece2EParamsQueryTypeOpenpgpkey DNSTimeseriesGroupDnssece2EParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupDnssece2EParamsQueryTypeOpt DNSTimeseriesGroupDnssece2EParamsQueryType = "OPT" DNSTimeseriesGroupDnssece2EParamsQueryTypePTR DNSTimeseriesGroupDnssece2EParamsQueryType = "PTR" DNSTimeseriesGroupDnssece2EParamsQueryTypePx DNSTimeseriesGroupDnssece2EParamsQueryType = "PX" DNSTimeseriesGroupDnssece2EParamsQueryTypeRkey DNSTimeseriesGroupDnssece2EParamsQueryType = "RKEY" DNSTimeseriesGroupDnssece2EParamsQueryTypeRp DNSTimeseriesGroupDnssece2EParamsQueryType = "RP" DNSTimeseriesGroupDnssece2EParamsQueryTypeRrsig DNSTimeseriesGroupDnssece2EParamsQueryType = "RRSIG" DNSTimeseriesGroupDnssece2EParamsQueryTypeRt DNSTimeseriesGroupDnssece2EParamsQueryType = "RT" DNSTimeseriesGroupDnssece2EParamsQueryTypeSig DNSTimeseriesGroupDnssece2EParamsQueryType = "SIG" DNSTimeseriesGroupDnssece2EParamsQueryTypeSink DNSTimeseriesGroupDnssece2EParamsQueryType = "SINK" DNSTimeseriesGroupDnssece2EParamsQueryTypeSMIMEA DNSTimeseriesGroupDnssece2EParamsQueryType = "SMIMEA" DNSTimeseriesGroupDnssece2EParamsQueryTypeSOA DNSTimeseriesGroupDnssece2EParamsQueryType = "SOA" DNSTimeseriesGroupDnssece2EParamsQueryTypeSPF DNSTimeseriesGroupDnssece2EParamsQueryType = "SPF" DNSTimeseriesGroupDnssece2EParamsQueryTypeSRV DNSTimeseriesGroupDnssece2EParamsQueryType = "SRV" DNSTimeseriesGroupDnssece2EParamsQueryTypeSSHFP DNSTimeseriesGroupDnssece2EParamsQueryType = "SSHFP" DNSTimeseriesGroupDnssece2EParamsQueryTypeSVCB DNSTimeseriesGroupDnssece2EParamsQueryType = "SVCB" DNSTimeseriesGroupDnssece2EParamsQueryTypeTa DNSTimeseriesGroupDnssece2EParamsQueryType = "TA" DNSTimeseriesGroupDnssece2EParamsQueryTypeTalink DNSTimeseriesGroupDnssece2EParamsQueryType = "TALINK" DNSTimeseriesGroupDnssece2EParamsQueryTypeTkey DNSTimeseriesGroupDnssece2EParamsQueryType = "TKEY" DNSTimeseriesGroupDnssece2EParamsQueryTypeTLSA DNSTimeseriesGroupDnssece2EParamsQueryType = "TLSA" DNSTimeseriesGroupDnssece2EParamsQueryTypeTSIG DNSTimeseriesGroupDnssece2EParamsQueryType = "TSIG" DNSTimeseriesGroupDnssece2EParamsQueryTypeTXT DNSTimeseriesGroupDnssece2EParamsQueryType = "TXT" DNSTimeseriesGroupDnssece2EParamsQueryTypeUinfo DNSTimeseriesGroupDnssece2EParamsQueryType = "UINFO" DNSTimeseriesGroupDnssece2EParamsQueryTypeUID DNSTimeseriesGroupDnssece2EParamsQueryType = "UID" DNSTimeseriesGroupDnssece2EParamsQueryTypeUnspec DNSTimeseriesGroupDnssece2EParamsQueryType = "UNSPEC" DNSTimeseriesGroupDnssece2EParamsQueryTypeURI DNSTimeseriesGroupDnssece2EParamsQueryType = "URI" DNSTimeseriesGroupDnssece2EParamsQueryTypeWks DNSTimeseriesGroupDnssece2EParamsQueryType = "WKS" DNSTimeseriesGroupDnssece2EParamsQueryTypeX25 DNSTimeseriesGroupDnssece2EParamsQueryType = "X25" DNSTimeseriesGroupDnssece2EParamsQueryTypeZonemd DNSTimeseriesGroupDnssece2EParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupDnssece2EParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupDnssece2EParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupDnssece2EParamsResponseCode ¶
type DNSTimeseriesGroupDnssece2EParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupDnssece2EParamsResponseCodeNoerror DNSTimeseriesGroupDnssece2EParamsResponseCode = "NOERROR" DNSTimeseriesGroupDnssece2EParamsResponseCodeFormerr DNSTimeseriesGroupDnssece2EParamsResponseCode = "FORMERR" DNSTimeseriesGroupDnssece2EParamsResponseCodeServfail DNSTimeseriesGroupDnssece2EParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupDnssece2EParamsResponseCodeNxdomain DNSTimeseriesGroupDnssece2EParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupDnssece2EParamsResponseCodeNotimp DNSTimeseriesGroupDnssece2EParamsResponseCode = "NOTIMP" DNSTimeseriesGroupDnssece2EParamsResponseCodeRefused DNSTimeseriesGroupDnssece2EParamsResponseCode = "REFUSED" DNSTimeseriesGroupDnssece2EParamsResponseCodeYxdomain DNSTimeseriesGroupDnssece2EParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupDnssece2EParamsResponseCodeYxrrset DNSTimeseriesGroupDnssece2EParamsResponseCode = "YXRRSET" DNSTimeseriesGroupDnssece2EParamsResponseCodeNxrrset DNSTimeseriesGroupDnssece2EParamsResponseCode = "NXRRSET" DNSTimeseriesGroupDnssece2EParamsResponseCodeNotauth DNSTimeseriesGroupDnssece2EParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupDnssece2EParamsResponseCodeNotzone DNSTimeseriesGroupDnssece2EParamsResponseCode = "NOTZONE" DNSTimeseriesGroupDnssece2EParamsResponseCodeBadsig DNSTimeseriesGroupDnssece2EParamsResponseCode = "BADSIG" DNSTimeseriesGroupDnssece2EParamsResponseCodeBadkey DNSTimeseriesGroupDnssece2EParamsResponseCode = "BADKEY" DNSTimeseriesGroupDnssece2EParamsResponseCodeBadtime DNSTimeseriesGroupDnssece2EParamsResponseCode = "BADTIME" DNSTimeseriesGroupDnssece2EParamsResponseCodeBadmode DNSTimeseriesGroupDnssece2EParamsResponseCode = "BADMODE" DNSTimeseriesGroupDnssece2EParamsResponseCodeBadname DNSTimeseriesGroupDnssece2EParamsResponseCode = "BADNAME" DNSTimeseriesGroupDnssece2EParamsResponseCodeBadalg DNSTimeseriesGroupDnssece2EParamsResponseCode = "BADALG" DNSTimeseriesGroupDnssece2EParamsResponseCodeBadtrunc DNSTimeseriesGroupDnssece2EParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupDnssece2EParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupDnssece2EParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupDnssece2EResponse ¶
type DNSTimeseriesGroupDnssece2EResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupDnssece2EResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupDnssece2EResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupDnssece2EResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupDnssece2EResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EResponseEnvelope ¶
type DNSTimeseriesGroupDnssece2EResponseEnvelope struct {
Result DNSTimeseriesGroupDnssece2EResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupDnssece2EResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupDnssece2EResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EResponseMeta ¶
type DNSTimeseriesGroupDnssece2EResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupDnssece2EResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupDnssece2EResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupDnssece2EResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupDnssece2EResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupDnssece2EResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupDnssece2EResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EResponseMetaAggInterval ¶
type DNSTimeseriesGroupDnssece2EResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupDnssece2EResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupDnssece2EResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupDnssece2EResponseMetaAggIntervalOneHour DNSTimeseriesGroupDnssece2EResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupDnssece2EResponseMetaAggIntervalOneDay DNSTimeseriesGroupDnssece2EResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupDnssece2EResponseMetaAggIntervalOneWeek DNSTimeseriesGroupDnssece2EResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupDnssece2EResponseMetaAggIntervalOneMonth DNSTimeseriesGroupDnssece2EResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupDnssece2EResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupDnssece2EResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupDnssece2EResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupDnssece2EResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EResponseMetaDateRange ¶
type DNSTimeseriesGroupDnssece2EResponseMetaDateRange 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 dnsTimeseriesGroupDnssece2EResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupDnssece2EResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EResponseMetaNormalization ¶
type DNSTimeseriesGroupDnssece2EResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupDnssece2EResponseMetaNormalizationPercentage DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupDnssece2EResponseMetaNormalizationMin0Max DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupDnssece2EResponseMetaNormalizationMinMax DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupDnssece2EResponseMetaNormalizationRawValues DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupDnssece2EResponseMetaNormalizationPercentageChange DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupDnssece2EResponseMetaNormalizationRollingAverage DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupDnssece2EResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupDnssece2EResponseMetaNormalizationRatio DNSTimeseriesGroupDnssece2EResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupDnssece2EResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupDnssece2EResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupDnssece2EResponseMetaUnit ¶
type DNSTimeseriesGroupDnssece2EResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupDnssece2EResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupDnssece2EResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupDnssece2EResponseSerie0 ¶
type DNSTimeseriesGroupDnssece2EResponseSerie0 struct {
Negative []string `json:"NEGATIVE,required"`
Positive []string `json:"POSITIVE,required"`
JSON dnsTimeseriesGroupDnssece2EResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupDnssece2EResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupDnssece2EResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionParams ¶
type DNSTimeseriesGroupIPVersionParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupIPVersionParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupIPVersionParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupIPVersionParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupIPVersionParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupIPVersionParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupIPVersionParams) URLQuery ¶
func (r DNSTimeseriesGroupIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupIPVersionParams's query parameters as `url.Values`.
type DNSTimeseriesGroupIPVersionParamsAggInterval ¶
type DNSTimeseriesGroupIPVersionParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupIPVersionParamsAggInterval15m DNSTimeseriesGroupIPVersionParamsAggInterval = "15m" DNSTimeseriesGroupIPVersionParamsAggInterval1h DNSTimeseriesGroupIPVersionParamsAggInterval = "1h" DNSTimeseriesGroupIPVersionParamsAggInterval1d DNSTimeseriesGroupIPVersionParamsAggInterval = "1d" DNSTimeseriesGroupIPVersionParamsAggInterval1w DNSTimeseriesGroupIPVersionParamsAggInterval = "1w" )
func (DNSTimeseriesGroupIPVersionParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupIPVersionParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupIPVersionParamsFormat ¶
type DNSTimeseriesGroupIPVersionParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupIPVersionParamsFormatJson DNSTimeseriesGroupIPVersionParamsFormat = "JSON" DNSTimeseriesGroupIPVersionParamsFormatCsv DNSTimeseriesGroupIPVersionParamsFormat = "CSV" )
func (DNSTimeseriesGroupIPVersionParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupIPVersionParamsFormat) IsKnown() bool
type DNSTimeseriesGroupIPVersionParamsProtocol ¶
type DNSTimeseriesGroupIPVersionParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupIPVersionParamsProtocolUdp DNSTimeseriesGroupIPVersionParamsProtocol = "UDP" DNSTimeseriesGroupIPVersionParamsProtocolTCP DNSTimeseriesGroupIPVersionParamsProtocol = "TCP" DNSTimeseriesGroupIPVersionParamsProtocolHTTPS DNSTimeseriesGroupIPVersionParamsProtocol = "HTTPS" DNSTimeseriesGroupIPVersionParamsProtocolTLS DNSTimeseriesGroupIPVersionParamsProtocol = "TLS" )
func (DNSTimeseriesGroupIPVersionParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupIPVersionParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupIPVersionParamsQueryType ¶
type DNSTimeseriesGroupIPVersionParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupIPVersionParamsQueryTypeA DNSTimeseriesGroupIPVersionParamsQueryType = "A" DNSTimeseriesGroupIPVersionParamsQueryTypeAAAA DNSTimeseriesGroupIPVersionParamsQueryType = "AAAA" DNSTimeseriesGroupIPVersionParamsQueryTypeA6 DNSTimeseriesGroupIPVersionParamsQueryType = "A6" DNSTimeseriesGroupIPVersionParamsQueryTypeAfsdb DNSTimeseriesGroupIPVersionParamsQueryType = "AFSDB" DNSTimeseriesGroupIPVersionParamsQueryTypeAny DNSTimeseriesGroupIPVersionParamsQueryType = "ANY" DNSTimeseriesGroupIPVersionParamsQueryTypeApl DNSTimeseriesGroupIPVersionParamsQueryType = "APL" DNSTimeseriesGroupIPVersionParamsQueryTypeAtma DNSTimeseriesGroupIPVersionParamsQueryType = "ATMA" DNSTimeseriesGroupIPVersionParamsQueryTypeAXFR DNSTimeseriesGroupIPVersionParamsQueryType = "AXFR" DNSTimeseriesGroupIPVersionParamsQueryTypeCAA DNSTimeseriesGroupIPVersionParamsQueryType = "CAA" DNSTimeseriesGroupIPVersionParamsQueryTypeCdnskey DNSTimeseriesGroupIPVersionParamsQueryType = "CDNSKEY" DNSTimeseriesGroupIPVersionParamsQueryTypeCds DNSTimeseriesGroupIPVersionParamsQueryType = "CDS" DNSTimeseriesGroupIPVersionParamsQueryTypeCERT DNSTimeseriesGroupIPVersionParamsQueryType = "CERT" DNSTimeseriesGroupIPVersionParamsQueryTypeCNAME DNSTimeseriesGroupIPVersionParamsQueryType = "CNAME" DNSTimeseriesGroupIPVersionParamsQueryTypeCsync DNSTimeseriesGroupIPVersionParamsQueryType = "CSYNC" DNSTimeseriesGroupIPVersionParamsQueryTypeDhcid DNSTimeseriesGroupIPVersionParamsQueryType = "DHCID" DNSTimeseriesGroupIPVersionParamsQueryTypeDlv DNSTimeseriesGroupIPVersionParamsQueryType = "DLV" DNSTimeseriesGroupIPVersionParamsQueryTypeDname DNSTimeseriesGroupIPVersionParamsQueryType = "DNAME" DNSTimeseriesGroupIPVersionParamsQueryTypeDNSKEY DNSTimeseriesGroupIPVersionParamsQueryType = "DNSKEY" DNSTimeseriesGroupIPVersionParamsQueryTypeDoa DNSTimeseriesGroupIPVersionParamsQueryType = "DOA" DNSTimeseriesGroupIPVersionParamsQueryTypeDS DNSTimeseriesGroupIPVersionParamsQueryType = "DS" DNSTimeseriesGroupIPVersionParamsQueryTypeEid DNSTimeseriesGroupIPVersionParamsQueryType = "EID" DNSTimeseriesGroupIPVersionParamsQueryTypeEui48 DNSTimeseriesGroupIPVersionParamsQueryType = "EUI48" DNSTimeseriesGroupIPVersionParamsQueryTypeEui64 DNSTimeseriesGroupIPVersionParamsQueryType = "EUI64" DNSTimeseriesGroupIPVersionParamsQueryTypeGpos DNSTimeseriesGroupIPVersionParamsQueryType = "GPOS" DNSTimeseriesGroupIPVersionParamsQueryTypeGid DNSTimeseriesGroupIPVersionParamsQueryType = "GID" DNSTimeseriesGroupIPVersionParamsQueryTypeHinfo DNSTimeseriesGroupIPVersionParamsQueryType = "HINFO" DNSTimeseriesGroupIPVersionParamsQueryTypeHip DNSTimeseriesGroupIPVersionParamsQueryType = "HIP" DNSTimeseriesGroupIPVersionParamsQueryTypeHTTPS DNSTimeseriesGroupIPVersionParamsQueryType = "HTTPS" DNSTimeseriesGroupIPVersionParamsQueryTypeIpseckey DNSTimeseriesGroupIPVersionParamsQueryType = "IPSECKEY" DNSTimeseriesGroupIPVersionParamsQueryTypeIsdn DNSTimeseriesGroupIPVersionParamsQueryType = "ISDN" DNSTimeseriesGroupIPVersionParamsQueryTypeIxfr DNSTimeseriesGroupIPVersionParamsQueryType = "IXFR" DNSTimeseriesGroupIPVersionParamsQueryTypeKey DNSTimeseriesGroupIPVersionParamsQueryType = "KEY" DNSTimeseriesGroupIPVersionParamsQueryTypeKx DNSTimeseriesGroupIPVersionParamsQueryType = "KX" DNSTimeseriesGroupIPVersionParamsQueryTypeL32 DNSTimeseriesGroupIPVersionParamsQueryType = "L32" DNSTimeseriesGroupIPVersionParamsQueryTypeL64 DNSTimeseriesGroupIPVersionParamsQueryType = "L64" DNSTimeseriesGroupIPVersionParamsQueryTypeLOC DNSTimeseriesGroupIPVersionParamsQueryType = "LOC" DNSTimeseriesGroupIPVersionParamsQueryTypeLp DNSTimeseriesGroupIPVersionParamsQueryType = "LP" DNSTimeseriesGroupIPVersionParamsQueryTypeMaila DNSTimeseriesGroupIPVersionParamsQueryType = "MAILA" DNSTimeseriesGroupIPVersionParamsQueryTypeMailb DNSTimeseriesGroupIPVersionParamsQueryType = "MAILB" DNSTimeseriesGroupIPVersionParamsQueryTypeMB DNSTimeseriesGroupIPVersionParamsQueryType = "MB" DNSTimeseriesGroupIPVersionParamsQueryTypeMd DNSTimeseriesGroupIPVersionParamsQueryType = "MD" DNSTimeseriesGroupIPVersionParamsQueryTypeMf DNSTimeseriesGroupIPVersionParamsQueryType = "MF" DNSTimeseriesGroupIPVersionParamsQueryTypeMg DNSTimeseriesGroupIPVersionParamsQueryType = "MG" DNSTimeseriesGroupIPVersionParamsQueryTypeMinfo DNSTimeseriesGroupIPVersionParamsQueryType = "MINFO" DNSTimeseriesGroupIPVersionParamsQueryTypeMr DNSTimeseriesGroupIPVersionParamsQueryType = "MR" DNSTimeseriesGroupIPVersionParamsQueryTypeMX DNSTimeseriesGroupIPVersionParamsQueryType = "MX" DNSTimeseriesGroupIPVersionParamsQueryTypeNAPTR DNSTimeseriesGroupIPVersionParamsQueryType = "NAPTR" DNSTimeseriesGroupIPVersionParamsQueryTypeNb DNSTimeseriesGroupIPVersionParamsQueryType = "NB" DNSTimeseriesGroupIPVersionParamsQueryTypeNbstat DNSTimeseriesGroupIPVersionParamsQueryType = "NBSTAT" DNSTimeseriesGroupIPVersionParamsQueryTypeNid DNSTimeseriesGroupIPVersionParamsQueryType = "NID" DNSTimeseriesGroupIPVersionParamsQueryTypeNimloc DNSTimeseriesGroupIPVersionParamsQueryType = "NIMLOC" DNSTimeseriesGroupIPVersionParamsQueryTypeNinfo DNSTimeseriesGroupIPVersionParamsQueryType = "NINFO" DNSTimeseriesGroupIPVersionParamsQueryTypeNS DNSTimeseriesGroupIPVersionParamsQueryType = "NS" DNSTimeseriesGroupIPVersionParamsQueryTypeNsap DNSTimeseriesGroupIPVersionParamsQueryType = "NSAP" DNSTimeseriesGroupIPVersionParamsQueryTypeNsec DNSTimeseriesGroupIPVersionParamsQueryType = "NSEC" DNSTimeseriesGroupIPVersionParamsQueryTypeNsec3 DNSTimeseriesGroupIPVersionParamsQueryType = "NSEC3" DNSTimeseriesGroupIPVersionParamsQueryTypeNsec3Param DNSTimeseriesGroupIPVersionParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupIPVersionParamsQueryTypeNull DNSTimeseriesGroupIPVersionParamsQueryType = "NULL" DNSTimeseriesGroupIPVersionParamsQueryTypeNxt DNSTimeseriesGroupIPVersionParamsQueryType = "NXT" DNSTimeseriesGroupIPVersionParamsQueryTypeOpenpgpkey DNSTimeseriesGroupIPVersionParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupIPVersionParamsQueryTypeOpt DNSTimeseriesGroupIPVersionParamsQueryType = "OPT" DNSTimeseriesGroupIPVersionParamsQueryTypePTR DNSTimeseriesGroupIPVersionParamsQueryType = "PTR" DNSTimeseriesGroupIPVersionParamsQueryTypePx DNSTimeseriesGroupIPVersionParamsQueryType = "PX" DNSTimeseriesGroupIPVersionParamsQueryTypeRkey DNSTimeseriesGroupIPVersionParamsQueryType = "RKEY" DNSTimeseriesGroupIPVersionParamsQueryTypeRp DNSTimeseriesGroupIPVersionParamsQueryType = "RP" DNSTimeseriesGroupIPVersionParamsQueryTypeRrsig DNSTimeseriesGroupIPVersionParamsQueryType = "RRSIG" DNSTimeseriesGroupIPVersionParamsQueryTypeRt DNSTimeseriesGroupIPVersionParamsQueryType = "RT" DNSTimeseriesGroupIPVersionParamsQueryTypeSig DNSTimeseriesGroupIPVersionParamsQueryType = "SIG" DNSTimeseriesGroupIPVersionParamsQueryTypeSink DNSTimeseriesGroupIPVersionParamsQueryType = "SINK" DNSTimeseriesGroupIPVersionParamsQueryTypeSMIMEA DNSTimeseriesGroupIPVersionParamsQueryType = "SMIMEA" DNSTimeseriesGroupIPVersionParamsQueryTypeSOA DNSTimeseriesGroupIPVersionParamsQueryType = "SOA" DNSTimeseriesGroupIPVersionParamsQueryTypeSPF DNSTimeseriesGroupIPVersionParamsQueryType = "SPF" DNSTimeseriesGroupIPVersionParamsQueryTypeSRV DNSTimeseriesGroupIPVersionParamsQueryType = "SRV" DNSTimeseriesGroupIPVersionParamsQueryTypeSSHFP DNSTimeseriesGroupIPVersionParamsQueryType = "SSHFP" DNSTimeseriesGroupIPVersionParamsQueryTypeSVCB DNSTimeseriesGroupIPVersionParamsQueryType = "SVCB" DNSTimeseriesGroupIPVersionParamsQueryTypeTa DNSTimeseriesGroupIPVersionParamsQueryType = "TA" DNSTimeseriesGroupIPVersionParamsQueryTypeTalink DNSTimeseriesGroupIPVersionParamsQueryType = "TALINK" DNSTimeseriesGroupIPVersionParamsQueryTypeTkey DNSTimeseriesGroupIPVersionParamsQueryType = "TKEY" DNSTimeseriesGroupIPVersionParamsQueryTypeTLSA DNSTimeseriesGroupIPVersionParamsQueryType = "TLSA" DNSTimeseriesGroupIPVersionParamsQueryTypeTSIG DNSTimeseriesGroupIPVersionParamsQueryType = "TSIG" DNSTimeseriesGroupIPVersionParamsQueryTypeTXT DNSTimeseriesGroupIPVersionParamsQueryType = "TXT" DNSTimeseriesGroupIPVersionParamsQueryTypeUinfo DNSTimeseriesGroupIPVersionParamsQueryType = "UINFO" DNSTimeseriesGroupIPVersionParamsQueryTypeUID DNSTimeseriesGroupIPVersionParamsQueryType = "UID" DNSTimeseriesGroupIPVersionParamsQueryTypeUnspec DNSTimeseriesGroupIPVersionParamsQueryType = "UNSPEC" DNSTimeseriesGroupIPVersionParamsQueryTypeURI DNSTimeseriesGroupIPVersionParamsQueryType = "URI" DNSTimeseriesGroupIPVersionParamsQueryTypeWks DNSTimeseriesGroupIPVersionParamsQueryType = "WKS" DNSTimeseriesGroupIPVersionParamsQueryTypeX25 DNSTimeseriesGroupIPVersionParamsQueryType = "X25" DNSTimeseriesGroupIPVersionParamsQueryTypeZonemd DNSTimeseriesGroupIPVersionParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupIPVersionParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupIPVersionParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupIPVersionParamsResponseCode ¶
type DNSTimeseriesGroupIPVersionParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupIPVersionParamsResponseCodeNoerror DNSTimeseriesGroupIPVersionParamsResponseCode = "NOERROR" DNSTimeseriesGroupIPVersionParamsResponseCodeFormerr DNSTimeseriesGroupIPVersionParamsResponseCode = "FORMERR" DNSTimeseriesGroupIPVersionParamsResponseCodeServfail DNSTimeseriesGroupIPVersionParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupIPVersionParamsResponseCodeNxdomain DNSTimeseriesGroupIPVersionParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupIPVersionParamsResponseCodeNotimp DNSTimeseriesGroupIPVersionParamsResponseCode = "NOTIMP" DNSTimeseriesGroupIPVersionParamsResponseCodeRefused DNSTimeseriesGroupIPVersionParamsResponseCode = "REFUSED" DNSTimeseriesGroupIPVersionParamsResponseCodeYxdomain DNSTimeseriesGroupIPVersionParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupIPVersionParamsResponseCodeYxrrset DNSTimeseriesGroupIPVersionParamsResponseCode = "YXRRSET" DNSTimeseriesGroupIPVersionParamsResponseCodeNxrrset DNSTimeseriesGroupIPVersionParamsResponseCode = "NXRRSET" DNSTimeseriesGroupIPVersionParamsResponseCodeNotauth DNSTimeseriesGroupIPVersionParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupIPVersionParamsResponseCodeNotzone DNSTimeseriesGroupIPVersionParamsResponseCode = "NOTZONE" DNSTimeseriesGroupIPVersionParamsResponseCodeBadsig DNSTimeseriesGroupIPVersionParamsResponseCode = "BADSIG" DNSTimeseriesGroupIPVersionParamsResponseCodeBadkey DNSTimeseriesGroupIPVersionParamsResponseCode = "BADKEY" DNSTimeseriesGroupIPVersionParamsResponseCodeBadtime DNSTimeseriesGroupIPVersionParamsResponseCode = "BADTIME" DNSTimeseriesGroupIPVersionParamsResponseCodeBadmode DNSTimeseriesGroupIPVersionParamsResponseCode = "BADMODE" DNSTimeseriesGroupIPVersionParamsResponseCodeBadname DNSTimeseriesGroupIPVersionParamsResponseCode = "BADNAME" DNSTimeseriesGroupIPVersionParamsResponseCodeBadalg DNSTimeseriesGroupIPVersionParamsResponseCode = "BADALG" DNSTimeseriesGroupIPVersionParamsResponseCodeBadtrunc DNSTimeseriesGroupIPVersionParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupIPVersionParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupIPVersionParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupIPVersionResponse ¶
type DNSTimeseriesGroupIPVersionResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupIPVersionResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupIPVersionResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupIPVersionResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupIPVersionResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionResponseEnvelope ¶
type DNSTimeseriesGroupIPVersionResponseEnvelope struct {
Result DNSTimeseriesGroupIPVersionResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupIPVersionResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionResponseMeta ¶
type DNSTimeseriesGroupIPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupIPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupIPVersionResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupIPVersionResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionResponseMetaAggInterval ¶
type DNSTimeseriesGroupIPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupIPVersionResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupIPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupIPVersionResponseMetaAggIntervalOneHour DNSTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupIPVersionResponseMetaAggIntervalOneDay DNSTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupIPVersionResponseMetaAggIntervalOneWeek DNSTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupIPVersionResponseMetaAggIntervalOneMonth DNSTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupIPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionResponseMetaDateRange ¶
type DNSTimeseriesGroupIPVersionResponseMetaDateRange 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 dnsTimeseriesGroupIPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionResponseMetaNormalization ¶
type DNSTimeseriesGroupIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupIPVersionResponseMetaNormalizationPercentage DNSTimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupIPVersionResponseMetaNormalizationMin0Max DNSTimeseriesGroupIPVersionResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupIPVersionResponseMetaNormalizationMinMax DNSTimeseriesGroupIPVersionResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupIPVersionResponseMetaNormalizationRawValues DNSTimeseriesGroupIPVersionResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupIPVersionResponseMetaNormalizationPercentageChange DNSTimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupIPVersionResponseMetaNormalizationRollingAverage DNSTimeseriesGroupIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupIPVersionResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupIPVersionResponseMetaNormalizationRatio DNSTimeseriesGroupIPVersionResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupIPVersionResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupIPVersionResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupIPVersionResponseMetaUnit ¶
type DNSTimeseriesGroupIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupIPVersionResponseSerie0 ¶
type DNSTimeseriesGroupIPVersionResponseSerie0 struct {
IPv4 []string `json:"IPv4,required"`
IPv6 []string `json:"IPv6,required"`
JSON dnsTimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerParams ¶
type DNSTimeseriesGroupMatchingAnswerParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupMatchingAnswerParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupMatchingAnswerParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupMatchingAnswerParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupMatchingAnswerParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupMatchingAnswerParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupMatchingAnswerParams) URLQuery ¶
func (r DNSTimeseriesGroupMatchingAnswerParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupMatchingAnswerParams's query parameters as `url.Values`.
type DNSTimeseriesGroupMatchingAnswerParamsAggInterval ¶
type DNSTimeseriesGroupMatchingAnswerParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupMatchingAnswerParamsAggInterval15m DNSTimeseriesGroupMatchingAnswerParamsAggInterval = "15m" DNSTimeseriesGroupMatchingAnswerParamsAggInterval1h DNSTimeseriesGroupMatchingAnswerParamsAggInterval = "1h" DNSTimeseriesGroupMatchingAnswerParamsAggInterval1d DNSTimeseriesGroupMatchingAnswerParamsAggInterval = "1d" DNSTimeseriesGroupMatchingAnswerParamsAggInterval1w DNSTimeseriesGroupMatchingAnswerParamsAggInterval = "1w" )
func (DNSTimeseriesGroupMatchingAnswerParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupMatchingAnswerParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupMatchingAnswerParamsFormat ¶
type DNSTimeseriesGroupMatchingAnswerParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupMatchingAnswerParamsFormatJson DNSTimeseriesGroupMatchingAnswerParamsFormat = "JSON" DNSTimeseriesGroupMatchingAnswerParamsFormatCsv DNSTimeseriesGroupMatchingAnswerParamsFormat = "CSV" )
func (DNSTimeseriesGroupMatchingAnswerParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupMatchingAnswerParamsFormat) IsKnown() bool
type DNSTimeseriesGroupMatchingAnswerParamsProtocol ¶
type DNSTimeseriesGroupMatchingAnswerParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupMatchingAnswerParamsProtocolUdp DNSTimeseriesGroupMatchingAnswerParamsProtocol = "UDP" DNSTimeseriesGroupMatchingAnswerParamsProtocolTCP DNSTimeseriesGroupMatchingAnswerParamsProtocol = "TCP" DNSTimeseriesGroupMatchingAnswerParamsProtocolHTTPS DNSTimeseriesGroupMatchingAnswerParamsProtocol = "HTTPS" DNSTimeseriesGroupMatchingAnswerParamsProtocolTLS DNSTimeseriesGroupMatchingAnswerParamsProtocol = "TLS" )
func (DNSTimeseriesGroupMatchingAnswerParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupMatchingAnswerParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupMatchingAnswerParamsQueryType ¶
type DNSTimeseriesGroupMatchingAnswerParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupMatchingAnswerParamsQueryTypeA DNSTimeseriesGroupMatchingAnswerParamsQueryType = "A" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeAAAA DNSTimeseriesGroupMatchingAnswerParamsQueryType = "AAAA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeA6 DNSTimeseriesGroupMatchingAnswerParamsQueryType = "A6" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeAfsdb DNSTimeseriesGroupMatchingAnswerParamsQueryType = "AFSDB" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeAny DNSTimeseriesGroupMatchingAnswerParamsQueryType = "ANY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeApl DNSTimeseriesGroupMatchingAnswerParamsQueryType = "APL" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeAtma DNSTimeseriesGroupMatchingAnswerParamsQueryType = "ATMA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeAXFR DNSTimeseriesGroupMatchingAnswerParamsQueryType = "AXFR" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeCAA DNSTimeseriesGroupMatchingAnswerParamsQueryType = "CAA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeCdnskey DNSTimeseriesGroupMatchingAnswerParamsQueryType = "CDNSKEY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeCds DNSTimeseriesGroupMatchingAnswerParamsQueryType = "CDS" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeCERT DNSTimeseriesGroupMatchingAnswerParamsQueryType = "CERT" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeCNAME DNSTimeseriesGroupMatchingAnswerParamsQueryType = "CNAME" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeCsync DNSTimeseriesGroupMatchingAnswerParamsQueryType = "CSYNC" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeDhcid DNSTimeseriesGroupMatchingAnswerParamsQueryType = "DHCID" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeDlv DNSTimeseriesGroupMatchingAnswerParamsQueryType = "DLV" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeDname DNSTimeseriesGroupMatchingAnswerParamsQueryType = "DNAME" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeDNSKEY DNSTimeseriesGroupMatchingAnswerParamsQueryType = "DNSKEY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeDoa DNSTimeseriesGroupMatchingAnswerParamsQueryType = "DOA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeDS DNSTimeseriesGroupMatchingAnswerParamsQueryType = "DS" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeEid DNSTimeseriesGroupMatchingAnswerParamsQueryType = "EID" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeEui48 DNSTimeseriesGroupMatchingAnswerParamsQueryType = "EUI48" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeEui64 DNSTimeseriesGroupMatchingAnswerParamsQueryType = "EUI64" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeGpos DNSTimeseriesGroupMatchingAnswerParamsQueryType = "GPOS" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeGid DNSTimeseriesGroupMatchingAnswerParamsQueryType = "GID" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeHinfo DNSTimeseriesGroupMatchingAnswerParamsQueryType = "HINFO" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeHip DNSTimeseriesGroupMatchingAnswerParamsQueryType = "HIP" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeHTTPS DNSTimeseriesGroupMatchingAnswerParamsQueryType = "HTTPS" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeIpseckey DNSTimeseriesGroupMatchingAnswerParamsQueryType = "IPSECKEY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeIsdn DNSTimeseriesGroupMatchingAnswerParamsQueryType = "ISDN" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeIxfr DNSTimeseriesGroupMatchingAnswerParamsQueryType = "IXFR" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeKey DNSTimeseriesGroupMatchingAnswerParamsQueryType = "KEY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeKx DNSTimeseriesGroupMatchingAnswerParamsQueryType = "KX" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeL32 DNSTimeseriesGroupMatchingAnswerParamsQueryType = "L32" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeL64 DNSTimeseriesGroupMatchingAnswerParamsQueryType = "L64" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeLOC DNSTimeseriesGroupMatchingAnswerParamsQueryType = "LOC" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeLp DNSTimeseriesGroupMatchingAnswerParamsQueryType = "LP" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMaila DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MAILA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMailb DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MAILB" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMB DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MB" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMd DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MD" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMf DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MF" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMg DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MG" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMinfo DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MINFO" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMr DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MR" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeMX DNSTimeseriesGroupMatchingAnswerParamsQueryType = "MX" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNAPTR DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NAPTR" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNb DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NB" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNbstat DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NBSTAT" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNid DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NID" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNimloc DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NIMLOC" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNinfo DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NINFO" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNS DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NS" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNsap DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NSAP" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNsec DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NSEC" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNsec3 DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NSEC3" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNsec3Param DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNull DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NULL" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeNxt DNSTimeseriesGroupMatchingAnswerParamsQueryType = "NXT" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeOpenpgpkey DNSTimeseriesGroupMatchingAnswerParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeOpt DNSTimeseriesGroupMatchingAnswerParamsQueryType = "OPT" DNSTimeseriesGroupMatchingAnswerParamsQueryTypePTR DNSTimeseriesGroupMatchingAnswerParamsQueryType = "PTR" DNSTimeseriesGroupMatchingAnswerParamsQueryTypePx DNSTimeseriesGroupMatchingAnswerParamsQueryType = "PX" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeRkey DNSTimeseriesGroupMatchingAnswerParamsQueryType = "RKEY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeRp DNSTimeseriesGroupMatchingAnswerParamsQueryType = "RP" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeRrsig DNSTimeseriesGroupMatchingAnswerParamsQueryType = "RRSIG" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeRt DNSTimeseriesGroupMatchingAnswerParamsQueryType = "RT" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSig DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SIG" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSink DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SINK" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSMIMEA DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SMIMEA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSOA DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SOA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSPF DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SPF" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSRV DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SRV" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSSHFP DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SSHFP" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeSVCB DNSTimeseriesGroupMatchingAnswerParamsQueryType = "SVCB" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeTa DNSTimeseriesGroupMatchingAnswerParamsQueryType = "TA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeTalink DNSTimeseriesGroupMatchingAnswerParamsQueryType = "TALINK" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeTkey DNSTimeseriesGroupMatchingAnswerParamsQueryType = "TKEY" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeTLSA DNSTimeseriesGroupMatchingAnswerParamsQueryType = "TLSA" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeTSIG DNSTimeseriesGroupMatchingAnswerParamsQueryType = "TSIG" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeTXT DNSTimeseriesGroupMatchingAnswerParamsQueryType = "TXT" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeUinfo DNSTimeseriesGroupMatchingAnswerParamsQueryType = "UINFO" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeUID DNSTimeseriesGroupMatchingAnswerParamsQueryType = "UID" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeUnspec DNSTimeseriesGroupMatchingAnswerParamsQueryType = "UNSPEC" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeURI DNSTimeseriesGroupMatchingAnswerParamsQueryType = "URI" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeWks DNSTimeseriesGroupMatchingAnswerParamsQueryType = "WKS" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeX25 DNSTimeseriesGroupMatchingAnswerParamsQueryType = "X25" DNSTimeseriesGroupMatchingAnswerParamsQueryTypeZonemd DNSTimeseriesGroupMatchingAnswerParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupMatchingAnswerParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupMatchingAnswerParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupMatchingAnswerParamsResponseCode ¶
type DNSTimeseriesGroupMatchingAnswerParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupMatchingAnswerParamsResponseCodeNoerror DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "NOERROR" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeFormerr DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "FORMERR" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeServfail DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeNxdomain DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeNotimp DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "NOTIMP" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeRefused DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "REFUSED" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeYxdomain DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeYxrrset DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "YXRRSET" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeNxrrset DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "NXRRSET" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeNotauth DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeNotzone DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "NOTZONE" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeBadsig DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "BADSIG" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeBadkey DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "BADKEY" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeBadtime DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "BADTIME" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeBadmode DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "BADMODE" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeBadname DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "BADNAME" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeBadalg DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "BADALG" DNSTimeseriesGroupMatchingAnswerParamsResponseCodeBadtrunc DNSTimeseriesGroupMatchingAnswerParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupMatchingAnswerParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupMatchingAnswerParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupMatchingAnswerResponse ¶
type DNSTimeseriesGroupMatchingAnswerResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupMatchingAnswerResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupMatchingAnswerResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupMatchingAnswerResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupMatchingAnswerResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerResponseEnvelope ¶
type DNSTimeseriesGroupMatchingAnswerResponseEnvelope struct {
Result DNSTimeseriesGroupMatchingAnswerResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupMatchingAnswerResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupMatchingAnswerResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerResponseMeta ¶
type DNSTimeseriesGroupMatchingAnswerResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupMatchingAnswerResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupMatchingAnswerResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupMatchingAnswerResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupMatchingAnswerResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval ¶
type DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupMatchingAnswerResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupMatchingAnswerResponseMetaAggIntervalOneHour DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupMatchingAnswerResponseMetaAggIntervalOneDay DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupMatchingAnswerResponseMetaAggIntervalOneWeek DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupMatchingAnswerResponseMetaAggIntervalOneMonth DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupMatchingAnswerResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerResponseMetaDateRange ¶
type DNSTimeseriesGroupMatchingAnswerResponseMetaDateRange 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 dnsTimeseriesGroupMatchingAnswerResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupMatchingAnswerResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization ¶
type DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationPercentage DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationMin0Max DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationMinMax DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationRawValues DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationPercentageChange DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationRollingAverage DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupMatchingAnswerResponseMetaNormalizationRatio DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupMatchingAnswerResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupMatchingAnswerResponseMetaUnit ¶
type DNSTimeseriesGroupMatchingAnswerResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupMatchingAnswerResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupMatchingAnswerResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupMatchingAnswerResponseSerie0 ¶
type DNSTimeseriesGroupMatchingAnswerResponseSerie0 struct {
Negative []string `json:"NEGATIVE,required"`
Positive []string `json:"POSITIVE,required"`
JSON dnsTimeseriesGroupMatchingAnswerResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupMatchingAnswerResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupMatchingAnswerResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolParams ¶
type DNSTimeseriesGroupProtocolParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupProtocolParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupProtocolParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupProtocolParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupProtocolParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupProtocolParams) URLQuery ¶
func (r DNSTimeseriesGroupProtocolParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupProtocolParams's query parameters as `url.Values`.
type DNSTimeseriesGroupProtocolParamsAggInterval ¶
type DNSTimeseriesGroupProtocolParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupProtocolParamsAggInterval15m DNSTimeseriesGroupProtocolParamsAggInterval = "15m" DNSTimeseriesGroupProtocolParamsAggInterval1h DNSTimeseriesGroupProtocolParamsAggInterval = "1h" DNSTimeseriesGroupProtocolParamsAggInterval1d DNSTimeseriesGroupProtocolParamsAggInterval = "1d" DNSTimeseriesGroupProtocolParamsAggInterval1w DNSTimeseriesGroupProtocolParamsAggInterval = "1w" )
func (DNSTimeseriesGroupProtocolParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupProtocolParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupProtocolParamsFormat ¶
type DNSTimeseriesGroupProtocolParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupProtocolParamsFormatJson DNSTimeseriesGroupProtocolParamsFormat = "JSON" DNSTimeseriesGroupProtocolParamsFormatCsv DNSTimeseriesGroupProtocolParamsFormat = "CSV" )
func (DNSTimeseriesGroupProtocolParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupProtocolParamsFormat) IsKnown() bool
type DNSTimeseriesGroupProtocolParamsQueryType ¶
type DNSTimeseriesGroupProtocolParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupProtocolParamsQueryTypeA DNSTimeseriesGroupProtocolParamsQueryType = "A" DNSTimeseriesGroupProtocolParamsQueryTypeAAAA DNSTimeseriesGroupProtocolParamsQueryType = "AAAA" DNSTimeseriesGroupProtocolParamsQueryTypeA6 DNSTimeseriesGroupProtocolParamsQueryType = "A6" DNSTimeseriesGroupProtocolParamsQueryTypeAfsdb DNSTimeseriesGroupProtocolParamsQueryType = "AFSDB" DNSTimeseriesGroupProtocolParamsQueryTypeAny DNSTimeseriesGroupProtocolParamsQueryType = "ANY" DNSTimeseriesGroupProtocolParamsQueryTypeApl DNSTimeseriesGroupProtocolParamsQueryType = "APL" DNSTimeseriesGroupProtocolParamsQueryTypeAtma DNSTimeseriesGroupProtocolParamsQueryType = "ATMA" DNSTimeseriesGroupProtocolParamsQueryTypeAXFR DNSTimeseriesGroupProtocolParamsQueryType = "AXFR" DNSTimeseriesGroupProtocolParamsQueryTypeCAA DNSTimeseriesGroupProtocolParamsQueryType = "CAA" DNSTimeseriesGroupProtocolParamsQueryTypeCdnskey DNSTimeseriesGroupProtocolParamsQueryType = "CDNSKEY" DNSTimeseriesGroupProtocolParamsQueryTypeCds DNSTimeseriesGroupProtocolParamsQueryType = "CDS" DNSTimeseriesGroupProtocolParamsQueryTypeCERT DNSTimeseriesGroupProtocolParamsQueryType = "CERT" DNSTimeseriesGroupProtocolParamsQueryTypeCNAME DNSTimeseriesGroupProtocolParamsQueryType = "CNAME" DNSTimeseriesGroupProtocolParamsQueryTypeCsync DNSTimeseriesGroupProtocolParamsQueryType = "CSYNC" DNSTimeseriesGroupProtocolParamsQueryTypeDhcid DNSTimeseriesGroupProtocolParamsQueryType = "DHCID" DNSTimeseriesGroupProtocolParamsQueryTypeDlv DNSTimeseriesGroupProtocolParamsQueryType = "DLV" DNSTimeseriesGroupProtocolParamsQueryTypeDname DNSTimeseriesGroupProtocolParamsQueryType = "DNAME" DNSTimeseriesGroupProtocolParamsQueryTypeDNSKEY DNSTimeseriesGroupProtocolParamsQueryType = "DNSKEY" DNSTimeseriesGroupProtocolParamsQueryTypeDoa DNSTimeseriesGroupProtocolParamsQueryType = "DOA" DNSTimeseriesGroupProtocolParamsQueryTypeDS DNSTimeseriesGroupProtocolParamsQueryType = "DS" DNSTimeseriesGroupProtocolParamsQueryTypeEid DNSTimeseriesGroupProtocolParamsQueryType = "EID" DNSTimeseriesGroupProtocolParamsQueryTypeEui48 DNSTimeseriesGroupProtocolParamsQueryType = "EUI48" DNSTimeseriesGroupProtocolParamsQueryTypeEui64 DNSTimeseriesGroupProtocolParamsQueryType = "EUI64" DNSTimeseriesGroupProtocolParamsQueryTypeGpos DNSTimeseriesGroupProtocolParamsQueryType = "GPOS" DNSTimeseriesGroupProtocolParamsQueryTypeGid DNSTimeseriesGroupProtocolParamsQueryType = "GID" DNSTimeseriesGroupProtocolParamsQueryTypeHinfo DNSTimeseriesGroupProtocolParamsQueryType = "HINFO" DNSTimeseriesGroupProtocolParamsQueryTypeHip DNSTimeseriesGroupProtocolParamsQueryType = "HIP" DNSTimeseriesGroupProtocolParamsQueryTypeHTTPS DNSTimeseriesGroupProtocolParamsQueryType = "HTTPS" DNSTimeseriesGroupProtocolParamsQueryTypeIpseckey DNSTimeseriesGroupProtocolParamsQueryType = "IPSECKEY" DNSTimeseriesGroupProtocolParamsQueryTypeIsdn DNSTimeseriesGroupProtocolParamsQueryType = "ISDN" DNSTimeseriesGroupProtocolParamsQueryTypeIxfr DNSTimeseriesGroupProtocolParamsQueryType = "IXFR" DNSTimeseriesGroupProtocolParamsQueryTypeKey DNSTimeseriesGroupProtocolParamsQueryType = "KEY" DNSTimeseriesGroupProtocolParamsQueryTypeKx DNSTimeseriesGroupProtocolParamsQueryType = "KX" DNSTimeseriesGroupProtocolParamsQueryTypeL32 DNSTimeseriesGroupProtocolParamsQueryType = "L32" DNSTimeseriesGroupProtocolParamsQueryTypeL64 DNSTimeseriesGroupProtocolParamsQueryType = "L64" DNSTimeseriesGroupProtocolParamsQueryTypeLOC DNSTimeseriesGroupProtocolParamsQueryType = "LOC" DNSTimeseriesGroupProtocolParamsQueryTypeLp DNSTimeseriesGroupProtocolParamsQueryType = "LP" DNSTimeseriesGroupProtocolParamsQueryTypeMaila DNSTimeseriesGroupProtocolParamsQueryType = "MAILA" DNSTimeseriesGroupProtocolParamsQueryTypeMailb DNSTimeseriesGroupProtocolParamsQueryType = "MAILB" DNSTimeseriesGroupProtocolParamsQueryTypeMB DNSTimeseriesGroupProtocolParamsQueryType = "MB" DNSTimeseriesGroupProtocolParamsQueryTypeMd DNSTimeseriesGroupProtocolParamsQueryType = "MD" DNSTimeseriesGroupProtocolParamsQueryTypeMf DNSTimeseriesGroupProtocolParamsQueryType = "MF" DNSTimeseriesGroupProtocolParamsQueryTypeMg DNSTimeseriesGroupProtocolParamsQueryType = "MG" DNSTimeseriesGroupProtocolParamsQueryTypeMinfo DNSTimeseriesGroupProtocolParamsQueryType = "MINFO" DNSTimeseriesGroupProtocolParamsQueryTypeMr DNSTimeseriesGroupProtocolParamsQueryType = "MR" DNSTimeseriesGroupProtocolParamsQueryTypeMX DNSTimeseriesGroupProtocolParamsQueryType = "MX" DNSTimeseriesGroupProtocolParamsQueryTypeNAPTR DNSTimeseriesGroupProtocolParamsQueryType = "NAPTR" DNSTimeseriesGroupProtocolParamsQueryTypeNb DNSTimeseriesGroupProtocolParamsQueryType = "NB" DNSTimeseriesGroupProtocolParamsQueryTypeNbstat DNSTimeseriesGroupProtocolParamsQueryType = "NBSTAT" DNSTimeseriesGroupProtocolParamsQueryTypeNid DNSTimeseriesGroupProtocolParamsQueryType = "NID" DNSTimeseriesGroupProtocolParamsQueryTypeNimloc DNSTimeseriesGroupProtocolParamsQueryType = "NIMLOC" DNSTimeseriesGroupProtocolParamsQueryTypeNinfo DNSTimeseriesGroupProtocolParamsQueryType = "NINFO" DNSTimeseriesGroupProtocolParamsQueryTypeNS DNSTimeseriesGroupProtocolParamsQueryType = "NS" DNSTimeseriesGroupProtocolParamsQueryTypeNsap DNSTimeseriesGroupProtocolParamsQueryType = "NSAP" DNSTimeseriesGroupProtocolParamsQueryTypeNsec DNSTimeseriesGroupProtocolParamsQueryType = "NSEC" DNSTimeseriesGroupProtocolParamsQueryTypeNsec3 DNSTimeseriesGroupProtocolParamsQueryType = "NSEC3" DNSTimeseriesGroupProtocolParamsQueryTypeNsec3Param DNSTimeseriesGroupProtocolParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupProtocolParamsQueryTypeNull DNSTimeseriesGroupProtocolParamsQueryType = "NULL" DNSTimeseriesGroupProtocolParamsQueryTypeNxt DNSTimeseriesGroupProtocolParamsQueryType = "NXT" DNSTimeseriesGroupProtocolParamsQueryTypeOpenpgpkey DNSTimeseriesGroupProtocolParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupProtocolParamsQueryTypeOpt DNSTimeseriesGroupProtocolParamsQueryType = "OPT" DNSTimeseriesGroupProtocolParamsQueryTypePTR DNSTimeseriesGroupProtocolParamsQueryType = "PTR" DNSTimeseriesGroupProtocolParamsQueryTypePx DNSTimeseriesGroupProtocolParamsQueryType = "PX" DNSTimeseriesGroupProtocolParamsQueryTypeRkey DNSTimeseriesGroupProtocolParamsQueryType = "RKEY" DNSTimeseriesGroupProtocolParamsQueryTypeRp DNSTimeseriesGroupProtocolParamsQueryType = "RP" DNSTimeseriesGroupProtocolParamsQueryTypeRrsig DNSTimeseriesGroupProtocolParamsQueryType = "RRSIG" DNSTimeseriesGroupProtocolParamsQueryTypeRt DNSTimeseriesGroupProtocolParamsQueryType = "RT" DNSTimeseriesGroupProtocolParamsQueryTypeSig DNSTimeseriesGroupProtocolParamsQueryType = "SIG" DNSTimeseriesGroupProtocolParamsQueryTypeSink DNSTimeseriesGroupProtocolParamsQueryType = "SINK" DNSTimeseriesGroupProtocolParamsQueryTypeSMIMEA DNSTimeseriesGroupProtocolParamsQueryType = "SMIMEA" DNSTimeseriesGroupProtocolParamsQueryTypeSOA DNSTimeseriesGroupProtocolParamsQueryType = "SOA" DNSTimeseriesGroupProtocolParamsQueryTypeSPF DNSTimeseriesGroupProtocolParamsQueryType = "SPF" DNSTimeseriesGroupProtocolParamsQueryTypeSRV DNSTimeseriesGroupProtocolParamsQueryType = "SRV" DNSTimeseriesGroupProtocolParamsQueryTypeSSHFP DNSTimeseriesGroupProtocolParamsQueryType = "SSHFP" DNSTimeseriesGroupProtocolParamsQueryTypeSVCB DNSTimeseriesGroupProtocolParamsQueryType = "SVCB" DNSTimeseriesGroupProtocolParamsQueryTypeTa DNSTimeseriesGroupProtocolParamsQueryType = "TA" DNSTimeseriesGroupProtocolParamsQueryTypeTalink DNSTimeseriesGroupProtocolParamsQueryType = "TALINK" DNSTimeseriesGroupProtocolParamsQueryTypeTkey DNSTimeseriesGroupProtocolParamsQueryType = "TKEY" DNSTimeseriesGroupProtocolParamsQueryTypeTLSA DNSTimeseriesGroupProtocolParamsQueryType = "TLSA" DNSTimeseriesGroupProtocolParamsQueryTypeTSIG DNSTimeseriesGroupProtocolParamsQueryType = "TSIG" DNSTimeseriesGroupProtocolParamsQueryTypeTXT DNSTimeseriesGroupProtocolParamsQueryType = "TXT" DNSTimeseriesGroupProtocolParamsQueryTypeUinfo DNSTimeseriesGroupProtocolParamsQueryType = "UINFO" DNSTimeseriesGroupProtocolParamsQueryTypeUID DNSTimeseriesGroupProtocolParamsQueryType = "UID" DNSTimeseriesGroupProtocolParamsQueryTypeUnspec DNSTimeseriesGroupProtocolParamsQueryType = "UNSPEC" DNSTimeseriesGroupProtocolParamsQueryTypeURI DNSTimeseriesGroupProtocolParamsQueryType = "URI" DNSTimeseriesGroupProtocolParamsQueryTypeWks DNSTimeseriesGroupProtocolParamsQueryType = "WKS" DNSTimeseriesGroupProtocolParamsQueryTypeX25 DNSTimeseriesGroupProtocolParamsQueryType = "X25" DNSTimeseriesGroupProtocolParamsQueryTypeZonemd DNSTimeseriesGroupProtocolParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupProtocolParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupProtocolParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupProtocolParamsResponseCode ¶
type DNSTimeseriesGroupProtocolParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupProtocolParamsResponseCodeNoerror DNSTimeseriesGroupProtocolParamsResponseCode = "NOERROR" DNSTimeseriesGroupProtocolParamsResponseCodeFormerr DNSTimeseriesGroupProtocolParamsResponseCode = "FORMERR" DNSTimeseriesGroupProtocolParamsResponseCodeServfail DNSTimeseriesGroupProtocolParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupProtocolParamsResponseCodeNxdomain DNSTimeseriesGroupProtocolParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupProtocolParamsResponseCodeNotimp DNSTimeseriesGroupProtocolParamsResponseCode = "NOTIMP" DNSTimeseriesGroupProtocolParamsResponseCodeRefused DNSTimeseriesGroupProtocolParamsResponseCode = "REFUSED" DNSTimeseriesGroupProtocolParamsResponseCodeYxdomain DNSTimeseriesGroupProtocolParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupProtocolParamsResponseCodeYxrrset DNSTimeseriesGroupProtocolParamsResponseCode = "YXRRSET" DNSTimeseriesGroupProtocolParamsResponseCodeNxrrset DNSTimeseriesGroupProtocolParamsResponseCode = "NXRRSET" DNSTimeseriesGroupProtocolParamsResponseCodeNotauth DNSTimeseriesGroupProtocolParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupProtocolParamsResponseCodeNotzone DNSTimeseriesGroupProtocolParamsResponseCode = "NOTZONE" DNSTimeseriesGroupProtocolParamsResponseCodeBadsig DNSTimeseriesGroupProtocolParamsResponseCode = "BADSIG" DNSTimeseriesGroupProtocolParamsResponseCodeBadkey DNSTimeseriesGroupProtocolParamsResponseCode = "BADKEY" DNSTimeseriesGroupProtocolParamsResponseCodeBadtime DNSTimeseriesGroupProtocolParamsResponseCode = "BADTIME" DNSTimeseriesGroupProtocolParamsResponseCodeBadmode DNSTimeseriesGroupProtocolParamsResponseCode = "BADMODE" DNSTimeseriesGroupProtocolParamsResponseCodeBadname DNSTimeseriesGroupProtocolParamsResponseCode = "BADNAME" DNSTimeseriesGroupProtocolParamsResponseCodeBadalg DNSTimeseriesGroupProtocolParamsResponseCode = "BADALG" DNSTimeseriesGroupProtocolParamsResponseCodeBadtrunc DNSTimeseriesGroupProtocolParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupProtocolParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupProtocolParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupProtocolResponse ¶
type DNSTimeseriesGroupProtocolResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupProtocolResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupProtocolResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupProtocolResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupProtocolResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolResponseEnvelope ¶
type DNSTimeseriesGroupProtocolResponseEnvelope struct {
Result DNSTimeseriesGroupProtocolResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupProtocolResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupProtocolResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolResponseMeta ¶
type DNSTimeseriesGroupProtocolResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupProtocolResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupProtocolResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupProtocolResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolResponseMetaAggInterval ¶
type DNSTimeseriesGroupProtocolResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupProtocolResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupProtocolResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupProtocolResponseMetaAggIntervalOneHour DNSTimeseriesGroupProtocolResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupProtocolResponseMetaAggIntervalOneDay DNSTimeseriesGroupProtocolResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupProtocolResponseMetaAggIntervalOneWeek DNSTimeseriesGroupProtocolResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupProtocolResponseMetaAggIntervalOneMonth DNSTimeseriesGroupProtocolResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupProtocolResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupProtocolResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupProtocolResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupProtocolResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupProtocolResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupProtocolResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolResponseMetaDateRange ¶
type DNSTimeseriesGroupProtocolResponseMetaDateRange 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 dnsTimeseriesGroupProtocolResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupProtocolResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolResponseMetaNormalization ¶
type DNSTimeseriesGroupProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupProtocolResponseMetaNormalizationPercentage DNSTimeseriesGroupProtocolResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupProtocolResponseMetaNormalizationMin0Max DNSTimeseriesGroupProtocolResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupProtocolResponseMetaNormalizationMinMax DNSTimeseriesGroupProtocolResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupProtocolResponseMetaNormalizationRawValues DNSTimeseriesGroupProtocolResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupProtocolResponseMetaNormalizationPercentageChange DNSTimeseriesGroupProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupProtocolResponseMetaNormalizationRollingAverage DNSTimeseriesGroupProtocolResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupProtocolResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupProtocolResponseMetaNormalizationRatio DNSTimeseriesGroupProtocolResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupProtocolResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupProtocolResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupProtocolResponseMetaUnit ¶
type DNSTimeseriesGroupProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupProtocolResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupProtocolResponseSerie0 ¶
type DNSTimeseriesGroupProtocolResponseSerie0 struct {
HTTPS []string `json:"HTTPS,required"`
TCP []string `json:"TCP,required"`
TLS []string `json:"TLS,required"`
Udp []string `json:"UDP,required"`
JSON dnsTimeseriesGroupProtocolResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupProtocolResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupProtocolResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeParams ¶
type DNSTimeseriesGroupQueryTypeParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupQueryTypeParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupQueryTypeParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupQueryTypeParamsProtocol] `query:"protocol"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupQueryTypeParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupQueryTypeParams) URLQuery ¶
func (r DNSTimeseriesGroupQueryTypeParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupQueryTypeParams's query parameters as `url.Values`.
type DNSTimeseriesGroupQueryTypeParamsAggInterval ¶
type DNSTimeseriesGroupQueryTypeParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupQueryTypeParamsAggInterval15m DNSTimeseriesGroupQueryTypeParamsAggInterval = "15m" DNSTimeseriesGroupQueryTypeParamsAggInterval1h DNSTimeseriesGroupQueryTypeParamsAggInterval = "1h" DNSTimeseriesGroupQueryTypeParamsAggInterval1d DNSTimeseriesGroupQueryTypeParamsAggInterval = "1d" DNSTimeseriesGroupQueryTypeParamsAggInterval1w DNSTimeseriesGroupQueryTypeParamsAggInterval = "1w" )
func (DNSTimeseriesGroupQueryTypeParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupQueryTypeParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupQueryTypeParamsFormat ¶
type DNSTimeseriesGroupQueryTypeParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupQueryTypeParamsFormatJson DNSTimeseriesGroupQueryTypeParamsFormat = "JSON" DNSTimeseriesGroupQueryTypeParamsFormatCsv DNSTimeseriesGroupQueryTypeParamsFormat = "CSV" )
func (DNSTimeseriesGroupQueryTypeParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupQueryTypeParamsFormat) IsKnown() bool
type DNSTimeseriesGroupQueryTypeParamsProtocol ¶
type DNSTimeseriesGroupQueryTypeParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupQueryTypeParamsProtocolUdp DNSTimeseriesGroupQueryTypeParamsProtocol = "UDP" DNSTimeseriesGroupQueryTypeParamsProtocolTCP DNSTimeseriesGroupQueryTypeParamsProtocol = "TCP" DNSTimeseriesGroupQueryTypeParamsProtocolHTTPS DNSTimeseriesGroupQueryTypeParamsProtocol = "HTTPS" DNSTimeseriesGroupQueryTypeParamsProtocolTLS DNSTimeseriesGroupQueryTypeParamsProtocol = "TLS" )
func (DNSTimeseriesGroupQueryTypeParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupQueryTypeParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupQueryTypeParamsResponseCode ¶
type DNSTimeseriesGroupQueryTypeParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupQueryTypeParamsResponseCodeNoerror DNSTimeseriesGroupQueryTypeParamsResponseCode = "NOERROR" DNSTimeseriesGroupQueryTypeParamsResponseCodeFormerr DNSTimeseriesGroupQueryTypeParamsResponseCode = "FORMERR" DNSTimeseriesGroupQueryTypeParamsResponseCodeServfail DNSTimeseriesGroupQueryTypeParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupQueryTypeParamsResponseCodeNxdomain DNSTimeseriesGroupQueryTypeParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupQueryTypeParamsResponseCodeNotimp DNSTimeseriesGroupQueryTypeParamsResponseCode = "NOTIMP" DNSTimeseriesGroupQueryTypeParamsResponseCodeRefused DNSTimeseriesGroupQueryTypeParamsResponseCode = "REFUSED" DNSTimeseriesGroupQueryTypeParamsResponseCodeYxdomain DNSTimeseriesGroupQueryTypeParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupQueryTypeParamsResponseCodeYxrrset DNSTimeseriesGroupQueryTypeParamsResponseCode = "YXRRSET" DNSTimeseriesGroupQueryTypeParamsResponseCodeNxrrset DNSTimeseriesGroupQueryTypeParamsResponseCode = "NXRRSET" DNSTimeseriesGroupQueryTypeParamsResponseCodeNotauth DNSTimeseriesGroupQueryTypeParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupQueryTypeParamsResponseCodeNotzone DNSTimeseriesGroupQueryTypeParamsResponseCode = "NOTZONE" DNSTimeseriesGroupQueryTypeParamsResponseCodeBadsig DNSTimeseriesGroupQueryTypeParamsResponseCode = "BADSIG" DNSTimeseriesGroupQueryTypeParamsResponseCodeBadkey DNSTimeseriesGroupQueryTypeParamsResponseCode = "BADKEY" DNSTimeseriesGroupQueryTypeParamsResponseCodeBadtime DNSTimeseriesGroupQueryTypeParamsResponseCode = "BADTIME" DNSTimeseriesGroupQueryTypeParamsResponseCodeBadmode DNSTimeseriesGroupQueryTypeParamsResponseCode = "BADMODE" DNSTimeseriesGroupQueryTypeParamsResponseCodeBadname DNSTimeseriesGroupQueryTypeParamsResponseCode = "BADNAME" DNSTimeseriesGroupQueryTypeParamsResponseCodeBadalg DNSTimeseriesGroupQueryTypeParamsResponseCode = "BADALG" DNSTimeseriesGroupQueryTypeParamsResponseCodeBadtrunc DNSTimeseriesGroupQueryTypeParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupQueryTypeParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupQueryTypeParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupQueryTypeResponse ¶
type DNSTimeseriesGroupQueryTypeResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupQueryTypeResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupQueryTypeResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupQueryTypeResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupQueryTypeResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeResponseEnvelope ¶
type DNSTimeseriesGroupQueryTypeResponseEnvelope struct {
Result DNSTimeseriesGroupQueryTypeResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupQueryTypeResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupQueryTypeResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeResponseMeta ¶
type DNSTimeseriesGroupQueryTypeResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupQueryTypeResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupQueryTypeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupQueryTypeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupQueryTypeResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupQueryTypeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupQueryTypeResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeResponseMetaAggInterval ¶
type DNSTimeseriesGroupQueryTypeResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupQueryTypeResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupQueryTypeResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupQueryTypeResponseMetaAggIntervalOneHour DNSTimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupQueryTypeResponseMetaAggIntervalOneDay DNSTimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupQueryTypeResponseMetaAggIntervalOneWeek DNSTimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupQueryTypeResponseMetaAggIntervalOneMonth DNSTimeseriesGroupQueryTypeResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupQueryTypeResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupQueryTypeResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupQueryTypeResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeResponseMetaDateRange ¶
type DNSTimeseriesGroupQueryTypeResponseMetaDateRange 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 dnsTimeseriesGroupQueryTypeResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupQueryTypeResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeResponseMetaNormalization ¶
type DNSTimeseriesGroupQueryTypeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupQueryTypeResponseMetaNormalizationPercentage DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupQueryTypeResponseMetaNormalizationMin0Max DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupQueryTypeResponseMetaNormalizationMinMax DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupQueryTypeResponseMetaNormalizationRawValues DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupQueryTypeResponseMetaNormalizationPercentageChange DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupQueryTypeResponseMetaNormalizationRollingAverage DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupQueryTypeResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupQueryTypeResponseMetaNormalizationRatio DNSTimeseriesGroupQueryTypeResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupQueryTypeResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupQueryTypeResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupQueryTypeResponseMetaUnit ¶
type DNSTimeseriesGroupQueryTypeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupQueryTypeResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupQueryTypeResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupQueryTypeResponseSerie0 ¶
type DNSTimeseriesGroupQueryTypeResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON dnsTimeseriesGroupQueryTypeResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupQueryTypeResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupQueryTypeResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeParams ¶
type DNSTimeseriesGroupResponseCodeParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupResponseCodeParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupResponseCodeParamsFormat] `query:"format"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupResponseCodeParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupResponseCodeParamsQueryType] `query:"queryType"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupResponseCodeParams) URLQuery ¶
func (r DNSTimeseriesGroupResponseCodeParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupResponseCodeParams's query parameters as `url.Values`.
type DNSTimeseriesGroupResponseCodeParamsAggInterval ¶
type DNSTimeseriesGroupResponseCodeParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupResponseCodeParamsAggInterval15m DNSTimeseriesGroupResponseCodeParamsAggInterval = "15m" DNSTimeseriesGroupResponseCodeParamsAggInterval1h DNSTimeseriesGroupResponseCodeParamsAggInterval = "1h" DNSTimeseriesGroupResponseCodeParamsAggInterval1d DNSTimeseriesGroupResponseCodeParamsAggInterval = "1d" DNSTimeseriesGroupResponseCodeParamsAggInterval1w DNSTimeseriesGroupResponseCodeParamsAggInterval = "1w" )
func (DNSTimeseriesGroupResponseCodeParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupResponseCodeParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupResponseCodeParamsFormat ¶
type DNSTimeseriesGroupResponseCodeParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupResponseCodeParamsFormatJson DNSTimeseriesGroupResponseCodeParamsFormat = "JSON" DNSTimeseriesGroupResponseCodeParamsFormatCsv DNSTimeseriesGroupResponseCodeParamsFormat = "CSV" )
func (DNSTimeseriesGroupResponseCodeParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupResponseCodeParamsFormat) IsKnown() bool
type DNSTimeseriesGroupResponseCodeParamsProtocol ¶
type DNSTimeseriesGroupResponseCodeParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupResponseCodeParamsProtocolUdp DNSTimeseriesGroupResponseCodeParamsProtocol = "UDP" DNSTimeseriesGroupResponseCodeParamsProtocolTCP DNSTimeseriesGroupResponseCodeParamsProtocol = "TCP" DNSTimeseriesGroupResponseCodeParamsProtocolHTTPS DNSTimeseriesGroupResponseCodeParamsProtocol = "HTTPS" DNSTimeseriesGroupResponseCodeParamsProtocolTLS DNSTimeseriesGroupResponseCodeParamsProtocol = "TLS" )
func (DNSTimeseriesGroupResponseCodeParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupResponseCodeParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupResponseCodeParamsQueryType ¶
type DNSTimeseriesGroupResponseCodeParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupResponseCodeParamsQueryTypeA DNSTimeseriesGroupResponseCodeParamsQueryType = "A" DNSTimeseriesGroupResponseCodeParamsQueryTypeAAAA DNSTimeseriesGroupResponseCodeParamsQueryType = "AAAA" DNSTimeseriesGroupResponseCodeParamsQueryTypeA6 DNSTimeseriesGroupResponseCodeParamsQueryType = "A6" DNSTimeseriesGroupResponseCodeParamsQueryTypeAfsdb DNSTimeseriesGroupResponseCodeParamsQueryType = "AFSDB" DNSTimeseriesGroupResponseCodeParamsQueryTypeAny DNSTimeseriesGroupResponseCodeParamsQueryType = "ANY" DNSTimeseriesGroupResponseCodeParamsQueryTypeApl DNSTimeseriesGroupResponseCodeParamsQueryType = "APL" DNSTimeseriesGroupResponseCodeParamsQueryTypeAtma DNSTimeseriesGroupResponseCodeParamsQueryType = "ATMA" DNSTimeseriesGroupResponseCodeParamsQueryTypeAXFR DNSTimeseriesGroupResponseCodeParamsQueryType = "AXFR" DNSTimeseriesGroupResponseCodeParamsQueryTypeCAA DNSTimeseriesGroupResponseCodeParamsQueryType = "CAA" DNSTimeseriesGroupResponseCodeParamsQueryTypeCdnskey DNSTimeseriesGroupResponseCodeParamsQueryType = "CDNSKEY" DNSTimeseriesGroupResponseCodeParamsQueryTypeCds DNSTimeseriesGroupResponseCodeParamsQueryType = "CDS" DNSTimeseriesGroupResponseCodeParamsQueryTypeCERT DNSTimeseriesGroupResponseCodeParamsQueryType = "CERT" DNSTimeseriesGroupResponseCodeParamsQueryTypeCNAME DNSTimeseriesGroupResponseCodeParamsQueryType = "CNAME" DNSTimeseriesGroupResponseCodeParamsQueryTypeCsync DNSTimeseriesGroupResponseCodeParamsQueryType = "CSYNC" DNSTimeseriesGroupResponseCodeParamsQueryTypeDhcid DNSTimeseriesGroupResponseCodeParamsQueryType = "DHCID" DNSTimeseriesGroupResponseCodeParamsQueryTypeDlv DNSTimeseriesGroupResponseCodeParamsQueryType = "DLV" DNSTimeseriesGroupResponseCodeParamsQueryTypeDname DNSTimeseriesGroupResponseCodeParamsQueryType = "DNAME" DNSTimeseriesGroupResponseCodeParamsQueryTypeDNSKEY DNSTimeseriesGroupResponseCodeParamsQueryType = "DNSKEY" DNSTimeseriesGroupResponseCodeParamsQueryTypeDoa DNSTimeseriesGroupResponseCodeParamsQueryType = "DOA" DNSTimeseriesGroupResponseCodeParamsQueryTypeDS DNSTimeseriesGroupResponseCodeParamsQueryType = "DS" DNSTimeseriesGroupResponseCodeParamsQueryTypeEid DNSTimeseriesGroupResponseCodeParamsQueryType = "EID" DNSTimeseriesGroupResponseCodeParamsQueryTypeEui48 DNSTimeseriesGroupResponseCodeParamsQueryType = "EUI48" DNSTimeseriesGroupResponseCodeParamsQueryTypeEui64 DNSTimeseriesGroupResponseCodeParamsQueryType = "EUI64" DNSTimeseriesGroupResponseCodeParamsQueryTypeGpos DNSTimeseriesGroupResponseCodeParamsQueryType = "GPOS" DNSTimeseriesGroupResponseCodeParamsQueryTypeGid DNSTimeseriesGroupResponseCodeParamsQueryType = "GID" DNSTimeseriesGroupResponseCodeParamsQueryTypeHinfo DNSTimeseriesGroupResponseCodeParamsQueryType = "HINFO" DNSTimeseriesGroupResponseCodeParamsQueryTypeHip DNSTimeseriesGroupResponseCodeParamsQueryType = "HIP" DNSTimeseriesGroupResponseCodeParamsQueryTypeHTTPS DNSTimeseriesGroupResponseCodeParamsQueryType = "HTTPS" DNSTimeseriesGroupResponseCodeParamsQueryTypeIpseckey DNSTimeseriesGroupResponseCodeParamsQueryType = "IPSECKEY" DNSTimeseriesGroupResponseCodeParamsQueryTypeIsdn DNSTimeseriesGroupResponseCodeParamsQueryType = "ISDN" DNSTimeseriesGroupResponseCodeParamsQueryTypeIxfr DNSTimeseriesGroupResponseCodeParamsQueryType = "IXFR" DNSTimeseriesGroupResponseCodeParamsQueryTypeKey DNSTimeseriesGroupResponseCodeParamsQueryType = "KEY" DNSTimeseriesGroupResponseCodeParamsQueryTypeKx DNSTimeseriesGroupResponseCodeParamsQueryType = "KX" DNSTimeseriesGroupResponseCodeParamsQueryTypeL32 DNSTimeseriesGroupResponseCodeParamsQueryType = "L32" DNSTimeseriesGroupResponseCodeParamsQueryTypeL64 DNSTimeseriesGroupResponseCodeParamsQueryType = "L64" DNSTimeseriesGroupResponseCodeParamsQueryTypeLOC DNSTimeseriesGroupResponseCodeParamsQueryType = "LOC" DNSTimeseriesGroupResponseCodeParamsQueryTypeLp DNSTimeseriesGroupResponseCodeParamsQueryType = "LP" DNSTimeseriesGroupResponseCodeParamsQueryTypeMaila DNSTimeseriesGroupResponseCodeParamsQueryType = "MAILA" DNSTimeseriesGroupResponseCodeParamsQueryTypeMailb DNSTimeseriesGroupResponseCodeParamsQueryType = "MAILB" DNSTimeseriesGroupResponseCodeParamsQueryTypeMB DNSTimeseriesGroupResponseCodeParamsQueryType = "MB" DNSTimeseriesGroupResponseCodeParamsQueryTypeMd DNSTimeseriesGroupResponseCodeParamsQueryType = "MD" DNSTimeseriesGroupResponseCodeParamsQueryTypeMf DNSTimeseriesGroupResponseCodeParamsQueryType = "MF" DNSTimeseriesGroupResponseCodeParamsQueryTypeMg DNSTimeseriesGroupResponseCodeParamsQueryType = "MG" DNSTimeseriesGroupResponseCodeParamsQueryTypeMinfo DNSTimeseriesGroupResponseCodeParamsQueryType = "MINFO" DNSTimeseriesGroupResponseCodeParamsQueryTypeMr DNSTimeseriesGroupResponseCodeParamsQueryType = "MR" DNSTimeseriesGroupResponseCodeParamsQueryTypeMX DNSTimeseriesGroupResponseCodeParamsQueryType = "MX" DNSTimeseriesGroupResponseCodeParamsQueryTypeNAPTR DNSTimeseriesGroupResponseCodeParamsQueryType = "NAPTR" DNSTimeseriesGroupResponseCodeParamsQueryTypeNb DNSTimeseriesGroupResponseCodeParamsQueryType = "NB" DNSTimeseriesGroupResponseCodeParamsQueryTypeNbstat DNSTimeseriesGroupResponseCodeParamsQueryType = "NBSTAT" DNSTimeseriesGroupResponseCodeParamsQueryTypeNid DNSTimeseriesGroupResponseCodeParamsQueryType = "NID" DNSTimeseriesGroupResponseCodeParamsQueryTypeNimloc DNSTimeseriesGroupResponseCodeParamsQueryType = "NIMLOC" DNSTimeseriesGroupResponseCodeParamsQueryTypeNinfo DNSTimeseriesGroupResponseCodeParamsQueryType = "NINFO" DNSTimeseriesGroupResponseCodeParamsQueryTypeNS DNSTimeseriesGroupResponseCodeParamsQueryType = "NS" DNSTimeseriesGroupResponseCodeParamsQueryTypeNsap DNSTimeseriesGroupResponseCodeParamsQueryType = "NSAP" DNSTimeseriesGroupResponseCodeParamsQueryTypeNsec DNSTimeseriesGroupResponseCodeParamsQueryType = "NSEC" DNSTimeseriesGroupResponseCodeParamsQueryTypeNsec3 DNSTimeseriesGroupResponseCodeParamsQueryType = "NSEC3" DNSTimeseriesGroupResponseCodeParamsQueryTypeNsec3Param DNSTimeseriesGroupResponseCodeParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupResponseCodeParamsQueryTypeNull DNSTimeseriesGroupResponseCodeParamsQueryType = "NULL" DNSTimeseriesGroupResponseCodeParamsQueryTypeNxt DNSTimeseriesGroupResponseCodeParamsQueryType = "NXT" DNSTimeseriesGroupResponseCodeParamsQueryTypeOpenpgpkey DNSTimeseriesGroupResponseCodeParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupResponseCodeParamsQueryTypeOpt DNSTimeseriesGroupResponseCodeParamsQueryType = "OPT" DNSTimeseriesGroupResponseCodeParamsQueryTypePTR DNSTimeseriesGroupResponseCodeParamsQueryType = "PTR" DNSTimeseriesGroupResponseCodeParamsQueryTypePx DNSTimeseriesGroupResponseCodeParamsQueryType = "PX" DNSTimeseriesGroupResponseCodeParamsQueryTypeRkey DNSTimeseriesGroupResponseCodeParamsQueryType = "RKEY" DNSTimeseriesGroupResponseCodeParamsQueryTypeRp DNSTimeseriesGroupResponseCodeParamsQueryType = "RP" DNSTimeseriesGroupResponseCodeParamsQueryTypeRrsig DNSTimeseriesGroupResponseCodeParamsQueryType = "RRSIG" DNSTimeseriesGroupResponseCodeParamsQueryTypeRt DNSTimeseriesGroupResponseCodeParamsQueryType = "RT" DNSTimeseriesGroupResponseCodeParamsQueryTypeSig DNSTimeseriesGroupResponseCodeParamsQueryType = "SIG" DNSTimeseriesGroupResponseCodeParamsQueryTypeSink DNSTimeseriesGroupResponseCodeParamsQueryType = "SINK" DNSTimeseriesGroupResponseCodeParamsQueryTypeSMIMEA DNSTimeseriesGroupResponseCodeParamsQueryType = "SMIMEA" DNSTimeseriesGroupResponseCodeParamsQueryTypeSOA DNSTimeseriesGroupResponseCodeParamsQueryType = "SOA" DNSTimeseriesGroupResponseCodeParamsQueryTypeSPF DNSTimeseriesGroupResponseCodeParamsQueryType = "SPF" DNSTimeseriesGroupResponseCodeParamsQueryTypeSRV DNSTimeseriesGroupResponseCodeParamsQueryType = "SRV" DNSTimeseriesGroupResponseCodeParamsQueryTypeSSHFP DNSTimeseriesGroupResponseCodeParamsQueryType = "SSHFP" DNSTimeseriesGroupResponseCodeParamsQueryTypeSVCB DNSTimeseriesGroupResponseCodeParamsQueryType = "SVCB" DNSTimeseriesGroupResponseCodeParamsQueryTypeTa DNSTimeseriesGroupResponseCodeParamsQueryType = "TA" DNSTimeseriesGroupResponseCodeParamsQueryTypeTalink DNSTimeseriesGroupResponseCodeParamsQueryType = "TALINK" DNSTimeseriesGroupResponseCodeParamsQueryTypeTkey DNSTimeseriesGroupResponseCodeParamsQueryType = "TKEY" DNSTimeseriesGroupResponseCodeParamsQueryTypeTLSA DNSTimeseriesGroupResponseCodeParamsQueryType = "TLSA" DNSTimeseriesGroupResponseCodeParamsQueryTypeTSIG DNSTimeseriesGroupResponseCodeParamsQueryType = "TSIG" DNSTimeseriesGroupResponseCodeParamsQueryTypeTXT DNSTimeseriesGroupResponseCodeParamsQueryType = "TXT" DNSTimeseriesGroupResponseCodeParamsQueryTypeUinfo DNSTimeseriesGroupResponseCodeParamsQueryType = "UINFO" DNSTimeseriesGroupResponseCodeParamsQueryTypeUID DNSTimeseriesGroupResponseCodeParamsQueryType = "UID" DNSTimeseriesGroupResponseCodeParamsQueryTypeUnspec DNSTimeseriesGroupResponseCodeParamsQueryType = "UNSPEC" DNSTimeseriesGroupResponseCodeParamsQueryTypeURI DNSTimeseriesGroupResponseCodeParamsQueryType = "URI" DNSTimeseriesGroupResponseCodeParamsQueryTypeWks DNSTimeseriesGroupResponseCodeParamsQueryType = "WKS" DNSTimeseriesGroupResponseCodeParamsQueryTypeX25 DNSTimeseriesGroupResponseCodeParamsQueryType = "X25" DNSTimeseriesGroupResponseCodeParamsQueryTypeZonemd DNSTimeseriesGroupResponseCodeParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupResponseCodeParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupResponseCodeParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupResponseCodeResponse ¶
type DNSTimeseriesGroupResponseCodeResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupResponseCodeResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupResponseCodeResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupResponseCodeResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseCodeResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeResponseEnvelope ¶
type DNSTimeseriesGroupResponseCodeResponseEnvelope struct {
Result DNSTimeseriesGroupResponseCodeResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupResponseCodeResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseCodeResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeResponseMeta ¶
type DNSTimeseriesGroupResponseCodeResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupResponseCodeResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupResponseCodeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupResponseCodeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupResponseCodeResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupResponseCodeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupResponseCodeResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeResponseMetaAggInterval ¶
type DNSTimeseriesGroupResponseCodeResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupResponseCodeResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupResponseCodeResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupResponseCodeResponseMetaAggIntervalOneHour DNSTimeseriesGroupResponseCodeResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupResponseCodeResponseMetaAggIntervalOneDay DNSTimeseriesGroupResponseCodeResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupResponseCodeResponseMetaAggIntervalOneWeek DNSTimeseriesGroupResponseCodeResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupResponseCodeResponseMetaAggIntervalOneMonth DNSTimeseriesGroupResponseCodeResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupResponseCodeResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupResponseCodeResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupResponseCodeResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupResponseCodeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeResponseMetaDateRange ¶
type DNSTimeseriesGroupResponseCodeResponseMetaDateRange 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 dnsTimeseriesGroupResponseCodeResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseCodeResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeResponseMetaNormalization ¶
type DNSTimeseriesGroupResponseCodeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupResponseCodeResponseMetaNormalizationPercentage DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupResponseCodeResponseMetaNormalizationMin0Max DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupResponseCodeResponseMetaNormalizationMinMax DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupResponseCodeResponseMetaNormalizationRawValues DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupResponseCodeResponseMetaNormalizationPercentageChange DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupResponseCodeResponseMetaNormalizationRollingAverage DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupResponseCodeResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupResponseCodeResponseMetaNormalizationRatio DNSTimeseriesGroupResponseCodeResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupResponseCodeResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupResponseCodeResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupResponseCodeResponseMetaUnit ¶
type DNSTimeseriesGroupResponseCodeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupResponseCodeResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseCodeResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseCodeResponseSerie0 ¶
type DNSTimeseriesGroupResponseCodeResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]string `json:"-,extras"`
JSON dnsTimeseriesGroupResponseCodeResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseCodeResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseCodeResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLParams ¶
type DNSTimeseriesGroupResponseTTLParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesGroupResponseTTLParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesGroupResponseTTLParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesGroupResponseTTLParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesGroupResponseTTLParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesGroupResponseTTLParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesGroupResponseTTLParams) URLQuery ¶
func (r DNSTimeseriesGroupResponseTTLParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesGroupResponseTTLParams's query parameters as `url.Values`.
type DNSTimeseriesGroupResponseTTLParamsAggInterval ¶
type DNSTimeseriesGroupResponseTTLParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupResponseTTLParamsAggInterval15m DNSTimeseriesGroupResponseTTLParamsAggInterval = "15m" DNSTimeseriesGroupResponseTTLParamsAggInterval1h DNSTimeseriesGroupResponseTTLParamsAggInterval = "1h" DNSTimeseriesGroupResponseTTLParamsAggInterval1d DNSTimeseriesGroupResponseTTLParamsAggInterval = "1d" DNSTimeseriesGroupResponseTTLParamsAggInterval1w DNSTimeseriesGroupResponseTTLParamsAggInterval = "1w" )
func (DNSTimeseriesGroupResponseTTLParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupResponseTTLParamsAggInterval) IsKnown() bool
type DNSTimeseriesGroupResponseTTLParamsFormat ¶
type DNSTimeseriesGroupResponseTTLParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesGroupResponseTTLParamsFormatJson DNSTimeseriesGroupResponseTTLParamsFormat = "JSON" DNSTimeseriesGroupResponseTTLParamsFormatCsv DNSTimeseriesGroupResponseTTLParamsFormat = "CSV" )
func (DNSTimeseriesGroupResponseTTLParamsFormat) IsKnown ¶
func (r DNSTimeseriesGroupResponseTTLParamsFormat) IsKnown() bool
type DNSTimeseriesGroupResponseTTLParamsProtocol ¶
type DNSTimeseriesGroupResponseTTLParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesGroupResponseTTLParamsProtocolUdp DNSTimeseriesGroupResponseTTLParamsProtocol = "UDP" DNSTimeseriesGroupResponseTTLParamsProtocolTCP DNSTimeseriesGroupResponseTTLParamsProtocol = "TCP" DNSTimeseriesGroupResponseTTLParamsProtocolHTTPS DNSTimeseriesGroupResponseTTLParamsProtocol = "HTTPS" DNSTimeseriesGroupResponseTTLParamsProtocolTLS DNSTimeseriesGroupResponseTTLParamsProtocol = "TLS" )
func (DNSTimeseriesGroupResponseTTLParamsProtocol) IsKnown ¶
func (r DNSTimeseriesGroupResponseTTLParamsProtocol) IsKnown() bool
type DNSTimeseriesGroupResponseTTLParamsQueryType ¶
type DNSTimeseriesGroupResponseTTLParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesGroupResponseTTLParamsQueryTypeA DNSTimeseriesGroupResponseTTLParamsQueryType = "A" DNSTimeseriesGroupResponseTTLParamsQueryTypeAAAA DNSTimeseriesGroupResponseTTLParamsQueryType = "AAAA" DNSTimeseriesGroupResponseTTLParamsQueryTypeA6 DNSTimeseriesGroupResponseTTLParamsQueryType = "A6" DNSTimeseriesGroupResponseTTLParamsQueryTypeAfsdb DNSTimeseriesGroupResponseTTLParamsQueryType = "AFSDB" DNSTimeseriesGroupResponseTTLParamsQueryTypeAny DNSTimeseriesGroupResponseTTLParamsQueryType = "ANY" DNSTimeseriesGroupResponseTTLParamsQueryTypeApl DNSTimeseriesGroupResponseTTLParamsQueryType = "APL" DNSTimeseriesGroupResponseTTLParamsQueryTypeAtma DNSTimeseriesGroupResponseTTLParamsQueryType = "ATMA" DNSTimeseriesGroupResponseTTLParamsQueryTypeAXFR DNSTimeseriesGroupResponseTTLParamsQueryType = "AXFR" DNSTimeseriesGroupResponseTTLParamsQueryTypeCAA DNSTimeseriesGroupResponseTTLParamsQueryType = "CAA" DNSTimeseriesGroupResponseTTLParamsQueryTypeCdnskey DNSTimeseriesGroupResponseTTLParamsQueryType = "CDNSKEY" DNSTimeseriesGroupResponseTTLParamsQueryTypeCds DNSTimeseriesGroupResponseTTLParamsQueryType = "CDS" DNSTimeseriesGroupResponseTTLParamsQueryTypeCERT DNSTimeseriesGroupResponseTTLParamsQueryType = "CERT" DNSTimeseriesGroupResponseTTLParamsQueryTypeCNAME DNSTimeseriesGroupResponseTTLParamsQueryType = "CNAME" DNSTimeseriesGroupResponseTTLParamsQueryTypeCsync DNSTimeseriesGroupResponseTTLParamsQueryType = "CSYNC" DNSTimeseriesGroupResponseTTLParamsQueryTypeDhcid DNSTimeseriesGroupResponseTTLParamsQueryType = "DHCID" DNSTimeseriesGroupResponseTTLParamsQueryTypeDlv DNSTimeseriesGroupResponseTTLParamsQueryType = "DLV" DNSTimeseriesGroupResponseTTLParamsQueryTypeDname DNSTimeseriesGroupResponseTTLParamsQueryType = "DNAME" DNSTimeseriesGroupResponseTTLParamsQueryTypeDNSKEY DNSTimeseriesGroupResponseTTLParamsQueryType = "DNSKEY" DNSTimeseriesGroupResponseTTLParamsQueryTypeDoa DNSTimeseriesGroupResponseTTLParamsQueryType = "DOA" DNSTimeseriesGroupResponseTTLParamsQueryTypeDS DNSTimeseriesGroupResponseTTLParamsQueryType = "DS" DNSTimeseriesGroupResponseTTLParamsQueryTypeEid DNSTimeseriesGroupResponseTTLParamsQueryType = "EID" DNSTimeseriesGroupResponseTTLParamsQueryTypeEui48 DNSTimeseriesGroupResponseTTLParamsQueryType = "EUI48" DNSTimeseriesGroupResponseTTLParamsQueryTypeEui64 DNSTimeseriesGroupResponseTTLParamsQueryType = "EUI64" DNSTimeseriesGroupResponseTTLParamsQueryTypeGpos DNSTimeseriesGroupResponseTTLParamsQueryType = "GPOS" DNSTimeseriesGroupResponseTTLParamsQueryTypeGid DNSTimeseriesGroupResponseTTLParamsQueryType = "GID" DNSTimeseriesGroupResponseTTLParamsQueryTypeHinfo DNSTimeseriesGroupResponseTTLParamsQueryType = "HINFO" DNSTimeseriesGroupResponseTTLParamsQueryTypeHip DNSTimeseriesGroupResponseTTLParamsQueryType = "HIP" DNSTimeseriesGroupResponseTTLParamsQueryTypeHTTPS DNSTimeseriesGroupResponseTTLParamsQueryType = "HTTPS" DNSTimeseriesGroupResponseTTLParamsQueryTypeIpseckey DNSTimeseriesGroupResponseTTLParamsQueryType = "IPSECKEY" DNSTimeseriesGroupResponseTTLParamsQueryTypeIsdn DNSTimeseriesGroupResponseTTLParamsQueryType = "ISDN" DNSTimeseriesGroupResponseTTLParamsQueryTypeIxfr DNSTimeseriesGroupResponseTTLParamsQueryType = "IXFR" DNSTimeseriesGroupResponseTTLParamsQueryTypeKey DNSTimeseriesGroupResponseTTLParamsQueryType = "KEY" DNSTimeseriesGroupResponseTTLParamsQueryTypeKx DNSTimeseriesGroupResponseTTLParamsQueryType = "KX" DNSTimeseriesGroupResponseTTLParamsQueryTypeL32 DNSTimeseriesGroupResponseTTLParamsQueryType = "L32" DNSTimeseriesGroupResponseTTLParamsQueryTypeL64 DNSTimeseriesGroupResponseTTLParamsQueryType = "L64" DNSTimeseriesGroupResponseTTLParamsQueryTypeLOC DNSTimeseriesGroupResponseTTLParamsQueryType = "LOC" DNSTimeseriesGroupResponseTTLParamsQueryTypeLp DNSTimeseriesGroupResponseTTLParamsQueryType = "LP" DNSTimeseriesGroupResponseTTLParamsQueryTypeMaila DNSTimeseriesGroupResponseTTLParamsQueryType = "MAILA" DNSTimeseriesGroupResponseTTLParamsQueryTypeMailb DNSTimeseriesGroupResponseTTLParamsQueryType = "MAILB" DNSTimeseriesGroupResponseTTLParamsQueryTypeMB DNSTimeseriesGroupResponseTTLParamsQueryType = "MB" DNSTimeseriesGroupResponseTTLParamsQueryTypeMd DNSTimeseriesGroupResponseTTLParamsQueryType = "MD" DNSTimeseriesGroupResponseTTLParamsQueryTypeMf DNSTimeseriesGroupResponseTTLParamsQueryType = "MF" DNSTimeseriesGroupResponseTTLParamsQueryTypeMg DNSTimeseriesGroupResponseTTLParamsQueryType = "MG" DNSTimeseriesGroupResponseTTLParamsQueryTypeMinfo DNSTimeseriesGroupResponseTTLParamsQueryType = "MINFO" DNSTimeseriesGroupResponseTTLParamsQueryTypeMr DNSTimeseriesGroupResponseTTLParamsQueryType = "MR" DNSTimeseriesGroupResponseTTLParamsQueryTypeMX DNSTimeseriesGroupResponseTTLParamsQueryType = "MX" DNSTimeseriesGroupResponseTTLParamsQueryTypeNAPTR DNSTimeseriesGroupResponseTTLParamsQueryType = "NAPTR" DNSTimeseriesGroupResponseTTLParamsQueryTypeNb DNSTimeseriesGroupResponseTTLParamsQueryType = "NB" DNSTimeseriesGroupResponseTTLParamsQueryTypeNbstat DNSTimeseriesGroupResponseTTLParamsQueryType = "NBSTAT" DNSTimeseriesGroupResponseTTLParamsQueryTypeNid DNSTimeseriesGroupResponseTTLParamsQueryType = "NID" DNSTimeseriesGroupResponseTTLParamsQueryTypeNimloc DNSTimeseriesGroupResponseTTLParamsQueryType = "NIMLOC" DNSTimeseriesGroupResponseTTLParamsQueryTypeNinfo DNSTimeseriesGroupResponseTTLParamsQueryType = "NINFO" DNSTimeseriesGroupResponseTTLParamsQueryTypeNS DNSTimeseriesGroupResponseTTLParamsQueryType = "NS" DNSTimeseriesGroupResponseTTLParamsQueryTypeNsap DNSTimeseriesGroupResponseTTLParamsQueryType = "NSAP" DNSTimeseriesGroupResponseTTLParamsQueryTypeNsec DNSTimeseriesGroupResponseTTLParamsQueryType = "NSEC" DNSTimeseriesGroupResponseTTLParamsQueryTypeNsec3 DNSTimeseriesGroupResponseTTLParamsQueryType = "NSEC3" DNSTimeseriesGroupResponseTTLParamsQueryTypeNsec3Param DNSTimeseriesGroupResponseTTLParamsQueryType = "NSEC3PARAM" DNSTimeseriesGroupResponseTTLParamsQueryTypeNull DNSTimeseriesGroupResponseTTLParamsQueryType = "NULL" DNSTimeseriesGroupResponseTTLParamsQueryTypeNxt DNSTimeseriesGroupResponseTTLParamsQueryType = "NXT" DNSTimeseriesGroupResponseTTLParamsQueryTypeOpenpgpkey DNSTimeseriesGroupResponseTTLParamsQueryType = "OPENPGPKEY" DNSTimeseriesGroupResponseTTLParamsQueryTypeOpt DNSTimeseriesGroupResponseTTLParamsQueryType = "OPT" DNSTimeseriesGroupResponseTTLParamsQueryTypePTR DNSTimeseriesGroupResponseTTLParamsQueryType = "PTR" DNSTimeseriesGroupResponseTTLParamsQueryTypePx DNSTimeseriesGroupResponseTTLParamsQueryType = "PX" DNSTimeseriesGroupResponseTTLParamsQueryTypeRkey DNSTimeseriesGroupResponseTTLParamsQueryType = "RKEY" DNSTimeseriesGroupResponseTTLParamsQueryTypeRp DNSTimeseriesGroupResponseTTLParamsQueryType = "RP" DNSTimeseriesGroupResponseTTLParamsQueryTypeRrsig DNSTimeseriesGroupResponseTTLParamsQueryType = "RRSIG" DNSTimeseriesGroupResponseTTLParamsQueryTypeRt DNSTimeseriesGroupResponseTTLParamsQueryType = "RT" DNSTimeseriesGroupResponseTTLParamsQueryTypeSig DNSTimeseriesGroupResponseTTLParamsQueryType = "SIG" DNSTimeseriesGroupResponseTTLParamsQueryTypeSink DNSTimeseriesGroupResponseTTLParamsQueryType = "SINK" DNSTimeseriesGroupResponseTTLParamsQueryTypeSMIMEA DNSTimeseriesGroupResponseTTLParamsQueryType = "SMIMEA" DNSTimeseriesGroupResponseTTLParamsQueryTypeSOA DNSTimeseriesGroupResponseTTLParamsQueryType = "SOA" DNSTimeseriesGroupResponseTTLParamsQueryTypeSPF DNSTimeseriesGroupResponseTTLParamsQueryType = "SPF" DNSTimeseriesGroupResponseTTLParamsQueryTypeSRV DNSTimeseriesGroupResponseTTLParamsQueryType = "SRV" DNSTimeseriesGroupResponseTTLParamsQueryTypeSSHFP DNSTimeseriesGroupResponseTTLParamsQueryType = "SSHFP" DNSTimeseriesGroupResponseTTLParamsQueryTypeSVCB DNSTimeseriesGroupResponseTTLParamsQueryType = "SVCB" DNSTimeseriesGroupResponseTTLParamsQueryTypeTa DNSTimeseriesGroupResponseTTLParamsQueryType = "TA" DNSTimeseriesGroupResponseTTLParamsQueryTypeTalink DNSTimeseriesGroupResponseTTLParamsQueryType = "TALINK" DNSTimeseriesGroupResponseTTLParamsQueryTypeTkey DNSTimeseriesGroupResponseTTLParamsQueryType = "TKEY" DNSTimeseriesGroupResponseTTLParamsQueryTypeTLSA DNSTimeseriesGroupResponseTTLParamsQueryType = "TLSA" DNSTimeseriesGroupResponseTTLParamsQueryTypeTSIG DNSTimeseriesGroupResponseTTLParamsQueryType = "TSIG" DNSTimeseriesGroupResponseTTLParamsQueryTypeTXT DNSTimeseriesGroupResponseTTLParamsQueryType = "TXT" DNSTimeseriesGroupResponseTTLParamsQueryTypeUinfo DNSTimeseriesGroupResponseTTLParamsQueryType = "UINFO" DNSTimeseriesGroupResponseTTLParamsQueryTypeUID DNSTimeseriesGroupResponseTTLParamsQueryType = "UID" DNSTimeseriesGroupResponseTTLParamsQueryTypeUnspec DNSTimeseriesGroupResponseTTLParamsQueryType = "UNSPEC" DNSTimeseriesGroupResponseTTLParamsQueryTypeURI DNSTimeseriesGroupResponseTTLParamsQueryType = "URI" DNSTimeseriesGroupResponseTTLParamsQueryTypeWks DNSTimeseriesGroupResponseTTLParamsQueryType = "WKS" DNSTimeseriesGroupResponseTTLParamsQueryTypeX25 DNSTimeseriesGroupResponseTTLParamsQueryType = "X25" DNSTimeseriesGroupResponseTTLParamsQueryTypeZonemd DNSTimeseriesGroupResponseTTLParamsQueryType = "ZONEMD" )
func (DNSTimeseriesGroupResponseTTLParamsQueryType) IsKnown ¶
func (r DNSTimeseriesGroupResponseTTLParamsQueryType) IsKnown() bool
type DNSTimeseriesGroupResponseTTLParamsResponseCode ¶
type DNSTimeseriesGroupResponseTTLParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesGroupResponseTTLParamsResponseCodeNoerror DNSTimeseriesGroupResponseTTLParamsResponseCode = "NOERROR" DNSTimeseriesGroupResponseTTLParamsResponseCodeFormerr DNSTimeseriesGroupResponseTTLParamsResponseCode = "FORMERR" DNSTimeseriesGroupResponseTTLParamsResponseCodeServfail DNSTimeseriesGroupResponseTTLParamsResponseCode = "SERVFAIL" DNSTimeseriesGroupResponseTTLParamsResponseCodeNxdomain DNSTimeseriesGroupResponseTTLParamsResponseCode = "NXDOMAIN" DNSTimeseriesGroupResponseTTLParamsResponseCodeNotimp DNSTimeseriesGroupResponseTTLParamsResponseCode = "NOTIMP" DNSTimeseriesGroupResponseTTLParamsResponseCodeRefused DNSTimeseriesGroupResponseTTLParamsResponseCode = "REFUSED" DNSTimeseriesGroupResponseTTLParamsResponseCodeYxdomain DNSTimeseriesGroupResponseTTLParamsResponseCode = "YXDOMAIN" DNSTimeseriesGroupResponseTTLParamsResponseCodeYxrrset DNSTimeseriesGroupResponseTTLParamsResponseCode = "YXRRSET" DNSTimeseriesGroupResponseTTLParamsResponseCodeNxrrset DNSTimeseriesGroupResponseTTLParamsResponseCode = "NXRRSET" DNSTimeseriesGroupResponseTTLParamsResponseCodeNotauth DNSTimeseriesGroupResponseTTLParamsResponseCode = "NOTAUTH" DNSTimeseriesGroupResponseTTLParamsResponseCodeNotzone DNSTimeseriesGroupResponseTTLParamsResponseCode = "NOTZONE" DNSTimeseriesGroupResponseTTLParamsResponseCodeBadsig DNSTimeseriesGroupResponseTTLParamsResponseCode = "BADSIG" DNSTimeseriesGroupResponseTTLParamsResponseCodeBadkey DNSTimeseriesGroupResponseTTLParamsResponseCode = "BADKEY" DNSTimeseriesGroupResponseTTLParamsResponseCodeBadtime DNSTimeseriesGroupResponseTTLParamsResponseCode = "BADTIME" DNSTimeseriesGroupResponseTTLParamsResponseCodeBadmode DNSTimeseriesGroupResponseTTLParamsResponseCode = "BADMODE" DNSTimeseriesGroupResponseTTLParamsResponseCodeBadname DNSTimeseriesGroupResponseTTLParamsResponseCode = "BADNAME" DNSTimeseriesGroupResponseTTLParamsResponseCodeBadalg DNSTimeseriesGroupResponseTTLParamsResponseCode = "BADALG" DNSTimeseriesGroupResponseTTLParamsResponseCodeBadtrunc DNSTimeseriesGroupResponseTTLParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesGroupResponseTTLParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesGroupResponseTTLParamsResponseCode) IsKnown() bool
type DNSTimeseriesGroupResponseTTLResponse ¶
type DNSTimeseriesGroupResponseTTLResponse struct {
// Metadata for the results.
Meta DNSTimeseriesGroupResponseTTLResponseMeta `json:"meta,required"`
Serie0 DNSTimeseriesGroupResponseTTLResponseSerie0 `json:"serie_0,required"`
JSON dnsTimeseriesGroupResponseTTLResponseJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseTTLResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLResponseEnvelope ¶
type DNSTimeseriesGroupResponseTTLResponseEnvelope struct {
Result DNSTimeseriesGroupResponseTTLResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesGroupResponseTTLResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseTTLResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLResponseMeta ¶
type DNSTimeseriesGroupResponseTTLResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesGroupResponseTTLResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesGroupResponseTTLResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesGroupResponseTTLResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesGroupResponseTTLResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesGroupResponseTTLResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesGroupResponseTTLResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLResponseMetaAggInterval ¶
type DNSTimeseriesGroupResponseTTLResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesGroupResponseTTLResponseMetaAggIntervalFifteenMinutes DNSTimeseriesGroupResponseTTLResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesGroupResponseTTLResponseMetaAggIntervalOneHour DNSTimeseriesGroupResponseTTLResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesGroupResponseTTLResponseMetaAggIntervalOneDay DNSTimeseriesGroupResponseTTLResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesGroupResponseTTLResponseMetaAggIntervalOneWeek DNSTimeseriesGroupResponseTTLResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesGroupResponseTTLResponseMetaAggIntervalOneMonth DNSTimeseriesGroupResponseTTLResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesGroupResponseTTLResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesGroupResponseTTLResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfo ¶
type DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesGroupResponseTTLResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesGroupResponseTTLResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLResponseMetaDateRange ¶
type DNSTimeseriesGroupResponseTTLResponseMetaDateRange 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 dnsTimeseriesGroupResponseTTLResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseTTLResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLResponseMetaNormalization ¶
type DNSTimeseriesGroupResponseTTLResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesGroupResponseTTLResponseMetaNormalizationPercentage DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesGroupResponseTTLResponseMetaNormalizationMin0Max DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesGroupResponseTTLResponseMetaNormalizationMinMax DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "MIN_MAX" DNSTimeseriesGroupResponseTTLResponseMetaNormalizationRawValues DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesGroupResponseTTLResponseMetaNormalizationPercentageChange DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesGroupResponseTTLResponseMetaNormalizationRollingAverage DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesGroupResponseTTLResponseMetaNormalizationOverlappedPercentage DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesGroupResponseTTLResponseMetaNormalizationRatio DNSTimeseriesGroupResponseTTLResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesGroupResponseTTLResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesGroupResponseTTLResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesGroupResponseTTLResponseMetaUnit ¶
type DNSTimeseriesGroupResponseTTLResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesGroupResponseTTLResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseTTLResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupResponseTTLResponseSerie0 ¶
type DNSTimeseriesGroupResponseTTLResponseSerie0 struct {
Gt15mLte1h []string `json:"gt_15m_lte_1h,required"`
Gt1dLte1w []string `json:"gt_1d_lte_1w,required"`
Gt1hLte1d []string `json:"gt_1h_lte_1d,required"`
Gt1mLte5m []string `json:"gt_1m_lte_5m,required"`
Gt1w []string `json:"gt_1w,required"`
Gt5mLte15m []string `json:"gt_5m_lte_15m,required"`
Lte1m []string `json:"lte_1m,required"`
JSON dnsTimeseriesGroupResponseTTLResponseSerie0JSON `json:"-"`
}
func (*DNSTimeseriesGroupResponseTTLResponseSerie0) UnmarshalJSON ¶
func (r *DNSTimeseriesGroupResponseTTLResponseSerie0) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesGroupService ¶
type DNSTimeseriesGroupService struct {
Options []option.RequestOption
}
DNSTimeseriesGroupService 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 NewDNSTimeseriesGroupService method instead.
func NewDNSTimeseriesGroupService ¶
func NewDNSTimeseriesGroupService(opts ...option.RequestOption) (r *DNSTimeseriesGroupService)
NewDNSTimeseriesGroupService 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 (*DNSTimeseriesGroupService) CacheHit ¶
func (r *DNSTimeseriesGroupService) CacheHit(ctx context.Context, query DNSTimeseriesGroupCacheHitParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupCacheHitResponse, err error)
Retrieves the distribution of DNS queries by cache status over time.
func (*DNSTimeseriesGroupService) DNSSEC ¶
func (r *DNSTimeseriesGroupService) DNSSEC(ctx context.Context, query DNSTimeseriesGroupDNSSECParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupDNSSECResponse, err error)
Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) support over time.
func (*DNSTimeseriesGroupService) DNSSECAware ¶
func (r *DNSTimeseriesGroupService) DNSSECAware(ctx context.Context, query DNSTimeseriesGroupDNSSECAwareParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupDNSSECAwareResponse, err error)
Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) client awareness over time.
func (*DNSTimeseriesGroupService) DNSSECE2E ¶
func (r *DNSTimeseriesGroupService) DNSSECE2E(ctx context.Context, query DNSTimeseriesGroupDNSSECE2EParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupDnssece2EResponse, err error)
Retrieves the distribution of DNSSEC-validated answers by end-to-end security status over time.
func (*DNSTimeseriesGroupService) IPVersion ¶
func (r *DNSTimeseriesGroupService) IPVersion(ctx context.Context, query DNSTimeseriesGroupIPVersionParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupIPVersionResponse, err error)
Retrieves the distribution of DNS queries by IP version over time.
func (*DNSTimeseriesGroupService) MatchingAnswer ¶
func (r *DNSTimeseriesGroupService) MatchingAnswer(ctx context.Context, query DNSTimeseriesGroupMatchingAnswerParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupMatchingAnswerResponse, err error)
Retrieves the distribution of DNS queries by matching answers over time.
func (*DNSTimeseriesGroupService) Protocol ¶
func (r *DNSTimeseriesGroupService) Protocol(ctx context.Context, query DNSTimeseriesGroupProtocolParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupProtocolResponse, err error)
Retrieves the distribution of DNS queries by DNS transport protocol over time.
func (*DNSTimeseriesGroupService) QueryType ¶
func (r *DNSTimeseriesGroupService) QueryType(ctx context.Context, query DNSTimeseriesGroupQueryTypeParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupQueryTypeResponse, err error)
Retrieves the distribution of DNS queries by type over time.
func (*DNSTimeseriesGroupService) ResponseCode ¶
func (r *DNSTimeseriesGroupService) ResponseCode(ctx context.Context, query DNSTimeseriesGroupResponseCodeParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupResponseCodeResponse, err error)
Retrieves the distribution of DNS queries by response code over time.
func (*DNSTimeseriesGroupService) ResponseTTL ¶
func (r *DNSTimeseriesGroupService) ResponseTTL(ctx context.Context, query DNSTimeseriesGroupResponseTTLParams, opts ...option.RequestOption) (res *DNSTimeseriesGroupResponseTTLResponse, err error)
Retrieves the distribution of DNS queries by minimum answer TTL over time.
type DNSTimeseriesParams ¶
type DNSTimeseriesParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[DNSTimeseriesParamsAggInterval] `query:"aggInterval"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[DNSTimeseriesParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies whether the response includes empty DNS responses (NODATA).
Nodata param.Field[bool] `query:"nodata"`
// Filters results by DNS transport protocol.
Protocol param.Field[DNSTimeseriesParamsProtocol] `query:"protocol"`
// Filters results by DNS query type.
QueryType param.Field[DNSTimeseriesParamsQueryType] `query:"queryType"`
// Filters results by DNS response code.
ResponseCode param.Field[DNSTimeseriesParamsResponseCode] `query:"responseCode"`
// Filters results by country code top-level domain (ccTLD).
Tld param.Field[[]string] `query:"tld"`
}
func (DNSTimeseriesParams) URLQuery ¶
func (r DNSTimeseriesParams) URLQuery() (v url.Values)
URLQuery serializes DNSTimeseriesParams's query parameters as `url.Values`.
type DNSTimeseriesParamsAggInterval ¶
type DNSTimeseriesParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesParamsAggInterval15m DNSTimeseriesParamsAggInterval = "15m" DNSTimeseriesParamsAggInterval1h DNSTimeseriesParamsAggInterval = "1h" DNSTimeseriesParamsAggInterval1d DNSTimeseriesParamsAggInterval = "1d" DNSTimeseriesParamsAggInterval1w DNSTimeseriesParamsAggInterval = "1w" )
func (DNSTimeseriesParamsAggInterval) IsKnown ¶
func (r DNSTimeseriesParamsAggInterval) IsKnown() bool
type DNSTimeseriesParamsFormat ¶
type DNSTimeseriesParamsFormat string
Format in which results will be returned.
const ( DNSTimeseriesParamsFormatJson DNSTimeseriesParamsFormat = "JSON" DNSTimeseriesParamsFormatCsv DNSTimeseriesParamsFormat = "CSV" )
func (DNSTimeseriesParamsFormat) IsKnown ¶
func (r DNSTimeseriesParamsFormat) IsKnown() bool
type DNSTimeseriesParamsProtocol ¶
type DNSTimeseriesParamsProtocol string
Filters results by DNS transport protocol.
const ( DNSTimeseriesParamsProtocolUdp DNSTimeseriesParamsProtocol = "UDP" DNSTimeseriesParamsProtocolTCP DNSTimeseriesParamsProtocol = "TCP" DNSTimeseriesParamsProtocolHTTPS DNSTimeseriesParamsProtocol = "HTTPS" DNSTimeseriesParamsProtocolTLS DNSTimeseriesParamsProtocol = "TLS" )
func (DNSTimeseriesParamsProtocol) IsKnown ¶
func (r DNSTimeseriesParamsProtocol) IsKnown() bool
type DNSTimeseriesParamsQueryType ¶
type DNSTimeseriesParamsQueryType string
Filters results by DNS query type.
const ( DNSTimeseriesParamsQueryTypeA DNSTimeseriesParamsQueryType = "A" DNSTimeseriesParamsQueryTypeAAAA DNSTimeseriesParamsQueryType = "AAAA" DNSTimeseriesParamsQueryTypeA6 DNSTimeseriesParamsQueryType = "A6" DNSTimeseriesParamsQueryTypeAfsdb DNSTimeseriesParamsQueryType = "AFSDB" DNSTimeseriesParamsQueryTypeAny DNSTimeseriesParamsQueryType = "ANY" DNSTimeseriesParamsQueryTypeApl DNSTimeseriesParamsQueryType = "APL" DNSTimeseriesParamsQueryTypeAtma DNSTimeseriesParamsQueryType = "ATMA" DNSTimeseriesParamsQueryTypeAXFR DNSTimeseriesParamsQueryType = "AXFR" DNSTimeseriesParamsQueryTypeCAA DNSTimeseriesParamsQueryType = "CAA" DNSTimeseriesParamsQueryTypeCdnskey DNSTimeseriesParamsQueryType = "CDNSKEY" DNSTimeseriesParamsQueryTypeCds DNSTimeseriesParamsQueryType = "CDS" DNSTimeseriesParamsQueryTypeCERT DNSTimeseriesParamsQueryType = "CERT" DNSTimeseriesParamsQueryTypeCNAME DNSTimeseriesParamsQueryType = "CNAME" DNSTimeseriesParamsQueryTypeCsync DNSTimeseriesParamsQueryType = "CSYNC" DNSTimeseriesParamsQueryTypeDhcid DNSTimeseriesParamsQueryType = "DHCID" DNSTimeseriesParamsQueryTypeDlv DNSTimeseriesParamsQueryType = "DLV" DNSTimeseriesParamsQueryTypeDname DNSTimeseriesParamsQueryType = "DNAME" DNSTimeseriesParamsQueryTypeDNSKEY DNSTimeseriesParamsQueryType = "DNSKEY" DNSTimeseriesParamsQueryTypeDoa DNSTimeseriesParamsQueryType = "DOA" DNSTimeseriesParamsQueryTypeDS DNSTimeseriesParamsQueryType = "DS" DNSTimeseriesParamsQueryTypeEid DNSTimeseriesParamsQueryType = "EID" DNSTimeseriesParamsQueryTypeEui48 DNSTimeseriesParamsQueryType = "EUI48" DNSTimeseriesParamsQueryTypeEui64 DNSTimeseriesParamsQueryType = "EUI64" DNSTimeseriesParamsQueryTypeGpos DNSTimeseriesParamsQueryType = "GPOS" DNSTimeseriesParamsQueryTypeGid DNSTimeseriesParamsQueryType = "GID" DNSTimeseriesParamsQueryTypeHinfo DNSTimeseriesParamsQueryType = "HINFO" DNSTimeseriesParamsQueryTypeHip DNSTimeseriesParamsQueryType = "HIP" DNSTimeseriesParamsQueryTypeHTTPS DNSTimeseriesParamsQueryType = "HTTPS" DNSTimeseriesParamsQueryTypeIpseckey DNSTimeseriesParamsQueryType = "IPSECKEY" DNSTimeseriesParamsQueryTypeIsdn DNSTimeseriesParamsQueryType = "ISDN" DNSTimeseriesParamsQueryTypeIxfr DNSTimeseriesParamsQueryType = "IXFR" DNSTimeseriesParamsQueryTypeKey DNSTimeseriesParamsQueryType = "KEY" DNSTimeseriesParamsQueryTypeKx DNSTimeseriesParamsQueryType = "KX" DNSTimeseriesParamsQueryTypeL32 DNSTimeseriesParamsQueryType = "L32" DNSTimeseriesParamsQueryTypeL64 DNSTimeseriesParamsQueryType = "L64" DNSTimeseriesParamsQueryTypeLOC DNSTimeseriesParamsQueryType = "LOC" DNSTimeseriesParamsQueryTypeLp DNSTimeseriesParamsQueryType = "LP" DNSTimeseriesParamsQueryTypeMaila DNSTimeseriesParamsQueryType = "MAILA" DNSTimeseriesParamsQueryTypeMailb DNSTimeseriesParamsQueryType = "MAILB" DNSTimeseriesParamsQueryTypeMB DNSTimeseriesParamsQueryType = "MB" DNSTimeseriesParamsQueryTypeMd DNSTimeseriesParamsQueryType = "MD" DNSTimeseriesParamsQueryTypeMf DNSTimeseriesParamsQueryType = "MF" DNSTimeseriesParamsQueryTypeMg DNSTimeseriesParamsQueryType = "MG" DNSTimeseriesParamsQueryTypeMinfo DNSTimeseriesParamsQueryType = "MINFO" DNSTimeseriesParamsQueryTypeMr DNSTimeseriesParamsQueryType = "MR" DNSTimeseriesParamsQueryTypeMX DNSTimeseriesParamsQueryType = "MX" DNSTimeseriesParamsQueryTypeNAPTR DNSTimeseriesParamsQueryType = "NAPTR" DNSTimeseriesParamsQueryTypeNb DNSTimeseriesParamsQueryType = "NB" DNSTimeseriesParamsQueryTypeNbstat DNSTimeseriesParamsQueryType = "NBSTAT" DNSTimeseriesParamsQueryTypeNid DNSTimeseriesParamsQueryType = "NID" DNSTimeseriesParamsQueryTypeNimloc DNSTimeseriesParamsQueryType = "NIMLOC" DNSTimeseriesParamsQueryTypeNinfo DNSTimeseriesParamsQueryType = "NINFO" DNSTimeseriesParamsQueryTypeNS DNSTimeseriesParamsQueryType = "NS" DNSTimeseriesParamsQueryTypeNsap DNSTimeseriesParamsQueryType = "NSAP" DNSTimeseriesParamsQueryTypeNsec DNSTimeseriesParamsQueryType = "NSEC" DNSTimeseriesParamsQueryTypeNsec3 DNSTimeseriesParamsQueryType = "NSEC3" DNSTimeseriesParamsQueryTypeNsec3Param DNSTimeseriesParamsQueryType = "NSEC3PARAM" DNSTimeseriesParamsQueryTypeNull DNSTimeseriesParamsQueryType = "NULL" DNSTimeseriesParamsQueryTypeNxt DNSTimeseriesParamsQueryType = "NXT" DNSTimeseriesParamsQueryTypeOpenpgpkey DNSTimeseriesParamsQueryType = "OPENPGPKEY" DNSTimeseriesParamsQueryTypeOpt DNSTimeseriesParamsQueryType = "OPT" DNSTimeseriesParamsQueryTypePTR DNSTimeseriesParamsQueryType = "PTR" DNSTimeseriesParamsQueryTypePx DNSTimeseriesParamsQueryType = "PX" DNSTimeseriesParamsQueryTypeRkey DNSTimeseriesParamsQueryType = "RKEY" DNSTimeseriesParamsQueryTypeRp DNSTimeseriesParamsQueryType = "RP" DNSTimeseriesParamsQueryTypeRrsig DNSTimeseriesParamsQueryType = "RRSIG" DNSTimeseriesParamsQueryTypeRt DNSTimeseriesParamsQueryType = "RT" DNSTimeseriesParamsQueryTypeSig DNSTimeseriesParamsQueryType = "SIG" DNSTimeseriesParamsQueryTypeSink DNSTimeseriesParamsQueryType = "SINK" DNSTimeseriesParamsQueryTypeSMIMEA DNSTimeseriesParamsQueryType = "SMIMEA" DNSTimeseriesParamsQueryTypeSOA DNSTimeseriesParamsQueryType = "SOA" DNSTimeseriesParamsQueryTypeSPF DNSTimeseriesParamsQueryType = "SPF" DNSTimeseriesParamsQueryTypeSRV DNSTimeseriesParamsQueryType = "SRV" DNSTimeseriesParamsQueryTypeSSHFP DNSTimeseriesParamsQueryType = "SSHFP" DNSTimeseriesParamsQueryTypeSVCB DNSTimeseriesParamsQueryType = "SVCB" DNSTimeseriesParamsQueryTypeTa DNSTimeseriesParamsQueryType = "TA" DNSTimeseriesParamsQueryTypeTalink DNSTimeseriesParamsQueryType = "TALINK" DNSTimeseriesParamsQueryTypeTkey DNSTimeseriesParamsQueryType = "TKEY" DNSTimeseriesParamsQueryTypeTLSA DNSTimeseriesParamsQueryType = "TLSA" DNSTimeseriesParamsQueryTypeTSIG DNSTimeseriesParamsQueryType = "TSIG" DNSTimeseriesParamsQueryTypeTXT DNSTimeseriesParamsQueryType = "TXT" DNSTimeseriesParamsQueryTypeUinfo DNSTimeseriesParamsQueryType = "UINFO" DNSTimeseriesParamsQueryTypeUID DNSTimeseriesParamsQueryType = "UID" DNSTimeseriesParamsQueryTypeUnspec DNSTimeseriesParamsQueryType = "UNSPEC" DNSTimeseriesParamsQueryTypeURI DNSTimeseriesParamsQueryType = "URI" DNSTimeseriesParamsQueryTypeWks DNSTimeseriesParamsQueryType = "WKS" DNSTimeseriesParamsQueryTypeX25 DNSTimeseriesParamsQueryType = "X25" DNSTimeseriesParamsQueryTypeZonemd DNSTimeseriesParamsQueryType = "ZONEMD" )
func (DNSTimeseriesParamsQueryType) IsKnown ¶
func (r DNSTimeseriesParamsQueryType) IsKnown() bool
type DNSTimeseriesParamsResponseCode ¶
type DNSTimeseriesParamsResponseCode string
Filters results by DNS response code.
const ( DNSTimeseriesParamsResponseCodeNoerror DNSTimeseriesParamsResponseCode = "NOERROR" DNSTimeseriesParamsResponseCodeFormerr DNSTimeseriesParamsResponseCode = "FORMERR" DNSTimeseriesParamsResponseCodeServfail DNSTimeseriesParamsResponseCode = "SERVFAIL" DNSTimeseriesParamsResponseCodeNxdomain DNSTimeseriesParamsResponseCode = "NXDOMAIN" DNSTimeseriesParamsResponseCodeNotimp DNSTimeseriesParamsResponseCode = "NOTIMP" DNSTimeseriesParamsResponseCodeRefused DNSTimeseriesParamsResponseCode = "REFUSED" DNSTimeseriesParamsResponseCodeYxdomain DNSTimeseriesParamsResponseCode = "YXDOMAIN" DNSTimeseriesParamsResponseCodeYxrrset DNSTimeseriesParamsResponseCode = "YXRRSET" DNSTimeseriesParamsResponseCodeNxrrset DNSTimeseriesParamsResponseCode = "NXRRSET" DNSTimeseriesParamsResponseCodeNotauth DNSTimeseriesParamsResponseCode = "NOTAUTH" DNSTimeseriesParamsResponseCodeNotzone DNSTimeseriesParamsResponseCode = "NOTZONE" DNSTimeseriesParamsResponseCodeBadsig DNSTimeseriesParamsResponseCode = "BADSIG" DNSTimeseriesParamsResponseCodeBadkey DNSTimeseriesParamsResponseCode = "BADKEY" DNSTimeseriesParamsResponseCodeBadtime DNSTimeseriesParamsResponseCode = "BADTIME" DNSTimeseriesParamsResponseCodeBadmode DNSTimeseriesParamsResponseCode = "BADMODE" DNSTimeseriesParamsResponseCodeBadname DNSTimeseriesParamsResponseCode = "BADNAME" DNSTimeseriesParamsResponseCodeBadalg DNSTimeseriesParamsResponseCode = "BADALG" DNSTimeseriesParamsResponseCodeBadtrunc DNSTimeseriesParamsResponseCode = "BADTRUNC" )
func (DNSTimeseriesParamsResponseCode) IsKnown ¶
func (r DNSTimeseriesParamsResponseCode) IsKnown() bool
type DNSTimeseriesResponse ¶
type DNSTimeseriesResponse struct {
// Metadata for the results.
Meta DNSTimeseriesResponseMeta `json:"meta,required"`
ExtraFields map[string]DNSTimeseriesResponse `json:"-,extras"`
JSON dnsTimeseriesResponseJSON `json:"-"`
}
func (*DNSTimeseriesResponse) UnmarshalJSON ¶
func (r *DNSTimeseriesResponse) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesResponseEnvelope ¶
type DNSTimeseriesResponseEnvelope struct {
Result DNSTimeseriesResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON dnsTimeseriesResponseEnvelopeJSON `json:"-"`
}
func (*DNSTimeseriesResponseEnvelope) UnmarshalJSON ¶
func (r *DNSTimeseriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesResponseMeta ¶
type DNSTimeseriesResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval DNSTimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo DNSTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []DNSTimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTimeseriesResponseMetaUnit `json:"units,required"`
JSON dnsTimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTimeseriesResponseMeta) UnmarshalJSON ¶
func (r *DNSTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesResponseMetaAggInterval ¶
type DNSTimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( DNSTimeseriesResponseMetaAggIntervalFifteenMinutes DNSTimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" DNSTimeseriesResponseMetaAggIntervalOneHour DNSTimeseriesResponseMetaAggInterval = "ONE_HOUR" DNSTimeseriesResponseMetaAggIntervalOneDay DNSTimeseriesResponseMetaAggInterval = "ONE_DAY" DNSTimeseriesResponseMetaAggIntervalOneWeek DNSTimeseriesResponseMetaAggInterval = "ONE_WEEK" DNSTimeseriesResponseMetaAggIntervalOneMonth DNSTimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (DNSTimeseriesResponseMetaAggInterval) IsKnown ¶
func (r DNSTimeseriesResponseMetaAggInterval) IsKnown() bool
type DNSTimeseriesResponseMetaConfidenceInfo ¶
type DNSTimeseriesResponseMetaConfidenceInfo struct {
Annotations []DNSTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON dnsTimeseriesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*DNSTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *DNSTimeseriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesResponseMetaConfidenceInfoAnnotation ¶
type DNSTimeseriesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*DNSTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *DNSTimeseriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesResponseMetaDateRange ¶
type DNSTimeseriesResponseMetaDateRange 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 dnsTimeseriesResponseMetaDateRangeJSON `json:"-"`
}
func (*DNSTimeseriesResponseMetaDateRange) UnmarshalJSON ¶
func (r *DNSTimeseriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type DNSTimeseriesResponseMetaNormalization ¶
type DNSTimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTimeseriesResponseMetaNormalizationPercentage DNSTimeseriesResponseMetaNormalization = "PERCENTAGE" DNSTimeseriesResponseMetaNormalizationMin0Max DNSTimeseriesResponseMetaNormalization = "MIN0_MAX" DNSTimeseriesResponseMetaNormalizationMinMax DNSTimeseriesResponseMetaNormalization = "MIN_MAX" DNSTimeseriesResponseMetaNormalizationRawValues DNSTimeseriesResponseMetaNormalization = "RAW_VALUES" DNSTimeseriesResponseMetaNormalizationPercentageChange DNSTimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTimeseriesResponseMetaNormalizationRollingAverage DNSTimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" DNSTimeseriesResponseMetaNormalizationOverlappedPercentage DNSTimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTimeseriesResponseMetaNormalizationRatio DNSTimeseriesResponseMetaNormalization = "RATIO" )
func (DNSTimeseriesResponseMetaNormalization) IsKnown ¶
func (r DNSTimeseriesResponseMetaNormalization) IsKnown() bool
type DNSTimeseriesResponseMetaUnit ¶
type DNSTimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*DNSTimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTimeseriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTopAsesParams ¶
type DNSTopAsesParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by domain name.
Domain param.Field[[]string] `query:"domain"`
// Format in which results will be returned.
Format param.Field[DNSTopAsesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( DNSTopAsesParamsFormatJson DNSTopAsesParamsFormat = "JSON" DNSTopAsesParamsFormatCsv DNSTopAsesParamsFormat = "CSV" )
func (DNSTopAsesParamsFormat) IsKnown ¶
func (r DNSTopAsesParamsFormat) IsKnown() bool
type DNSTopAsesResponse ¶
type DNSTopAsesResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo DNSTopAsesResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []DNSTopAsesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTopAsesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTopAsesResponseMetaUnit `json:"units,required"`
JSON dnsTopAsesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTopAsesResponseMeta) UnmarshalJSON ¶
func (r *DNSTopAsesResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTopAsesResponseMetaConfidenceInfo ¶
type DNSTopAsesResponseMetaConfidenceInfo struct {
Annotations []DNSTopAsesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTopAsesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 DNSTopAsesResponseMetaNormalization ¶
type DNSTopAsesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTopAsesResponseMetaNormalizationPercentage DNSTopAsesResponseMetaNormalization = "PERCENTAGE" DNSTopAsesResponseMetaNormalizationMin0Max DNSTopAsesResponseMetaNormalization = "MIN0_MAX" DNSTopAsesResponseMetaNormalizationMinMax DNSTopAsesResponseMetaNormalization = "MIN_MAX" DNSTopAsesResponseMetaNormalizationRawValues DNSTopAsesResponseMetaNormalization = "RAW_VALUES" DNSTopAsesResponseMetaNormalizationPercentageChange DNSTopAsesResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTopAsesResponseMetaNormalizationRollingAverage DNSTopAsesResponseMetaNormalization = "ROLLING_AVERAGE" DNSTopAsesResponseMetaNormalizationOverlappedPercentage DNSTopAsesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTopAsesResponseMetaNormalizationRatio DNSTopAsesResponseMetaNormalization = "RATIO" )
func (DNSTopAsesResponseMetaNormalization) IsKnown ¶
func (r DNSTopAsesResponseMetaNormalization) IsKnown() bool
type DNSTopAsesResponseMetaUnit ¶
type DNSTopAsesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTopAsesResponseMetaUnitJSON `json:"-"`
}
func (*DNSTopAsesResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTopAsesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTopAsesResponseTop0 ¶
type DNSTopAsesResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
Value string `json:"value,required"`
JSON dnsTopAsesResponseTop0JSON `json:"-"`
}
func (*DNSTopAsesResponseTop0) UnmarshalJSON ¶
func (r *DNSTopAsesResponseTop0) UnmarshalJSON(data []byte) (err error)
type DNSTopLocationsParams ¶
type DNSTopLocationsParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by domain name.
Domain param.Field[[]string] `query:"domain"`
// Format in which results will be returned.
Format param.Field[DNSTopLocationsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( DNSTopLocationsParamsFormatJson DNSTopLocationsParamsFormat = "JSON" DNSTopLocationsParamsFormatCsv DNSTopLocationsParamsFormat = "CSV" )
func (DNSTopLocationsParamsFormat) IsKnown ¶
func (r DNSTopLocationsParamsFormat) IsKnown() bool
type DNSTopLocationsResponse ¶
type DNSTopLocationsResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo DNSTopLocationsResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []DNSTopLocationsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization DNSTopLocationsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []DNSTopLocationsResponseMetaUnit `json:"units,required"`
JSON dnsTopLocationsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*DNSTopLocationsResponseMeta) UnmarshalJSON ¶
func (r *DNSTopLocationsResponseMeta) UnmarshalJSON(data []byte) (err error)
type DNSTopLocationsResponseMetaConfidenceInfo ¶
type DNSTopLocationsResponseMetaConfidenceInfo struct {
Annotations []DNSTopLocationsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON dnsTopLocationsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 DNSTopLocationsResponseMetaNormalization ¶
type DNSTopLocationsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( DNSTopLocationsResponseMetaNormalizationPercentage DNSTopLocationsResponseMetaNormalization = "PERCENTAGE" DNSTopLocationsResponseMetaNormalizationMin0Max DNSTopLocationsResponseMetaNormalization = "MIN0_MAX" DNSTopLocationsResponseMetaNormalizationMinMax DNSTopLocationsResponseMetaNormalization = "MIN_MAX" DNSTopLocationsResponseMetaNormalizationRawValues DNSTopLocationsResponseMetaNormalization = "RAW_VALUES" DNSTopLocationsResponseMetaNormalizationPercentageChange DNSTopLocationsResponseMetaNormalization = "PERCENTAGE_CHANGE" DNSTopLocationsResponseMetaNormalizationRollingAverage DNSTopLocationsResponseMetaNormalization = "ROLLING_AVERAGE" DNSTopLocationsResponseMetaNormalizationOverlappedPercentage DNSTopLocationsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" DNSTopLocationsResponseMetaNormalizationRatio DNSTopLocationsResponseMetaNormalization = "RATIO" )
func (DNSTopLocationsResponseMetaNormalization) IsKnown ¶
func (r DNSTopLocationsResponseMetaNormalization) IsKnown() bool
type DNSTopLocationsResponseMetaUnit ¶
type DNSTopLocationsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON dnsTopLocationsResponseMetaUnitJSON `json:"-"`
}
func (*DNSTopLocationsResponseMetaUnit) UnmarshalJSON ¶
func (r *DNSTopLocationsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type DNSTopLocationsResponseTop0 ¶
type DNSTopLocationsResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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)
Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS resolver.
func (*DNSTopService) Locations ¶
func (r *DNSTopService) Locations(ctx context.Context, query DNSTopLocationsParams, opts ...option.RequestOption) (res *DNSTopLocationsResponse, err error)
Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver.
type DatasetDownloadParams ¶
type DatasetDownloadParams struct {
DatasetID param.Field[int64] `json:"datasetId,required"`
// Format in which results will be returned.
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 in which results will be returned.
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 {
// Filters results by dataset type.
DatasetType param.Field[DatasetListParamsDatasetType] `query:"datasetType"`
// Filters results by the specified date.
Date param.Field[time.Time] `query:"date" format:"date"`
// Format in which results will be returned.
Format param.Field[DatasetListParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Skips the specified number of objects before fetching the 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
Filters results by dataset type.
const ( DatasetListParamsDatasetTypeRankingBucket DatasetListParamsDatasetType = "RANKING_BUCKET" DatasetListParamsDatasetTypeReport DatasetListParamsDatasetType = "REPORT" )
func (DatasetListParamsDatasetType) IsKnown ¶
func (r DatasetListParamsDatasetType) IsKnown() bool
type DatasetListParamsFormat ¶
type DatasetListParamsFormat string
Format in which results will be returned.
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 ¶
func (r *DatasetService) Download(ctx context.Context, params DatasetDownloadParams, opts ...option.RequestOption) (res *DatasetDownloadResponse, err error)
Retrieves an 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)
Retrieves 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 ¶
func (r *DatasetService) List(ctx context.Context, query DatasetListParams, opts ...option.RequestOption) (res *DatasetListResponse, err error)
Retrieves 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingSummaryARCParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingSummaryARCParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingSummaryARCParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingSummaryARCParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingSummaryARCParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
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 ¶
func (r EmailRoutingSummaryARCParamsDKIM) IsKnown() bool
type EmailRoutingSummaryARCParamsDMARC ¶
type EmailRoutingSummaryARCParamsDMARC string
const ( EmailRoutingSummaryARCParamsDMARCPass EmailRoutingSummaryARCParamsDMARC = "PASS" EmailRoutingSummaryARCParamsDMARCNone EmailRoutingSummaryARCParamsDMARC = "NONE" EmailRoutingSummaryARCParamsDMARCFail EmailRoutingSummaryARCParamsDMARC = "FAIL" )
func (EmailRoutingSummaryARCParamsDMARC) IsKnown ¶
func (r EmailRoutingSummaryARCParamsDMARC) IsKnown() bool
type EmailRoutingSummaryARCParamsEncrypted ¶
type EmailRoutingSummaryARCParamsEncrypted string
const ( EmailRoutingSummaryARCParamsEncryptedEncrypted EmailRoutingSummaryARCParamsEncrypted = "ENCRYPTED" EmailRoutingSummaryARCParamsEncryptedNotEncrypted EmailRoutingSummaryARCParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingSummaryARCParamsEncrypted) IsKnown ¶
func (r EmailRoutingSummaryARCParamsEncrypted) IsKnown() bool
type EmailRoutingSummaryARCParamsFormat ¶
type EmailRoutingSummaryARCParamsFormat string
Format in which results will be returned.
const ( EmailRoutingSummaryARCParamsFormatJson EmailRoutingSummaryARCParamsFormat = "JSON" EmailRoutingSummaryARCParamsFormatCsv EmailRoutingSummaryARCParamsFormat = "CSV" )
func (EmailRoutingSummaryARCParamsFormat) IsKnown ¶
func (r EmailRoutingSummaryARCParamsFormat) IsKnown() bool
type EmailRoutingSummaryARCParamsIPVersion ¶
type EmailRoutingSummaryARCParamsIPVersion string
const ( EmailRoutingSummaryARCParamsIPVersionIPv4 EmailRoutingSummaryARCParamsIPVersion = "IPv4" EmailRoutingSummaryARCParamsIPVersionIPv6 EmailRoutingSummaryARCParamsIPVersion = "IPv6" )
func (EmailRoutingSummaryARCParamsIPVersion) IsKnown ¶
func (r EmailRoutingSummaryARCParamsIPVersion) IsKnown() bool
type EmailRoutingSummaryARCParamsSPF ¶
type EmailRoutingSummaryARCParamsSPF string
const ( EmailRoutingSummaryARCParamsSPFPass EmailRoutingSummaryARCParamsSPF = "PASS" EmailRoutingSummaryARCParamsSPFNone EmailRoutingSummaryARCParamsSPF = "NONE" EmailRoutingSummaryARCParamsSPFFail EmailRoutingSummaryARCParamsSPF = "FAIL" )
func (EmailRoutingSummaryARCParamsSPF) IsKnown ¶
func (r EmailRoutingSummaryARCParamsSPF) IsKnown() bool
type EmailRoutingSummaryARCResponse ¶
type EmailRoutingSummaryARCResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailRoutingSummaryARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingSummaryARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingSummaryARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingSummaryARCResponseMetaUnit `json:"units,required"`
JSON emailRoutingSummaryARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingSummaryARCResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingSummaryARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryARCResponseMetaConfidenceInfo ¶
type EmailRoutingSummaryARCResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingSummaryARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingSummaryARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailRoutingSummaryARCResponseMetaNormalization ¶
type EmailRoutingSummaryARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingSummaryARCResponseMetaNormalizationPercentage EmailRoutingSummaryARCResponseMetaNormalization = "PERCENTAGE" EmailRoutingSummaryARCResponseMetaNormalizationMin0Max EmailRoutingSummaryARCResponseMetaNormalization = "MIN0_MAX" EmailRoutingSummaryARCResponseMetaNormalizationMinMax EmailRoutingSummaryARCResponseMetaNormalization = "MIN_MAX" EmailRoutingSummaryARCResponseMetaNormalizationRawValues EmailRoutingSummaryARCResponseMetaNormalization = "RAW_VALUES" EmailRoutingSummaryARCResponseMetaNormalizationPercentageChange EmailRoutingSummaryARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingSummaryARCResponseMetaNormalizationRollingAverage EmailRoutingSummaryARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingSummaryARCResponseMetaNormalizationOverlappedPercentage EmailRoutingSummaryARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingSummaryARCResponseMetaNormalizationRatio EmailRoutingSummaryARCResponseMetaNormalization = "RATIO" )
func (EmailRoutingSummaryARCResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingSummaryARCResponseMetaNormalization) IsKnown() bool
type EmailRoutingSummaryARCResponseMetaUnit ¶
type EmailRoutingSummaryARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingSummaryARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingSummaryARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingSummaryARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryDKIMParams ¶
type EmailRoutingSummaryDKIMParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingSummaryDKIMParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingSummaryDKIMParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingSummaryDKIMParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingSummaryDKIMParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingSummaryDKIMParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
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 ¶
func (r EmailRoutingSummaryDKIMParamsARC) IsKnown() bool
type EmailRoutingSummaryDKIMParamsDMARC ¶
type EmailRoutingSummaryDKIMParamsDMARC string
const ( EmailRoutingSummaryDKIMParamsDMARCPass EmailRoutingSummaryDKIMParamsDMARC = "PASS" EmailRoutingSummaryDKIMParamsDMARCNone EmailRoutingSummaryDKIMParamsDMARC = "NONE" EmailRoutingSummaryDKIMParamsDMARCFail EmailRoutingSummaryDKIMParamsDMARC = "FAIL" )
func (EmailRoutingSummaryDKIMParamsDMARC) IsKnown ¶
func (r EmailRoutingSummaryDKIMParamsDMARC) IsKnown() bool
type EmailRoutingSummaryDKIMParamsEncrypted ¶
type EmailRoutingSummaryDKIMParamsEncrypted string
const ( EmailRoutingSummaryDKIMParamsEncryptedEncrypted EmailRoutingSummaryDKIMParamsEncrypted = "ENCRYPTED" EmailRoutingSummaryDKIMParamsEncryptedNotEncrypted EmailRoutingSummaryDKIMParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingSummaryDKIMParamsEncrypted) IsKnown ¶
func (r EmailRoutingSummaryDKIMParamsEncrypted) IsKnown() bool
type EmailRoutingSummaryDKIMParamsFormat ¶
type EmailRoutingSummaryDKIMParamsFormat string
Format in which results will be returned.
const ( EmailRoutingSummaryDKIMParamsFormatJson EmailRoutingSummaryDKIMParamsFormat = "JSON" EmailRoutingSummaryDKIMParamsFormatCsv EmailRoutingSummaryDKIMParamsFormat = "CSV" )
func (EmailRoutingSummaryDKIMParamsFormat) IsKnown ¶
func (r EmailRoutingSummaryDKIMParamsFormat) IsKnown() bool
type EmailRoutingSummaryDKIMParamsIPVersion ¶
type EmailRoutingSummaryDKIMParamsIPVersion string
const ( EmailRoutingSummaryDKIMParamsIPVersionIPv4 EmailRoutingSummaryDKIMParamsIPVersion = "IPv4" EmailRoutingSummaryDKIMParamsIPVersionIPv6 EmailRoutingSummaryDKIMParamsIPVersion = "IPv6" )
func (EmailRoutingSummaryDKIMParamsIPVersion) IsKnown ¶
func (r EmailRoutingSummaryDKIMParamsIPVersion) IsKnown() bool
type EmailRoutingSummaryDKIMParamsSPF ¶
type EmailRoutingSummaryDKIMParamsSPF string
const ( EmailRoutingSummaryDKIMParamsSPFPass EmailRoutingSummaryDKIMParamsSPF = "PASS" EmailRoutingSummaryDKIMParamsSPFNone EmailRoutingSummaryDKIMParamsSPF = "NONE" EmailRoutingSummaryDKIMParamsSPFFail EmailRoutingSummaryDKIMParamsSPF = "FAIL" )
func (EmailRoutingSummaryDKIMParamsSPF) IsKnown ¶
func (r EmailRoutingSummaryDKIMParamsSPF) IsKnown() bool
type EmailRoutingSummaryDKIMResponse ¶
type EmailRoutingSummaryDKIMResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailRoutingSummaryDKIMResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingSummaryDKIMResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingSummaryDKIMResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingSummaryDKIMResponseMetaUnit `json:"units,required"`
JSON emailRoutingSummaryDKIMResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingSummaryDKIMResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingSummaryDKIMResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryDKIMResponseMetaConfidenceInfo ¶
type EmailRoutingSummaryDKIMResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingSummaryDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailRoutingSummaryDKIMResponseMetaNormalization ¶
type EmailRoutingSummaryDKIMResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingSummaryDKIMResponseMetaNormalizationPercentage EmailRoutingSummaryDKIMResponseMetaNormalization = "PERCENTAGE" EmailRoutingSummaryDKIMResponseMetaNormalizationMin0Max EmailRoutingSummaryDKIMResponseMetaNormalization = "MIN0_MAX" EmailRoutingSummaryDKIMResponseMetaNormalizationMinMax EmailRoutingSummaryDKIMResponseMetaNormalization = "MIN_MAX" EmailRoutingSummaryDKIMResponseMetaNormalizationRawValues EmailRoutingSummaryDKIMResponseMetaNormalization = "RAW_VALUES" EmailRoutingSummaryDKIMResponseMetaNormalizationPercentageChange EmailRoutingSummaryDKIMResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingSummaryDKIMResponseMetaNormalizationRollingAverage EmailRoutingSummaryDKIMResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingSummaryDKIMResponseMetaNormalizationOverlappedPercentage EmailRoutingSummaryDKIMResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingSummaryDKIMResponseMetaNormalizationRatio EmailRoutingSummaryDKIMResponseMetaNormalization = "RATIO" )
func (EmailRoutingSummaryDKIMResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingSummaryDKIMResponseMetaNormalization) IsKnown() bool
type EmailRoutingSummaryDKIMResponseMetaUnit ¶
type EmailRoutingSummaryDKIMResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingSummaryDKIMResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingSummaryDKIMResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingSummaryDKIMResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryDMARCParams ¶
type EmailRoutingSummaryDMARCParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingSummaryDMARCParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingSummaryDMARCParamsDKIM] `query:"dkim"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingSummaryDMARCParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingSummaryDMARCParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingSummaryDMARCParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
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 ¶
func (r EmailRoutingSummaryDMARCParamsARC) IsKnown() bool
type EmailRoutingSummaryDMARCParamsDKIM ¶
type EmailRoutingSummaryDMARCParamsDKIM string
const ( EmailRoutingSummaryDMARCParamsDKIMPass EmailRoutingSummaryDMARCParamsDKIM = "PASS" EmailRoutingSummaryDMARCParamsDKIMNone EmailRoutingSummaryDMARCParamsDKIM = "NONE" EmailRoutingSummaryDMARCParamsDKIMFail EmailRoutingSummaryDMARCParamsDKIM = "FAIL" )
func (EmailRoutingSummaryDMARCParamsDKIM) IsKnown ¶
func (r EmailRoutingSummaryDMARCParamsDKIM) IsKnown() bool
type EmailRoutingSummaryDMARCParamsEncrypted ¶
type EmailRoutingSummaryDMARCParamsEncrypted string
const ( EmailRoutingSummaryDMARCParamsEncryptedEncrypted EmailRoutingSummaryDMARCParamsEncrypted = "ENCRYPTED" EmailRoutingSummaryDMARCParamsEncryptedNotEncrypted EmailRoutingSummaryDMARCParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingSummaryDMARCParamsEncrypted) IsKnown ¶
func (r EmailRoutingSummaryDMARCParamsEncrypted) IsKnown() bool
type EmailRoutingSummaryDMARCParamsFormat ¶
type EmailRoutingSummaryDMARCParamsFormat string
Format in which results will be returned.
const ( EmailRoutingSummaryDMARCParamsFormatJson EmailRoutingSummaryDMARCParamsFormat = "JSON" EmailRoutingSummaryDMARCParamsFormatCsv EmailRoutingSummaryDMARCParamsFormat = "CSV" )
func (EmailRoutingSummaryDMARCParamsFormat) IsKnown ¶
func (r EmailRoutingSummaryDMARCParamsFormat) IsKnown() bool
type EmailRoutingSummaryDMARCParamsIPVersion ¶
type EmailRoutingSummaryDMARCParamsIPVersion string
const ( EmailRoutingSummaryDMARCParamsIPVersionIPv4 EmailRoutingSummaryDMARCParamsIPVersion = "IPv4" EmailRoutingSummaryDMARCParamsIPVersionIPv6 EmailRoutingSummaryDMARCParamsIPVersion = "IPv6" )
func (EmailRoutingSummaryDMARCParamsIPVersion) IsKnown ¶
func (r EmailRoutingSummaryDMARCParamsIPVersion) IsKnown() bool
type EmailRoutingSummaryDMARCParamsSPF ¶
type EmailRoutingSummaryDMARCParamsSPF string
const ( EmailRoutingSummaryDMARCParamsSPFPass EmailRoutingSummaryDMARCParamsSPF = "PASS" EmailRoutingSummaryDMARCParamsSPFNone EmailRoutingSummaryDMARCParamsSPF = "NONE" EmailRoutingSummaryDMARCParamsSPFFail EmailRoutingSummaryDMARCParamsSPF = "FAIL" )
func (EmailRoutingSummaryDMARCParamsSPF) IsKnown ¶
func (r EmailRoutingSummaryDMARCParamsSPF) IsKnown() bool
type EmailRoutingSummaryDMARCResponse ¶
type EmailRoutingSummaryDMARCResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailRoutingSummaryDMARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingSummaryDMARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingSummaryDMARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingSummaryDMARCResponseMetaUnit `json:"units,required"`
JSON emailRoutingSummaryDMARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingSummaryDMARCResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingSummaryDMARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryDMARCResponseMetaConfidenceInfo ¶
type EmailRoutingSummaryDMARCResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingSummaryDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailRoutingSummaryDMARCResponseMetaNormalization ¶
type EmailRoutingSummaryDMARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingSummaryDMARCResponseMetaNormalizationPercentage EmailRoutingSummaryDMARCResponseMetaNormalization = "PERCENTAGE" EmailRoutingSummaryDMARCResponseMetaNormalizationMin0Max EmailRoutingSummaryDMARCResponseMetaNormalization = "MIN0_MAX" EmailRoutingSummaryDMARCResponseMetaNormalizationMinMax EmailRoutingSummaryDMARCResponseMetaNormalization = "MIN_MAX" EmailRoutingSummaryDMARCResponseMetaNormalizationRawValues EmailRoutingSummaryDMARCResponseMetaNormalization = "RAW_VALUES" EmailRoutingSummaryDMARCResponseMetaNormalizationPercentageChange EmailRoutingSummaryDMARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingSummaryDMARCResponseMetaNormalizationRollingAverage EmailRoutingSummaryDMARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingSummaryDMARCResponseMetaNormalizationOverlappedPercentage EmailRoutingSummaryDMARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingSummaryDMARCResponseMetaNormalizationRatio EmailRoutingSummaryDMARCResponseMetaNormalization = "RATIO" )
func (EmailRoutingSummaryDMARCResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingSummaryDMARCResponseMetaNormalization) IsKnown() bool
type EmailRoutingSummaryDMARCResponseMetaUnit ¶
type EmailRoutingSummaryDMARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingSummaryDMARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingSummaryDMARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingSummaryDMARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryEncryptedParams ¶
type EmailRoutingSummaryEncryptedParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingSummaryEncryptedParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingSummaryEncryptedParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingSummaryEncryptedParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailRoutingSummaryEncryptedParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingSummaryEncryptedParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailRoutingSummaryEncryptedParamsSPF] `query:"spf"`
}
func (EmailRoutingSummaryEncryptedParams) URLQuery ¶
func (r EmailRoutingSummaryEncryptedParams) URLQuery() (v url.Values)
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 ¶
func (r EmailRoutingSummaryEncryptedParamsARC) IsKnown() bool
type EmailRoutingSummaryEncryptedParamsDKIM ¶
type EmailRoutingSummaryEncryptedParamsDKIM string
const ( EmailRoutingSummaryEncryptedParamsDKIMPass EmailRoutingSummaryEncryptedParamsDKIM = "PASS" EmailRoutingSummaryEncryptedParamsDKIMNone EmailRoutingSummaryEncryptedParamsDKIM = "NONE" EmailRoutingSummaryEncryptedParamsDKIMFail EmailRoutingSummaryEncryptedParamsDKIM = "FAIL" )
func (EmailRoutingSummaryEncryptedParamsDKIM) IsKnown ¶
func (r EmailRoutingSummaryEncryptedParamsDKIM) IsKnown() bool
type EmailRoutingSummaryEncryptedParamsDMARC ¶
type EmailRoutingSummaryEncryptedParamsDMARC string
const ( EmailRoutingSummaryEncryptedParamsDMARCPass EmailRoutingSummaryEncryptedParamsDMARC = "PASS" EmailRoutingSummaryEncryptedParamsDMARCNone EmailRoutingSummaryEncryptedParamsDMARC = "NONE" EmailRoutingSummaryEncryptedParamsDMARCFail EmailRoutingSummaryEncryptedParamsDMARC = "FAIL" )
func (EmailRoutingSummaryEncryptedParamsDMARC) IsKnown ¶
func (r EmailRoutingSummaryEncryptedParamsDMARC) IsKnown() bool
type EmailRoutingSummaryEncryptedParamsFormat ¶
type EmailRoutingSummaryEncryptedParamsFormat string
Format in which results will be returned.
const ( EmailRoutingSummaryEncryptedParamsFormatJson EmailRoutingSummaryEncryptedParamsFormat = "JSON" EmailRoutingSummaryEncryptedParamsFormatCsv EmailRoutingSummaryEncryptedParamsFormat = "CSV" )
func (EmailRoutingSummaryEncryptedParamsFormat) IsKnown ¶
func (r EmailRoutingSummaryEncryptedParamsFormat) IsKnown() bool
type EmailRoutingSummaryEncryptedParamsIPVersion ¶
type EmailRoutingSummaryEncryptedParamsIPVersion string
const ( EmailRoutingSummaryEncryptedParamsIPVersionIPv4 EmailRoutingSummaryEncryptedParamsIPVersion = "IPv4" EmailRoutingSummaryEncryptedParamsIPVersionIPv6 EmailRoutingSummaryEncryptedParamsIPVersion = "IPv6" )
func (EmailRoutingSummaryEncryptedParamsIPVersion) IsKnown ¶
func (r EmailRoutingSummaryEncryptedParamsIPVersion) IsKnown() bool
type EmailRoutingSummaryEncryptedParamsSPF ¶
type EmailRoutingSummaryEncryptedParamsSPF string
const ( EmailRoutingSummaryEncryptedParamsSPFPass EmailRoutingSummaryEncryptedParamsSPF = "PASS" EmailRoutingSummaryEncryptedParamsSPFNone EmailRoutingSummaryEncryptedParamsSPF = "NONE" EmailRoutingSummaryEncryptedParamsSPFFail EmailRoutingSummaryEncryptedParamsSPF = "FAIL" )
func (EmailRoutingSummaryEncryptedParamsSPF) IsKnown ¶
func (r EmailRoutingSummaryEncryptedParamsSPF) IsKnown() bool
type EmailRoutingSummaryEncryptedResponse ¶
type EmailRoutingSummaryEncryptedResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingSummaryEncryptedResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingSummaryEncryptedResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingSummaryEncryptedResponseMetaUnit `json:"units,required"`
JSON emailRoutingSummaryEncryptedResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingSummaryEncryptedResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingSummaryEncryptedResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo ¶
type EmailRoutingSummaryEncryptedResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingSummaryEncryptedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailRoutingSummaryEncryptedResponseMetaNormalization ¶
type EmailRoutingSummaryEncryptedResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingSummaryEncryptedResponseMetaNormalizationPercentage EmailRoutingSummaryEncryptedResponseMetaNormalization = "PERCENTAGE" EmailRoutingSummaryEncryptedResponseMetaNormalizationMin0Max EmailRoutingSummaryEncryptedResponseMetaNormalization = "MIN0_MAX" EmailRoutingSummaryEncryptedResponseMetaNormalizationMinMax EmailRoutingSummaryEncryptedResponseMetaNormalization = "MIN_MAX" EmailRoutingSummaryEncryptedResponseMetaNormalizationRawValues EmailRoutingSummaryEncryptedResponseMetaNormalization = "RAW_VALUES" EmailRoutingSummaryEncryptedResponseMetaNormalizationPercentageChange EmailRoutingSummaryEncryptedResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingSummaryEncryptedResponseMetaNormalizationRollingAverage EmailRoutingSummaryEncryptedResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingSummaryEncryptedResponseMetaNormalizationOverlappedPercentage EmailRoutingSummaryEncryptedResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingSummaryEncryptedResponseMetaNormalizationRatio EmailRoutingSummaryEncryptedResponseMetaNormalization = "RATIO" )
func (EmailRoutingSummaryEncryptedResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingSummaryEncryptedResponseMetaNormalization) IsKnown() bool
type EmailRoutingSummaryEncryptedResponseMetaUnit ¶
type EmailRoutingSummaryEncryptedResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingSummaryEncryptedResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingSummaryEncryptedResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingSummaryEncryptedResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryEncryptedResponseSummary0 ¶
type EmailRoutingSummaryEncryptedResponseSummary0 struct {
// A numeric string.
Encrypted string `json:"ENCRYPTED,required"`
// A numeric string.
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 {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingSummaryIPVersionParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingSummaryIPVersionParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingSummaryIPVersionParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingSummaryIPVersionParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingSummaryIPVersionParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailRoutingSummaryIPVersionParamsSPF] `query:"spf"`
}
func (EmailRoutingSummaryIPVersionParams) URLQuery ¶
func (r EmailRoutingSummaryIPVersionParams) URLQuery() (v url.Values)
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 ¶
func (r EmailRoutingSummaryIPVersionParamsARC) IsKnown() bool
type EmailRoutingSummaryIPVersionParamsDKIM ¶
type EmailRoutingSummaryIPVersionParamsDKIM string
const ( EmailRoutingSummaryIPVersionParamsDKIMPass EmailRoutingSummaryIPVersionParamsDKIM = "PASS" EmailRoutingSummaryIPVersionParamsDKIMNone EmailRoutingSummaryIPVersionParamsDKIM = "NONE" EmailRoutingSummaryIPVersionParamsDKIMFail EmailRoutingSummaryIPVersionParamsDKIM = "FAIL" )
func (EmailRoutingSummaryIPVersionParamsDKIM) IsKnown ¶
func (r EmailRoutingSummaryIPVersionParamsDKIM) IsKnown() bool
type EmailRoutingSummaryIPVersionParamsDMARC ¶
type EmailRoutingSummaryIPVersionParamsDMARC string
const ( EmailRoutingSummaryIPVersionParamsDMARCPass EmailRoutingSummaryIPVersionParamsDMARC = "PASS" EmailRoutingSummaryIPVersionParamsDMARCNone EmailRoutingSummaryIPVersionParamsDMARC = "NONE" EmailRoutingSummaryIPVersionParamsDMARCFail EmailRoutingSummaryIPVersionParamsDMARC = "FAIL" )
func (EmailRoutingSummaryIPVersionParamsDMARC) IsKnown ¶
func (r EmailRoutingSummaryIPVersionParamsDMARC) IsKnown() bool
type EmailRoutingSummaryIPVersionParamsEncrypted ¶
type EmailRoutingSummaryIPVersionParamsEncrypted string
const ( EmailRoutingSummaryIPVersionParamsEncryptedEncrypted EmailRoutingSummaryIPVersionParamsEncrypted = "ENCRYPTED" EmailRoutingSummaryIPVersionParamsEncryptedNotEncrypted EmailRoutingSummaryIPVersionParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingSummaryIPVersionParamsEncrypted) IsKnown ¶
func (r EmailRoutingSummaryIPVersionParamsEncrypted) IsKnown() bool
type EmailRoutingSummaryIPVersionParamsFormat ¶
type EmailRoutingSummaryIPVersionParamsFormat string
Format in which results will be returned.
const ( EmailRoutingSummaryIPVersionParamsFormatJson EmailRoutingSummaryIPVersionParamsFormat = "JSON" EmailRoutingSummaryIPVersionParamsFormatCsv EmailRoutingSummaryIPVersionParamsFormat = "CSV" )
func (EmailRoutingSummaryIPVersionParamsFormat) IsKnown ¶
func (r EmailRoutingSummaryIPVersionParamsFormat) IsKnown() bool
type EmailRoutingSummaryIPVersionParamsSPF ¶
type EmailRoutingSummaryIPVersionParamsSPF string
const ( EmailRoutingSummaryIPVersionParamsSPFPass EmailRoutingSummaryIPVersionParamsSPF = "PASS" EmailRoutingSummaryIPVersionParamsSPFNone EmailRoutingSummaryIPVersionParamsSPF = "NONE" EmailRoutingSummaryIPVersionParamsSPFFail EmailRoutingSummaryIPVersionParamsSPF = "FAIL" )
func (EmailRoutingSummaryIPVersionParamsSPF) IsKnown ¶
func (r EmailRoutingSummaryIPVersionParamsSPF) IsKnown() bool
type EmailRoutingSummaryIPVersionResponse ¶
type EmailRoutingSummaryIPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingSummaryIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingSummaryIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingSummaryIPVersionResponseMetaUnit `json:"units,required"`
JSON emailRoutingSummaryIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingSummaryIPVersionResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingSummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo ¶
type EmailRoutingSummaryIPVersionResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailRoutingSummaryIPVersionResponseMetaNormalization ¶
type EmailRoutingSummaryIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingSummaryIPVersionResponseMetaNormalizationPercentage EmailRoutingSummaryIPVersionResponseMetaNormalization = "PERCENTAGE" EmailRoutingSummaryIPVersionResponseMetaNormalizationMin0Max EmailRoutingSummaryIPVersionResponseMetaNormalization = "MIN0_MAX" EmailRoutingSummaryIPVersionResponseMetaNormalizationMinMax EmailRoutingSummaryIPVersionResponseMetaNormalization = "MIN_MAX" EmailRoutingSummaryIPVersionResponseMetaNormalizationRawValues EmailRoutingSummaryIPVersionResponseMetaNormalization = "RAW_VALUES" EmailRoutingSummaryIPVersionResponseMetaNormalizationPercentageChange EmailRoutingSummaryIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingSummaryIPVersionResponseMetaNormalizationRollingAverage EmailRoutingSummaryIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingSummaryIPVersionResponseMetaNormalizationOverlappedPercentage EmailRoutingSummaryIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingSummaryIPVersionResponseMetaNormalizationRatio EmailRoutingSummaryIPVersionResponseMetaNormalization = "RATIO" )
func (EmailRoutingSummaryIPVersionResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingSummaryIPVersionResponseMetaNormalization) IsKnown() bool
type EmailRoutingSummaryIPVersionResponseMetaUnit ¶
type EmailRoutingSummaryIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingSummaryIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingSummaryIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingSummaryIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummaryIPVersionResponseSummary0 ¶
type EmailRoutingSummaryIPVersionResponseSummary0 struct {
// A numeric string.
IPv4 string `json:"IPv4,required"`
// A numeric string.
IPv6 string `json:"IPv6,required"`
JSON emailRoutingSummaryIPVersionResponseSummary0JSON `json:"-"`
}
func (*EmailRoutingSummaryIPVersionResponseSummary0) UnmarshalJSON ¶
func (r *EmailRoutingSummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummarySPFParams ¶
type EmailRoutingSummarySPFParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingSummarySPFParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingSummarySPFParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingSummarySPFParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingSummarySPFParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingSummarySPFParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingSummarySPFParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
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 ¶
func (r EmailRoutingSummarySPFParamsARC) IsKnown() bool
type EmailRoutingSummarySPFParamsDKIM ¶
type EmailRoutingSummarySPFParamsDKIM string
const ( EmailRoutingSummarySPFParamsDKIMPass EmailRoutingSummarySPFParamsDKIM = "PASS" EmailRoutingSummarySPFParamsDKIMNone EmailRoutingSummarySPFParamsDKIM = "NONE" EmailRoutingSummarySPFParamsDKIMFail EmailRoutingSummarySPFParamsDKIM = "FAIL" )
func (EmailRoutingSummarySPFParamsDKIM) IsKnown ¶
func (r EmailRoutingSummarySPFParamsDKIM) IsKnown() bool
type EmailRoutingSummarySPFParamsDMARC ¶
type EmailRoutingSummarySPFParamsDMARC string
const ( EmailRoutingSummarySPFParamsDMARCPass EmailRoutingSummarySPFParamsDMARC = "PASS" EmailRoutingSummarySPFParamsDMARCNone EmailRoutingSummarySPFParamsDMARC = "NONE" EmailRoutingSummarySPFParamsDMARCFail EmailRoutingSummarySPFParamsDMARC = "FAIL" )
func (EmailRoutingSummarySPFParamsDMARC) IsKnown ¶
func (r EmailRoutingSummarySPFParamsDMARC) IsKnown() bool
type EmailRoutingSummarySPFParamsEncrypted ¶
type EmailRoutingSummarySPFParamsEncrypted string
const ( EmailRoutingSummarySPFParamsEncryptedEncrypted EmailRoutingSummarySPFParamsEncrypted = "ENCRYPTED" EmailRoutingSummarySPFParamsEncryptedNotEncrypted EmailRoutingSummarySPFParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingSummarySPFParamsEncrypted) IsKnown ¶
func (r EmailRoutingSummarySPFParamsEncrypted) IsKnown() bool
type EmailRoutingSummarySPFParamsFormat ¶
type EmailRoutingSummarySPFParamsFormat string
Format in which results will be returned.
const ( EmailRoutingSummarySPFParamsFormatJson EmailRoutingSummarySPFParamsFormat = "JSON" EmailRoutingSummarySPFParamsFormatCsv EmailRoutingSummarySPFParamsFormat = "CSV" )
func (EmailRoutingSummarySPFParamsFormat) IsKnown ¶
func (r EmailRoutingSummarySPFParamsFormat) IsKnown() bool
type EmailRoutingSummarySPFParamsIPVersion ¶
type EmailRoutingSummarySPFParamsIPVersion string
const ( EmailRoutingSummarySPFParamsIPVersionIPv4 EmailRoutingSummarySPFParamsIPVersion = "IPv4" EmailRoutingSummarySPFParamsIPVersionIPv6 EmailRoutingSummarySPFParamsIPVersion = "IPv6" )
func (EmailRoutingSummarySPFParamsIPVersion) IsKnown ¶
func (r EmailRoutingSummarySPFParamsIPVersion) IsKnown() bool
type EmailRoutingSummarySPFResponse ¶
type EmailRoutingSummarySPFResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailRoutingSummarySPFResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingSummarySPFResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingSummarySPFResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingSummarySPFResponseMetaUnit `json:"units,required"`
JSON emailRoutingSummarySPFResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingSummarySPFResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingSummarySPFResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingSummarySPFResponseMetaConfidenceInfo ¶
type EmailRoutingSummarySPFResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingSummarySPFResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingSummarySPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailRoutingSummarySPFResponseMetaNormalization ¶
type EmailRoutingSummarySPFResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingSummarySPFResponseMetaNormalizationPercentage EmailRoutingSummarySPFResponseMetaNormalization = "PERCENTAGE" EmailRoutingSummarySPFResponseMetaNormalizationMin0Max EmailRoutingSummarySPFResponseMetaNormalization = "MIN0_MAX" EmailRoutingSummarySPFResponseMetaNormalizationMinMax EmailRoutingSummarySPFResponseMetaNormalization = "MIN_MAX" EmailRoutingSummarySPFResponseMetaNormalizationRawValues EmailRoutingSummarySPFResponseMetaNormalization = "RAW_VALUES" EmailRoutingSummarySPFResponseMetaNormalizationPercentageChange EmailRoutingSummarySPFResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingSummarySPFResponseMetaNormalizationRollingAverage EmailRoutingSummarySPFResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingSummarySPFResponseMetaNormalizationOverlappedPercentage EmailRoutingSummarySPFResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingSummarySPFResponseMetaNormalizationRatio EmailRoutingSummarySPFResponseMetaNormalization = "RATIO" )
func (EmailRoutingSummarySPFResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingSummarySPFResponseMetaNormalization) IsKnown() bool
type EmailRoutingSummarySPFResponseMetaUnit ¶
type EmailRoutingSummarySPFResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingSummarySPFResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingSummarySPFResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingSummarySPFResponseMetaUnit) 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 ¶
func (r *EmailRoutingSummaryService) ARC(ctx context.Context, query EmailRoutingSummaryARCParams, opts ...option.RequestOption) (res *EmailRoutingSummaryARCResponse, err error)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.
func (*EmailRoutingSummaryService) DKIM ¶
func (r *EmailRoutingSummaryService) DKIM(ctx context.Context, query EmailRoutingSummaryDKIMParams, opts ...option.RequestOption) (res *EmailRoutingSummaryDKIMResponse, err error)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.
func (*EmailRoutingSummaryService) DMARC ¶
func (r *EmailRoutingSummaryService) DMARC(ctx context.Context, query EmailRoutingSummaryDMARCParams, opts ...option.RequestOption) (res *EmailRoutingSummaryDMARCResponse, err error)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.
func (*EmailRoutingSummaryService) Encrypted ¶
func (r *EmailRoutingSummaryService) Encrypted(ctx context.Context, query EmailRoutingSummaryEncryptedParams, opts ...option.RequestOption) (res *EmailRoutingSummaryEncryptedResponse, err error)
Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted).
func (*EmailRoutingSummaryService) IPVersion ¶
func (r *EmailRoutingSummaryService) IPVersion(ctx context.Context, query EmailRoutingSummaryIPVersionParams, opts ...option.RequestOption) (res *EmailRoutingSummaryIPVersionResponse, err error)
Retrieves the distribution of emails by IP version.
func (*EmailRoutingSummaryService) SPF ¶
func (r *EmailRoutingSummaryService) SPF(ctx context.Context, query EmailRoutingSummarySPFParams, opts ...option.RequestOption) (res *EmailRoutingSummarySPFResponse, err error)
Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.
type EmailRoutingTimeseriesGroupARCParams ¶
type EmailRoutingTimeseriesGroupARCParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingTimeseriesGroupARCParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingTimeseriesGroupARCParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingTimeseriesGroupARCParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingTimeseriesGroupARCParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingTimeseriesGroupARCParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailRoutingTimeseriesGroupARCParamsSPF] `query:"spf"`
}
func (EmailRoutingTimeseriesGroupARCParams) URLQuery ¶
func (r EmailRoutingTimeseriesGroupARCParams) URLQuery() (v url.Values)
URLQuery serializes EmailRoutingTimeseriesGroupARCParams's query parameters as `url.Values`.
type EmailRoutingTimeseriesGroupARCParamsAggInterval ¶
type EmailRoutingTimeseriesGroupARCParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailRoutingTimeseriesGroupARCParamsAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupARCParamsDKIM ¶
type EmailRoutingTimeseriesGroupARCParamsDKIM string
const ( EmailRoutingTimeseriesGroupARCParamsDKIMPass EmailRoutingTimeseriesGroupARCParamsDKIM = "PASS" EmailRoutingTimeseriesGroupARCParamsDKIMNone EmailRoutingTimeseriesGroupARCParamsDKIM = "NONE" EmailRoutingTimeseriesGroupARCParamsDKIMFail EmailRoutingTimeseriesGroupARCParamsDKIM = "FAIL" )
func (EmailRoutingTimeseriesGroupARCParamsDKIM) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCParamsDKIM) IsKnown() bool
type EmailRoutingTimeseriesGroupARCParamsDMARC ¶
type EmailRoutingTimeseriesGroupARCParamsDMARC string
const ( EmailRoutingTimeseriesGroupARCParamsDMARCPass EmailRoutingTimeseriesGroupARCParamsDMARC = "PASS" EmailRoutingTimeseriesGroupARCParamsDMARCNone EmailRoutingTimeseriesGroupARCParamsDMARC = "NONE" EmailRoutingTimeseriesGroupARCParamsDMARCFail EmailRoutingTimeseriesGroupARCParamsDMARC = "FAIL" )
func (EmailRoutingTimeseriesGroupARCParamsDMARC) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCParamsDMARC) IsKnown() bool
type EmailRoutingTimeseriesGroupARCParamsEncrypted ¶
type EmailRoutingTimeseriesGroupARCParamsEncrypted string
const ( EmailRoutingTimeseriesGroupARCParamsEncryptedEncrypted EmailRoutingTimeseriesGroupARCParamsEncrypted = "ENCRYPTED" EmailRoutingTimeseriesGroupARCParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupARCParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingTimeseriesGroupARCParamsEncrypted) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCParamsEncrypted) IsKnown() bool
type EmailRoutingTimeseriesGroupARCParamsFormat ¶
type EmailRoutingTimeseriesGroupARCParamsFormat string
Format in which results will be returned.
const ( EmailRoutingTimeseriesGroupARCParamsFormatJson EmailRoutingTimeseriesGroupARCParamsFormat = "JSON" EmailRoutingTimeseriesGroupARCParamsFormatCsv EmailRoutingTimeseriesGroupARCParamsFormat = "CSV" )
func (EmailRoutingTimeseriesGroupARCParamsFormat) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCParamsFormat) IsKnown() bool
type EmailRoutingTimeseriesGroupARCParamsIPVersion ¶
type EmailRoutingTimeseriesGroupARCParamsIPVersion string
const ( EmailRoutingTimeseriesGroupARCParamsIPVersionIPv4 EmailRoutingTimeseriesGroupARCParamsIPVersion = "IPv4" EmailRoutingTimeseriesGroupARCParamsIPVersionIPv6 EmailRoutingTimeseriesGroupARCParamsIPVersion = "IPv6" )
func (EmailRoutingTimeseriesGroupARCParamsIPVersion) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCParamsIPVersion) IsKnown() bool
type EmailRoutingTimeseriesGroupARCParamsSPF ¶
type EmailRoutingTimeseriesGroupARCParamsSPF string
const ( EmailRoutingTimeseriesGroupARCParamsSPFPass EmailRoutingTimeseriesGroupARCParamsSPF = "PASS" EmailRoutingTimeseriesGroupARCParamsSPFNone EmailRoutingTimeseriesGroupARCParamsSPF = "NONE" EmailRoutingTimeseriesGroupARCParamsSPFFail EmailRoutingTimeseriesGroupARCParamsSPF = "FAIL" )
func (EmailRoutingTimeseriesGroupARCParamsSPF) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCParamsSPF) IsKnown() bool
type EmailRoutingTimeseriesGroupARCResponse ¶
type EmailRoutingTimeseriesGroupARCResponse struct {
// Metadata for the results.
Meta EmailRoutingTimeseriesGroupARCResponseMeta `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 EmailRoutingTimeseriesGroupARCResponseMeta ¶
type EmailRoutingTimeseriesGroupARCResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailRoutingTimeseriesGroupARCResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingTimeseriesGroupARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingTimeseriesGroupARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingTimeseriesGroupARCResponseMetaUnit `json:"units,required"`
JSON emailRoutingTimeseriesGroupARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingTimeseriesGroupARCResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupARCResponseMetaAggInterval ¶
type EmailRoutingTimeseriesGroupARCResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailRoutingTimeseriesGroupARCResponseMetaAggIntervalFifteenMinutes EmailRoutingTimeseriesGroupARCResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailRoutingTimeseriesGroupARCResponseMetaAggIntervalOneHour EmailRoutingTimeseriesGroupARCResponseMetaAggInterval = "ONE_HOUR" EmailRoutingTimeseriesGroupARCResponseMetaAggIntervalOneDay EmailRoutingTimeseriesGroupARCResponseMetaAggInterval = "ONE_DAY" EmailRoutingTimeseriesGroupARCResponseMetaAggIntervalOneWeek EmailRoutingTimeseriesGroupARCResponseMetaAggInterval = "ONE_WEEK" EmailRoutingTimeseriesGroupARCResponseMetaAggIntervalOneMonth EmailRoutingTimeseriesGroupARCResponseMetaAggInterval = "ONE_MONTH" )
func (EmailRoutingTimeseriesGroupARCResponseMetaAggInterval) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCResponseMetaAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfo ¶
type EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation ¶
type EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupARCResponseMetaDateRange ¶
type EmailRoutingTimeseriesGroupARCResponseMetaDateRange 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 emailRoutingTimeseriesGroupARCResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupARCResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupARCResponseMetaNormalization ¶
type EmailRoutingTimeseriesGroupARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingTimeseriesGroupARCResponseMetaNormalizationPercentage EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "PERCENTAGE" EmailRoutingTimeseriesGroupARCResponseMetaNormalizationMin0Max EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "MIN0_MAX" EmailRoutingTimeseriesGroupARCResponseMetaNormalizationMinMax EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "MIN_MAX" EmailRoutingTimeseriesGroupARCResponseMetaNormalizationRawValues EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "RAW_VALUES" EmailRoutingTimeseriesGroupARCResponseMetaNormalizationPercentageChange EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingTimeseriesGroupARCResponseMetaNormalizationRollingAverage EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingTimeseriesGroupARCResponseMetaNormalizationOverlappedPercentage EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingTimeseriesGroupARCResponseMetaNormalizationRatio EmailRoutingTimeseriesGroupARCResponseMetaNormalization = "RATIO" )
func (EmailRoutingTimeseriesGroupARCResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingTimeseriesGroupARCResponseMetaNormalization) IsKnown() bool
type EmailRoutingTimeseriesGroupARCResponseMetaUnit ¶
type EmailRoutingTimeseriesGroupARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingTimeseriesGroupARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDKIMParams ¶
type EmailRoutingTimeseriesGroupDKIMParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingTimeseriesGroupDKIMParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsSPF] `query:"spf"`
}
func (EmailRoutingTimeseriesGroupDKIMParams) URLQuery ¶
func (r EmailRoutingTimeseriesGroupDKIMParams) URLQuery() (v url.Values)
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 ¶
func (r EmailRoutingTimeseriesGroupDKIMParamsARC) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMParamsAggInterval ¶
type EmailRoutingTimeseriesGroupDKIMParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailRoutingTimeseriesGroupDKIMParamsAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMParamsDMARC ¶
type EmailRoutingTimeseriesGroupDKIMParamsDMARC string
const ( EmailRoutingTimeseriesGroupDKIMParamsDMARCPass EmailRoutingTimeseriesGroupDKIMParamsDMARC = "PASS" EmailRoutingTimeseriesGroupDKIMParamsDMARCNone EmailRoutingTimeseriesGroupDKIMParamsDMARC = "NONE" EmailRoutingTimeseriesGroupDKIMParamsDMARCFail EmailRoutingTimeseriesGroupDKIMParamsDMARC = "FAIL" )
func (EmailRoutingTimeseriesGroupDKIMParamsDMARC) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDKIMParamsDMARC) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMParamsEncrypted ¶
type EmailRoutingTimeseriesGroupDKIMParamsEncrypted string
const ( EmailRoutingTimeseriesGroupDKIMParamsEncryptedEncrypted EmailRoutingTimeseriesGroupDKIMParamsEncrypted = "ENCRYPTED" EmailRoutingTimeseriesGroupDKIMParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupDKIMParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingTimeseriesGroupDKIMParamsEncrypted) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDKIMParamsEncrypted) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMParamsFormat ¶
type EmailRoutingTimeseriesGroupDKIMParamsFormat string
Format in which results will be returned.
const ( EmailRoutingTimeseriesGroupDKIMParamsFormatJson EmailRoutingTimeseriesGroupDKIMParamsFormat = "JSON" EmailRoutingTimeseriesGroupDKIMParamsFormatCsv EmailRoutingTimeseriesGroupDKIMParamsFormat = "CSV" )
func (EmailRoutingTimeseriesGroupDKIMParamsFormat) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDKIMParamsFormat) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMParamsIPVersion ¶
type EmailRoutingTimeseriesGroupDKIMParamsIPVersion string
const ( EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv4 EmailRoutingTimeseriesGroupDKIMParamsIPVersion = "IPv4" EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv6 EmailRoutingTimeseriesGroupDKIMParamsIPVersion = "IPv6" )
func (EmailRoutingTimeseriesGroupDKIMParamsIPVersion) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDKIMParamsIPVersion) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMParamsSPF ¶
type EmailRoutingTimeseriesGroupDKIMParamsSPF string
const ( EmailRoutingTimeseriesGroupDKIMParamsSPFPass EmailRoutingTimeseriesGroupDKIMParamsSPF = "PASS" EmailRoutingTimeseriesGroupDKIMParamsSPFNone EmailRoutingTimeseriesGroupDKIMParamsSPF = "NONE" EmailRoutingTimeseriesGroupDKIMParamsSPFFail EmailRoutingTimeseriesGroupDKIMParamsSPF = "FAIL" )
func (EmailRoutingTimeseriesGroupDKIMParamsSPF) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDKIMParamsSPF) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMResponse ¶
type EmailRoutingTimeseriesGroupDKIMResponse struct {
// Metadata for the results.
Meta EmailRoutingTimeseriesGroupDKIMResponseMeta `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 EmailRoutingTimeseriesGroupDKIMResponseMeta ¶
type EmailRoutingTimeseriesGroupDKIMResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingTimeseriesGroupDKIMResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingTimeseriesGroupDKIMResponseMetaUnit `json:"units,required"`
JSON emailRoutingTimeseriesGroupDKIMResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingTimeseriesGroupDKIMResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDKIMResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval ¶
type EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailRoutingTimeseriesGroupDKIMResponseMetaAggIntervalFifteenMinutes EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailRoutingTimeseriesGroupDKIMResponseMetaAggIntervalOneHour EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_HOUR" EmailRoutingTimeseriesGroupDKIMResponseMetaAggIntervalOneDay EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_DAY" EmailRoutingTimeseriesGroupDKIMResponseMetaAggIntervalOneWeek EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_WEEK" EmailRoutingTimeseriesGroupDKIMResponseMetaAggIntervalOneMonth EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_MONTH" )
func (EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDKIMResponseMetaAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfo ¶
type EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation ¶
type EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDKIMResponseMetaDateRange ¶
type EmailRoutingTimeseriesGroupDKIMResponseMetaDateRange 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 emailRoutingTimeseriesGroupDKIMResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupDKIMResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDKIMResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization ¶
type EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationPercentage EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "PERCENTAGE" EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationMin0Max EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "MIN0_MAX" EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationMinMax EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "MIN_MAX" EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationRawValues EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "RAW_VALUES" EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationPercentageChange EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationRollingAverage EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationOverlappedPercentage EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingTimeseriesGroupDKIMResponseMetaNormalizationRatio EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization = "RATIO" )
func (EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDKIMResponseMetaNormalization) IsKnown() bool
type EmailRoutingTimeseriesGroupDKIMResponseMetaUnit ¶
type EmailRoutingTimeseriesGroupDKIMResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingTimeseriesGroupDKIMResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupDKIMResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDKIMResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDMARCParams ¶
type EmailRoutingTimeseriesGroupDMARCParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsDKIM] `query:"dkim"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingTimeseriesGroupDMARCParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsSPF] `query:"spf"`
}
func (EmailRoutingTimeseriesGroupDMARCParams) URLQuery ¶
func (r EmailRoutingTimeseriesGroupDMARCParams) URLQuery() (v url.Values)
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 ¶
func (r EmailRoutingTimeseriesGroupDMARCParamsARC) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCParamsAggInterval ¶
type EmailRoutingTimeseriesGroupDMARCParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailRoutingTimeseriesGroupDMARCParamsAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCParamsDKIM ¶
type EmailRoutingTimeseriesGroupDMARCParamsDKIM string
const ( EmailRoutingTimeseriesGroupDMARCParamsDKIMPass EmailRoutingTimeseriesGroupDMARCParamsDKIM = "PASS" EmailRoutingTimeseriesGroupDMARCParamsDKIMNone EmailRoutingTimeseriesGroupDMARCParamsDKIM = "NONE" EmailRoutingTimeseriesGroupDMARCParamsDKIMFail EmailRoutingTimeseriesGroupDMARCParamsDKIM = "FAIL" )
func (EmailRoutingTimeseriesGroupDMARCParamsDKIM) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDMARCParamsDKIM) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCParamsEncrypted ¶
type EmailRoutingTimeseriesGroupDMARCParamsEncrypted string
const ( EmailRoutingTimeseriesGroupDMARCParamsEncryptedEncrypted EmailRoutingTimeseriesGroupDMARCParamsEncrypted = "ENCRYPTED" EmailRoutingTimeseriesGroupDMARCParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupDMARCParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingTimeseriesGroupDMARCParamsEncrypted) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDMARCParamsEncrypted) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCParamsFormat ¶
type EmailRoutingTimeseriesGroupDMARCParamsFormat string
Format in which results will be returned.
const ( EmailRoutingTimeseriesGroupDMARCParamsFormatJson EmailRoutingTimeseriesGroupDMARCParamsFormat = "JSON" EmailRoutingTimeseriesGroupDMARCParamsFormatCsv EmailRoutingTimeseriesGroupDMARCParamsFormat = "CSV" )
func (EmailRoutingTimeseriesGroupDMARCParamsFormat) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDMARCParamsFormat) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCParamsIPVersion ¶
type EmailRoutingTimeseriesGroupDMARCParamsIPVersion string
const ( EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv4 EmailRoutingTimeseriesGroupDMARCParamsIPVersion = "IPv4" EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv6 EmailRoutingTimeseriesGroupDMARCParamsIPVersion = "IPv6" )
func (EmailRoutingTimeseriesGroupDMARCParamsIPVersion) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDMARCParamsIPVersion) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCParamsSPF ¶
type EmailRoutingTimeseriesGroupDMARCParamsSPF string
const ( EmailRoutingTimeseriesGroupDMARCParamsSPFPass EmailRoutingTimeseriesGroupDMARCParamsSPF = "PASS" EmailRoutingTimeseriesGroupDMARCParamsSPFNone EmailRoutingTimeseriesGroupDMARCParamsSPF = "NONE" EmailRoutingTimeseriesGroupDMARCParamsSPFFail EmailRoutingTimeseriesGroupDMARCParamsSPF = "FAIL" )
func (EmailRoutingTimeseriesGroupDMARCParamsSPF) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDMARCParamsSPF) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCResponse ¶
type EmailRoutingTimeseriesGroupDMARCResponse struct {
// Metadata for the results.
Meta EmailRoutingTimeseriesGroupDMARCResponseMeta `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 EmailRoutingTimeseriesGroupDMARCResponseMeta ¶
type EmailRoutingTimeseriesGroupDMARCResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingTimeseriesGroupDMARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingTimeseriesGroupDMARCResponseMetaUnit `json:"units,required"`
JSON emailRoutingTimeseriesGroupDMARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingTimeseriesGroupDMARCResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDMARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval ¶
type EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailRoutingTimeseriesGroupDMARCResponseMetaAggIntervalFifteenMinutes EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailRoutingTimeseriesGroupDMARCResponseMetaAggIntervalOneHour EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_HOUR" EmailRoutingTimeseriesGroupDMARCResponseMetaAggIntervalOneDay EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_DAY" EmailRoutingTimeseriesGroupDMARCResponseMetaAggIntervalOneWeek EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_WEEK" EmailRoutingTimeseriesGroupDMARCResponseMetaAggIntervalOneMonth EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_MONTH" )
func (EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDMARCResponseMetaAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfo ¶
type EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation ¶
type EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDMARCResponseMetaDateRange ¶
type EmailRoutingTimeseriesGroupDMARCResponseMetaDateRange 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 emailRoutingTimeseriesGroupDMARCResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupDMARCResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDMARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization ¶
type EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationPercentage EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "PERCENTAGE" EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationMin0Max EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "MIN0_MAX" EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationMinMax EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "MIN_MAX" EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationRawValues EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "RAW_VALUES" EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationPercentageChange EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationRollingAverage EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationOverlappedPercentage EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingTimeseriesGroupDMARCResponseMetaNormalizationRatio EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization = "RATIO" )
func (EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingTimeseriesGroupDMARCResponseMetaNormalization) IsKnown() bool
type EmailRoutingTimeseriesGroupDMARCResponseMetaUnit ¶
type EmailRoutingTimeseriesGroupDMARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingTimeseriesGroupDMARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupDMARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupDMARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupEncryptedParams ¶
type EmailRoutingTimeseriesGroupEncryptedParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailRoutingTimeseriesGroupEncryptedParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsSPF] `query:"spf"`
}
func (EmailRoutingTimeseriesGroupEncryptedParams) URLQuery ¶
func (r EmailRoutingTimeseriesGroupEncryptedParams) URLQuery() (v url.Values)
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 ¶
func (r EmailRoutingTimeseriesGroupEncryptedParamsARC) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedParamsAggInterval ¶
type EmailRoutingTimeseriesGroupEncryptedParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailRoutingTimeseriesGroupEncryptedParamsAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedParamsDKIM ¶
type EmailRoutingTimeseriesGroupEncryptedParamsDKIM string
const ( EmailRoutingTimeseriesGroupEncryptedParamsDKIMPass EmailRoutingTimeseriesGroupEncryptedParamsDKIM = "PASS" EmailRoutingTimeseriesGroupEncryptedParamsDKIMNone EmailRoutingTimeseriesGroupEncryptedParamsDKIM = "NONE" EmailRoutingTimeseriesGroupEncryptedParamsDKIMFail EmailRoutingTimeseriesGroupEncryptedParamsDKIM = "FAIL" )
func (EmailRoutingTimeseriesGroupEncryptedParamsDKIM) IsKnown ¶
func (r EmailRoutingTimeseriesGroupEncryptedParamsDKIM) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedParamsDMARC ¶
type EmailRoutingTimeseriesGroupEncryptedParamsDMARC string
const ( EmailRoutingTimeseriesGroupEncryptedParamsDMARCPass EmailRoutingTimeseriesGroupEncryptedParamsDMARC = "PASS" EmailRoutingTimeseriesGroupEncryptedParamsDMARCNone EmailRoutingTimeseriesGroupEncryptedParamsDMARC = "NONE" EmailRoutingTimeseriesGroupEncryptedParamsDMARCFail EmailRoutingTimeseriesGroupEncryptedParamsDMARC = "FAIL" )
func (EmailRoutingTimeseriesGroupEncryptedParamsDMARC) IsKnown ¶
func (r EmailRoutingTimeseriesGroupEncryptedParamsDMARC) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedParamsFormat ¶
type EmailRoutingTimeseriesGroupEncryptedParamsFormat string
Format in which results will be returned.
const ( EmailRoutingTimeseriesGroupEncryptedParamsFormatJson EmailRoutingTimeseriesGroupEncryptedParamsFormat = "JSON" EmailRoutingTimeseriesGroupEncryptedParamsFormatCsv EmailRoutingTimeseriesGroupEncryptedParamsFormat = "CSV" )
func (EmailRoutingTimeseriesGroupEncryptedParamsFormat) IsKnown ¶
func (r EmailRoutingTimeseriesGroupEncryptedParamsFormat) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedParamsIPVersion ¶
type EmailRoutingTimeseriesGroupEncryptedParamsIPVersion string
const ( EmailRoutingTimeseriesGroupEncryptedParamsIPVersionIPv4 EmailRoutingTimeseriesGroupEncryptedParamsIPVersion = "IPv4" EmailRoutingTimeseriesGroupEncryptedParamsIPVersionIPv6 EmailRoutingTimeseriesGroupEncryptedParamsIPVersion = "IPv6" )
func (EmailRoutingTimeseriesGroupEncryptedParamsIPVersion) IsKnown ¶
func (r EmailRoutingTimeseriesGroupEncryptedParamsIPVersion) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedParamsSPF ¶
type EmailRoutingTimeseriesGroupEncryptedParamsSPF string
const ( EmailRoutingTimeseriesGroupEncryptedParamsSPFPass EmailRoutingTimeseriesGroupEncryptedParamsSPF = "PASS" EmailRoutingTimeseriesGroupEncryptedParamsSPFNone EmailRoutingTimeseriesGroupEncryptedParamsSPF = "NONE" EmailRoutingTimeseriesGroupEncryptedParamsSPFFail EmailRoutingTimeseriesGroupEncryptedParamsSPF = "FAIL" )
func (EmailRoutingTimeseriesGroupEncryptedParamsSPF) IsKnown ¶
func (r EmailRoutingTimeseriesGroupEncryptedParamsSPF) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedResponse ¶
type EmailRoutingTimeseriesGroupEncryptedResponse struct {
// Metadata for the results.
Meta EmailRoutingTimeseriesGroupEncryptedResponseMeta `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 EmailRoutingTimeseriesGroupEncryptedResponseMeta ¶
type EmailRoutingTimeseriesGroupEncryptedResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingTimeseriesGroupEncryptedResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingTimeseriesGroupEncryptedResponseMetaUnit `json:"units,required"`
JSON emailRoutingTimeseriesGroupEncryptedResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingTimeseriesGroupEncryptedResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupEncryptedResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval ¶
type EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailRoutingTimeseriesGroupEncryptedResponseMetaAggIntervalFifteenMinutes EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailRoutingTimeseriesGroupEncryptedResponseMetaAggIntervalOneHour EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval = "ONE_HOUR" EmailRoutingTimeseriesGroupEncryptedResponseMetaAggIntervalOneDay EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval = "ONE_DAY" EmailRoutingTimeseriesGroupEncryptedResponseMetaAggIntervalOneWeek EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval = "ONE_WEEK" EmailRoutingTimeseriesGroupEncryptedResponseMetaAggIntervalOneMonth EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval = "ONE_MONTH" )
func (EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval) IsKnown ¶
func (r EmailRoutingTimeseriesGroupEncryptedResponseMetaAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfo ¶
type EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoAnnotation ¶
type EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupEncryptedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupEncryptedResponseMetaDateRange ¶
type EmailRoutingTimeseriesGroupEncryptedResponseMetaDateRange 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 emailRoutingTimeseriesGroupEncryptedResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupEncryptedResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupEncryptedResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization ¶
type EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationPercentage EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "PERCENTAGE" EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationMin0Max EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "MIN0_MAX" EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationMinMax EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "MIN_MAX" EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationRawValues EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "RAW_VALUES" EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationPercentageChange EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationRollingAverage EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationOverlappedPercentage EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalizationRatio EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization = "RATIO" )
func (EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingTimeseriesGroupEncryptedResponseMetaNormalization) IsKnown() bool
type EmailRoutingTimeseriesGroupEncryptedResponseMetaUnit ¶
type EmailRoutingTimeseriesGroupEncryptedResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingTimeseriesGroupEncryptedResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupEncryptedResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupEncryptedResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingTimeseriesGroupIPVersionParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailRoutingTimeseriesGroupIPVersionParamsSPF] `query:"spf"`
}
func (EmailRoutingTimeseriesGroupIPVersionParams) URLQuery ¶
func (r EmailRoutingTimeseriesGroupIPVersionParams) URLQuery() (v url.Values)
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 ¶
func (r EmailRoutingTimeseriesGroupIPVersionParamsARC) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionParamsAggInterval ¶
type EmailRoutingTimeseriesGroupIPVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailRoutingTimeseriesGroupIPVersionParamsAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionParamsDKIM ¶
type EmailRoutingTimeseriesGroupIPVersionParamsDKIM string
const ( EmailRoutingTimeseriesGroupIPVersionParamsDKIMPass EmailRoutingTimeseriesGroupIPVersionParamsDKIM = "PASS" EmailRoutingTimeseriesGroupIPVersionParamsDKIMNone EmailRoutingTimeseriesGroupIPVersionParamsDKIM = "NONE" EmailRoutingTimeseriesGroupIPVersionParamsDKIMFail EmailRoutingTimeseriesGroupIPVersionParamsDKIM = "FAIL" )
func (EmailRoutingTimeseriesGroupIPVersionParamsDKIM) IsKnown ¶
func (r EmailRoutingTimeseriesGroupIPVersionParamsDKIM) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionParamsDMARC ¶
type EmailRoutingTimeseriesGroupIPVersionParamsDMARC string
const ( EmailRoutingTimeseriesGroupIPVersionParamsDMARCPass EmailRoutingTimeseriesGroupIPVersionParamsDMARC = "PASS" EmailRoutingTimeseriesGroupIPVersionParamsDMARCNone EmailRoutingTimeseriesGroupIPVersionParamsDMARC = "NONE" EmailRoutingTimeseriesGroupIPVersionParamsDMARCFail EmailRoutingTimeseriesGroupIPVersionParamsDMARC = "FAIL" )
func (EmailRoutingTimeseriesGroupIPVersionParamsDMARC) IsKnown ¶
func (r EmailRoutingTimeseriesGroupIPVersionParamsDMARC) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionParamsEncrypted ¶
type EmailRoutingTimeseriesGroupIPVersionParamsEncrypted string
const ( EmailRoutingTimeseriesGroupIPVersionParamsEncryptedEncrypted EmailRoutingTimeseriesGroupIPVersionParamsEncrypted = "ENCRYPTED" EmailRoutingTimeseriesGroupIPVersionParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupIPVersionParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingTimeseriesGroupIPVersionParamsEncrypted) IsKnown ¶
func (r EmailRoutingTimeseriesGroupIPVersionParamsEncrypted) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionParamsFormat ¶
type EmailRoutingTimeseriesGroupIPVersionParamsFormat string
Format in which results will be returned.
const ( EmailRoutingTimeseriesGroupIPVersionParamsFormatJson EmailRoutingTimeseriesGroupIPVersionParamsFormat = "JSON" EmailRoutingTimeseriesGroupIPVersionParamsFormatCsv EmailRoutingTimeseriesGroupIPVersionParamsFormat = "CSV" )
func (EmailRoutingTimeseriesGroupIPVersionParamsFormat) IsKnown ¶
func (r EmailRoutingTimeseriesGroupIPVersionParamsFormat) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionParamsSPF ¶
type EmailRoutingTimeseriesGroupIPVersionParamsSPF string
const ( EmailRoutingTimeseriesGroupIPVersionParamsSPFPass EmailRoutingTimeseriesGroupIPVersionParamsSPF = "PASS" EmailRoutingTimeseriesGroupIPVersionParamsSPFNone EmailRoutingTimeseriesGroupIPVersionParamsSPF = "NONE" EmailRoutingTimeseriesGroupIPVersionParamsSPFFail EmailRoutingTimeseriesGroupIPVersionParamsSPF = "FAIL" )
func (EmailRoutingTimeseriesGroupIPVersionParamsSPF) IsKnown ¶
func (r EmailRoutingTimeseriesGroupIPVersionParamsSPF) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionResponse ¶
type EmailRoutingTimeseriesGroupIPVersionResponse struct {
// Metadata for the results.
Meta EmailRoutingTimeseriesGroupIPVersionResponseMeta `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 EmailRoutingTimeseriesGroupIPVersionResponseMeta ¶
type EmailRoutingTimeseriesGroupIPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingTimeseriesGroupIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingTimeseriesGroupIPVersionResponseMetaUnit `json:"units,required"`
JSON emailRoutingTimeseriesGroupIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingTimeseriesGroupIPVersionResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval ¶
type EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailRoutingTimeseriesGroupIPVersionResponseMetaAggIntervalFifteenMinutes EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailRoutingTimeseriesGroupIPVersionResponseMetaAggIntervalOneHour EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_HOUR" EmailRoutingTimeseriesGroupIPVersionResponseMetaAggIntervalOneDay EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_DAY" EmailRoutingTimeseriesGroupIPVersionResponseMetaAggIntervalOneWeek EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_WEEK" EmailRoutingTimeseriesGroupIPVersionResponseMetaAggIntervalOneMonth EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown ¶
func (r EmailRoutingTimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfo ¶
type EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation ¶
type EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupIPVersionResponseMetaDateRange ¶
type EmailRoutingTimeseriesGroupIPVersionResponseMetaDateRange 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 emailRoutingTimeseriesGroupIPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization ¶
type EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationPercentage EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE" EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationMin0Max EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "MIN0_MAX" EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationMinMax EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "MIN_MAX" EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationRawValues EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "RAW_VALUES" EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationPercentageChange EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationRollingAverage EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationOverlappedPercentage EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalizationRatio EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization = "RATIO" )
func (EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingTimeseriesGroupIPVersionResponseMetaNormalization) IsKnown() bool
type EmailRoutingTimeseriesGroupIPVersionResponseMetaUnit ¶
type EmailRoutingTimeseriesGroupIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingTimeseriesGroupIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupIPVersionResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailRoutingTimeseriesGroupSPFParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailRoutingTimeseriesGroupSPFParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailRoutingTimeseriesGroupSPFParamsDMARC] `query:"dmarc"`
// Filters results by encryption status (encrypted vs. not-encrypted).
Encrypted param.Field[[]EmailRoutingTimeseriesGroupSPFParamsEncrypted] `query:"encrypted"`
// Format in which results will be returned.
Format param.Field[EmailRoutingTimeseriesGroupSPFParamsFormat] `query:"format"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]EmailRoutingTimeseriesGroupSPFParamsIPVersion] `query:"ipVersion"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (EmailRoutingTimeseriesGroupSPFParams) URLQuery ¶
func (r EmailRoutingTimeseriesGroupSPFParams) URLQuery() (v url.Values)
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 ¶
func (r EmailRoutingTimeseriesGroupSPFParamsARC) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFParamsAggInterval ¶
type EmailRoutingTimeseriesGroupSPFParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailRoutingTimeseriesGroupSPFParamsAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFParamsDKIM ¶
type EmailRoutingTimeseriesGroupSPFParamsDKIM string
const ( EmailRoutingTimeseriesGroupSPFParamsDKIMPass EmailRoutingTimeseriesGroupSPFParamsDKIM = "PASS" EmailRoutingTimeseriesGroupSPFParamsDKIMNone EmailRoutingTimeseriesGroupSPFParamsDKIM = "NONE" EmailRoutingTimeseriesGroupSPFParamsDKIMFail EmailRoutingTimeseriesGroupSPFParamsDKIM = "FAIL" )
func (EmailRoutingTimeseriesGroupSPFParamsDKIM) IsKnown ¶
func (r EmailRoutingTimeseriesGroupSPFParamsDKIM) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFParamsDMARC ¶
type EmailRoutingTimeseriesGroupSPFParamsDMARC string
const ( EmailRoutingTimeseriesGroupSPFParamsDMARCPass EmailRoutingTimeseriesGroupSPFParamsDMARC = "PASS" EmailRoutingTimeseriesGroupSPFParamsDMARCNone EmailRoutingTimeseriesGroupSPFParamsDMARC = "NONE" EmailRoutingTimeseriesGroupSPFParamsDMARCFail EmailRoutingTimeseriesGroupSPFParamsDMARC = "FAIL" )
func (EmailRoutingTimeseriesGroupSPFParamsDMARC) IsKnown ¶
func (r EmailRoutingTimeseriesGroupSPFParamsDMARC) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFParamsEncrypted ¶
type EmailRoutingTimeseriesGroupSPFParamsEncrypted string
const ( EmailRoutingTimeseriesGroupSPFParamsEncryptedEncrypted EmailRoutingTimeseriesGroupSPFParamsEncrypted = "ENCRYPTED" EmailRoutingTimeseriesGroupSPFParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupSPFParamsEncrypted = "NOT_ENCRYPTED" )
func (EmailRoutingTimeseriesGroupSPFParamsEncrypted) IsKnown ¶
func (r EmailRoutingTimeseriesGroupSPFParamsEncrypted) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFParamsFormat ¶
type EmailRoutingTimeseriesGroupSPFParamsFormat string
Format in which results will be returned.
const ( EmailRoutingTimeseriesGroupSPFParamsFormatJson EmailRoutingTimeseriesGroupSPFParamsFormat = "JSON" EmailRoutingTimeseriesGroupSPFParamsFormatCsv EmailRoutingTimeseriesGroupSPFParamsFormat = "CSV" )
func (EmailRoutingTimeseriesGroupSPFParamsFormat) IsKnown ¶
func (r EmailRoutingTimeseriesGroupSPFParamsFormat) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFParamsIPVersion ¶
type EmailRoutingTimeseriesGroupSPFParamsIPVersion string
const ( EmailRoutingTimeseriesGroupSPFParamsIPVersionIPv4 EmailRoutingTimeseriesGroupSPFParamsIPVersion = "IPv4" EmailRoutingTimeseriesGroupSPFParamsIPVersionIPv6 EmailRoutingTimeseriesGroupSPFParamsIPVersion = "IPv6" )
func (EmailRoutingTimeseriesGroupSPFParamsIPVersion) IsKnown ¶
func (r EmailRoutingTimeseriesGroupSPFParamsIPVersion) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFResponse ¶
type EmailRoutingTimeseriesGroupSPFResponse struct {
// Metadata for the results.
Meta EmailRoutingTimeseriesGroupSPFResponseMeta `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 EmailRoutingTimeseriesGroupSPFResponseMeta ¶
type EmailRoutingTimeseriesGroupSPFResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailRoutingTimeseriesGroupSPFResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailRoutingTimeseriesGroupSPFResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailRoutingTimeseriesGroupSPFResponseMetaUnit `json:"units,required"`
JSON emailRoutingTimeseriesGroupSPFResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailRoutingTimeseriesGroupSPFResponseMeta) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupSPFResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval ¶
type EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailRoutingTimeseriesGroupSPFResponseMetaAggIntervalFifteenMinutes EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailRoutingTimeseriesGroupSPFResponseMetaAggIntervalOneHour EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval = "ONE_HOUR" EmailRoutingTimeseriesGroupSPFResponseMetaAggIntervalOneDay EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval = "ONE_DAY" EmailRoutingTimeseriesGroupSPFResponseMetaAggIntervalOneWeek EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval = "ONE_WEEK" EmailRoutingTimeseriesGroupSPFResponseMetaAggIntervalOneMonth EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval = "ONE_MONTH" )
func (EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval) IsKnown ¶
func (r EmailRoutingTimeseriesGroupSPFResponseMetaAggInterval) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfo ¶
type EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfo struct {
Annotations []EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation ¶
type EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupSPFResponseMetaDateRange ¶
type EmailRoutingTimeseriesGroupSPFResponseMetaDateRange 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 emailRoutingTimeseriesGroupSPFResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupSPFResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupSPFResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailRoutingTimeseriesGroupSPFResponseMetaNormalization ¶
type EmailRoutingTimeseriesGroupSPFResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationPercentage EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "PERCENTAGE" EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationMin0Max EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "MIN0_MAX" EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationMinMax EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "MIN_MAX" EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationRawValues EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "RAW_VALUES" EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationPercentageChange EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationRollingAverage EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "ROLLING_AVERAGE" EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationOverlappedPercentage EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailRoutingTimeseriesGroupSPFResponseMetaNormalizationRatio EmailRoutingTimeseriesGroupSPFResponseMetaNormalization = "RATIO" )
func (EmailRoutingTimeseriesGroupSPFResponseMetaNormalization) IsKnown ¶
func (r EmailRoutingTimeseriesGroupSPFResponseMetaNormalization) IsKnown() bool
type EmailRoutingTimeseriesGroupSPFResponseMetaUnit ¶
type EmailRoutingTimeseriesGroupSPFResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailRoutingTimeseriesGroupSPFResponseMetaUnitJSON `json:"-"`
}
func (*EmailRoutingTimeseriesGroupSPFResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailRoutingTimeseriesGroupSPFResponseMetaUnit) 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 ¶
func (r *EmailRoutingTimeseriesGroupService) ARC(ctx context.Context, query EmailRoutingTimeseriesGroupARCParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupARCResponse, err error)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.
func (*EmailRoutingTimeseriesGroupService) DKIM ¶
func (r *EmailRoutingTimeseriesGroupService) DKIM(ctx context.Context, query EmailRoutingTimeseriesGroupDKIMParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupDKIMResponse, err error)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.
func (*EmailRoutingTimeseriesGroupService) DMARC ¶
func (r *EmailRoutingTimeseriesGroupService) DMARC(ctx context.Context, query EmailRoutingTimeseriesGroupDMARCParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupDMARCResponse, err error)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.
func (*EmailRoutingTimeseriesGroupService) Encrypted ¶
func (r *EmailRoutingTimeseriesGroupService) Encrypted(ctx context.Context, query EmailRoutingTimeseriesGroupEncryptedParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupEncryptedResponse, err error)
Retrieves the distribution of emails by encryption status (encrypted vs. not-encrypted) over time.
func (*EmailRoutingTimeseriesGroupService) IPVersion ¶
func (r *EmailRoutingTimeseriesGroupService) IPVersion(ctx context.Context, query EmailRoutingTimeseriesGroupIPVersionParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupIPVersionResponse, err error)
Retrieves the distribution of emails by IP version over time.
func (*EmailRoutingTimeseriesGroupService) SPF ¶
func (r *EmailRoutingTimeseriesGroupService) SPF(ctx context.Context, query EmailRoutingTimeseriesGroupSPFParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupSPFResponse, err error)
Retrieves the distribution of emails by SPF (Sender Policy Framework) 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummaryARCParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummaryARCParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummaryARCParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummaryARCParamsSPF] `query:"spf"`
// Filters results by 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 ¶
func (r EmailSecuritySummaryARCParamsDKIM) IsKnown() bool
type EmailSecuritySummaryARCParamsDMARC ¶
type EmailSecuritySummaryARCParamsDMARC string
const ( EmailSecuritySummaryARCParamsDMARCPass EmailSecuritySummaryARCParamsDMARC = "PASS" EmailSecuritySummaryARCParamsDMARCNone EmailSecuritySummaryARCParamsDMARC = "NONE" EmailSecuritySummaryARCParamsDMARCFail EmailSecuritySummaryARCParamsDMARC = "FAIL" )
func (EmailSecuritySummaryARCParamsDMARC) IsKnown ¶
func (r EmailSecuritySummaryARCParamsDMARC) IsKnown() bool
type EmailSecuritySummaryARCParamsFormat ¶
type EmailSecuritySummaryARCParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummaryARCParamsFormatJson EmailSecuritySummaryARCParamsFormat = "JSON" EmailSecuritySummaryARCParamsFormatCsv EmailSecuritySummaryARCParamsFormat = "CSV" )
func (EmailSecuritySummaryARCParamsFormat) IsKnown ¶
func (r EmailSecuritySummaryARCParamsFormat) IsKnown() bool
type EmailSecuritySummaryARCParamsSPF ¶
type EmailSecuritySummaryARCParamsSPF string
const ( EmailSecuritySummaryARCParamsSPFPass EmailSecuritySummaryARCParamsSPF = "PASS" EmailSecuritySummaryARCParamsSPFNone EmailSecuritySummaryARCParamsSPF = "NONE" EmailSecuritySummaryARCParamsSPFFail EmailSecuritySummaryARCParamsSPF = "FAIL" )
func (EmailSecuritySummaryARCParamsSPF) IsKnown ¶
func (r EmailSecuritySummaryARCParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecuritySummaryARCParamsTLSVersion) IsKnown() bool
type EmailSecuritySummaryARCResponse ¶
type EmailSecuritySummaryARCResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummaryARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummaryARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummaryARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummaryARCResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummaryARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummaryARCResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummaryARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryARCResponseMetaConfidenceInfo ¶
type EmailSecuritySummaryARCResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummaryARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummaryARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummaryARCResponseMetaNormalization ¶
type EmailSecuritySummaryARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummaryARCResponseMetaNormalizationPercentage EmailSecuritySummaryARCResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummaryARCResponseMetaNormalizationMin0Max EmailSecuritySummaryARCResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummaryARCResponseMetaNormalizationMinMax EmailSecuritySummaryARCResponseMetaNormalization = "MIN_MAX" EmailSecuritySummaryARCResponseMetaNormalizationRawValues EmailSecuritySummaryARCResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummaryARCResponseMetaNormalizationPercentageChange EmailSecuritySummaryARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummaryARCResponseMetaNormalizationRollingAverage EmailSecuritySummaryARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummaryARCResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummaryARCResponseMetaNormalizationRatio EmailSecuritySummaryARCResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummaryARCResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummaryARCResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummaryARCResponseMetaUnit ¶
type EmailSecuritySummaryARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummaryARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummaryARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummaryARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryDKIMParams ¶
type EmailSecuritySummaryDKIMParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummaryDKIMParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummaryDKIMParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummaryDKIMParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummaryDKIMParamsSPF] `query:"spf"`
// Filters results by 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 ¶
func (r EmailSecuritySummaryDKIMParamsARC) IsKnown() bool
type EmailSecuritySummaryDKIMParamsDMARC ¶
type EmailSecuritySummaryDKIMParamsDMARC string
const ( EmailSecuritySummaryDKIMParamsDMARCPass EmailSecuritySummaryDKIMParamsDMARC = "PASS" EmailSecuritySummaryDKIMParamsDMARCNone EmailSecuritySummaryDKIMParamsDMARC = "NONE" EmailSecuritySummaryDKIMParamsDMARCFail EmailSecuritySummaryDKIMParamsDMARC = "FAIL" )
func (EmailSecuritySummaryDKIMParamsDMARC) IsKnown ¶
func (r EmailSecuritySummaryDKIMParamsDMARC) IsKnown() bool
type EmailSecuritySummaryDKIMParamsFormat ¶
type EmailSecuritySummaryDKIMParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummaryDKIMParamsFormatJson EmailSecuritySummaryDKIMParamsFormat = "JSON" EmailSecuritySummaryDKIMParamsFormatCsv EmailSecuritySummaryDKIMParamsFormat = "CSV" )
func (EmailSecuritySummaryDKIMParamsFormat) IsKnown ¶
func (r EmailSecuritySummaryDKIMParamsFormat) IsKnown() bool
type EmailSecuritySummaryDKIMParamsSPF ¶
type EmailSecuritySummaryDKIMParamsSPF string
const ( EmailSecuritySummaryDKIMParamsSPFPass EmailSecuritySummaryDKIMParamsSPF = "PASS" EmailSecuritySummaryDKIMParamsSPFNone EmailSecuritySummaryDKIMParamsSPF = "NONE" EmailSecuritySummaryDKIMParamsSPFFail EmailSecuritySummaryDKIMParamsSPF = "FAIL" )
func (EmailSecuritySummaryDKIMParamsSPF) IsKnown ¶
func (r EmailSecuritySummaryDKIMParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecuritySummaryDKIMParamsTLSVersion) IsKnown() bool
type EmailSecuritySummaryDKIMResponse ¶
type EmailSecuritySummaryDKIMResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummaryDKIMResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummaryDKIMResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummaryDKIMResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummaryDKIMResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummaryDKIMResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummaryDKIMResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummaryDKIMResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryDKIMResponseMetaConfidenceInfo ¶
type EmailSecuritySummaryDKIMResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummaryDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummaryDKIMResponseMetaNormalization ¶
type EmailSecuritySummaryDKIMResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummaryDKIMResponseMetaNormalizationPercentage EmailSecuritySummaryDKIMResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummaryDKIMResponseMetaNormalizationMin0Max EmailSecuritySummaryDKIMResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummaryDKIMResponseMetaNormalizationMinMax EmailSecuritySummaryDKIMResponseMetaNormalization = "MIN_MAX" EmailSecuritySummaryDKIMResponseMetaNormalizationRawValues EmailSecuritySummaryDKIMResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummaryDKIMResponseMetaNormalizationPercentageChange EmailSecuritySummaryDKIMResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummaryDKIMResponseMetaNormalizationRollingAverage EmailSecuritySummaryDKIMResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummaryDKIMResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryDKIMResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummaryDKIMResponseMetaNormalizationRatio EmailSecuritySummaryDKIMResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummaryDKIMResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummaryDKIMResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummaryDKIMResponseMetaUnit ¶
type EmailSecuritySummaryDKIMResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummaryDKIMResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummaryDKIMResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummaryDKIMResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryDMARCParams ¶
type EmailSecuritySummaryDMARCParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummaryDMARCParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummaryDMARCParamsDKIM] `query:"dkim"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummaryDMARCParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummaryDMARCParamsSPF] `query:"spf"`
// Filters results by 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 ¶
func (r EmailSecuritySummaryDMARCParamsARC) IsKnown() bool
type EmailSecuritySummaryDMARCParamsDKIM ¶
type EmailSecuritySummaryDMARCParamsDKIM string
const ( EmailSecuritySummaryDMARCParamsDKIMPass EmailSecuritySummaryDMARCParamsDKIM = "PASS" EmailSecuritySummaryDMARCParamsDKIMNone EmailSecuritySummaryDMARCParamsDKIM = "NONE" EmailSecuritySummaryDMARCParamsDKIMFail EmailSecuritySummaryDMARCParamsDKIM = "FAIL" )
func (EmailSecuritySummaryDMARCParamsDKIM) IsKnown ¶
func (r EmailSecuritySummaryDMARCParamsDKIM) IsKnown() bool
type EmailSecuritySummaryDMARCParamsFormat ¶
type EmailSecuritySummaryDMARCParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummaryDMARCParamsFormatJson EmailSecuritySummaryDMARCParamsFormat = "JSON" EmailSecuritySummaryDMARCParamsFormatCsv EmailSecuritySummaryDMARCParamsFormat = "CSV" )
func (EmailSecuritySummaryDMARCParamsFormat) IsKnown ¶
func (r EmailSecuritySummaryDMARCParamsFormat) IsKnown() bool
type EmailSecuritySummaryDMARCParamsSPF ¶
type EmailSecuritySummaryDMARCParamsSPF string
const ( EmailSecuritySummaryDMARCParamsSPFPass EmailSecuritySummaryDMARCParamsSPF = "PASS" EmailSecuritySummaryDMARCParamsSPFNone EmailSecuritySummaryDMARCParamsSPF = "NONE" EmailSecuritySummaryDMARCParamsSPFFail EmailSecuritySummaryDMARCParamsSPF = "FAIL" )
func (EmailSecuritySummaryDMARCParamsSPF) IsKnown ¶
func (r EmailSecuritySummaryDMARCParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecuritySummaryDMARCParamsTLSVersion) IsKnown() bool
type EmailSecuritySummaryDMARCResponse ¶
type EmailSecuritySummaryDMARCResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummaryDMARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummaryDMARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummaryDMARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummaryDMARCResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummaryDMARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummaryDMARCResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummaryDMARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryDMARCResponseMetaConfidenceInfo ¶
type EmailSecuritySummaryDMARCResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummaryDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummaryDMARCResponseMetaNormalization ¶
type EmailSecuritySummaryDMARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummaryDMARCResponseMetaNormalizationPercentage EmailSecuritySummaryDMARCResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummaryDMARCResponseMetaNormalizationMin0Max EmailSecuritySummaryDMARCResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummaryDMARCResponseMetaNormalizationMinMax EmailSecuritySummaryDMARCResponseMetaNormalization = "MIN_MAX" EmailSecuritySummaryDMARCResponseMetaNormalizationRawValues EmailSecuritySummaryDMARCResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummaryDMARCResponseMetaNormalizationPercentageChange EmailSecuritySummaryDMARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummaryDMARCResponseMetaNormalizationRollingAverage EmailSecuritySummaryDMARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummaryDMARCResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryDMARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummaryDMARCResponseMetaNormalizationRatio EmailSecuritySummaryDMARCResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummaryDMARCResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummaryDMARCResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummaryDMARCResponseMetaUnit ¶
type EmailSecuritySummaryDMARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummaryDMARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummaryDMARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummaryDMARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryMaliciousParams ¶
type EmailSecuritySummaryMaliciousParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummaryMaliciousParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummaryMaliciousParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummaryMaliciousParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummaryMaliciousParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummaryMaliciousParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecuritySummaryMaliciousParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecuritySummaryMaliciousParams) URLQuery ¶
func (r EmailSecuritySummaryMaliciousParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecuritySummaryMaliciousParamsARC) IsKnown() bool
type EmailSecuritySummaryMaliciousParamsDKIM ¶
type EmailSecuritySummaryMaliciousParamsDKIM string
const ( EmailSecuritySummaryMaliciousParamsDKIMPass EmailSecuritySummaryMaliciousParamsDKIM = "PASS" EmailSecuritySummaryMaliciousParamsDKIMNone EmailSecuritySummaryMaliciousParamsDKIM = "NONE" EmailSecuritySummaryMaliciousParamsDKIMFail EmailSecuritySummaryMaliciousParamsDKIM = "FAIL" )
func (EmailSecuritySummaryMaliciousParamsDKIM) IsKnown ¶
func (r EmailSecuritySummaryMaliciousParamsDKIM) IsKnown() bool
type EmailSecuritySummaryMaliciousParamsDMARC ¶
type EmailSecuritySummaryMaliciousParamsDMARC string
const ( EmailSecuritySummaryMaliciousParamsDMARCPass EmailSecuritySummaryMaliciousParamsDMARC = "PASS" EmailSecuritySummaryMaliciousParamsDMARCNone EmailSecuritySummaryMaliciousParamsDMARC = "NONE" EmailSecuritySummaryMaliciousParamsDMARCFail EmailSecuritySummaryMaliciousParamsDMARC = "FAIL" )
func (EmailSecuritySummaryMaliciousParamsDMARC) IsKnown ¶
func (r EmailSecuritySummaryMaliciousParamsDMARC) IsKnown() bool
type EmailSecuritySummaryMaliciousParamsFormat ¶
type EmailSecuritySummaryMaliciousParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummaryMaliciousParamsFormatJson EmailSecuritySummaryMaliciousParamsFormat = "JSON" EmailSecuritySummaryMaliciousParamsFormatCsv EmailSecuritySummaryMaliciousParamsFormat = "CSV" )
func (EmailSecuritySummaryMaliciousParamsFormat) IsKnown ¶
func (r EmailSecuritySummaryMaliciousParamsFormat) IsKnown() bool
type EmailSecuritySummaryMaliciousParamsSPF ¶
type EmailSecuritySummaryMaliciousParamsSPF string
const ( EmailSecuritySummaryMaliciousParamsSPFPass EmailSecuritySummaryMaliciousParamsSPF = "PASS" EmailSecuritySummaryMaliciousParamsSPFNone EmailSecuritySummaryMaliciousParamsSPF = "NONE" EmailSecuritySummaryMaliciousParamsSPFFail EmailSecuritySummaryMaliciousParamsSPF = "FAIL" )
func (EmailSecuritySummaryMaliciousParamsSPF) IsKnown ¶
func (r EmailSecuritySummaryMaliciousParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecuritySummaryMaliciousParamsTLSVersion) IsKnown() bool
type EmailSecuritySummaryMaliciousResponse ¶
type EmailSecuritySummaryMaliciousResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummaryMaliciousResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummaryMaliciousResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummaryMaliciousResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummaryMaliciousResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummaryMaliciousResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummaryMaliciousResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo ¶
type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecuritySummaryMaliciousResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecuritySummaryMaliciousResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation ¶
type EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummaryMaliciousResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummaryMaliciousResponseMetaNormalization ¶
type EmailSecuritySummaryMaliciousResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummaryMaliciousResponseMetaNormalizationPercentage EmailSecuritySummaryMaliciousResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummaryMaliciousResponseMetaNormalizationMin0Max EmailSecuritySummaryMaliciousResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummaryMaliciousResponseMetaNormalizationMinMax EmailSecuritySummaryMaliciousResponseMetaNormalization = "MIN_MAX" EmailSecuritySummaryMaliciousResponseMetaNormalizationRawValues EmailSecuritySummaryMaliciousResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummaryMaliciousResponseMetaNormalizationPercentageChange EmailSecuritySummaryMaliciousResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummaryMaliciousResponseMetaNormalizationRollingAverage EmailSecuritySummaryMaliciousResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummaryMaliciousResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryMaliciousResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummaryMaliciousResponseMetaNormalizationRatio EmailSecuritySummaryMaliciousResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummaryMaliciousResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummaryMaliciousResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummaryMaliciousResponseMetaUnit ¶
type EmailSecuritySummaryMaliciousResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummaryMaliciousResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummaryMaliciousResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummaryMaliciousResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryMaliciousResponseSummary0 ¶
type EmailSecuritySummaryMaliciousResponseSummary0 struct {
// A numeric string.
Malicious string `json:"MALICIOUS,required"`
// A numeric string.
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 {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummarySPFParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummarySPFParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummarySPFParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummarySPFParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by 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 ¶
func (r EmailSecuritySummarySPFParamsARC) IsKnown() bool
type EmailSecuritySummarySPFParamsDKIM ¶
type EmailSecuritySummarySPFParamsDKIM string
const ( EmailSecuritySummarySPFParamsDKIMPass EmailSecuritySummarySPFParamsDKIM = "PASS" EmailSecuritySummarySPFParamsDKIMNone EmailSecuritySummarySPFParamsDKIM = "NONE" EmailSecuritySummarySPFParamsDKIMFail EmailSecuritySummarySPFParamsDKIM = "FAIL" )
func (EmailSecuritySummarySPFParamsDKIM) IsKnown ¶
func (r EmailSecuritySummarySPFParamsDKIM) IsKnown() bool
type EmailSecuritySummarySPFParamsDMARC ¶
type EmailSecuritySummarySPFParamsDMARC string
const ( EmailSecuritySummarySPFParamsDMARCPass EmailSecuritySummarySPFParamsDMARC = "PASS" EmailSecuritySummarySPFParamsDMARCNone EmailSecuritySummarySPFParamsDMARC = "NONE" EmailSecuritySummarySPFParamsDMARCFail EmailSecuritySummarySPFParamsDMARC = "FAIL" )
func (EmailSecuritySummarySPFParamsDMARC) IsKnown ¶
func (r EmailSecuritySummarySPFParamsDMARC) IsKnown() bool
type EmailSecuritySummarySPFParamsFormat ¶
type EmailSecuritySummarySPFParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummarySPFParamsFormatJson EmailSecuritySummarySPFParamsFormat = "JSON" EmailSecuritySummarySPFParamsFormatCsv EmailSecuritySummarySPFParamsFormat = "CSV" )
func (EmailSecuritySummarySPFParamsFormat) IsKnown ¶
func (r EmailSecuritySummarySPFParamsFormat) IsKnown() bool
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 ¶
func (r EmailSecuritySummarySPFParamsTLSVersion) IsKnown() bool
type EmailSecuritySummarySPFResponse ¶
type EmailSecuritySummarySPFResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummarySPFResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummarySPFResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummarySPFResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummarySPFResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummarySPFResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummarySPFResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummarySPFResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummarySPFResponseMetaConfidenceInfo ¶
type EmailSecuritySummarySPFResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummarySPFResponseMetaNormalization ¶
type EmailSecuritySummarySPFResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummarySPFResponseMetaNormalizationPercentage EmailSecuritySummarySPFResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummarySPFResponseMetaNormalizationMin0Max EmailSecuritySummarySPFResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummarySPFResponseMetaNormalizationMinMax EmailSecuritySummarySPFResponseMetaNormalization = "MIN_MAX" EmailSecuritySummarySPFResponseMetaNormalizationRawValues EmailSecuritySummarySPFResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummarySPFResponseMetaNormalizationPercentageChange EmailSecuritySummarySPFResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummarySPFResponseMetaNormalizationRollingAverage EmailSecuritySummarySPFResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummarySPFResponseMetaNormalizationOverlappedPercentage EmailSecuritySummarySPFResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummarySPFResponseMetaNormalizationRatio EmailSecuritySummarySPFResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummarySPFResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummarySPFResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummarySPFResponseMetaUnit ¶
type EmailSecuritySummarySPFResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummarySPFResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummarySPFResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummarySPFResponseMetaUnit) 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 ¶
func (r *EmailSecuritySummaryService) ARC(ctx context.Context, query EmailSecuritySummaryARCParams, opts ...option.RequestOption) (res *EmailSecuritySummaryARCResponse, err error)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation.
func (*EmailSecuritySummaryService) DKIM ¶
func (r *EmailSecuritySummaryService) DKIM(ctx context.Context, query EmailSecuritySummaryDKIMParams, opts ...option.RequestOption) (res *EmailSecuritySummaryDKIMResponse, err error)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation.
func (*EmailSecuritySummaryService) DMARC ¶
func (r *EmailSecuritySummaryService) DMARC(ctx context.Context, query EmailSecuritySummaryDMARCParams, opts ...option.RequestOption) (res *EmailSecuritySummaryDMARCResponse, err error)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation.
func (*EmailSecuritySummaryService) Malicious ¶
func (r *EmailSecuritySummaryService) Malicious(ctx context.Context, query EmailSecuritySummaryMaliciousParams, opts ...option.RequestOption) (res *EmailSecuritySummaryMaliciousResponse, err error)
Retrieves the distribution of emails by malicious classification.
func (*EmailSecuritySummaryService) SPF ¶
func (r *EmailSecuritySummaryService) SPF(ctx context.Context, query EmailSecuritySummarySPFParams, opts ...option.RequestOption) (res *EmailSecuritySummarySPFResponse, err error)
Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.
func (*EmailSecuritySummaryService) Spam ¶
func (r *EmailSecuritySummaryService) Spam(ctx context.Context, query EmailSecuritySummarySpamParams, opts ...option.RequestOption) (res *EmailSecuritySummarySpamResponse, err error)
Retrieves the proportion of emails by spam classification (spam vs. non-spam).
func (*EmailSecuritySummaryService) Spoof ¶
func (r *EmailSecuritySummaryService) Spoof(ctx context.Context, query EmailSecuritySummarySpoofParams, opts ...option.RequestOption) (res *EmailSecuritySummarySpoofResponse, err error)
Retrieves the proportion of emails by spoof classification (spoof vs. non-spoof).
func (*EmailSecuritySummaryService) TLSVersion ¶
func (r *EmailSecuritySummaryService) TLSVersion(ctx context.Context, query EmailSecuritySummaryTLSVersionParams, opts ...option.RequestOption) (res *EmailSecuritySummaryTLSVersionResponse, err error)
Retrieves the distribution of emails by TLS version.
func (*EmailSecuritySummaryService) ThreatCategory ¶
func (r *EmailSecuritySummaryService) ThreatCategory(ctx context.Context, query EmailSecuritySummaryThreatCategoryParams, opts ...option.RequestOption) (res *EmailSecuritySummaryThreatCategoryResponse, err error)
Retrieves the distribution of emails by threat categories.
type EmailSecuritySummarySpamParams ¶
type EmailSecuritySummarySpamParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummarySpamParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummarySpamParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummarySpamParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummarySpamParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummarySpamParamsSPF] `query:"spf"`
// Filters results by 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 ¶
func (r EmailSecuritySummarySpamParamsARC) IsKnown() bool
type EmailSecuritySummarySpamParamsDKIM ¶
type EmailSecuritySummarySpamParamsDKIM string
const ( EmailSecuritySummarySpamParamsDKIMPass EmailSecuritySummarySpamParamsDKIM = "PASS" EmailSecuritySummarySpamParamsDKIMNone EmailSecuritySummarySpamParamsDKIM = "NONE" EmailSecuritySummarySpamParamsDKIMFail EmailSecuritySummarySpamParamsDKIM = "FAIL" )
func (EmailSecuritySummarySpamParamsDKIM) IsKnown ¶
func (r EmailSecuritySummarySpamParamsDKIM) IsKnown() bool
type EmailSecuritySummarySpamParamsDMARC ¶
type EmailSecuritySummarySpamParamsDMARC string
const ( EmailSecuritySummarySpamParamsDMARCPass EmailSecuritySummarySpamParamsDMARC = "PASS" EmailSecuritySummarySpamParamsDMARCNone EmailSecuritySummarySpamParamsDMARC = "NONE" EmailSecuritySummarySpamParamsDMARCFail EmailSecuritySummarySpamParamsDMARC = "FAIL" )
func (EmailSecuritySummarySpamParamsDMARC) IsKnown ¶
func (r EmailSecuritySummarySpamParamsDMARC) IsKnown() bool
type EmailSecuritySummarySpamParamsFormat ¶
type EmailSecuritySummarySpamParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummarySpamParamsFormatJson EmailSecuritySummarySpamParamsFormat = "JSON" EmailSecuritySummarySpamParamsFormatCsv EmailSecuritySummarySpamParamsFormat = "CSV" )
func (EmailSecuritySummarySpamParamsFormat) IsKnown ¶
func (r EmailSecuritySummarySpamParamsFormat) IsKnown() bool
type EmailSecuritySummarySpamParamsSPF ¶
type EmailSecuritySummarySpamParamsSPF string
const ( EmailSecuritySummarySpamParamsSPFPass EmailSecuritySummarySpamParamsSPF = "PASS" EmailSecuritySummarySpamParamsSPFNone EmailSecuritySummarySpamParamsSPF = "NONE" EmailSecuritySummarySpamParamsSPFFail EmailSecuritySummarySpamParamsSPF = "FAIL" )
func (EmailSecuritySummarySpamParamsSPF) IsKnown ¶
func (r EmailSecuritySummarySpamParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecuritySummarySpamParamsTLSVersion) IsKnown() bool
type EmailSecuritySummarySpamResponse ¶
type EmailSecuritySummarySpamResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummarySpamResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummarySpamResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummarySpamResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummarySpamResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummarySpamResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummarySpamResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpamResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummarySpamResponseMetaConfidenceInfo ¶
type EmailSecuritySummarySpamResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummarySpamResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpamResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummarySpamResponseMetaNormalization ¶
type EmailSecuritySummarySpamResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummarySpamResponseMetaNormalizationPercentage EmailSecuritySummarySpamResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummarySpamResponseMetaNormalizationMin0Max EmailSecuritySummarySpamResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummarySpamResponseMetaNormalizationMinMax EmailSecuritySummarySpamResponseMetaNormalization = "MIN_MAX" EmailSecuritySummarySpamResponseMetaNormalizationRawValues EmailSecuritySummarySpamResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummarySpamResponseMetaNormalizationPercentageChange EmailSecuritySummarySpamResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummarySpamResponseMetaNormalizationRollingAverage EmailSecuritySummarySpamResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummarySpamResponseMetaNormalizationOverlappedPercentage EmailSecuritySummarySpamResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummarySpamResponseMetaNormalizationRatio EmailSecuritySummarySpamResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummarySpamResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummarySpamResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummarySpamResponseMetaUnit ¶
type EmailSecuritySummarySpamResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummarySpamResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummarySpamResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpamResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummarySpamResponseSummary0 ¶
type EmailSecuritySummarySpamResponseSummary0 struct {
// A numeric string.
NotSpam string `json:"NOT_SPAM,required"`
// A numeric string.
Spam string `json:"SPAM,required"`
JSON emailSecuritySummarySpamResponseSummary0JSON `json:"-"`
}
func (*EmailSecuritySummarySpamResponseSummary0) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpamResponseSummary0) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummarySpoofParams ¶
type EmailSecuritySummarySpoofParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummarySpoofParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummarySpoofParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummarySpoofParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummarySpoofParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummarySpoofParamsSPF] `query:"spf"`
// Filters results by 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 ¶
func (r EmailSecuritySummarySpoofParamsARC) IsKnown() bool
type EmailSecuritySummarySpoofParamsDKIM ¶
type EmailSecuritySummarySpoofParamsDKIM string
const ( EmailSecuritySummarySpoofParamsDKIMPass EmailSecuritySummarySpoofParamsDKIM = "PASS" EmailSecuritySummarySpoofParamsDKIMNone EmailSecuritySummarySpoofParamsDKIM = "NONE" EmailSecuritySummarySpoofParamsDKIMFail EmailSecuritySummarySpoofParamsDKIM = "FAIL" )
func (EmailSecuritySummarySpoofParamsDKIM) IsKnown ¶
func (r EmailSecuritySummarySpoofParamsDKIM) IsKnown() bool
type EmailSecuritySummarySpoofParamsDMARC ¶
type EmailSecuritySummarySpoofParamsDMARC string
const ( EmailSecuritySummarySpoofParamsDMARCPass EmailSecuritySummarySpoofParamsDMARC = "PASS" EmailSecuritySummarySpoofParamsDMARCNone EmailSecuritySummarySpoofParamsDMARC = "NONE" EmailSecuritySummarySpoofParamsDMARCFail EmailSecuritySummarySpoofParamsDMARC = "FAIL" )
func (EmailSecuritySummarySpoofParamsDMARC) IsKnown ¶
func (r EmailSecuritySummarySpoofParamsDMARC) IsKnown() bool
type EmailSecuritySummarySpoofParamsFormat ¶
type EmailSecuritySummarySpoofParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummarySpoofParamsFormatJson EmailSecuritySummarySpoofParamsFormat = "JSON" EmailSecuritySummarySpoofParamsFormatCsv EmailSecuritySummarySpoofParamsFormat = "CSV" )
func (EmailSecuritySummarySpoofParamsFormat) IsKnown ¶
func (r EmailSecuritySummarySpoofParamsFormat) IsKnown() bool
type EmailSecuritySummarySpoofParamsSPF ¶
type EmailSecuritySummarySpoofParamsSPF string
const ( EmailSecuritySummarySpoofParamsSPFPass EmailSecuritySummarySpoofParamsSPF = "PASS" EmailSecuritySummarySpoofParamsSPFNone EmailSecuritySummarySpoofParamsSPF = "NONE" EmailSecuritySummarySpoofParamsSPFFail EmailSecuritySummarySpoofParamsSPF = "FAIL" )
func (EmailSecuritySummarySpoofParamsSPF) IsKnown ¶
func (r EmailSecuritySummarySpoofParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecuritySummarySpoofParamsTLSVersion) IsKnown() bool
type EmailSecuritySummarySpoofResponse ¶
type EmailSecuritySummarySpoofResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummarySpoofResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummarySpoofResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummarySpoofResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummarySpoofResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummarySpoofResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummarySpoofResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpoofResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummarySpoofResponseMetaConfidenceInfo ¶
type EmailSecuritySummarySpoofResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpoofResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummarySpoofResponseMetaNormalization ¶
type EmailSecuritySummarySpoofResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummarySpoofResponseMetaNormalizationPercentage EmailSecuritySummarySpoofResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummarySpoofResponseMetaNormalizationMin0Max EmailSecuritySummarySpoofResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummarySpoofResponseMetaNormalizationMinMax EmailSecuritySummarySpoofResponseMetaNormalization = "MIN_MAX" EmailSecuritySummarySpoofResponseMetaNormalizationRawValues EmailSecuritySummarySpoofResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummarySpoofResponseMetaNormalizationPercentageChange EmailSecuritySummarySpoofResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummarySpoofResponseMetaNormalizationRollingAverage EmailSecuritySummarySpoofResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummarySpoofResponseMetaNormalizationOverlappedPercentage EmailSecuritySummarySpoofResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummarySpoofResponseMetaNormalizationRatio EmailSecuritySummarySpoofResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummarySpoofResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummarySpoofResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummarySpoofResponseMetaUnit ¶
type EmailSecuritySummarySpoofResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummarySpoofResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummarySpoofResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpoofResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummarySpoofResponseSummary0 ¶
type EmailSecuritySummarySpoofResponseSummary0 struct {
// A numeric string.
NotSpoof string `json:"NOT_SPOOF,required"`
// A numeric string.
Spoof string `json:"SPOOF,required"`
JSON emailSecuritySummarySpoofResponseSummary0JSON `json:"-"`
}
func (*EmailSecuritySummarySpoofResponseSummary0) UnmarshalJSON ¶
func (r *EmailSecuritySummarySpoofResponseSummary0) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryTLSVersionParams ¶
type EmailSecuritySummaryTLSVersionParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummaryTLSVersionParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummaryTLSVersionParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummaryTLSVersionParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummaryTLSVersionParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummaryTLSVersionParamsSPF] `query:"spf"`
}
func (EmailSecuritySummaryTLSVersionParams) URLQuery ¶
func (r EmailSecuritySummaryTLSVersionParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecuritySummaryTLSVersionParamsARC) IsKnown() bool
type EmailSecuritySummaryTLSVersionParamsDKIM ¶
type EmailSecuritySummaryTLSVersionParamsDKIM string
const ( EmailSecuritySummaryTLSVersionParamsDKIMPass EmailSecuritySummaryTLSVersionParamsDKIM = "PASS" EmailSecuritySummaryTLSVersionParamsDKIMNone EmailSecuritySummaryTLSVersionParamsDKIM = "NONE" EmailSecuritySummaryTLSVersionParamsDKIMFail EmailSecuritySummaryTLSVersionParamsDKIM = "FAIL" )
func (EmailSecuritySummaryTLSVersionParamsDKIM) IsKnown ¶
func (r EmailSecuritySummaryTLSVersionParamsDKIM) IsKnown() bool
type EmailSecuritySummaryTLSVersionParamsDMARC ¶
type EmailSecuritySummaryTLSVersionParamsDMARC string
const ( EmailSecuritySummaryTLSVersionParamsDMARCPass EmailSecuritySummaryTLSVersionParamsDMARC = "PASS" EmailSecuritySummaryTLSVersionParamsDMARCNone EmailSecuritySummaryTLSVersionParamsDMARC = "NONE" EmailSecuritySummaryTLSVersionParamsDMARCFail EmailSecuritySummaryTLSVersionParamsDMARC = "FAIL" )
func (EmailSecuritySummaryTLSVersionParamsDMARC) IsKnown ¶
func (r EmailSecuritySummaryTLSVersionParamsDMARC) IsKnown() bool
type EmailSecuritySummaryTLSVersionParamsFormat ¶
type EmailSecuritySummaryTLSVersionParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummaryTLSVersionParamsFormatJson EmailSecuritySummaryTLSVersionParamsFormat = "JSON" EmailSecuritySummaryTLSVersionParamsFormatCsv EmailSecuritySummaryTLSVersionParamsFormat = "CSV" )
func (EmailSecuritySummaryTLSVersionParamsFormat) IsKnown ¶
func (r EmailSecuritySummaryTLSVersionParamsFormat) IsKnown() bool
type EmailSecuritySummaryTLSVersionParamsSPF ¶
type EmailSecuritySummaryTLSVersionParamsSPF string
const ( EmailSecuritySummaryTLSVersionParamsSPFPass EmailSecuritySummaryTLSVersionParamsSPF = "PASS" EmailSecuritySummaryTLSVersionParamsSPFNone EmailSecuritySummaryTLSVersionParamsSPF = "NONE" EmailSecuritySummaryTLSVersionParamsSPFFail EmailSecuritySummaryTLSVersionParamsSPF = "FAIL" )
func (EmailSecuritySummaryTLSVersionParamsSPF) IsKnown ¶
func (r EmailSecuritySummaryTLSVersionParamsSPF) IsKnown() bool
type EmailSecuritySummaryTLSVersionResponse ¶
type EmailSecuritySummaryTLSVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummaryTLSVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummaryTLSVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummaryTLSVersionResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummaryTLSVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummaryTLSVersionResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummaryTLSVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo ¶
type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecuritySummaryTLSVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation ¶
type EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummaryTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecuritySummaryTLSVersionResponseMetaNormalization ¶
type EmailSecuritySummaryTLSVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummaryTLSVersionResponseMetaNormalizationPercentage EmailSecuritySummaryTLSVersionResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummaryTLSVersionResponseMetaNormalizationMin0Max EmailSecuritySummaryTLSVersionResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummaryTLSVersionResponseMetaNormalizationMinMax EmailSecuritySummaryTLSVersionResponseMetaNormalization = "MIN_MAX" EmailSecuritySummaryTLSVersionResponseMetaNormalizationRawValues EmailSecuritySummaryTLSVersionResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummaryTLSVersionResponseMetaNormalizationPercentageChange EmailSecuritySummaryTLSVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummaryTLSVersionResponseMetaNormalizationRollingAverage EmailSecuritySummaryTLSVersionResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummaryTLSVersionResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryTLSVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummaryTLSVersionResponseMetaNormalizationRatio EmailSecuritySummaryTLSVersionResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummaryTLSVersionResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummaryTLSVersionResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummaryTLSVersionResponseMetaUnit ¶
type EmailSecuritySummaryTLSVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummaryTLSVersionResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummaryTLSVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummaryTLSVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryTLSVersionResponseSummary0 ¶
type EmailSecuritySummaryTLSVersionResponseSummary0 struct {
// A numeric string.
TLS1_0 string `json:"TLS 1.0,required"`
// A numeric string.
TLS1_1 string `json:"TLS 1.1,required"`
// A numeric string.
TLS1_2 string `json:"TLS 1.2,required"`
// A numeric string.
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 {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecuritySummaryThreatCategoryParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecuritySummaryThreatCategoryParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecuritySummaryThreatCategoryParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecuritySummaryThreatCategoryParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecuritySummaryThreatCategoryParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecuritySummaryThreatCategoryParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecuritySummaryThreatCategoryParams) URLQuery ¶
func (r EmailSecuritySummaryThreatCategoryParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecuritySummaryThreatCategoryParamsARC) IsKnown() bool
type EmailSecuritySummaryThreatCategoryParamsDKIM ¶
type EmailSecuritySummaryThreatCategoryParamsDKIM string
const ( EmailSecuritySummaryThreatCategoryParamsDKIMPass EmailSecuritySummaryThreatCategoryParamsDKIM = "PASS" EmailSecuritySummaryThreatCategoryParamsDKIMNone EmailSecuritySummaryThreatCategoryParamsDKIM = "NONE" EmailSecuritySummaryThreatCategoryParamsDKIMFail EmailSecuritySummaryThreatCategoryParamsDKIM = "FAIL" )
func (EmailSecuritySummaryThreatCategoryParamsDKIM) IsKnown ¶
func (r EmailSecuritySummaryThreatCategoryParamsDKIM) IsKnown() bool
type EmailSecuritySummaryThreatCategoryParamsDMARC ¶
type EmailSecuritySummaryThreatCategoryParamsDMARC string
const ( EmailSecuritySummaryThreatCategoryParamsDMARCPass EmailSecuritySummaryThreatCategoryParamsDMARC = "PASS" EmailSecuritySummaryThreatCategoryParamsDMARCNone EmailSecuritySummaryThreatCategoryParamsDMARC = "NONE" EmailSecuritySummaryThreatCategoryParamsDMARCFail EmailSecuritySummaryThreatCategoryParamsDMARC = "FAIL" )
func (EmailSecuritySummaryThreatCategoryParamsDMARC) IsKnown ¶
func (r EmailSecuritySummaryThreatCategoryParamsDMARC) IsKnown() bool
type EmailSecuritySummaryThreatCategoryParamsFormat ¶
type EmailSecuritySummaryThreatCategoryParamsFormat string
Format in which results will be returned.
const ( EmailSecuritySummaryThreatCategoryParamsFormatJson EmailSecuritySummaryThreatCategoryParamsFormat = "JSON" EmailSecuritySummaryThreatCategoryParamsFormatCsv EmailSecuritySummaryThreatCategoryParamsFormat = "CSV" )
func (EmailSecuritySummaryThreatCategoryParamsFormat) IsKnown ¶
func (r EmailSecuritySummaryThreatCategoryParamsFormat) IsKnown() bool
type EmailSecuritySummaryThreatCategoryParamsSPF ¶
type EmailSecuritySummaryThreatCategoryParamsSPF string
const ( EmailSecuritySummaryThreatCategoryParamsSPFPass EmailSecuritySummaryThreatCategoryParamsSPF = "PASS" EmailSecuritySummaryThreatCategoryParamsSPFNone EmailSecuritySummaryThreatCategoryParamsSPF = "NONE" EmailSecuritySummaryThreatCategoryParamsSPFFail EmailSecuritySummaryThreatCategoryParamsSPF = "FAIL" )
func (EmailSecuritySummaryThreatCategoryParamsSPF) IsKnown ¶
func (r EmailSecuritySummaryThreatCategoryParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecuritySummaryThreatCategoryParamsTLSVersion) IsKnown() bool
type EmailSecuritySummaryThreatCategoryResponse ¶
type EmailSecuritySummaryThreatCategoryResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecuritySummaryThreatCategoryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecuritySummaryThreatCategoryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecuritySummaryThreatCategoryResponseMetaUnit `json:"units,required"`
JSON emailSecuritySummaryThreatCategoryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecuritySummaryThreatCategoryResponseMeta) UnmarshalJSON ¶
func (r *EmailSecuritySummaryThreatCategoryResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo ¶
type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo struct {
Annotations []EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation ¶
type EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecuritySummaryThreatCategoryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r *EmailSecuritySummaryThreatCategoryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryThreatCategoryResponseMetaNormalization ¶
type EmailSecuritySummaryThreatCategoryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecuritySummaryThreatCategoryResponseMetaNormalizationPercentage EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "PERCENTAGE" EmailSecuritySummaryThreatCategoryResponseMetaNormalizationMin0Max EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "MIN0_MAX" EmailSecuritySummaryThreatCategoryResponseMetaNormalizationMinMax EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "MIN_MAX" EmailSecuritySummaryThreatCategoryResponseMetaNormalizationRawValues EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "RAW_VALUES" EmailSecuritySummaryThreatCategoryResponseMetaNormalizationPercentageChange EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecuritySummaryThreatCategoryResponseMetaNormalizationRollingAverage EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecuritySummaryThreatCategoryResponseMetaNormalizationOverlappedPercentage EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecuritySummaryThreatCategoryResponseMetaNormalizationRatio EmailSecuritySummaryThreatCategoryResponseMetaNormalization = "RATIO" )
func (EmailSecuritySummaryThreatCategoryResponseMetaNormalization) IsKnown ¶
func (r EmailSecuritySummaryThreatCategoryResponseMetaNormalization) IsKnown() bool
type EmailSecuritySummaryThreatCategoryResponseMetaUnit ¶
type EmailSecuritySummaryThreatCategoryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecuritySummaryThreatCategoryResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecuritySummaryThreatCategoryResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecuritySummaryThreatCategoryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecuritySummaryThreatCategoryResponseSummary0 ¶
type EmailSecuritySummaryThreatCategoryResponseSummary0 struct {
// A numeric string.
BrandImpersonation string `json:"BrandImpersonation,required"`
// A numeric string.
CredentialHarvester string `json:"CredentialHarvester,required"`
// A numeric string.
IdentityDeception string `json:"IdentityDeception,required"`
// A numeric string.
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 of the results (e.g., 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupARCParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupARCParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupARCParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupARCParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupARCParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupARCParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupARCParams) URLQuery() (v url.Values)
URLQuery serializes EmailSecurityTimeseriesGroupARCParams's query parameters as `url.Values`.
type EmailSecurityTimeseriesGroupARCParamsAggInterval ¶
type EmailSecurityTimeseriesGroupARCParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupARCParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupARCParamsDKIM ¶
type EmailSecurityTimeseriesGroupARCParamsDKIM string
const ( EmailSecurityTimeseriesGroupARCParamsDKIMPass EmailSecurityTimeseriesGroupARCParamsDKIM = "PASS" EmailSecurityTimeseriesGroupARCParamsDKIMNone EmailSecurityTimeseriesGroupARCParamsDKIM = "NONE" EmailSecurityTimeseriesGroupARCParamsDKIMFail EmailSecurityTimeseriesGroupARCParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupARCParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupARCParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupARCParamsDMARC ¶
type EmailSecurityTimeseriesGroupARCParamsDMARC string
const ( EmailSecurityTimeseriesGroupARCParamsDMARCPass EmailSecurityTimeseriesGroupARCParamsDMARC = "PASS" EmailSecurityTimeseriesGroupARCParamsDMARCNone EmailSecurityTimeseriesGroupARCParamsDMARC = "NONE" EmailSecurityTimeseriesGroupARCParamsDMARCFail EmailSecurityTimeseriesGroupARCParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupARCParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupARCParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupARCParamsFormat ¶
type EmailSecurityTimeseriesGroupARCParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupARCParamsFormatJson EmailSecurityTimeseriesGroupARCParamsFormat = "JSON" EmailSecurityTimeseriesGroupARCParamsFormatCsv EmailSecurityTimeseriesGroupARCParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupARCParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupARCParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupARCParamsSPF ¶
type EmailSecurityTimeseriesGroupARCParamsSPF string
const ( EmailSecurityTimeseriesGroupARCParamsSPFPass EmailSecurityTimeseriesGroupARCParamsSPF = "PASS" EmailSecurityTimeseriesGroupARCParamsSPFNone EmailSecurityTimeseriesGroupARCParamsSPF = "NONE" EmailSecurityTimeseriesGroupARCParamsSPFFail EmailSecurityTimeseriesGroupARCParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupARCParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupARCParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupARCParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupARCResponse ¶
type EmailSecurityTimeseriesGroupARCResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupARCResponseMeta `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 EmailSecurityTimeseriesGroupARCResponseMeta ¶
type EmailSecurityTimeseriesGroupARCResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupARCResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupARCResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupARCResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupARCResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupARCResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupARCResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupARCResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupARCResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupARCResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupARCResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupARCResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupARCResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupARCResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupARCResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupARCResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupARCResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupARCResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupARCResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupARCResponseMetaDateRange 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 emailSecurityTimeseriesGroupARCResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupARCResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupARCResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupARCResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupARCResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupARCResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupARCResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupARCResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupARCResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupARCResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupARCResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupARCResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupARCResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupARCResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupARCResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDKIMParams ¶
type EmailSecurityTimeseriesGroupDKIMParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupDKIMParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupDKIMParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupDKIMParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupDKIMParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupDKIMParamsAggInterval ¶
type EmailSecurityTimeseriesGroupDKIMParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupDKIMParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupDKIMParamsDMARC ¶
type EmailSecurityTimeseriesGroupDKIMParamsDMARC string
const ( EmailSecurityTimeseriesGroupDKIMParamsDMARCPass EmailSecurityTimeseriesGroupDKIMParamsDMARC = "PASS" EmailSecurityTimeseriesGroupDKIMParamsDMARCNone EmailSecurityTimeseriesGroupDKIMParamsDMARC = "NONE" EmailSecurityTimeseriesGroupDKIMParamsDMARCFail EmailSecurityTimeseriesGroupDKIMParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupDKIMParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDKIMParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupDKIMParamsFormat ¶
type EmailSecurityTimeseriesGroupDKIMParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupDKIMParamsFormatJson EmailSecurityTimeseriesGroupDKIMParamsFormat = "JSON" EmailSecurityTimeseriesGroupDKIMParamsFormatCsv EmailSecurityTimeseriesGroupDKIMParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupDKIMParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDKIMParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupDKIMParamsSPF ¶
type EmailSecurityTimeseriesGroupDKIMParamsSPF string
const ( EmailSecurityTimeseriesGroupDKIMParamsSPFPass EmailSecurityTimeseriesGroupDKIMParamsSPF = "PASS" EmailSecurityTimeseriesGroupDKIMParamsSPFNone EmailSecurityTimeseriesGroupDKIMParamsSPF = "NONE" EmailSecurityTimeseriesGroupDKIMParamsSPFFail EmailSecurityTimeseriesGroupDKIMParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupDKIMParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDKIMParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupDKIMParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupDKIMResponse ¶
type EmailSecurityTimeseriesGroupDKIMResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupDKIMResponseMeta `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 EmailSecurityTimeseriesGroupDKIMResponseMeta ¶
type EmailSecurityTimeseriesGroupDKIMResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupDKIMResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupDKIMResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupDKIMResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupDKIMResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDKIMResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupDKIMResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupDKIMResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupDKIMResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupDKIMResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupDKIMResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDKIMResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDKIMResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDKIMResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupDKIMResponseMetaDateRange 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 emailSecurityTimeseriesGroupDKIMResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupDKIMResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDKIMResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupDKIMResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDKIMResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupDKIMResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupDKIMResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupDKIMResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupDKIMResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDKIMResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDMARCParams ¶
type EmailSecurityTimeseriesGroupDMARCParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsDKIM] `query:"dkim"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupDMARCParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupDMARCParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupDMARCParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupDMARCParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupDMARCParamsAggInterval ¶
type EmailSecurityTimeseriesGroupDMARCParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupDMARCParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupDMARCParamsDKIM ¶
type EmailSecurityTimeseriesGroupDMARCParamsDKIM string
const ( EmailSecurityTimeseriesGroupDMARCParamsDKIMPass EmailSecurityTimeseriesGroupDMARCParamsDKIM = "PASS" EmailSecurityTimeseriesGroupDMARCParamsDKIMNone EmailSecurityTimeseriesGroupDMARCParamsDKIM = "NONE" EmailSecurityTimeseriesGroupDMARCParamsDKIMFail EmailSecurityTimeseriesGroupDMARCParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupDMARCParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDMARCParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupDMARCParamsFormat ¶
type EmailSecurityTimeseriesGroupDMARCParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupDMARCParamsFormatJson EmailSecurityTimeseriesGroupDMARCParamsFormat = "JSON" EmailSecurityTimeseriesGroupDMARCParamsFormatCsv EmailSecurityTimeseriesGroupDMARCParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupDMARCParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDMARCParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupDMARCParamsSPF ¶
type EmailSecurityTimeseriesGroupDMARCParamsSPF string
const ( EmailSecurityTimeseriesGroupDMARCParamsSPFPass EmailSecurityTimeseriesGroupDMARCParamsSPF = "PASS" EmailSecurityTimeseriesGroupDMARCParamsSPFNone EmailSecurityTimeseriesGroupDMARCParamsSPF = "NONE" EmailSecurityTimeseriesGroupDMARCParamsSPFFail EmailSecurityTimeseriesGroupDMARCParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupDMARCParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDMARCParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupDMARCParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupDMARCResponse ¶
type EmailSecurityTimeseriesGroupDMARCResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupDMARCResponseMeta `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 EmailSecurityTimeseriesGroupDMARCResponseMeta ¶
type EmailSecurityTimeseriesGroupDMARCResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupDMARCResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupDMARCResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupDMARCResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupDMARCResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDMARCResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupDMARCResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupDMARCResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupDMARCResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupDMARCResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupDMARCResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDMARCResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDMARCResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDMARCResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupDMARCResponseMetaDateRange 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 emailSecurityTimeseriesGroupDMARCResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupDMARCResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDMARCResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupDMARCResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupDMARCResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupDMARCResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupDMARCResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupDMARCResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupDMARCResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupDMARCResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupMaliciousParams ¶
type EmailSecurityTimeseriesGroupMaliciousParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupMaliciousParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupMaliciousParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupMaliciousParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupMaliciousParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousParamsAggInterval ¶
type EmailSecurityTimeseriesGroupMaliciousParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupMaliciousParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousParamsDKIM ¶
type EmailSecurityTimeseriesGroupMaliciousParamsDKIM string
const ( EmailSecurityTimeseriesGroupMaliciousParamsDKIMPass EmailSecurityTimeseriesGroupMaliciousParamsDKIM = "PASS" EmailSecurityTimeseriesGroupMaliciousParamsDKIMNone EmailSecurityTimeseriesGroupMaliciousParamsDKIM = "NONE" EmailSecurityTimeseriesGroupMaliciousParamsDKIMFail EmailSecurityTimeseriesGroupMaliciousParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupMaliciousParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupMaliciousParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousParamsDMARC ¶
type EmailSecurityTimeseriesGroupMaliciousParamsDMARC string
const ( EmailSecurityTimeseriesGroupMaliciousParamsDMARCPass EmailSecurityTimeseriesGroupMaliciousParamsDMARC = "PASS" EmailSecurityTimeseriesGroupMaliciousParamsDMARCNone EmailSecurityTimeseriesGroupMaliciousParamsDMARC = "NONE" EmailSecurityTimeseriesGroupMaliciousParamsDMARCFail EmailSecurityTimeseriesGroupMaliciousParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupMaliciousParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupMaliciousParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousParamsFormat ¶
type EmailSecurityTimeseriesGroupMaliciousParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupMaliciousParamsFormatJson EmailSecurityTimeseriesGroupMaliciousParamsFormat = "JSON" EmailSecurityTimeseriesGroupMaliciousParamsFormatCsv EmailSecurityTimeseriesGroupMaliciousParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupMaliciousParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupMaliciousParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousParamsSPF ¶
type EmailSecurityTimeseriesGroupMaliciousParamsSPF string
const ( EmailSecurityTimeseriesGroupMaliciousParamsSPFPass EmailSecurityTimeseriesGroupMaliciousParamsSPF = "PASS" EmailSecurityTimeseriesGroupMaliciousParamsSPFNone EmailSecurityTimeseriesGroupMaliciousParamsSPF = "NONE" EmailSecurityTimeseriesGroupMaliciousParamsSPFFail EmailSecurityTimeseriesGroupMaliciousParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupMaliciousParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupMaliciousParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupMaliciousParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousResponse ¶
type EmailSecurityTimeseriesGroupMaliciousResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupMaliciousResponseMeta `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 EmailSecurityTimeseriesGroupMaliciousResponseMeta ¶
type EmailSecurityTimeseriesGroupMaliciousResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupMaliciousResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupMaliciousResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupMaliciousResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupMaliciousResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupMaliciousResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupMaliciousResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupMaliciousResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupMaliciousResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupMaliciousResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupMaliciousResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupMaliciousResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupMaliciousResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupMaliciousResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupMaliciousResponseMetaDateRange 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 emailSecurityTimeseriesGroupMaliciousResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupMaliciousResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupMaliciousResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupMaliciousResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupMaliciousResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupMaliciousResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupMaliciousResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupMaliciousResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupMaliciousResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupSPFParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupSPFParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupSPFParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupSPFParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupSPFParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupSPFParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupSPFParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupSPFParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupSPFParamsAggInterval ¶
type EmailSecurityTimeseriesGroupSPFParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupSPFParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupSPFParamsDKIM ¶
type EmailSecurityTimeseriesGroupSPFParamsDKIM string
const ( EmailSecurityTimeseriesGroupSPFParamsDKIMPass EmailSecurityTimeseriesGroupSPFParamsDKIM = "PASS" EmailSecurityTimeseriesGroupSPFParamsDKIMNone EmailSecurityTimeseriesGroupSPFParamsDKIM = "NONE" EmailSecurityTimeseriesGroupSPFParamsDKIMFail EmailSecurityTimeseriesGroupSPFParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupSPFParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSPFParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupSPFParamsDMARC ¶
type EmailSecurityTimeseriesGroupSPFParamsDMARC string
const ( EmailSecurityTimeseriesGroupSPFParamsDMARCPass EmailSecurityTimeseriesGroupSPFParamsDMARC = "PASS" EmailSecurityTimeseriesGroupSPFParamsDMARCNone EmailSecurityTimeseriesGroupSPFParamsDMARC = "NONE" EmailSecurityTimeseriesGroupSPFParamsDMARCFail EmailSecurityTimeseriesGroupSPFParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupSPFParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSPFParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupSPFParamsFormat ¶
type EmailSecurityTimeseriesGroupSPFParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupSPFParamsFormatJson EmailSecurityTimeseriesGroupSPFParamsFormat = "JSON" EmailSecurityTimeseriesGroupSPFParamsFormatCsv EmailSecurityTimeseriesGroupSPFParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupSPFParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSPFParamsFormat) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupSPFParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupSPFResponse ¶
type EmailSecurityTimeseriesGroupSPFResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupSPFResponseMeta `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 EmailSecurityTimeseriesGroupSPFResponseMeta ¶
type EmailSecurityTimeseriesGroupSPFResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupSPFResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupSPFResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupSPFResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupSPFResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupSPFResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSPFResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupSPFResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupSPFResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupSPFResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupSPFResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupSPFResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSPFResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSPFResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSPFResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupSPFResponseMetaDateRange 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 emailSecurityTimeseriesGroupSPFResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSPFResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSPFResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSPFResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupSPFResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupSPFResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupSPFResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupSPFResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSPFResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupSPFResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupSPFResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupSPFResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSPFResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSPFResponseMetaUnit) 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 ¶
func (r *EmailSecurityTimeseriesGroupService) ARC(ctx context.Context, query EmailSecurityTimeseriesGroupARCParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupARCResponse, err error)
Retrieves the distribution of emails by ARC (Authenticated Received Chain) validation over time.
func (*EmailSecurityTimeseriesGroupService) DKIM ¶
func (r *EmailSecurityTimeseriesGroupService) DKIM(ctx context.Context, query EmailSecurityTimeseriesGroupDKIMParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupDKIMResponse, err error)
Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) validation over time.
func (*EmailSecurityTimeseriesGroupService) DMARC ¶
func (r *EmailSecurityTimeseriesGroupService) DMARC(ctx context.Context, query EmailSecurityTimeseriesGroupDMARCParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupDMARCResponse, err error)
Retrieves the distribution of emails by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation over time.
func (*EmailSecurityTimeseriesGroupService) Malicious ¶
func (r *EmailSecurityTimeseriesGroupService) Malicious(ctx context.Context, query EmailSecurityTimeseriesGroupMaliciousParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupMaliciousResponse, err error)
Retrieves the distribution of emails by malicious classification over time.
func (*EmailSecurityTimeseriesGroupService) SPF ¶
func (r *EmailSecurityTimeseriesGroupService) SPF(ctx context.Context, query EmailSecurityTimeseriesGroupSPFParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupSPFResponse, err error)
Retrieves the distribution of emails by SPF (Sender Policy Framework) validation over time.
func (*EmailSecurityTimeseriesGroupService) Spam ¶
func (r *EmailSecurityTimeseriesGroupService) Spam(ctx context.Context, query EmailSecurityTimeseriesGroupSpamParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupSpamResponse, err error)
Retrieves the distribution of emails by spam classification (spam vs. non-spam) over time.
func (*EmailSecurityTimeseriesGroupService) Spoof ¶
func (r *EmailSecurityTimeseriesGroupService) Spoof(ctx context.Context, query EmailSecurityTimeseriesGroupSpoofParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupSpoofResponse, err error)
Retrieves the distribution of emails by spoof classification (spoof vs. non-spoof) over time.
func (*EmailSecurityTimeseriesGroupService) TLSVersion ¶
func (r *EmailSecurityTimeseriesGroupService) TLSVersion(ctx context.Context, query EmailSecurityTimeseriesGroupTLSVersionParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupTLSVersionResponse, err error)
Retrieves the distribution of emails by TLS version over time.
func (*EmailSecurityTimeseriesGroupService) ThreatCategory ¶
func (r *EmailSecurityTimeseriesGroupService) ThreatCategory(ctx context.Context, query EmailSecurityTimeseriesGroupThreatCategoryParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupThreatCategoryResponse, err error)
Retrieves the distribution of emails by threat category over time.
type EmailSecurityTimeseriesGroupSpamParams ¶
type EmailSecurityTimeseriesGroupSpamParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupSpamParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupSpamParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupSpamParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupSpamParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupSpamParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupSpamParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupSpamParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupSpamParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupSpamParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamParamsAggInterval ¶
type EmailSecurityTimeseriesGroupSpamParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupSpamParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamParamsDKIM ¶
type EmailSecurityTimeseriesGroupSpamParamsDKIM string
const ( EmailSecurityTimeseriesGroupSpamParamsDKIMPass EmailSecurityTimeseriesGroupSpamParamsDKIM = "PASS" EmailSecurityTimeseriesGroupSpamParamsDKIMNone EmailSecurityTimeseriesGroupSpamParamsDKIM = "NONE" EmailSecurityTimeseriesGroupSpamParamsDKIMFail EmailSecurityTimeseriesGroupSpamParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupSpamParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpamParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamParamsDMARC ¶
type EmailSecurityTimeseriesGroupSpamParamsDMARC string
const ( EmailSecurityTimeseriesGroupSpamParamsDMARCPass EmailSecurityTimeseriesGroupSpamParamsDMARC = "PASS" EmailSecurityTimeseriesGroupSpamParamsDMARCNone EmailSecurityTimeseriesGroupSpamParamsDMARC = "NONE" EmailSecurityTimeseriesGroupSpamParamsDMARCFail EmailSecurityTimeseriesGroupSpamParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupSpamParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpamParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamParamsFormat ¶
type EmailSecurityTimeseriesGroupSpamParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupSpamParamsFormatJson EmailSecurityTimeseriesGroupSpamParamsFormat = "JSON" EmailSecurityTimeseriesGroupSpamParamsFormatCsv EmailSecurityTimeseriesGroupSpamParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupSpamParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpamParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamParamsSPF ¶
type EmailSecurityTimeseriesGroupSpamParamsSPF string
const ( EmailSecurityTimeseriesGroupSpamParamsSPFPass EmailSecurityTimeseriesGroupSpamParamsSPF = "PASS" EmailSecurityTimeseriesGroupSpamParamsSPFNone EmailSecurityTimeseriesGroupSpamParamsSPF = "NONE" EmailSecurityTimeseriesGroupSpamParamsSPFFail EmailSecurityTimeseriesGroupSpamParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupSpamParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpamParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupSpamParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamResponse ¶
type EmailSecurityTimeseriesGroupSpamResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupSpamResponseMeta `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 EmailSecurityTimeseriesGroupSpamResponseMeta ¶
type EmailSecurityTimeseriesGroupSpamResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupSpamResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupSpamResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupSpamResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupSpamResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupSpamResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpamResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupSpamResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupSpamResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupSpamResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupSpamResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupSpamResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpamResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpamResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpamResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupSpamResponseMetaDateRange 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 emailSecurityTimeseriesGroupSpamResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSpamResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpamResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpamResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupSpamResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupSpamResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupSpamResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupSpamResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpamResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupSpamResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupSpamResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupSpamResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSpamResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpamResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupSpoofParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupSpoofParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupSpoofParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupSpoofParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupSpoofParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofParamsAggInterval ¶
type EmailSecurityTimeseriesGroupSpoofParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupSpoofParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofParamsDKIM ¶
type EmailSecurityTimeseriesGroupSpoofParamsDKIM string
const ( EmailSecurityTimeseriesGroupSpoofParamsDKIMPass EmailSecurityTimeseriesGroupSpoofParamsDKIM = "PASS" EmailSecurityTimeseriesGroupSpoofParamsDKIMNone EmailSecurityTimeseriesGroupSpoofParamsDKIM = "NONE" EmailSecurityTimeseriesGroupSpoofParamsDKIMFail EmailSecurityTimeseriesGroupSpoofParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupSpoofParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpoofParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofParamsDMARC ¶
type EmailSecurityTimeseriesGroupSpoofParamsDMARC string
const ( EmailSecurityTimeseriesGroupSpoofParamsDMARCPass EmailSecurityTimeseriesGroupSpoofParamsDMARC = "PASS" EmailSecurityTimeseriesGroupSpoofParamsDMARCNone EmailSecurityTimeseriesGroupSpoofParamsDMARC = "NONE" EmailSecurityTimeseriesGroupSpoofParamsDMARCFail EmailSecurityTimeseriesGroupSpoofParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupSpoofParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpoofParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofParamsFormat ¶
type EmailSecurityTimeseriesGroupSpoofParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupSpoofParamsFormatJson EmailSecurityTimeseriesGroupSpoofParamsFormat = "JSON" EmailSecurityTimeseriesGroupSpoofParamsFormatCsv EmailSecurityTimeseriesGroupSpoofParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupSpoofParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpoofParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofParamsSPF ¶
type EmailSecurityTimeseriesGroupSpoofParamsSPF string
const ( EmailSecurityTimeseriesGroupSpoofParamsSPFPass EmailSecurityTimeseriesGroupSpoofParamsSPF = "PASS" EmailSecurityTimeseriesGroupSpoofParamsSPFNone EmailSecurityTimeseriesGroupSpoofParamsSPF = "NONE" EmailSecurityTimeseriesGroupSpoofParamsSPFFail EmailSecurityTimeseriesGroupSpoofParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupSpoofParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpoofParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupSpoofParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofResponse ¶
type EmailSecurityTimeseriesGroupSpoofResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupSpoofResponseMeta `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 EmailSecurityTimeseriesGroupSpoofResponseMeta ¶
type EmailSecurityTimeseriesGroupSpoofResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupSpoofResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupSpoofResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupSpoofResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupSpoofResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpoofResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupSpoofResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupSpoofResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupSpoofResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupSpoofResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupSpoofResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpoofResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpoofResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpoofResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupSpoofResponseMetaDateRange 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 emailSecurityTimeseriesGroupSpoofResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSpoofResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpoofResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupSpoofResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupSpoofResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupSpoofResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupSpoofResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupSpoofResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupSpoofResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupSpoofResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupTLSVersionParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupTLSVersionParamsSPF] `query:"spf"`
}
func (EmailSecurityTimeseriesGroupTLSVersionParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupTLSVersionParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupTLSVersionParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval ¶
type EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupTLSVersionParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionParamsDKIM ¶
type EmailSecurityTimeseriesGroupTLSVersionParamsDKIM string
const ( EmailSecurityTimeseriesGroupTLSVersionParamsDKIMPass EmailSecurityTimeseriesGroupTLSVersionParamsDKIM = "PASS" EmailSecurityTimeseriesGroupTLSVersionParamsDKIMNone EmailSecurityTimeseriesGroupTLSVersionParamsDKIM = "NONE" EmailSecurityTimeseriesGroupTLSVersionParamsDKIMFail EmailSecurityTimeseriesGroupTLSVersionParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupTLSVersionParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupTLSVersionParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionParamsDMARC ¶
type EmailSecurityTimeseriesGroupTLSVersionParamsDMARC string
const ( EmailSecurityTimeseriesGroupTLSVersionParamsDMARCPass EmailSecurityTimeseriesGroupTLSVersionParamsDMARC = "PASS" EmailSecurityTimeseriesGroupTLSVersionParamsDMARCNone EmailSecurityTimeseriesGroupTLSVersionParamsDMARC = "NONE" EmailSecurityTimeseriesGroupTLSVersionParamsDMARCFail EmailSecurityTimeseriesGroupTLSVersionParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupTLSVersionParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupTLSVersionParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionParamsFormat ¶
type EmailSecurityTimeseriesGroupTLSVersionParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupTLSVersionParamsFormatJson EmailSecurityTimeseriesGroupTLSVersionParamsFormat = "JSON" EmailSecurityTimeseriesGroupTLSVersionParamsFormatCsv EmailSecurityTimeseriesGroupTLSVersionParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupTLSVersionParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupTLSVersionParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionParamsSPF ¶
type EmailSecurityTimeseriesGroupTLSVersionParamsSPF string
const ( EmailSecurityTimeseriesGroupTLSVersionParamsSPFPass EmailSecurityTimeseriesGroupTLSVersionParamsSPF = "PASS" EmailSecurityTimeseriesGroupTLSVersionParamsSPFNone EmailSecurityTimeseriesGroupTLSVersionParamsSPF = "NONE" EmailSecurityTimeseriesGroupTLSVersionParamsSPFFail EmailSecurityTimeseriesGroupTLSVersionParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupTLSVersionParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupTLSVersionParamsSPF) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionResponse ¶
type EmailSecurityTimeseriesGroupTLSVersionResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupTLSVersionResponseMeta `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 EmailSecurityTimeseriesGroupTLSVersionResponseMeta ¶
type EmailSecurityTimeseriesGroupTLSVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupTLSVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupTLSVersionResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupTLSVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupTLSVersionResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupTLSVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupTLSVersionResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaDateRange 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 emailSecurityTimeseriesGroupTLSVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupTLSVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupTLSVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupTLSVersionResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupTLSVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupTLSVersionResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupTLSVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupTLSVersionResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTimeseriesGroupThreatCategoryParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsSPF] `query:"spf"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTimeseriesGroupThreatCategoryParams) URLQuery ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParamsARC) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval ¶
type EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParamsAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM ¶
type EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM string
const ( EmailSecurityTimeseriesGroupThreatCategoryParamsDKIMPass EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM = "PASS" EmailSecurityTimeseriesGroupThreatCategoryParamsDKIMNone EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM = "NONE" EmailSecurityTimeseriesGroupThreatCategoryParamsDKIMFail EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM = "FAIL" )
func (EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM) IsKnown ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParamsDKIM) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC ¶
type EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC string
const ( EmailSecurityTimeseriesGroupThreatCategoryParamsDMARCPass EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC = "PASS" EmailSecurityTimeseriesGroupThreatCategoryParamsDMARCNone EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC = "NONE" EmailSecurityTimeseriesGroupThreatCategoryParamsDMARCFail EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC = "FAIL" )
func (EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC) IsKnown ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParamsDMARC) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryParamsFormat ¶
type EmailSecurityTimeseriesGroupThreatCategoryParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTimeseriesGroupThreatCategoryParamsFormatJson EmailSecurityTimeseriesGroupThreatCategoryParamsFormat = "JSON" EmailSecurityTimeseriesGroupThreatCategoryParamsFormatCsv EmailSecurityTimeseriesGroupThreatCategoryParamsFormat = "CSV" )
func (EmailSecurityTimeseriesGroupThreatCategoryParamsFormat) IsKnown ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParamsFormat) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryParamsSPF ¶
type EmailSecurityTimeseriesGroupThreatCategoryParamsSPF string
const ( EmailSecurityTimeseriesGroupThreatCategoryParamsSPFPass EmailSecurityTimeseriesGroupThreatCategoryParamsSPF = "PASS" EmailSecurityTimeseriesGroupThreatCategoryParamsSPFNone EmailSecurityTimeseriesGroupThreatCategoryParamsSPF = "NONE" EmailSecurityTimeseriesGroupThreatCategoryParamsSPFFail EmailSecurityTimeseriesGroupThreatCategoryParamsSPF = "FAIL" )
func (EmailSecurityTimeseriesGroupThreatCategoryParamsSPF) IsKnown ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryParamsTLSVersion) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryResponse ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponse struct {
// Metadata for the results.
Meta EmailSecurityTimeseriesGroupThreatCategoryResponseMeta `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 ¶
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupThreatCategoryResponseMeta ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []EmailSecurityTimeseriesGroupThreatCategoryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTimeseriesGroupThreatCategoryResponseMetaUnit `json:"units,required"`
JSON emailSecurityTimeseriesGroupThreatCategoryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTimeseriesGroupThreatCategoryResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggIntervalFifteenMinutes EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval = "FIFTEEN_MINUTES" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggIntervalOneHour EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval = "ONE_HOUR" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggIntervalOneDay EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval = "ONE_DAY" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggIntervalOneWeek EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval = "ONE_WEEK" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggIntervalOneMonth EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval = "ONE_MONTH" )
func (EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval) IsKnown ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryResponseMetaAggInterval) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfo ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaDateRange ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaDateRange 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 emailSecurityTimeseriesGroupThreatCategoryResponseMetaDateRangeJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupThreatCategoryResponseMetaDateRange) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationPercentage EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "PERCENTAGE" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationMin0Max EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "MIN0_MAX" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationMinMax EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "MIN_MAX" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationRawValues EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "RAW_VALUES" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationPercentageChange EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationRollingAverage EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationOverlappedPercentage EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalizationRatio EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization = "RATIO" )
func (EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTimeseriesGroupThreatCategoryResponseMetaNormalization) IsKnown() bool
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaUnit ¶
type EmailSecurityTimeseriesGroupThreatCategoryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTimeseriesGroupThreatCategoryResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTimeseriesGroupThreatCategoryResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0) UnmarshalJSON(data []byte) (err error)
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 {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTopTldGetParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTopTldGetParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTopTldGetParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTopTldGetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTopTldGetParamsSPF] `query:"spf"`
// Filters results by TLD category.
TldCategory param.Field[EmailSecurityTopTldGetParamsTldCategory] `query:"tldCategory"`
// Filters results by 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 ¶
func (r EmailSecurityTopTldGetParamsARC) IsKnown() bool
type EmailSecurityTopTldGetParamsDKIM ¶
type EmailSecurityTopTldGetParamsDKIM string
const ( EmailSecurityTopTldGetParamsDKIMPass EmailSecurityTopTldGetParamsDKIM = "PASS" EmailSecurityTopTldGetParamsDKIMNone EmailSecurityTopTldGetParamsDKIM = "NONE" EmailSecurityTopTldGetParamsDKIMFail EmailSecurityTopTldGetParamsDKIM = "FAIL" )
func (EmailSecurityTopTldGetParamsDKIM) IsKnown ¶
func (r EmailSecurityTopTldGetParamsDKIM) IsKnown() bool
type EmailSecurityTopTldGetParamsDMARC ¶
type EmailSecurityTopTldGetParamsDMARC string
const ( EmailSecurityTopTldGetParamsDMARCPass EmailSecurityTopTldGetParamsDMARC = "PASS" EmailSecurityTopTldGetParamsDMARCNone EmailSecurityTopTldGetParamsDMARC = "NONE" EmailSecurityTopTldGetParamsDMARCFail EmailSecurityTopTldGetParamsDMARC = "FAIL" )
func (EmailSecurityTopTldGetParamsDMARC) IsKnown ¶
func (r EmailSecurityTopTldGetParamsDMARC) IsKnown() bool
type EmailSecurityTopTldGetParamsFormat ¶
type EmailSecurityTopTldGetParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTopTldGetParamsFormatJson EmailSecurityTopTldGetParamsFormat = "JSON" EmailSecurityTopTldGetParamsFormatCsv EmailSecurityTopTldGetParamsFormat = "CSV" )
func (EmailSecurityTopTldGetParamsFormat) IsKnown ¶
func (r EmailSecurityTopTldGetParamsFormat) IsKnown() bool
type EmailSecurityTopTldGetParamsSPF ¶
type EmailSecurityTopTldGetParamsSPF string
const ( EmailSecurityTopTldGetParamsSPFPass EmailSecurityTopTldGetParamsSPF = "PASS" EmailSecurityTopTldGetParamsSPFNone EmailSecurityTopTldGetParamsSPF = "NONE" EmailSecurityTopTldGetParamsSPFFail EmailSecurityTopTldGetParamsSPF = "FAIL" )
func (EmailSecurityTopTldGetParamsSPF) IsKnown ¶
func (r EmailSecurityTopTldGetParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTopTldGetParamsTLSVersion) IsKnown() bool
type EmailSecurityTopTldGetParamsTldCategory ¶
type EmailSecurityTopTldGetParamsTldCategory string
Filters results by TLD category.
const ( EmailSecurityTopTldGetParamsTldCategoryClassic EmailSecurityTopTldGetParamsTldCategory = "CLASSIC" EmailSecurityTopTldGetParamsTldCategoryCountry EmailSecurityTopTldGetParamsTldCategory = "COUNTRY" )
func (EmailSecurityTopTldGetParamsTldCategory) IsKnown ¶
func (r EmailSecurityTopTldGetParamsTldCategory) IsKnown() bool
type EmailSecurityTopTldGetResponse ¶
type EmailSecurityTopTldGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecurityTopTldGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []EmailSecurityTopTldGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTopTldGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTopTldGetResponseMetaUnit `json:"units,required"`
JSON emailSecurityTopTldGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTopTldGetResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTopTldGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldGetResponseMetaConfidenceInfo ¶
type EmailSecurityTopTldGetResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTopTldGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTopTldGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecurityTopTldGetResponseMetaNormalization ¶
type EmailSecurityTopTldGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTopTldGetResponseMetaNormalizationPercentage EmailSecurityTopTldGetResponseMetaNormalization = "PERCENTAGE" EmailSecurityTopTldGetResponseMetaNormalizationMin0Max EmailSecurityTopTldGetResponseMetaNormalization = "MIN0_MAX" EmailSecurityTopTldGetResponseMetaNormalizationMinMax EmailSecurityTopTldGetResponseMetaNormalization = "MIN_MAX" EmailSecurityTopTldGetResponseMetaNormalizationRawValues EmailSecurityTopTldGetResponseMetaNormalization = "RAW_VALUES" EmailSecurityTopTldGetResponseMetaNormalizationPercentageChange EmailSecurityTopTldGetResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTopTldGetResponseMetaNormalizationRollingAverage EmailSecurityTopTldGetResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTopTldGetResponseMetaNormalizationOverlappedPercentage EmailSecurityTopTldGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTopTldGetResponseMetaNormalizationRatio EmailSecurityTopTldGetResponseMetaNormalization = "RATIO" )
func (EmailSecurityTopTldGetResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTopTldGetResponseMetaNormalization) IsKnown() bool
type EmailSecurityTopTldGetResponseMetaUnit ¶
type EmailSecurityTopTldGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTopTldGetResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTopTldGetResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTopTldGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldGetResponseTop0 ¶
type EmailSecurityTopTldGetResponseTop0 struct {
Name string `json:"name,required"`
// A numeric string.
Value string `json:"value,required"`
JSON emailSecurityTopTldGetResponseTop0JSON `json:"-"`
}
func (*EmailSecurityTopTldGetResponseTop0) UnmarshalJSON ¶
func (r *EmailSecurityTopTldGetResponseTop0) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldMaliciousGetParams ¶
type EmailSecurityTopTldMaliciousGetParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTopTldMaliciousGetParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTopTldMaliciousGetParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTopTldMaliciousGetParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTopTldMaliciousGetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTopTldMaliciousGetParamsSPF] `query:"spf"`
// Filters results by TLD category.
TldCategory param.Field[EmailSecurityTopTldMaliciousGetParamsTldCategory] `query:"tldCategory"`
// Filters results by TLS version.
TLSVersion param.Field[[]EmailSecurityTopTldMaliciousGetParamsTLSVersion] `query:"tlsVersion"`
}
func (EmailSecurityTopTldMaliciousGetParams) URLQuery ¶
func (r EmailSecurityTopTldMaliciousGetParams) URLQuery() (v url.Values)
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 ¶
func (r EmailSecurityTopTldMaliciousGetParamsARC) IsKnown() bool
type EmailSecurityTopTldMaliciousGetParamsDKIM ¶
type EmailSecurityTopTldMaliciousGetParamsDKIM string
const ( EmailSecurityTopTldMaliciousGetParamsDKIMPass EmailSecurityTopTldMaliciousGetParamsDKIM = "PASS" EmailSecurityTopTldMaliciousGetParamsDKIMNone EmailSecurityTopTldMaliciousGetParamsDKIM = "NONE" EmailSecurityTopTldMaliciousGetParamsDKIMFail EmailSecurityTopTldMaliciousGetParamsDKIM = "FAIL" )
func (EmailSecurityTopTldMaliciousGetParamsDKIM) IsKnown ¶
func (r EmailSecurityTopTldMaliciousGetParamsDKIM) IsKnown() bool
type EmailSecurityTopTldMaliciousGetParamsDMARC ¶
type EmailSecurityTopTldMaliciousGetParamsDMARC string
const ( EmailSecurityTopTldMaliciousGetParamsDMARCPass EmailSecurityTopTldMaliciousGetParamsDMARC = "PASS" EmailSecurityTopTldMaliciousGetParamsDMARCNone EmailSecurityTopTldMaliciousGetParamsDMARC = "NONE" EmailSecurityTopTldMaliciousGetParamsDMARCFail EmailSecurityTopTldMaliciousGetParamsDMARC = "FAIL" )
func (EmailSecurityTopTldMaliciousGetParamsDMARC) IsKnown ¶
func (r EmailSecurityTopTldMaliciousGetParamsDMARC) IsKnown() bool
type EmailSecurityTopTldMaliciousGetParamsFormat ¶
type EmailSecurityTopTldMaliciousGetParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTopTldMaliciousGetParamsFormatJson EmailSecurityTopTldMaliciousGetParamsFormat = "JSON" EmailSecurityTopTldMaliciousGetParamsFormatCsv EmailSecurityTopTldMaliciousGetParamsFormat = "CSV" )
func (EmailSecurityTopTldMaliciousGetParamsFormat) IsKnown ¶
func (r EmailSecurityTopTldMaliciousGetParamsFormat) IsKnown() bool
type EmailSecurityTopTldMaliciousGetParamsMalicious ¶
type EmailSecurityTopTldMaliciousGetParamsMalicious string
Malicious classification.
const ( EmailSecurityTopTldMaliciousGetParamsMaliciousMalicious EmailSecurityTopTldMaliciousGetParamsMalicious = "MALICIOUS" EmailSecurityTopTldMaliciousGetParamsMaliciousNotMalicious EmailSecurityTopTldMaliciousGetParamsMalicious = "NOT_MALICIOUS" )
func (EmailSecurityTopTldMaliciousGetParamsMalicious) IsKnown ¶
func (r EmailSecurityTopTldMaliciousGetParamsMalicious) IsKnown() bool
type EmailSecurityTopTldMaliciousGetParamsSPF ¶
type EmailSecurityTopTldMaliciousGetParamsSPF string
const ( EmailSecurityTopTldMaliciousGetParamsSPFPass EmailSecurityTopTldMaliciousGetParamsSPF = "PASS" EmailSecurityTopTldMaliciousGetParamsSPFNone EmailSecurityTopTldMaliciousGetParamsSPF = "NONE" EmailSecurityTopTldMaliciousGetParamsSPFFail EmailSecurityTopTldMaliciousGetParamsSPF = "FAIL" )
func (EmailSecurityTopTldMaliciousGetParamsSPF) IsKnown ¶
func (r EmailSecurityTopTldMaliciousGetParamsSPF) IsKnown() bool
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 ¶
func (r EmailSecurityTopTldMaliciousGetParamsTLSVersion) IsKnown() bool
type EmailSecurityTopTldMaliciousGetParamsTldCategory ¶
type EmailSecurityTopTldMaliciousGetParamsTldCategory string
Filters results by TLD category.
const ( EmailSecurityTopTldMaliciousGetParamsTldCategoryClassic EmailSecurityTopTldMaliciousGetParamsTldCategory = "CLASSIC" EmailSecurityTopTldMaliciousGetParamsTldCategoryCountry EmailSecurityTopTldMaliciousGetParamsTldCategory = "COUNTRY" )
func (EmailSecurityTopTldMaliciousGetParamsTldCategory) IsKnown ¶
func (r EmailSecurityTopTldMaliciousGetParamsTldCategory) IsKnown() bool
type EmailSecurityTopTldMaliciousGetResponse ¶
type EmailSecurityTopTldMaliciousGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []EmailSecurityTopTldMaliciousGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTopTldMaliciousGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTopTldMaliciousGetResponseMetaUnit `json:"units,required"`
JSON emailSecurityTopTldMaliciousGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTopTldMaliciousGetResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTopTldMaliciousGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo ¶
type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation ¶
type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecurityTopTldMaliciousGetResponseMetaNormalization ¶
type EmailSecurityTopTldMaliciousGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTopTldMaliciousGetResponseMetaNormalizationPercentage EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "PERCENTAGE" EmailSecurityTopTldMaliciousGetResponseMetaNormalizationMin0Max EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "MIN0_MAX" EmailSecurityTopTldMaliciousGetResponseMetaNormalizationMinMax EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "MIN_MAX" EmailSecurityTopTldMaliciousGetResponseMetaNormalizationRawValues EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "RAW_VALUES" EmailSecurityTopTldMaliciousGetResponseMetaNormalizationPercentageChange EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTopTldMaliciousGetResponseMetaNormalizationRollingAverage EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTopTldMaliciousGetResponseMetaNormalizationOverlappedPercentage EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTopTldMaliciousGetResponseMetaNormalizationRatio EmailSecurityTopTldMaliciousGetResponseMetaNormalization = "RATIO" )
func (EmailSecurityTopTldMaliciousGetResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTopTldMaliciousGetResponseMetaNormalization) IsKnown() bool
type EmailSecurityTopTldMaliciousGetResponseMetaUnit ¶
type EmailSecurityTopTldMaliciousGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTopTldMaliciousGetResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTopTldMaliciousGetResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTopTldMaliciousGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldMaliciousGetResponseTop0 ¶
type EmailSecurityTopTldMaliciousGetResponseTop0 struct {
Name string `json:"name,required"`
// A numeric string.
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 ¶
func (r *EmailSecurityTopTldMaliciousService) Get(ctx context.Context, malicious EmailSecurityTopTldMaliciousGetParamsMalicious, query EmailSecurityTopTldMaliciousGetParams, opts ...option.RequestOption) (res *EmailSecurityTopTldMaliciousGetResponse, err error)
Retrieves the top 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 ¶
func (r *EmailSecurityTopTldService) Get(ctx context.Context, query EmailSecurityTopTldGetParams, opts ...option.RequestOption) (res *EmailSecurityTopTldGetResponse, err error)
Retrieves the top TLDs by number of email messages.
type EmailSecurityTopTldSpamGetParams ¶
type EmailSecurityTopTldSpamGetParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTopTldSpamGetParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTopTldSpamGetParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTopTldSpamGetParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTopTldSpamGetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTopTldSpamGetParamsSPF] `query:"spf"`
// Filters results by TLD category.
TldCategory param.Field[EmailSecurityTopTldSpamGetParamsTldCategory] `query:"tldCategory"`
// Filters results by 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 ¶
func (r EmailSecurityTopTldSpamGetParamsARC) IsKnown() bool
type EmailSecurityTopTldSpamGetParamsDKIM ¶
type EmailSecurityTopTldSpamGetParamsDKIM string
const ( EmailSecurityTopTldSpamGetParamsDKIMPass EmailSecurityTopTldSpamGetParamsDKIM = "PASS" EmailSecurityTopTldSpamGetParamsDKIMNone EmailSecurityTopTldSpamGetParamsDKIM = "NONE" EmailSecurityTopTldSpamGetParamsDKIMFail EmailSecurityTopTldSpamGetParamsDKIM = "FAIL" )
func (EmailSecurityTopTldSpamGetParamsDKIM) IsKnown ¶
func (r EmailSecurityTopTldSpamGetParamsDKIM) IsKnown() bool
type EmailSecurityTopTldSpamGetParamsDMARC ¶
type EmailSecurityTopTldSpamGetParamsDMARC string
const ( EmailSecurityTopTldSpamGetParamsDMARCPass EmailSecurityTopTldSpamGetParamsDMARC = "PASS" EmailSecurityTopTldSpamGetParamsDMARCNone EmailSecurityTopTldSpamGetParamsDMARC = "NONE" EmailSecurityTopTldSpamGetParamsDMARCFail EmailSecurityTopTldSpamGetParamsDMARC = "FAIL" )
func (EmailSecurityTopTldSpamGetParamsDMARC) IsKnown ¶
func (r EmailSecurityTopTldSpamGetParamsDMARC) IsKnown() bool
type EmailSecurityTopTldSpamGetParamsFormat ¶
type EmailSecurityTopTldSpamGetParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTopTldSpamGetParamsFormatJson EmailSecurityTopTldSpamGetParamsFormat = "JSON" EmailSecurityTopTldSpamGetParamsFormatCsv EmailSecurityTopTldSpamGetParamsFormat = "CSV" )
func (EmailSecurityTopTldSpamGetParamsFormat) IsKnown ¶
func (r EmailSecurityTopTldSpamGetParamsFormat) IsKnown() bool
type EmailSecurityTopTldSpamGetParamsSPF ¶
type EmailSecurityTopTldSpamGetParamsSPF string
const ( EmailSecurityTopTldSpamGetParamsSPFPass EmailSecurityTopTldSpamGetParamsSPF = "PASS" EmailSecurityTopTldSpamGetParamsSPFNone EmailSecurityTopTldSpamGetParamsSPF = "NONE" EmailSecurityTopTldSpamGetParamsSPFFail EmailSecurityTopTldSpamGetParamsSPF = "FAIL" )
func (EmailSecurityTopTldSpamGetParamsSPF) IsKnown ¶
func (r EmailSecurityTopTldSpamGetParamsSPF) IsKnown() bool
type EmailSecurityTopTldSpamGetParamsSpam ¶
type EmailSecurityTopTldSpamGetParamsSpam string
Spam classification.
const ( EmailSecurityTopTldSpamGetParamsSpamSpam EmailSecurityTopTldSpamGetParamsSpam = "SPAM" EmailSecurityTopTldSpamGetParamsSpamNotSpam EmailSecurityTopTldSpamGetParamsSpam = "NOT_SPAM" )
func (EmailSecurityTopTldSpamGetParamsSpam) IsKnown ¶
func (r EmailSecurityTopTldSpamGetParamsSpam) IsKnown() bool
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 ¶
func (r EmailSecurityTopTldSpamGetParamsTLSVersion) IsKnown() bool
type EmailSecurityTopTldSpamGetParamsTldCategory ¶
type EmailSecurityTopTldSpamGetParamsTldCategory string
Filters results by TLD category.
const ( EmailSecurityTopTldSpamGetParamsTldCategoryClassic EmailSecurityTopTldSpamGetParamsTldCategory = "CLASSIC" EmailSecurityTopTldSpamGetParamsTldCategoryCountry EmailSecurityTopTldSpamGetParamsTldCategory = "COUNTRY" )
func (EmailSecurityTopTldSpamGetParamsTldCategory) IsKnown ¶
func (r EmailSecurityTopTldSpamGetParamsTldCategory) IsKnown() bool
type EmailSecurityTopTldSpamGetResponse ¶
type EmailSecurityTopTldSpamGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []EmailSecurityTopTldSpamGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTopTldSpamGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTopTldSpamGetResponseMetaUnit `json:"units,required"`
JSON emailSecurityTopTldSpamGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTopTldSpamGetResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTopTldSpamGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo ¶
type EmailSecurityTopTldSpamGetResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTopTldSpamGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecurityTopTldSpamGetResponseMetaNormalization ¶
type EmailSecurityTopTldSpamGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTopTldSpamGetResponseMetaNormalizationPercentage EmailSecurityTopTldSpamGetResponseMetaNormalization = "PERCENTAGE" EmailSecurityTopTldSpamGetResponseMetaNormalizationMin0Max EmailSecurityTopTldSpamGetResponseMetaNormalization = "MIN0_MAX" EmailSecurityTopTldSpamGetResponseMetaNormalizationMinMax EmailSecurityTopTldSpamGetResponseMetaNormalization = "MIN_MAX" EmailSecurityTopTldSpamGetResponseMetaNormalizationRawValues EmailSecurityTopTldSpamGetResponseMetaNormalization = "RAW_VALUES" EmailSecurityTopTldSpamGetResponseMetaNormalizationPercentageChange EmailSecurityTopTldSpamGetResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTopTldSpamGetResponseMetaNormalizationRollingAverage EmailSecurityTopTldSpamGetResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTopTldSpamGetResponseMetaNormalizationOverlappedPercentage EmailSecurityTopTldSpamGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTopTldSpamGetResponseMetaNormalizationRatio EmailSecurityTopTldSpamGetResponseMetaNormalization = "RATIO" )
func (EmailSecurityTopTldSpamGetResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTopTldSpamGetResponseMetaNormalization) IsKnown() bool
type EmailSecurityTopTldSpamGetResponseMetaUnit ¶
type EmailSecurityTopTldSpamGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTopTldSpamGetResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTopTldSpamGetResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTopTldSpamGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldSpamGetResponseTop0 ¶
type EmailSecurityTopTldSpamGetResponseTop0 struct {
Name string `json:"name,required"`
// A numeric string.
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 ¶
func (r *EmailSecurityTopTldSpamService) Get(ctx context.Context, spam EmailSecurityTopTldSpamGetParamsSpam, query EmailSecurityTopTldSpamGetParams, opts ...option.RequestOption) (res *EmailSecurityTopTldSpamGetResponse, err error)
Retrieves the top TLDs by emails classified as spam or not.
type EmailSecurityTopTldSpoofGetParams ¶
type EmailSecurityTopTldSpoofGetParams struct {
// Filters results by ARC (Authenticated Received Chain) validation.
ARC param.Field[[]EmailSecurityTopTldSpoofGetParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by DKIM (DomainKeys Identified Mail) validation status.
DKIM param.Field[[]EmailSecurityTopTldSpoofGetParamsDKIM] `query:"dkim"`
// Filters results by DMARC (Domain-based Message Authentication, Reporting and
// Conformance) validation status.
DMARC param.Field[[]EmailSecurityTopTldSpoofGetParamsDMARC] `query:"dmarc"`
// Format in which results will be returned.
Format param.Field[EmailSecurityTopTldSpoofGetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by SPF (Sender Policy Framework) validation status.
SPF param.Field[[]EmailSecurityTopTldSpoofGetParamsSPF] `query:"spf"`
// Filters results by TLD category.
TldCategory param.Field[EmailSecurityTopTldSpoofGetParamsTldCategory] `query:"tldCategory"`
// Filters results by 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 ¶
func (r EmailSecurityTopTldSpoofGetParamsARC) IsKnown() bool
type EmailSecurityTopTldSpoofGetParamsDKIM ¶
type EmailSecurityTopTldSpoofGetParamsDKIM string
const ( EmailSecurityTopTldSpoofGetParamsDKIMPass EmailSecurityTopTldSpoofGetParamsDKIM = "PASS" EmailSecurityTopTldSpoofGetParamsDKIMNone EmailSecurityTopTldSpoofGetParamsDKIM = "NONE" EmailSecurityTopTldSpoofGetParamsDKIMFail EmailSecurityTopTldSpoofGetParamsDKIM = "FAIL" )
func (EmailSecurityTopTldSpoofGetParamsDKIM) IsKnown ¶
func (r EmailSecurityTopTldSpoofGetParamsDKIM) IsKnown() bool
type EmailSecurityTopTldSpoofGetParamsDMARC ¶
type EmailSecurityTopTldSpoofGetParamsDMARC string
const ( EmailSecurityTopTldSpoofGetParamsDMARCPass EmailSecurityTopTldSpoofGetParamsDMARC = "PASS" EmailSecurityTopTldSpoofGetParamsDMARCNone EmailSecurityTopTldSpoofGetParamsDMARC = "NONE" EmailSecurityTopTldSpoofGetParamsDMARCFail EmailSecurityTopTldSpoofGetParamsDMARC = "FAIL" )
func (EmailSecurityTopTldSpoofGetParamsDMARC) IsKnown ¶
func (r EmailSecurityTopTldSpoofGetParamsDMARC) IsKnown() bool
type EmailSecurityTopTldSpoofGetParamsFormat ¶
type EmailSecurityTopTldSpoofGetParamsFormat string
Format in which results will be returned.
const ( EmailSecurityTopTldSpoofGetParamsFormatJson EmailSecurityTopTldSpoofGetParamsFormat = "JSON" EmailSecurityTopTldSpoofGetParamsFormatCsv EmailSecurityTopTldSpoofGetParamsFormat = "CSV" )
func (EmailSecurityTopTldSpoofGetParamsFormat) IsKnown ¶
func (r EmailSecurityTopTldSpoofGetParamsFormat) IsKnown() bool
type EmailSecurityTopTldSpoofGetParamsSPF ¶
type EmailSecurityTopTldSpoofGetParamsSPF string
const ( EmailSecurityTopTldSpoofGetParamsSPFPass EmailSecurityTopTldSpoofGetParamsSPF = "PASS" EmailSecurityTopTldSpoofGetParamsSPFNone EmailSecurityTopTldSpoofGetParamsSPF = "NONE" EmailSecurityTopTldSpoofGetParamsSPFFail EmailSecurityTopTldSpoofGetParamsSPF = "FAIL" )
func (EmailSecurityTopTldSpoofGetParamsSPF) IsKnown ¶
func (r EmailSecurityTopTldSpoofGetParamsSPF) IsKnown() bool
type EmailSecurityTopTldSpoofGetParamsSpoof ¶
type EmailSecurityTopTldSpoofGetParamsSpoof string
Spoof classification.
const ( EmailSecurityTopTldSpoofGetParamsSpoofSpoof EmailSecurityTopTldSpoofGetParamsSpoof = "SPOOF" EmailSecurityTopTldSpoofGetParamsSpoofNotSpoof EmailSecurityTopTldSpoofGetParamsSpoof = "NOT_SPOOF" )
func (EmailSecurityTopTldSpoofGetParamsSpoof) IsKnown ¶
func (r EmailSecurityTopTldSpoofGetParamsSpoof) IsKnown() bool
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 ¶
func (r EmailSecurityTopTldSpoofGetParamsTLSVersion) IsKnown() bool
type EmailSecurityTopTldSpoofGetParamsTldCategory ¶
type EmailSecurityTopTldSpoofGetParamsTldCategory string
Filters results by TLD category.
const ( EmailSecurityTopTldSpoofGetParamsTldCategoryClassic EmailSecurityTopTldSpoofGetParamsTldCategory = "CLASSIC" EmailSecurityTopTldSpoofGetParamsTldCategoryCountry EmailSecurityTopTldSpoofGetParamsTldCategory = "COUNTRY" )
func (EmailSecurityTopTldSpoofGetParamsTldCategory) IsKnown ¶
func (r EmailSecurityTopTldSpoofGetParamsTldCategory) IsKnown() bool
type EmailSecurityTopTldSpoofGetResponse ¶
type EmailSecurityTopTldSpoofGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []EmailSecurityTopTldSpoofGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization EmailSecurityTopTldSpoofGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []EmailSecurityTopTldSpoofGetResponseMetaUnit `json:"units,required"`
JSON emailSecurityTopTldSpoofGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*EmailSecurityTopTldSpoofGetResponseMeta) UnmarshalJSON ¶
func (r *EmailSecurityTopTldSpoofGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo ¶
type EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON emailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *EmailSecurityTopTldSpoofGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 EmailSecurityTopTldSpoofGetResponseMetaNormalization ¶
type EmailSecurityTopTldSpoofGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( EmailSecurityTopTldSpoofGetResponseMetaNormalizationPercentage EmailSecurityTopTldSpoofGetResponseMetaNormalization = "PERCENTAGE" EmailSecurityTopTldSpoofGetResponseMetaNormalizationMin0Max EmailSecurityTopTldSpoofGetResponseMetaNormalization = "MIN0_MAX" EmailSecurityTopTldSpoofGetResponseMetaNormalizationMinMax EmailSecurityTopTldSpoofGetResponseMetaNormalization = "MIN_MAX" EmailSecurityTopTldSpoofGetResponseMetaNormalizationRawValues EmailSecurityTopTldSpoofGetResponseMetaNormalization = "RAW_VALUES" EmailSecurityTopTldSpoofGetResponseMetaNormalizationPercentageChange EmailSecurityTopTldSpoofGetResponseMetaNormalization = "PERCENTAGE_CHANGE" EmailSecurityTopTldSpoofGetResponseMetaNormalizationRollingAverage EmailSecurityTopTldSpoofGetResponseMetaNormalization = "ROLLING_AVERAGE" EmailSecurityTopTldSpoofGetResponseMetaNormalizationOverlappedPercentage EmailSecurityTopTldSpoofGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" EmailSecurityTopTldSpoofGetResponseMetaNormalizationRatio EmailSecurityTopTldSpoofGetResponseMetaNormalization = "RATIO" )
func (EmailSecurityTopTldSpoofGetResponseMetaNormalization) IsKnown ¶
func (r EmailSecurityTopTldSpoofGetResponseMetaNormalization) IsKnown() bool
type EmailSecurityTopTldSpoofGetResponseMetaUnit ¶
type EmailSecurityTopTldSpoofGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON emailSecurityTopTldSpoofGetResponseMetaUnitJSON `json:"-"`
}
func (*EmailSecurityTopTldSpoofGetResponseMetaUnit) UnmarshalJSON ¶
func (r *EmailSecurityTopTldSpoofGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type EmailSecurityTopTldSpoofGetResponseTop0 ¶
type EmailSecurityTopTldSpoofGetResponseTop0 struct {
Name string `json:"name,required"`
// A numeric string.
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 ¶
func (r *EmailSecurityTopTldSpoofService) Get(ctx context.Context, spoof EmailSecurityTopTldSpoofGetParamsSpoof, query EmailSecurityTopTldSpoofGetParams, opts ...option.RequestOption) (res *EmailSecurityTopTldSpoofGetResponse, err error)
Retrieves the top 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 in which results will be returned.
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 in which results will be returned.
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"`
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:"ip"`
// Format in which results will be returned.
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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list.
ASN param.Field[string] `query:"asn"`
// Format in which results will be returned.
Format param.Field[EntityASNListParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify an alpha-2 location code.
Location param.Field[string] `query:"location"`
// Skips the specified number of objects before fetching the results.
Offset param.Field[int64] `query:"offset"`
// Specifies the metric to order the ASNs by.
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 in which results will be returned.
const ( EntityASNListParamsFormatJson EntityASNListParamsFormat = "JSON" EntityASNListParamsFormatCsv EntityASNListParamsFormat = "CSV" )
func (EntityASNListParamsFormat) IsKnown ¶
func (r EntityASNListParamsFormat) IsKnown() bool
type EntityASNListParamsOrderBy ¶
type EntityASNListParamsOrderBy string
Specifies the metric to order the ASNs by.
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"`
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 {
// Retrieves the AS relationship of ASN2 with respect to the given ASN.
Asn2 param.Field[int64] `query:"asn2"`
// Format in which results will be returned.
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 in which results will be returned.
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 ¶
func (r *EntityASNService) Get(ctx context.Context, asn int64, query EntityASNGetParams, opts ...option.RequestOption) (res *EntityASNGetResponse, err error)
Retrieves 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 ¶
func (r *EntityASNService) IP(ctx context.Context, query EntityASNIPParams, opts ...option.RequestOption) (res *EntityAsnipResponse, err error)
Retrieves 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 ¶
func (r *EntityASNService) List(ctx context.Context, query EntityASNListParams, opts ...option.RequestOption) (res *EntityASNListResponse, err error)
Retrieves a list of autonomous systems.
func (*EntityASNService) Rel ¶
func (r *EntityASNService) Rel(ctx context.Context, asn int64, query EntityASNRelParams, opts ...option.RequestOption) (res *EntityASNRelResponse, err error)
Retrieves AS-level relationship for given networks.
type EntityAsnipParamsFormat ¶
type EntityAsnipParamsFormat string
Format in which results will be returned.
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"`
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:"ip"`
// Format in which results will be returned.
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 in which results will be returned.
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 in which results will be returned.
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 in which results will be returned.
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"`
// A numeric string.
Latitude string `json:"latitude,required"`
// A numeric string.
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 in which results will be returned.
Format param.Field[EntityLocationListParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 location
// codes.
Location param.Field[string] `query:"location"`
// Skips the specified number of objects before fetching the 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 in which results will be returned.
const ( EntityLocationListParamsFormatJson EntityLocationListParamsFormat = "JSON" EntityLocationListParamsFormatCsv EntityLocationListParamsFormat = "CSV" )
func (EntityLocationListParamsFormat) IsKnown ¶
func (r EntityLocationListParamsFormat) IsKnown() bool
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"`
// A numeric string.
Latitude string `json:"latitude,required"`
// A numeric string.
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 ¶
func (r *EntityLocationService) Get(ctx context.Context, location string, query EntityLocationGetParams, opts ...option.RequestOption) (res *EntityLocationGetResponse, err error)
Retrieves 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 ¶
func (r *EntityLocationService) List(ctx context.Context, query EntityLocationListParams, opts ...option.RequestOption) (res *EntityLocationListResponse, err error)
Retrieves 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)
Retrieves IP address information.
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type HTTPAseBotClassGetParams ¶
type HTTPAseBotClassGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseBotClassGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseBotClassGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseBotClassGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseBotClassGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseBotClassGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseBotClassGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPAseBotClassGetParamsOS] `query:"os"`
// Filters results by 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. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
const ( HTTPAseBotClassGetParamsBotClassLikelyAutomated HTTPAseBotClassGetParamsBotClass = "LIKELY_AUTOMATED" HTTPAseBotClassGetParamsBotClassLikelyHuman HTTPAseBotClassGetParamsBotClass = "LIKELY_HUMAN" )
func (HTTPAseBotClassGetParamsBotClass) IsKnown ¶
func (r HTTPAseBotClassGetParamsBotClass) IsKnown() bool
type HTTPAseBotClassGetParamsBrowserFamily ¶
type HTTPAseBotClassGetParamsBrowserFamily string
const ( HTTPAseBotClassGetParamsBrowserFamilyChrome HTTPAseBotClassGetParamsBrowserFamily = "CHROME" HTTPAseBotClassGetParamsBrowserFamilyEdge HTTPAseBotClassGetParamsBrowserFamily = "EDGE" HTTPAseBotClassGetParamsBrowserFamilyFirefox HTTPAseBotClassGetParamsBrowserFamily = "FIREFOX" HTTPAseBotClassGetParamsBrowserFamilySafari HTTPAseBotClassGetParamsBrowserFamily = "SAFARI" )
func (HTTPAseBotClassGetParamsBrowserFamily) IsKnown ¶
func (r HTTPAseBotClassGetParamsBrowserFamily) IsKnown() bool
type HTTPAseBotClassGetParamsDeviceType ¶
type HTTPAseBotClassGetParamsDeviceType string
const ( HTTPAseBotClassGetParamsDeviceTypeDesktop HTTPAseBotClassGetParamsDeviceType = "DESKTOP" HTTPAseBotClassGetParamsDeviceTypeMobile HTTPAseBotClassGetParamsDeviceType = "MOBILE" HTTPAseBotClassGetParamsDeviceTypeOther HTTPAseBotClassGetParamsDeviceType = "OTHER" )
func (HTTPAseBotClassGetParamsDeviceType) IsKnown ¶
func (r HTTPAseBotClassGetParamsDeviceType) IsKnown() bool
type HTTPAseBotClassGetParamsFormat ¶
type HTTPAseBotClassGetParamsFormat string
Format in which results will be returned.
const ( HTTPAseBotClassGetParamsFormatJson HTTPAseBotClassGetParamsFormat = "JSON" HTTPAseBotClassGetParamsFormatCsv HTTPAseBotClassGetParamsFormat = "CSV" )
func (HTTPAseBotClassGetParamsFormat) IsKnown ¶
func (r HTTPAseBotClassGetParamsFormat) IsKnown() bool
type HTTPAseBotClassGetParamsHTTPProtocol ¶
type HTTPAseBotClassGetParamsHTTPProtocol string
const ( HTTPAseBotClassGetParamsHTTPProtocolHTTP HTTPAseBotClassGetParamsHTTPProtocol = "HTTP" HTTPAseBotClassGetParamsHTTPProtocolHTTPS HTTPAseBotClassGetParamsHTTPProtocol = "HTTPS" )
func (HTTPAseBotClassGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPAseBotClassGetParamsHTTPProtocol) IsKnown() bool
type HTTPAseBotClassGetParamsHTTPVersion ¶
type HTTPAseBotClassGetParamsHTTPVersion string
const ( HTTPAseBotClassGetParamsHTTPVersionHttPv1 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv1" HTTPAseBotClassGetParamsHTTPVersionHttPv2 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv2" HTTPAseBotClassGetParamsHTTPVersionHttPv3 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv3" )
func (HTTPAseBotClassGetParamsHTTPVersion) IsKnown ¶
func (r HTTPAseBotClassGetParamsHTTPVersion) IsKnown() bool
type HTTPAseBotClassGetParamsIPVersion ¶
type HTTPAseBotClassGetParamsIPVersion string
const ( HTTPAseBotClassGetParamsIPVersionIPv4 HTTPAseBotClassGetParamsIPVersion = "IPv4" HTTPAseBotClassGetParamsIPVersionIPv6 HTTPAseBotClassGetParamsIPVersion = "IPv6" )
func (HTTPAseBotClassGetParamsIPVersion) IsKnown ¶
func (r HTTPAseBotClassGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPAseBotClassGetParamsTLSVersion) IsKnown() bool
type HTTPAseBotClassGetResponse ¶
type HTTPAseBotClassGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseBotClassGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseBotClassGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseBotClassGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseBotClassGetResponseMetaUnit `json:"units,required"`
JSON httpAseBotClassGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseBotClassGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseBotClassGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseBotClassGetResponseMetaConfidenceInfo ¶
type HTTPAseBotClassGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseBotClassGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPAseBotClassGetResponseMetaNormalization ¶
type HTTPAseBotClassGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseBotClassGetResponseMetaNormalizationPercentage HTTPAseBotClassGetResponseMetaNormalization = "PERCENTAGE" HTTPAseBotClassGetResponseMetaNormalizationMin0Max HTTPAseBotClassGetResponseMetaNormalization = "MIN0_MAX" HTTPAseBotClassGetResponseMetaNormalizationMinMax HTTPAseBotClassGetResponseMetaNormalization = "MIN_MAX" HTTPAseBotClassGetResponseMetaNormalizationRawValues HTTPAseBotClassGetResponseMetaNormalization = "RAW_VALUES" HTTPAseBotClassGetResponseMetaNormalizationPercentageChange HTTPAseBotClassGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseBotClassGetResponseMetaNormalizationRollingAverage HTTPAseBotClassGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseBotClassGetResponseMetaNormalizationOverlappedPercentage HTTPAseBotClassGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseBotClassGetResponseMetaNormalizationRatio HTTPAseBotClassGetResponseMetaNormalization = "RATIO" )
func (HTTPAseBotClassGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseBotClassGetResponseMetaNormalization) IsKnown() bool
type HTTPAseBotClassGetResponseMetaUnit ¶
type HTTPAseBotClassGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseBotClassGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseBotClassGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseBotClassGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseBotClassGetResponseTop0 ¶
type HTTPAseBotClassGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseBotClassService) Get(ctx context.Context, botClass HTTPAseBotClassGetParamsBotClass, query HTTPAseBotClassGetParams, opts ...option.RequestOption) (res *HTTPAseBotClassGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested bot class.
type HTTPAseBrowserFamilyGetParams ¶
type HTTPAseBrowserFamilyGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseBrowserFamilyGetParamsBotClass] `query:"botClass"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseBrowserFamilyGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseBrowserFamilyGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseBrowserFamilyGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseBrowserFamilyGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseBrowserFamilyGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPAseBrowserFamilyGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPAseBrowserFamilyGetParamsBotClass) IsKnown() bool
type HTTPAseBrowserFamilyGetParamsBrowserFamily ¶
type HTTPAseBrowserFamilyGetParamsBrowserFamily string
Browser family.
const ( HTTPAseBrowserFamilyGetParamsBrowserFamilyChrome HTTPAseBrowserFamilyGetParamsBrowserFamily = "CHROME" HTTPAseBrowserFamilyGetParamsBrowserFamilyEdge HTTPAseBrowserFamilyGetParamsBrowserFamily = "EDGE" HTTPAseBrowserFamilyGetParamsBrowserFamilyFirefox HTTPAseBrowserFamilyGetParamsBrowserFamily = "FIREFOX" HTTPAseBrowserFamilyGetParamsBrowserFamilySafari HTTPAseBrowserFamilyGetParamsBrowserFamily = "SAFARI" )
func (HTTPAseBrowserFamilyGetParamsBrowserFamily) IsKnown ¶
func (r HTTPAseBrowserFamilyGetParamsBrowserFamily) IsKnown() bool
type HTTPAseBrowserFamilyGetParamsDeviceType ¶
type HTTPAseBrowserFamilyGetParamsDeviceType string
const ( HTTPAseBrowserFamilyGetParamsDeviceTypeDesktop HTTPAseBrowserFamilyGetParamsDeviceType = "DESKTOP" HTTPAseBrowserFamilyGetParamsDeviceTypeMobile HTTPAseBrowserFamilyGetParamsDeviceType = "MOBILE" HTTPAseBrowserFamilyGetParamsDeviceTypeOther HTTPAseBrowserFamilyGetParamsDeviceType = "OTHER" )
func (HTTPAseBrowserFamilyGetParamsDeviceType) IsKnown ¶
func (r HTTPAseBrowserFamilyGetParamsDeviceType) IsKnown() bool
type HTTPAseBrowserFamilyGetParamsFormat ¶
type HTTPAseBrowserFamilyGetParamsFormat string
Format in which results will be returned.
const ( HTTPAseBrowserFamilyGetParamsFormatJson HTTPAseBrowserFamilyGetParamsFormat = "JSON" HTTPAseBrowserFamilyGetParamsFormatCsv HTTPAseBrowserFamilyGetParamsFormat = "CSV" )
func (HTTPAseBrowserFamilyGetParamsFormat) IsKnown ¶
func (r HTTPAseBrowserFamilyGetParamsFormat) IsKnown() bool
type HTTPAseBrowserFamilyGetParamsHTTPProtocol ¶
type HTTPAseBrowserFamilyGetParamsHTTPProtocol string
const ( HTTPAseBrowserFamilyGetParamsHTTPProtocolHTTP HTTPAseBrowserFamilyGetParamsHTTPProtocol = "HTTP" HTTPAseBrowserFamilyGetParamsHTTPProtocolHTTPS HTTPAseBrowserFamilyGetParamsHTTPProtocol = "HTTPS" )
func (HTTPAseBrowserFamilyGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPAseBrowserFamilyGetParamsHTTPProtocol) IsKnown() bool
type HTTPAseBrowserFamilyGetParamsHTTPVersion ¶
type HTTPAseBrowserFamilyGetParamsHTTPVersion string
const ( HTTPAseBrowserFamilyGetParamsHTTPVersionHttPv1 HTTPAseBrowserFamilyGetParamsHTTPVersion = "HTTPv1" HTTPAseBrowserFamilyGetParamsHTTPVersionHttPv2 HTTPAseBrowserFamilyGetParamsHTTPVersion = "HTTPv2" HTTPAseBrowserFamilyGetParamsHTTPVersionHttPv3 HTTPAseBrowserFamilyGetParamsHTTPVersion = "HTTPv3" )
func (HTTPAseBrowserFamilyGetParamsHTTPVersion) IsKnown ¶
func (r HTTPAseBrowserFamilyGetParamsHTTPVersion) IsKnown() bool
type HTTPAseBrowserFamilyGetParamsIPVersion ¶
type HTTPAseBrowserFamilyGetParamsIPVersion string
const ( HTTPAseBrowserFamilyGetParamsIPVersionIPv4 HTTPAseBrowserFamilyGetParamsIPVersion = "IPv4" HTTPAseBrowserFamilyGetParamsIPVersionIPv6 HTTPAseBrowserFamilyGetParamsIPVersion = "IPv6" )
func (HTTPAseBrowserFamilyGetParamsIPVersion) IsKnown ¶
func (r HTTPAseBrowserFamilyGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPAseBrowserFamilyGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPAseBrowserFamilyGetParamsTLSVersion) IsKnown() bool
type HTTPAseBrowserFamilyGetResponse ¶
type HTTPAseBrowserFamilyGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseBrowserFamilyGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseBrowserFamilyGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseBrowserFamilyGetResponseMetaUnit `json:"units,required"`
JSON httpAseBrowserFamilyGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseBrowserFamilyGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseBrowserFamilyGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo ¶
type HTTPAseBrowserFamilyGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPAseBrowserFamilyGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPAseBrowserFamilyGetResponseMetaNormalization ¶
type HTTPAseBrowserFamilyGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseBrowserFamilyGetResponseMetaNormalizationPercentage HTTPAseBrowserFamilyGetResponseMetaNormalization = "PERCENTAGE" HTTPAseBrowserFamilyGetResponseMetaNormalizationMin0Max HTTPAseBrowserFamilyGetResponseMetaNormalization = "MIN0_MAX" HTTPAseBrowserFamilyGetResponseMetaNormalizationMinMax HTTPAseBrowserFamilyGetResponseMetaNormalization = "MIN_MAX" HTTPAseBrowserFamilyGetResponseMetaNormalizationRawValues HTTPAseBrowserFamilyGetResponseMetaNormalization = "RAW_VALUES" HTTPAseBrowserFamilyGetResponseMetaNormalizationPercentageChange HTTPAseBrowserFamilyGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseBrowserFamilyGetResponseMetaNormalizationRollingAverage HTTPAseBrowserFamilyGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseBrowserFamilyGetResponseMetaNormalizationOverlappedPercentage HTTPAseBrowserFamilyGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseBrowserFamilyGetResponseMetaNormalizationRatio HTTPAseBrowserFamilyGetResponseMetaNormalization = "RATIO" )
func (HTTPAseBrowserFamilyGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseBrowserFamilyGetResponseMetaNormalization) IsKnown() bool
type HTTPAseBrowserFamilyGetResponseMetaUnit ¶
type HTTPAseBrowserFamilyGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseBrowserFamilyGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseBrowserFamilyGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseBrowserFamilyGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseBrowserFamilyGetResponseTop0 ¶
type HTTPAseBrowserFamilyGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseBrowserFamilyService) Get(ctx context.Context, browserFamily HTTPAseBrowserFamilyGetParamsBrowserFamily, query HTTPAseBrowserFamilyGetParams, opts ...option.RequestOption) (res *HTTPAseBrowserFamilyGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested browser family.
type HTTPAseDeviceTypeGetParams ¶
type HTTPAseDeviceTypeGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseDeviceTypeGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseDeviceTypeGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[HTTPAseDeviceTypeGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseDeviceTypeGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseDeviceTypeGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseDeviceTypeGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPAseDeviceTypeGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPAseDeviceTypeGetParamsBotClass) IsKnown() bool
type HTTPAseDeviceTypeGetParamsBrowserFamily ¶
type HTTPAseDeviceTypeGetParamsBrowserFamily string
const ( HTTPAseDeviceTypeGetParamsBrowserFamilyChrome HTTPAseDeviceTypeGetParamsBrowserFamily = "CHROME" HTTPAseDeviceTypeGetParamsBrowserFamilyEdge HTTPAseDeviceTypeGetParamsBrowserFamily = "EDGE" HTTPAseDeviceTypeGetParamsBrowserFamilyFirefox HTTPAseDeviceTypeGetParamsBrowserFamily = "FIREFOX" HTTPAseDeviceTypeGetParamsBrowserFamilySafari HTTPAseDeviceTypeGetParamsBrowserFamily = "SAFARI" )
func (HTTPAseDeviceTypeGetParamsBrowserFamily) IsKnown ¶
func (r HTTPAseDeviceTypeGetParamsBrowserFamily) IsKnown() bool
type HTTPAseDeviceTypeGetParamsDeviceType ¶
type HTTPAseDeviceTypeGetParamsDeviceType string
Device type.
const ( HTTPAseDeviceTypeGetParamsDeviceTypeDesktop HTTPAseDeviceTypeGetParamsDeviceType = "DESKTOP" HTTPAseDeviceTypeGetParamsDeviceTypeMobile HTTPAseDeviceTypeGetParamsDeviceType = "MOBILE" HTTPAseDeviceTypeGetParamsDeviceTypeOther HTTPAseDeviceTypeGetParamsDeviceType = "OTHER" )
func (HTTPAseDeviceTypeGetParamsDeviceType) IsKnown ¶
func (r HTTPAseDeviceTypeGetParamsDeviceType) IsKnown() bool
type HTTPAseDeviceTypeGetParamsFormat ¶
type HTTPAseDeviceTypeGetParamsFormat string
Format in which results will be returned.
const ( HTTPAseDeviceTypeGetParamsFormatJson HTTPAseDeviceTypeGetParamsFormat = "JSON" HTTPAseDeviceTypeGetParamsFormatCsv HTTPAseDeviceTypeGetParamsFormat = "CSV" )
func (HTTPAseDeviceTypeGetParamsFormat) IsKnown ¶
func (r HTTPAseDeviceTypeGetParamsFormat) IsKnown() bool
type HTTPAseDeviceTypeGetParamsHTTPProtocol ¶
type HTTPAseDeviceTypeGetParamsHTTPProtocol string
const ( HTTPAseDeviceTypeGetParamsHTTPProtocolHTTP HTTPAseDeviceTypeGetParamsHTTPProtocol = "HTTP" HTTPAseDeviceTypeGetParamsHTTPProtocolHTTPS HTTPAseDeviceTypeGetParamsHTTPProtocol = "HTTPS" )
func (HTTPAseDeviceTypeGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPAseDeviceTypeGetParamsHTTPProtocol) IsKnown() bool
type HTTPAseDeviceTypeGetParamsHTTPVersion ¶
type HTTPAseDeviceTypeGetParamsHTTPVersion string
const ( HTTPAseDeviceTypeGetParamsHTTPVersionHttPv1 HTTPAseDeviceTypeGetParamsHTTPVersion = "HTTPv1" HTTPAseDeviceTypeGetParamsHTTPVersionHttPv2 HTTPAseDeviceTypeGetParamsHTTPVersion = "HTTPv2" HTTPAseDeviceTypeGetParamsHTTPVersionHttPv3 HTTPAseDeviceTypeGetParamsHTTPVersion = "HTTPv3" )
func (HTTPAseDeviceTypeGetParamsHTTPVersion) IsKnown ¶
func (r HTTPAseDeviceTypeGetParamsHTTPVersion) IsKnown() bool
type HTTPAseDeviceTypeGetParamsIPVersion ¶
type HTTPAseDeviceTypeGetParamsIPVersion string
const ( HTTPAseDeviceTypeGetParamsIPVersionIPv4 HTTPAseDeviceTypeGetParamsIPVersion = "IPv4" HTTPAseDeviceTypeGetParamsIPVersionIPv6 HTTPAseDeviceTypeGetParamsIPVersion = "IPv6" )
func (HTTPAseDeviceTypeGetParamsIPVersion) IsKnown ¶
func (r HTTPAseDeviceTypeGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPAseDeviceTypeGetParamsTLSVersion) IsKnown() bool
type HTTPAseDeviceTypeGetResponse ¶
type HTTPAseDeviceTypeGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseDeviceTypeGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseDeviceTypeGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseDeviceTypeGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseDeviceTypeGetResponseMetaUnit `json:"units,required"`
JSON httpAseDeviceTypeGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseDeviceTypeGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseDeviceTypeGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseDeviceTypeGetResponseMetaConfidenceInfo ¶
type HTTPAseDeviceTypeGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseDeviceTypeGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPAseDeviceTypeGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPAseDeviceTypeGetResponseMetaNormalization ¶
type HTTPAseDeviceTypeGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseDeviceTypeGetResponseMetaNormalizationPercentage HTTPAseDeviceTypeGetResponseMetaNormalization = "PERCENTAGE" HTTPAseDeviceTypeGetResponseMetaNormalizationMin0Max HTTPAseDeviceTypeGetResponseMetaNormalization = "MIN0_MAX" HTTPAseDeviceTypeGetResponseMetaNormalizationMinMax HTTPAseDeviceTypeGetResponseMetaNormalization = "MIN_MAX" HTTPAseDeviceTypeGetResponseMetaNormalizationRawValues HTTPAseDeviceTypeGetResponseMetaNormalization = "RAW_VALUES" HTTPAseDeviceTypeGetResponseMetaNormalizationPercentageChange HTTPAseDeviceTypeGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseDeviceTypeGetResponseMetaNormalizationRollingAverage HTTPAseDeviceTypeGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseDeviceTypeGetResponseMetaNormalizationOverlappedPercentage HTTPAseDeviceTypeGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseDeviceTypeGetResponseMetaNormalizationRatio HTTPAseDeviceTypeGetResponseMetaNormalization = "RATIO" )
func (HTTPAseDeviceTypeGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseDeviceTypeGetResponseMetaNormalization) IsKnown() bool
type HTTPAseDeviceTypeGetResponseMetaUnit ¶
type HTTPAseDeviceTypeGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseDeviceTypeGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseDeviceTypeGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseDeviceTypeGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseDeviceTypeGetResponseTop0 ¶
type HTTPAseDeviceTypeGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseDeviceTypeService) Get(ctx context.Context, deviceType HTTPAseDeviceTypeGetParamsDeviceType, query HTTPAseDeviceTypeGetParams, opts ...option.RequestOption) (res *HTTPAseDeviceTypeGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested device type.
type HTTPAseGetParams ¶
type HTTPAseGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPAseGetParamsOS] `query:"os"`
// Filters results by 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 in which results will be returned.
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 {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseGetResponseMetaUnit `json:"units,required"`
JSON httpAseGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseGetResponseMetaConfidenceInfo ¶
type HTTPAseGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPAseGetResponseMetaNormalization ¶
type HTTPAseGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseGetResponseMetaNormalizationPercentage HTTPAseGetResponseMetaNormalization = "PERCENTAGE" HTTPAseGetResponseMetaNormalizationMin0Max HTTPAseGetResponseMetaNormalization = "MIN0_MAX" HTTPAseGetResponseMetaNormalizationMinMax HTTPAseGetResponseMetaNormalization = "MIN_MAX" HTTPAseGetResponseMetaNormalizationRawValues HTTPAseGetResponseMetaNormalization = "RAW_VALUES" HTTPAseGetResponseMetaNormalizationPercentageChange HTTPAseGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseGetResponseMetaNormalizationRollingAverage HTTPAseGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseGetResponseMetaNormalizationOverlappedPercentage HTTPAseGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseGetResponseMetaNormalizationRatio HTTPAseGetResponseMetaNormalization = "RATIO" )
func (HTTPAseGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseGetResponseMetaNormalization) IsKnown() bool
type HTTPAseGetResponseMetaUnit ¶
type HTTPAseGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseGetResponseTop0 ¶
type HTTPAseGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
Value string `json:"value,required"`
JSON httpAseGetResponseTop0JSON `json:"-"`
}
func (*HTTPAseGetResponseTop0) UnmarshalJSON ¶
func (r *HTTPAseGetResponseTop0) UnmarshalJSON(data []byte) (err error)
type HTTPAseHTTPMethodGetParams ¶
type HTTPAseHTTPMethodGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseHTTPMethodGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseHTTPMethodGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseHTTPMethodGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseHTTPMethodGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseHTTPMethodGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseHTTPMethodGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPAseHTTPMethodGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPAseHTTPMethodGetParamsBotClass) IsKnown() bool
type HTTPAseHTTPMethodGetParamsBrowserFamily ¶
type HTTPAseHTTPMethodGetParamsBrowserFamily string
const ( HTTPAseHTTPMethodGetParamsBrowserFamilyChrome HTTPAseHTTPMethodGetParamsBrowserFamily = "CHROME" HTTPAseHTTPMethodGetParamsBrowserFamilyEdge HTTPAseHTTPMethodGetParamsBrowserFamily = "EDGE" HTTPAseHTTPMethodGetParamsBrowserFamilyFirefox HTTPAseHTTPMethodGetParamsBrowserFamily = "FIREFOX" HTTPAseHTTPMethodGetParamsBrowserFamilySafari HTTPAseHTTPMethodGetParamsBrowserFamily = "SAFARI" )
func (HTTPAseHTTPMethodGetParamsBrowserFamily) IsKnown ¶
func (r HTTPAseHTTPMethodGetParamsBrowserFamily) IsKnown() bool
type HTTPAseHTTPMethodGetParamsDeviceType ¶
type HTTPAseHTTPMethodGetParamsDeviceType string
const ( HTTPAseHTTPMethodGetParamsDeviceTypeDesktop HTTPAseHTTPMethodGetParamsDeviceType = "DESKTOP" HTTPAseHTTPMethodGetParamsDeviceTypeMobile HTTPAseHTTPMethodGetParamsDeviceType = "MOBILE" HTTPAseHTTPMethodGetParamsDeviceTypeOther HTTPAseHTTPMethodGetParamsDeviceType = "OTHER" )
func (HTTPAseHTTPMethodGetParamsDeviceType) IsKnown ¶
func (r HTTPAseHTTPMethodGetParamsDeviceType) IsKnown() bool
type HTTPAseHTTPMethodGetParamsFormat ¶
type HTTPAseHTTPMethodGetParamsFormat string
Format in which results will be returned.
const ( HTTPAseHTTPMethodGetParamsFormatJson HTTPAseHTTPMethodGetParamsFormat = "JSON" HTTPAseHTTPMethodGetParamsFormatCsv HTTPAseHTTPMethodGetParamsFormat = "CSV" )
func (HTTPAseHTTPMethodGetParamsFormat) IsKnown ¶
func (r HTTPAseHTTPMethodGetParamsFormat) IsKnown() bool
type HTTPAseHTTPMethodGetParamsHTTPProtocol ¶
type HTTPAseHTTPMethodGetParamsHTTPProtocol string
const ( HTTPAseHTTPMethodGetParamsHTTPProtocolHTTP HTTPAseHTTPMethodGetParamsHTTPProtocol = "HTTP" HTTPAseHTTPMethodGetParamsHTTPProtocolHTTPS HTTPAseHTTPMethodGetParamsHTTPProtocol = "HTTPS" )
func (HTTPAseHTTPMethodGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPAseHTTPMethodGetParamsHTTPProtocol) IsKnown() bool
type HTTPAseHTTPMethodGetParamsHTTPVersion ¶
type HTTPAseHTTPMethodGetParamsHTTPVersion string
HTTP version.
const ( HTTPAseHTTPMethodGetParamsHTTPVersionHttPv1 HTTPAseHTTPMethodGetParamsHTTPVersion = "HTTPv1" HTTPAseHTTPMethodGetParamsHTTPVersionHttPv2 HTTPAseHTTPMethodGetParamsHTTPVersion = "HTTPv2" HTTPAseHTTPMethodGetParamsHTTPVersionHttPv3 HTTPAseHTTPMethodGetParamsHTTPVersion = "HTTPv3" )
func (HTTPAseHTTPMethodGetParamsHTTPVersion) IsKnown ¶
func (r HTTPAseHTTPMethodGetParamsHTTPVersion) IsKnown() bool
type HTTPAseHTTPMethodGetParamsIPVersion ¶
type HTTPAseHTTPMethodGetParamsIPVersion string
const ( HTTPAseHTTPMethodGetParamsIPVersionIPv4 HTTPAseHTTPMethodGetParamsIPVersion = "IPv4" HTTPAseHTTPMethodGetParamsIPVersionIPv6 HTTPAseHTTPMethodGetParamsIPVersion = "IPv6" )
func (HTTPAseHTTPMethodGetParamsIPVersion) IsKnown ¶
func (r HTTPAseHTTPMethodGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPAseHTTPMethodGetParamsTLSVersion) IsKnown() bool
type HTTPAseHTTPMethodGetResponse ¶
type HTTPAseHTTPMethodGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseHTTPMethodGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseHTTPMethodGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseHTTPMethodGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseHTTPMethodGetResponseMetaUnit `json:"units,required"`
JSON httpAseHTTPMethodGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseHTTPMethodGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseHTTPMethodGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseHTTPMethodGetResponseMetaConfidenceInfo ¶
type HTTPAseHTTPMethodGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseHTTPMethodGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPAseHTTPMethodGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPAseHTTPMethodGetResponseMetaNormalization ¶
type HTTPAseHTTPMethodGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseHTTPMethodGetResponseMetaNormalizationPercentage HTTPAseHTTPMethodGetResponseMetaNormalization = "PERCENTAGE" HTTPAseHTTPMethodGetResponseMetaNormalizationMin0Max HTTPAseHTTPMethodGetResponseMetaNormalization = "MIN0_MAX" HTTPAseHTTPMethodGetResponseMetaNormalizationMinMax HTTPAseHTTPMethodGetResponseMetaNormalization = "MIN_MAX" HTTPAseHTTPMethodGetResponseMetaNormalizationRawValues HTTPAseHTTPMethodGetResponseMetaNormalization = "RAW_VALUES" HTTPAseHTTPMethodGetResponseMetaNormalizationPercentageChange HTTPAseHTTPMethodGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseHTTPMethodGetResponseMetaNormalizationRollingAverage HTTPAseHTTPMethodGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseHTTPMethodGetResponseMetaNormalizationOverlappedPercentage HTTPAseHTTPMethodGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseHTTPMethodGetResponseMetaNormalizationRatio HTTPAseHTTPMethodGetResponseMetaNormalization = "RATIO" )
func (HTTPAseHTTPMethodGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseHTTPMethodGetResponseMetaNormalization) IsKnown() bool
type HTTPAseHTTPMethodGetResponseMetaUnit ¶
type HTTPAseHTTPMethodGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseHTTPMethodGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseHTTPMethodGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseHTTPMethodGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseHTTPMethodGetResponseTop0 ¶
type HTTPAseHTTPMethodGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseHTTPMethodService) Get(ctx context.Context, httpVersion HTTPAseHTTPMethodGetParamsHTTPVersion, query HTTPAseHTTPMethodGetParams, opts ...option.RequestOption) (res *HTTPAseHTTPMethodGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP version.
type HTTPAseHTTPProtocolGetParams ¶
type HTTPAseHTTPProtocolGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseHTTPProtocolGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseHTTPProtocolGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseHTTPProtocolGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseHTTPProtocolGetParamsFormat] `query:"format"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseHTTPProtocolGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseHTTPProtocolGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPAseHTTPProtocolGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPAseHTTPProtocolGetParamsBotClass) IsKnown() bool
type HTTPAseHTTPProtocolGetParamsBrowserFamily ¶
type HTTPAseHTTPProtocolGetParamsBrowserFamily string
const ( HTTPAseHTTPProtocolGetParamsBrowserFamilyChrome HTTPAseHTTPProtocolGetParamsBrowserFamily = "CHROME" HTTPAseHTTPProtocolGetParamsBrowserFamilyEdge HTTPAseHTTPProtocolGetParamsBrowserFamily = "EDGE" HTTPAseHTTPProtocolGetParamsBrowserFamilyFirefox HTTPAseHTTPProtocolGetParamsBrowserFamily = "FIREFOX" HTTPAseHTTPProtocolGetParamsBrowserFamilySafari HTTPAseHTTPProtocolGetParamsBrowserFamily = "SAFARI" )
func (HTTPAseHTTPProtocolGetParamsBrowserFamily) IsKnown ¶
func (r HTTPAseHTTPProtocolGetParamsBrowserFamily) IsKnown() bool
type HTTPAseHTTPProtocolGetParamsDeviceType ¶
type HTTPAseHTTPProtocolGetParamsDeviceType string
const ( HTTPAseHTTPProtocolGetParamsDeviceTypeDesktop HTTPAseHTTPProtocolGetParamsDeviceType = "DESKTOP" HTTPAseHTTPProtocolGetParamsDeviceTypeMobile HTTPAseHTTPProtocolGetParamsDeviceType = "MOBILE" HTTPAseHTTPProtocolGetParamsDeviceTypeOther HTTPAseHTTPProtocolGetParamsDeviceType = "OTHER" )
func (HTTPAseHTTPProtocolGetParamsDeviceType) IsKnown ¶
func (r HTTPAseHTTPProtocolGetParamsDeviceType) IsKnown() bool
type HTTPAseHTTPProtocolGetParamsFormat ¶
type HTTPAseHTTPProtocolGetParamsFormat string
Format in which results will be returned.
const ( HTTPAseHTTPProtocolGetParamsFormatJson HTTPAseHTTPProtocolGetParamsFormat = "JSON" HTTPAseHTTPProtocolGetParamsFormatCsv HTTPAseHTTPProtocolGetParamsFormat = "CSV" )
func (HTTPAseHTTPProtocolGetParamsFormat) IsKnown ¶
func (r HTTPAseHTTPProtocolGetParamsFormat) IsKnown() bool
type HTTPAseHTTPProtocolGetParamsHTTPProtocol ¶
type HTTPAseHTTPProtocolGetParamsHTTPProtocol string
HTTP protocol (HTTP vs. HTTPS).
const ( HTTPAseHTTPProtocolGetParamsHTTPProtocolHTTP HTTPAseHTTPProtocolGetParamsHTTPProtocol = "HTTP" HTTPAseHTTPProtocolGetParamsHTTPProtocolHTTPS HTTPAseHTTPProtocolGetParamsHTTPProtocol = "HTTPS" )
func (HTTPAseHTTPProtocolGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPAseHTTPProtocolGetParamsHTTPProtocol) IsKnown() bool
type HTTPAseHTTPProtocolGetParamsHTTPVersion ¶
type HTTPAseHTTPProtocolGetParamsHTTPVersion string
const ( HTTPAseHTTPProtocolGetParamsHTTPVersionHttPv1 HTTPAseHTTPProtocolGetParamsHTTPVersion = "HTTPv1" HTTPAseHTTPProtocolGetParamsHTTPVersionHttPv2 HTTPAseHTTPProtocolGetParamsHTTPVersion = "HTTPv2" HTTPAseHTTPProtocolGetParamsHTTPVersionHttPv3 HTTPAseHTTPProtocolGetParamsHTTPVersion = "HTTPv3" )
func (HTTPAseHTTPProtocolGetParamsHTTPVersion) IsKnown ¶
func (r HTTPAseHTTPProtocolGetParamsHTTPVersion) IsKnown() bool
type HTTPAseHTTPProtocolGetParamsIPVersion ¶
type HTTPAseHTTPProtocolGetParamsIPVersion string
const ( HTTPAseHTTPProtocolGetParamsIPVersionIPv4 HTTPAseHTTPProtocolGetParamsIPVersion = "IPv4" HTTPAseHTTPProtocolGetParamsIPVersionIPv6 HTTPAseHTTPProtocolGetParamsIPVersion = "IPv6" )
func (HTTPAseHTTPProtocolGetParamsIPVersion) IsKnown ¶
func (r HTTPAseHTTPProtocolGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPAseHTTPProtocolGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPAseHTTPProtocolGetParamsTLSVersion) IsKnown() bool
type HTTPAseHTTPProtocolGetResponse ¶
type HTTPAseHTTPProtocolGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseHTTPProtocolGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseHTTPProtocolGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseHTTPProtocolGetResponseMetaUnit `json:"units,required"`
JSON httpAseHTTPProtocolGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseHTTPProtocolGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseHTTPProtocolGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo ¶
type HTTPAseHTTPProtocolGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPAseHTTPProtocolGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPAseHTTPProtocolGetResponseMetaNormalization ¶
type HTTPAseHTTPProtocolGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseHTTPProtocolGetResponseMetaNormalizationPercentage HTTPAseHTTPProtocolGetResponseMetaNormalization = "PERCENTAGE" HTTPAseHTTPProtocolGetResponseMetaNormalizationMin0Max HTTPAseHTTPProtocolGetResponseMetaNormalization = "MIN0_MAX" HTTPAseHTTPProtocolGetResponseMetaNormalizationMinMax HTTPAseHTTPProtocolGetResponseMetaNormalization = "MIN_MAX" HTTPAseHTTPProtocolGetResponseMetaNormalizationRawValues HTTPAseHTTPProtocolGetResponseMetaNormalization = "RAW_VALUES" HTTPAseHTTPProtocolGetResponseMetaNormalizationPercentageChange HTTPAseHTTPProtocolGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseHTTPProtocolGetResponseMetaNormalizationRollingAverage HTTPAseHTTPProtocolGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseHTTPProtocolGetResponseMetaNormalizationOverlappedPercentage HTTPAseHTTPProtocolGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseHTTPProtocolGetResponseMetaNormalizationRatio HTTPAseHTTPProtocolGetResponseMetaNormalization = "RATIO" )
func (HTTPAseHTTPProtocolGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseHTTPProtocolGetResponseMetaNormalization) IsKnown() bool
type HTTPAseHTTPProtocolGetResponseMetaUnit ¶
type HTTPAseHTTPProtocolGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseHTTPProtocolGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseHTTPProtocolGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseHTTPProtocolGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseHTTPProtocolGetResponseTop0 ¶
type HTTPAseHTTPProtocolGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseHTTPProtocolService) Get(ctx context.Context, httpProtocol HTTPAseHTTPProtocolGetParamsHTTPProtocol, query HTTPAseHTTPProtocolGetParams, opts ...option.RequestOption) (res *HTTPAseHTTPProtocolGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP protocol.
type HTTPAseIPVersionGetParams ¶
type HTTPAseIPVersionGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseIPVersionGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseIPVersionGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseIPVersionGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseIPVersionGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseIPVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseIPVersionGetParamsHTTPVersion] `query:"httpVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPAseIPVersionGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPAseIPVersionGetParamsBotClass) IsKnown() bool
type HTTPAseIPVersionGetParamsBrowserFamily ¶
type HTTPAseIPVersionGetParamsBrowserFamily string
const ( HTTPAseIPVersionGetParamsBrowserFamilyChrome HTTPAseIPVersionGetParamsBrowserFamily = "CHROME" HTTPAseIPVersionGetParamsBrowserFamilyEdge HTTPAseIPVersionGetParamsBrowserFamily = "EDGE" HTTPAseIPVersionGetParamsBrowserFamilyFirefox HTTPAseIPVersionGetParamsBrowserFamily = "FIREFOX" HTTPAseIPVersionGetParamsBrowserFamilySafari HTTPAseIPVersionGetParamsBrowserFamily = "SAFARI" )
func (HTTPAseIPVersionGetParamsBrowserFamily) IsKnown ¶
func (r HTTPAseIPVersionGetParamsBrowserFamily) IsKnown() bool
type HTTPAseIPVersionGetParamsDeviceType ¶
type HTTPAseIPVersionGetParamsDeviceType string
const ( HTTPAseIPVersionGetParamsDeviceTypeDesktop HTTPAseIPVersionGetParamsDeviceType = "DESKTOP" HTTPAseIPVersionGetParamsDeviceTypeMobile HTTPAseIPVersionGetParamsDeviceType = "MOBILE" HTTPAseIPVersionGetParamsDeviceTypeOther HTTPAseIPVersionGetParamsDeviceType = "OTHER" )
func (HTTPAseIPVersionGetParamsDeviceType) IsKnown ¶
func (r HTTPAseIPVersionGetParamsDeviceType) IsKnown() bool
type HTTPAseIPVersionGetParamsFormat ¶
type HTTPAseIPVersionGetParamsFormat string
Format in which results will be returned.
const ( HTTPAseIPVersionGetParamsFormatJson HTTPAseIPVersionGetParamsFormat = "JSON" HTTPAseIPVersionGetParamsFormatCsv HTTPAseIPVersionGetParamsFormat = "CSV" )
func (HTTPAseIPVersionGetParamsFormat) IsKnown ¶
func (r HTTPAseIPVersionGetParamsFormat) IsKnown() bool
type HTTPAseIPVersionGetParamsHTTPProtocol ¶
type HTTPAseIPVersionGetParamsHTTPProtocol string
const ( HTTPAseIPVersionGetParamsHTTPProtocolHTTP HTTPAseIPVersionGetParamsHTTPProtocol = "HTTP" HTTPAseIPVersionGetParamsHTTPProtocolHTTPS HTTPAseIPVersionGetParamsHTTPProtocol = "HTTPS" )
func (HTTPAseIPVersionGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPAseIPVersionGetParamsHTTPProtocol) IsKnown() bool
type HTTPAseIPVersionGetParamsHTTPVersion ¶
type HTTPAseIPVersionGetParamsHTTPVersion string
const ( HTTPAseIPVersionGetParamsHTTPVersionHttPv1 HTTPAseIPVersionGetParamsHTTPVersion = "HTTPv1" HTTPAseIPVersionGetParamsHTTPVersionHttPv2 HTTPAseIPVersionGetParamsHTTPVersion = "HTTPv2" HTTPAseIPVersionGetParamsHTTPVersionHttPv3 HTTPAseIPVersionGetParamsHTTPVersion = "HTTPv3" )
func (HTTPAseIPVersionGetParamsHTTPVersion) IsKnown ¶
func (r HTTPAseIPVersionGetParamsHTTPVersion) IsKnown() bool
type HTTPAseIPVersionGetParamsIPVersion ¶
type HTTPAseIPVersionGetParamsIPVersion string
IP version.
const ( HTTPAseIPVersionGetParamsIPVersionIPv4 HTTPAseIPVersionGetParamsIPVersion = "IPv4" HTTPAseIPVersionGetParamsIPVersionIPv6 HTTPAseIPVersionGetParamsIPVersion = "IPv6" )
func (HTTPAseIPVersionGetParamsIPVersion) IsKnown ¶
func (r HTTPAseIPVersionGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPAseIPVersionGetParamsTLSVersion) IsKnown() bool
type HTTPAseIPVersionGetResponse ¶
type HTTPAseIPVersionGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseIPVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseIPVersionGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseIPVersionGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseIPVersionGetResponseMetaUnit `json:"units,required"`
JSON httpAseIPVersionGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseIPVersionGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseIPVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseIPVersionGetResponseMetaConfidenceInfo ¶
type HTTPAseIPVersionGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseIPVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPAseIPVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPAseIPVersionGetResponseMetaNormalization ¶
type HTTPAseIPVersionGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseIPVersionGetResponseMetaNormalizationPercentage HTTPAseIPVersionGetResponseMetaNormalization = "PERCENTAGE" HTTPAseIPVersionGetResponseMetaNormalizationMin0Max HTTPAseIPVersionGetResponseMetaNormalization = "MIN0_MAX" HTTPAseIPVersionGetResponseMetaNormalizationMinMax HTTPAseIPVersionGetResponseMetaNormalization = "MIN_MAX" HTTPAseIPVersionGetResponseMetaNormalizationRawValues HTTPAseIPVersionGetResponseMetaNormalization = "RAW_VALUES" HTTPAseIPVersionGetResponseMetaNormalizationPercentageChange HTTPAseIPVersionGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseIPVersionGetResponseMetaNormalizationRollingAverage HTTPAseIPVersionGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseIPVersionGetResponseMetaNormalizationOverlappedPercentage HTTPAseIPVersionGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseIPVersionGetResponseMetaNormalizationRatio HTTPAseIPVersionGetResponseMetaNormalization = "RATIO" )
func (HTTPAseIPVersionGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseIPVersionGetResponseMetaNormalization) IsKnown() bool
type HTTPAseIPVersionGetResponseMetaUnit ¶
type HTTPAseIPVersionGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseIPVersionGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseIPVersionGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseIPVersionGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseIPVersionGetResponseTop0 ¶
type HTTPAseIPVersionGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseIPVersionService) Get(ctx context.Context, ipVersion HTTPAseIPVersionGetParamsIPVersion, query HTTPAseIPVersionGetParams, opts ...option.RequestOption) (res *HTTPAseIPVersionGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested IP version.
type HTTPAseOSGetParams ¶
type HTTPAseOSGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseOSGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseOSGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseOSGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseOSGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseOSGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseOSGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseOSGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by 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 ¶
func (r HTTPAseOSGetParamsBrowserFamily) IsKnown() bool
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 in which results will be returned.
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 ¶
func (r HTTPAseOSGetParamsHTTPProtocol) IsKnown() bool
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 {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseOSGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseOSGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseOSGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseOSGetResponseMetaUnit `json:"units,required"`
JSON httpAseOSGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseOSGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseOSGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseOSGetResponseMetaConfidenceInfo ¶
type HTTPAseOSGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseOSGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseOSGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPAseOSGetResponseMetaNormalization ¶
type HTTPAseOSGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseOSGetResponseMetaNormalizationPercentage HTTPAseOSGetResponseMetaNormalization = "PERCENTAGE" HTTPAseOSGetResponseMetaNormalizationMin0Max HTTPAseOSGetResponseMetaNormalization = "MIN0_MAX" HTTPAseOSGetResponseMetaNormalizationMinMax HTTPAseOSGetResponseMetaNormalization = "MIN_MAX" HTTPAseOSGetResponseMetaNormalizationRawValues HTTPAseOSGetResponseMetaNormalization = "RAW_VALUES" HTTPAseOSGetResponseMetaNormalizationPercentageChange HTTPAseOSGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseOSGetResponseMetaNormalizationRollingAverage HTTPAseOSGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseOSGetResponseMetaNormalizationOverlappedPercentage HTTPAseOSGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseOSGetResponseMetaNormalizationRatio HTTPAseOSGetResponseMetaNormalization = "RATIO" )
func (HTTPAseOSGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseOSGetResponseMetaNormalization) IsKnown() bool
type HTTPAseOSGetResponseMetaUnit ¶
type HTTPAseOSGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseOSGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseOSGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseOSGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseOSGetResponseTop0 ¶
type HTTPAseOSGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseOSService) Get(ctx context.Context, os HTTPAseOSGetParamsOS, query HTTPAseOSGetParams, opts ...option.RequestOption) (res *HTTPAseOSGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested operating system.
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 ¶
func (r *HTTPAseService) Get(ctx context.Context, query HTTPAseGetParams, opts ...option.RequestOption) (res *HTTPAseGetResponse, err error)
Retrieves the top autonomous systems by HTTP requests.
type HTTPAseTLSVersionGetParams ¶
type HTTPAseTLSVersionGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPAseTLSVersionGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPAseTLSVersionGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPAseTLSVersionGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPAseTLSVersionGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPAseTLSVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPAseTLSVersionGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPAseTLSVersionGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
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 ¶
func (r HTTPAseTLSVersionGetParamsBotClass) IsKnown() bool
type HTTPAseTLSVersionGetParamsBrowserFamily ¶
type HTTPAseTLSVersionGetParamsBrowserFamily string
const ( HTTPAseTLSVersionGetParamsBrowserFamilyChrome HTTPAseTLSVersionGetParamsBrowserFamily = "CHROME" HTTPAseTLSVersionGetParamsBrowserFamilyEdge HTTPAseTLSVersionGetParamsBrowserFamily = "EDGE" HTTPAseTLSVersionGetParamsBrowserFamilyFirefox HTTPAseTLSVersionGetParamsBrowserFamily = "FIREFOX" HTTPAseTLSVersionGetParamsBrowserFamilySafari HTTPAseTLSVersionGetParamsBrowserFamily = "SAFARI" )
func (HTTPAseTLSVersionGetParamsBrowserFamily) IsKnown ¶
func (r HTTPAseTLSVersionGetParamsBrowserFamily) IsKnown() bool
type HTTPAseTLSVersionGetParamsDeviceType ¶
type HTTPAseTLSVersionGetParamsDeviceType string
const ( HTTPAseTLSVersionGetParamsDeviceTypeDesktop HTTPAseTLSVersionGetParamsDeviceType = "DESKTOP" HTTPAseTLSVersionGetParamsDeviceTypeMobile HTTPAseTLSVersionGetParamsDeviceType = "MOBILE" HTTPAseTLSVersionGetParamsDeviceTypeOther HTTPAseTLSVersionGetParamsDeviceType = "OTHER" )
func (HTTPAseTLSVersionGetParamsDeviceType) IsKnown ¶
func (r HTTPAseTLSVersionGetParamsDeviceType) IsKnown() bool
type HTTPAseTLSVersionGetParamsFormat ¶
type HTTPAseTLSVersionGetParamsFormat string
Format in which results will be returned.
const ( HTTPAseTLSVersionGetParamsFormatJson HTTPAseTLSVersionGetParamsFormat = "JSON" HTTPAseTLSVersionGetParamsFormatCsv HTTPAseTLSVersionGetParamsFormat = "CSV" )
func (HTTPAseTLSVersionGetParamsFormat) IsKnown ¶
func (r HTTPAseTLSVersionGetParamsFormat) IsKnown() bool
type HTTPAseTLSVersionGetParamsHTTPProtocol ¶
type HTTPAseTLSVersionGetParamsHTTPProtocol string
const ( HTTPAseTLSVersionGetParamsHTTPProtocolHTTP HTTPAseTLSVersionGetParamsHTTPProtocol = "HTTP" HTTPAseTLSVersionGetParamsHTTPProtocolHTTPS HTTPAseTLSVersionGetParamsHTTPProtocol = "HTTPS" )
func (HTTPAseTLSVersionGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPAseTLSVersionGetParamsHTTPProtocol) IsKnown() bool
type HTTPAseTLSVersionGetParamsHTTPVersion ¶
type HTTPAseTLSVersionGetParamsHTTPVersion string
const ( HTTPAseTLSVersionGetParamsHTTPVersionHttPv1 HTTPAseTLSVersionGetParamsHTTPVersion = "HTTPv1" HTTPAseTLSVersionGetParamsHTTPVersionHttPv2 HTTPAseTLSVersionGetParamsHTTPVersion = "HTTPv2" HTTPAseTLSVersionGetParamsHTTPVersionHttPv3 HTTPAseTLSVersionGetParamsHTTPVersion = "HTTPv3" )
func (HTTPAseTLSVersionGetParamsHTTPVersion) IsKnown ¶
func (r HTTPAseTLSVersionGetParamsHTTPVersion) IsKnown() bool
type HTTPAseTLSVersionGetParamsIPVersion ¶
type HTTPAseTLSVersionGetParamsIPVersion string
const ( HTTPAseTLSVersionGetParamsIPVersionIPv4 HTTPAseTLSVersionGetParamsIPVersion = "IPv4" HTTPAseTLSVersionGetParamsIPVersionIPv6 HTTPAseTLSVersionGetParamsIPVersion = "IPv6" )
func (HTTPAseTLSVersionGetParamsIPVersion) IsKnown ¶
func (r HTTPAseTLSVersionGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPAseTLSVersionGetParamsTLSVersion) IsKnown() bool
type HTTPAseTLSVersionGetResponse ¶
type HTTPAseTLSVersionGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPAseTLSVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPAseTLSVersionGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPAseTLSVersionGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPAseTLSVersionGetResponseMetaUnit `json:"units,required"`
JSON httpAseTLSVersionGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPAseTLSVersionGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPAseTLSVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPAseTLSVersionGetResponseMetaConfidenceInfo ¶
type HTTPAseTLSVersionGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpAseTLSVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPAseTLSVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPAseTLSVersionGetResponseMetaNormalization ¶
type HTTPAseTLSVersionGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPAseTLSVersionGetResponseMetaNormalizationPercentage HTTPAseTLSVersionGetResponseMetaNormalization = "PERCENTAGE" HTTPAseTLSVersionGetResponseMetaNormalizationMin0Max HTTPAseTLSVersionGetResponseMetaNormalization = "MIN0_MAX" HTTPAseTLSVersionGetResponseMetaNormalizationMinMax HTTPAseTLSVersionGetResponseMetaNormalization = "MIN_MAX" HTTPAseTLSVersionGetResponseMetaNormalizationRawValues HTTPAseTLSVersionGetResponseMetaNormalization = "RAW_VALUES" HTTPAseTLSVersionGetResponseMetaNormalizationPercentageChange HTTPAseTLSVersionGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPAseTLSVersionGetResponseMetaNormalizationRollingAverage HTTPAseTLSVersionGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPAseTLSVersionGetResponseMetaNormalizationOverlappedPercentage HTTPAseTLSVersionGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPAseTLSVersionGetResponseMetaNormalizationRatio HTTPAseTLSVersionGetResponseMetaNormalization = "RATIO" )
func (HTTPAseTLSVersionGetResponseMetaNormalization) IsKnown ¶
func (r HTTPAseTLSVersionGetResponseMetaNormalization) IsKnown() bool
type HTTPAseTLSVersionGetResponseMetaUnit ¶
type HTTPAseTLSVersionGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpAseTLSVersionGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPAseTLSVersionGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPAseTLSVersionGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPAseTLSVersionGetResponseTop0 ¶
type HTTPAseTLSVersionGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
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 ¶
func (r *HTTPAseTLSVersionService) Get(ctx context.Context, tlsVersion HTTPAseTLSVersionGetParamsTLSVersion, query HTTPAseTLSVersionGetParams, opts ...option.RequestOption) (res *HTTPAseTLSVersionGetResponse, err error)
Retrieves the top autonomous systems, by HTTP requests, of the requested TLS protocol version.
type HTTPLocationBotClassGetParams ¶
type HTTPLocationBotClassGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationBotClassGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationBotClassGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationBotClassGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationBotClassGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationBotClassGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationBotClassGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPLocationBotClassGetParamsOS] `query:"os"`
// Filters results by 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. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
const ( HTTPLocationBotClassGetParamsBotClassLikelyAutomated HTTPLocationBotClassGetParamsBotClass = "LIKELY_AUTOMATED" HTTPLocationBotClassGetParamsBotClassLikelyHuman HTTPLocationBotClassGetParamsBotClass = "LIKELY_HUMAN" )
func (HTTPLocationBotClassGetParamsBotClass) IsKnown ¶
func (r HTTPLocationBotClassGetParamsBotClass) IsKnown() bool
type HTTPLocationBotClassGetParamsBrowserFamily ¶
type HTTPLocationBotClassGetParamsBrowserFamily string
const ( HTTPLocationBotClassGetParamsBrowserFamilyChrome HTTPLocationBotClassGetParamsBrowserFamily = "CHROME" HTTPLocationBotClassGetParamsBrowserFamilyEdge HTTPLocationBotClassGetParamsBrowserFamily = "EDGE" HTTPLocationBotClassGetParamsBrowserFamilyFirefox HTTPLocationBotClassGetParamsBrowserFamily = "FIREFOX" HTTPLocationBotClassGetParamsBrowserFamilySafari HTTPLocationBotClassGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationBotClassGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationBotClassGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationBotClassGetParamsDeviceType ¶
type HTTPLocationBotClassGetParamsDeviceType string
const ( HTTPLocationBotClassGetParamsDeviceTypeDesktop HTTPLocationBotClassGetParamsDeviceType = "DESKTOP" HTTPLocationBotClassGetParamsDeviceTypeMobile HTTPLocationBotClassGetParamsDeviceType = "MOBILE" HTTPLocationBotClassGetParamsDeviceTypeOther HTTPLocationBotClassGetParamsDeviceType = "OTHER" )
func (HTTPLocationBotClassGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationBotClassGetParamsDeviceType) IsKnown() bool
type HTTPLocationBotClassGetParamsFormat ¶
type HTTPLocationBotClassGetParamsFormat string
Format in which results will be returned.
const ( HTTPLocationBotClassGetParamsFormatJson HTTPLocationBotClassGetParamsFormat = "JSON" HTTPLocationBotClassGetParamsFormatCsv HTTPLocationBotClassGetParamsFormat = "CSV" )
func (HTTPLocationBotClassGetParamsFormat) IsKnown ¶
func (r HTTPLocationBotClassGetParamsFormat) IsKnown() bool
type HTTPLocationBotClassGetParamsHTTPProtocol ¶
type HTTPLocationBotClassGetParamsHTTPProtocol string
const ( HTTPLocationBotClassGetParamsHTTPProtocolHTTP HTTPLocationBotClassGetParamsHTTPProtocol = "HTTP" HTTPLocationBotClassGetParamsHTTPProtocolHTTPS HTTPLocationBotClassGetParamsHTTPProtocol = "HTTPS" )
func (HTTPLocationBotClassGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPLocationBotClassGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationBotClassGetParamsHTTPVersion ¶
type HTTPLocationBotClassGetParamsHTTPVersion string
const ( HTTPLocationBotClassGetParamsHTTPVersionHttPv1 HTTPLocationBotClassGetParamsHTTPVersion = "HTTPv1" HTTPLocationBotClassGetParamsHTTPVersionHttPv2 HTTPLocationBotClassGetParamsHTTPVersion = "HTTPv2" HTTPLocationBotClassGetParamsHTTPVersionHttPv3 HTTPLocationBotClassGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationBotClassGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationBotClassGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationBotClassGetParamsIPVersion ¶
type HTTPLocationBotClassGetParamsIPVersion string
const ( HTTPLocationBotClassGetParamsIPVersionIPv4 HTTPLocationBotClassGetParamsIPVersion = "IPv4" HTTPLocationBotClassGetParamsIPVersionIPv6 HTTPLocationBotClassGetParamsIPVersion = "IPv6" )
func (HTTPLocationBotClassGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationBotClassGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationBotClassGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPLocationBotClassGetParamsTLSVersion) IsKnown() bool
type HTTPLocationBotClassGetResponse ¶
type HTTPLocationBotClassGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationBotClassGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationBotClassGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationBotClassGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationBotClassGetResponseMetaUnit `json:"units,required"`
JSON httpLocationBotClassGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationBotClassGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationBotClassGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationBotClassGetResponseMetaConfidenceInfo ¶
type HTTPLocationBotClassGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationBotClassGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPLocationBotClassGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPLocationBotClassGetResponseMetaNormalization ¶
type HTTPLocationBotClassGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationBotClassGetResponseMetaNormalizationPercentage HTTPLocationBotClassGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationBotClassGetResponseMetaNormalizationMin0Max HTTPLocationBotClassGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationBotClassGetResponseMetaNormalizationMinMax HTTPLocationBotClassGetResponseMetaNormalization = "MIN_MAX" HTTPLocationBotClassGetResponseMetaNormalizationRawValues HTTPLocationBotClassGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationBotClassGetResponseMetaNormalizationPercentageChange HTTPLocationBotClassGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationBotClassGetResponseMetaNormalizationRollingAverage HTTPLocationBotClassGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationBotClassGetResponseMetaNormalizationOverlappedPercentage HTTPLocationBotClassGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationBotClassGetResponseMetaNormalizationRatio HTTPLocationBotClassGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationBotClassGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationBotClassGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationBotClassGetResponseMetaUnit ¶
type HTTPLocationBotClassGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationBotClassGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationBotClassGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationBotClassGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationBotClassGetResponseTop0 ¶
type HTTPLocationBotClassGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationBotClassService) Get(ctx context.Context, botClass HTTPLocationBotClassGetParamsBotClass, query HTTPLocationBotClassGetParams, opts ...option.RequestOption) (res *HTTPLocationBotClassGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested bot class.
type HTTPLocationBrowserFamilyGetParams ¶
type HTTPLocationBrowserFamilyGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationBrowserFamilyGetParamsBotClass] `query:"botClass"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationBrowserFamilyGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationBrowserFamilyGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationBrowserFamilyGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationBrowserFamilyGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationBrowserFamilyGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPLocationBrowserFamilyGetParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPLocationBrowserFamilyGetParamsTLSVersion] `query:"tlsVersion"`
}
func (HTTPLocationBrowserFamilyGetParams) URLQuery ¶
func (r HTTPLocationBrowserFamilyGetParams) URLQuery() (v url.Values)
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 ¶
func (r HTTPLocationBrowserFamilyGetParamsBotClass) IsKnown() bool
type HTTPLocationBrowserFamilyGetParamsBrowserFamily ¶
type HTTPLocationBrowserFamilyGetParamsBrowserFamily string
Browser family.
const ( HTTPLocationBrowserFamilyGetParamsBrowserFamilyChrome HTTPLocationBrowserFamilyGetParamsBrowserFamily = "CHROME" HTTPLocationBrowserFamilyGetParamsBrowserFamilyEdge HTTPLocationBrowserFamilyGetParamsBrowserFamily = "EDGE" HTTPLocationBrowserFamilyGetParamsBrowserFamilyFirefox HTTPLocationBrowserFamilyGetParamsBrowserFamily = "FIREFOX" HTTPLocationBrowserFamilyGetParamsBrowserFamilySafari HTTPLocationBrowserFamilyGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationBrowserFamilyGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationBrowserFamilyGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationBrowserFamilyGetParamsDeviceType ¶
type HTTPLocationBrowserFamilyGetParamsDeviceType string
const ( HTTPLocationBrowserFamilyGetParamsDeviceTypeDesktop HTTPLocationBrowserFamilyGetParamsDeviceType = "DESKTOP" HTTPLocationBrowserFamilyGetParamsDeviceTypeMobile HTTPLocationBrowserFamilyGetParamsDeviceType = "MOBILE" HTTPLocationBrowserFamilyGetParamsDeviceTypeOther HTTPLocationBrowserFamilyGetParamsDeviceType = "OTHER" )
func (HTTPLocationBrowserFamilyGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationBrowserFamilyGetParamsDeviceType) IsKnown() bool
type HTTPLocationBrowserFamilyGetParamsFormat ¶
type HTTPLocationBrowserFamilyGetParamsFormat string
Format in which results will be returned.
const ( HTTPLocationBrowserFamilyGetParamsFormatJson HTTPLocationBrowserFamilyGetParamsFormat = "JSON" HTTPLocationBrowserFamilyGetParamsFormatCsv HTTPLocationBrowserFamilyGetParamsFormat = "CSV" )
func (HTTPLocationBrowserFamilyGetParamsFormat) IsKnown ¶
func (r HTTPLocationBrowserFamilyGetParamsFormat) IsKnown() bool
type HTTPLocationBrowserFamilyGetParamsHTTPProtocol ¶
type HTTPLocationBrowserFamilyGetParamsHTTPProtocol string
const ( HTTPLocationBrowserFamilyGetParamsHTTPProtocolHTTP HTTPLocationBrowserFamilyGetParamsHTTPProtocol = "HTTP" HTTPLocationBrowserFamilyGetParamsHTTPProtocolHTTPS HTTPLocationBrowserFamilyGetParamsHTTPProtocol = "HTTPS" )
func (HTTPLocationBrowserFamilyGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPLocationBrowserFamilyGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationBrowserFamilyGetParamsHTTPVersion ¶
type HTTPLocationBrowserFamilyGetParamsHTTPVersion string
const ( HTTPLocationBrowserFamilyGetParamsHTTPVersionHttPv1 HTTPLocationBrowserFamilyGetParamsHTTPVersion = "HTTPv1" HTTPLocationBrowserFamilyGetParamsHTTPVersionHttPv2 HTTPLocationBrowserFamilyGetParamsHTTPVersion = "HTTPv2" HTTPLocationBrowserFamilyGetParamsHTTPVersionHttPv3 HTTPLocationBrowserFamilyGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationBrowserFamilyGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationBrowserFamilyGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationBrowserFamilyGetParamsIPVersion ¶
type HTTPLocationBrowserFamilyGetParamsIPVersion string
const ( HTTPLocationBrowserFamilyGetParamsIPVersionIPv4 HTTPLocationBrowserFamilyGetParamsIPVersion = "IPv4" HTTPLocationBrowserFamilyGetParamsIPVersionIPv6 HTTPLocationBrowserFamilyGetParamsIPVersion = "IPv6" )
func (HTTPLocationBrowserFamilyGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationBrowserFamilyGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationBrowserFamilyGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPLocationBrowserFamilyGetParamsTLSVersion) IsKnown() bool
type HTTPLocationBrowserFamilyGetResponse ¶
type HTTPLocationBrowserFamilyGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationBrowserFamilyGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationBrowserFamilyGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationBrowserFamilyGetResponseMetaUnit `json:"units,required"`
JSON httpLocationBrowserFamilyGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationBrowserFamilyGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationBrowserFamilyGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo ¶
type HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPLocationBrowserFamilyGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPLocationBrowserFamilyGetResponseMetaNormalization ¶
type HTTPLocationBrowserFamilyGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationBrowserFamilyGetResponseMetaNormalizationPercentage HTTPLocationBrowserFamilyGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationBrowserFamilyGetResponseMetaNormalizationMin0Max HTTPLocationBrowserFamilyGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationBrowserFamilyGetResponseMetaNormalizationMinMax HTTPLocationBrowserFamilyGetResponseMetaNormalization = "MIN_MAX" HTTPLocationBrowserFamilyGetResponseMetaNormalizationRawValues HTTPLocationBrowserFamilyGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationBrowserFamilyGetResponseMetaNormalizationPercentageChange HTTPLocationBrowserFamilyGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationBrowserFamilyGetResponseMetaNormalizationRollingAverage HTTPLocationBrowserFamilyGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationBrowserFamilyGetResponseMetaNormalizationOverlappedPercentage HTTPLocationBrowserFamilyGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationBrowserFamilyGetResponseMetaNormalizationRatio HTTPLocationBrowserFamilyGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationBrowserFamilyGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationBrowserFamilyGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationBrowserFamilyGetResponseMetaUnit ¶
type HTTPLocationBrowserFamilyGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationBrowserFamilyGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationBrowserFamilyGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationBrowserFamilyGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationBrowserFamilyGetResponseTop0 ¶
type HTTPLocationBrowserFamilyGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationBrowserFamilyService) Get(ctx context.Context, browserFamily HTTPLocationBrowserFamilyGetParamsBrowserFamily, query HTTPLocationBrowserFamilyGetParams, opts ...option.RequestOption) (res *HTTPLocationBrowserFamilyGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested browser family.
type HTTPLocationDeviceTypeGetParams ¶
type HTTPLocationDeviceTypeGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationDeviceTypeGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationDeviceTypeGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[HTTPLocationDeviceTypeGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationDeviceTypeGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationDeviceTypeGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationDeviceTypeGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPLocationDeviceTypeGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPLocationDeviceTypeGetParamsBotClass) IsKnown() bool
type HTTPLocationDeviceTypeGetParamsBrowserFamily ¶
type HTTPLocationDeviceTypeGetParamsBrowserFamily string
const ( HTTPLocationDeviceTypeGetParamsBrowserFamilyChrome HTTPLocationDeviceTypeGetParamsBrowserFamily = "CHROME" HTTPLocationDeviceTypeGetParamsBrowserFamilyEdge HTTPLocationDeviceTypeGetParamsBrowserFamily = "EDGE" HTTPLocationDeviceTypeGetParamsBrowserFamilyFirefox HTTPLocationDeviceTypeGetParamsBrowserFamily = "FIREFOX" HTTPLocationDeviceTypeGetParamsBrowserFamilySafari HTTPLocationDeviceTypeGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationDeviceTypeGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationDeviceTypeGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationDeviceTypeGetParamsDeviceType ¶
type HTTPLocationDeviceTypeGetParamsDeviceType string
Device type.
const ( HTTPLocationDeviceTypeGetParamsDeviceTypeDesktop HTTPLocationDeviceTypeGetParamsDeviceType = "DESKTOP" HTTPLocationDeviceTypeGetParamsDeviceTypeMobile HTTPLocationDeviceTypeGetParamsDeviceType = "MOBILE" HTTPLocationDeviceTypeGetParamsDeviceTypeOther HTTPLocationDeviceTypeGetParamsDeviceType = "OTHER" )
func (HTTPLocationDeviceTypeGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationDeviceTypeGetParamsDeviceType) IsKnown() bool
type HTTPLocationDeviceTypeGetParamsFormat ¶
type HTTPLocationDeviceTypeGetParamsFormat string
Format in which results will be returned.
const ( HTTPLocationDeviceTypeGetParamsFormatJson HTTPLocationDeviceTypeGetParamsFormat = "JSON" HTTPLocationDeviceTypeGetParamsFormatCsv HTTPLocationDeviceTypeGetParamsFormat = "CSV" )
func (HTTPLocationDeviceTypeGetParamsFormat) IsKnown ¶
func (r HTTPLocationDeviceTypeGetParamsFormat) IsKnown() bool
type HTTPLocationDeviceTypeGetParamsHTTPProtocol ¶
type HTTPLocationDeviceTypeGetParamsHTTPProtocol string
const ( HTTPLocationDeviceTypeGetParamsHTTPProtocolHTTP HTTPLocationDeviceTypeGetParamsHTTPProtocol = "HTTP" HTTPLocationDeviceTypeGetParamsHTTPProtocolHTTPS HTTPLocationDeviceTypeGetParamsHTTPProtocol = "HTTPS" )
func (HTTPLocationDeviceTypeGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPLocationDeviceTypeGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationDeviceTypeGetParamsHTTPVersion ¶
type HTTPLocationDeviceTypeGetParamsHTTPVersion string
const ( HTTPLocationDeviceTypeGetParamsHTTPVersionHttPv1 HTTPLocationDeviceTypeGetParamsHTTPVersion = "HTTPv1" HTTPLocationDeviceTypeGetParamsHTTPVersionHttPv2 HTTPLocationDeviceTypeGetParamsHTTPVersion = "HTTPv2" HTTPLocationDeviceTypeGetParamsHTTPVersionHttPv3 HTTPLocationDeviceTypeGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationDeviceTypeGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationDeviceTypeGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationDeviceTypeGetParamsIPVersion ¶
type HTTPLocationDeviceTypeGetParamsIPVersion string
const ( HTTPLocationDeviceTypeGetParamsIPVersionIPv4 HTTPLocationDeviceTypeGetParamsIPVersion = "IPv4" HTTPLocationDeviceTypeGetParamsIPVersionIPv6 HTTPLocationDeviceTypeGetParamsIPVersion = "IPv6" )
func (HTTPLocationDeviceTypeGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationDeviceTypeGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationDeviceTypeGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPLocationDeviceTypeGetParamsTLSVersion) IsKnown() bool
type HTTPLocationDeviceTypeGetResponse ¶
type HTTPLocationDeviceTypeGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationDeviceTypeGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationDeviceTypeGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationDeviceTypeGetResponseMetaUnit `json:"units,required"`
JSON httpLocationDeviceTypeGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationDeviceTypeGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationDeviceTypeGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo ¶
type HTTPLocationDeviceTypeGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPLocationDeviceTypeGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPLocationDeviceTypeGetResponseMetaNormalization ¶
type HTTPLocationDeviceTypeGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationDeviceTypeGetResponseMetaNormalizationPercentage HTTPLocationDeviceTypeGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationDeviceTypeGetResponseMetaNormalizationMin0Max HTTPLocationDeviceTypeGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationDeviceTypeGetResponseMetaNormalizationMinMax HTTPLocationDeviceTypeGetResponseMetaNormalization = "MIN_MAX" HTTPLocationDeviceTypeGetResponseMetaNormalizationRawValues HTTPLocationDeviceTypeGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationDeviceTypeGetResponseMetaNormalizationPercentageChange HTTPLocationDeviceTypeGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationDeviceTypeGetResponseMetaNormalizationRollingAverage HTTPLocationDeviceTypeGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationDeviceTypeGetResponseMetaNormalizationOverlappedPercentage HTTPLocationDeviceTypeGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationDeviceTypeGetResponseMetaNormalizationRatio HTTPLocationDeviceTypeGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationDeviceTypeGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationDeviceTypeGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationDeviceTypeGetResponseMetaUnit ¶
type HTTPLocationDeviceTypeGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationDeviceTypeGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationDeviceTypeGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationDeviceTypeGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationDeviceTypeGetResponseTop0 ¶
type HTTPLocationDeviceTypeGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationDeviceTypeService) Get(ctx context.Context, deviceType HTTPLocationDeviceTypeGetParamsDeviceType, query HTTPLocationDeviceTypeGetParams, opts ...option.RequestOption) (res *HTTPLocationDeviceTypeGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested device type.
type HTTPLocationGetParams ¶
type HTTPLocationGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPLocationGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPLocationGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationGetParamsDeviceType ¶
type HTTPLocationGetParamsDeviceType string
const ( HTTPLocationGetParamsDeviceTypeDesktop HTTPLocationGetParamsDeviceType = "DESKTOP" HTTPLocationGetParamsDeviceTypeMobile HTTPLocationGetParamsDeviceType = "MOBILE" HTTPLocationGetParamsDeviceTypeOther HTTPLocationGetParamsDeviceType = "OTHER" )
func (HTTPLocationGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationGetParamsDeviceType) IsKnown() bool
type HTTPLocationGetParamsFormat ¶
type HTTPLocationGetParamsFormat string
Format in which results will be returned.
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 ¶
func (r HTTPLocationGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationGetParamsHTTPVersion ¶
type HTTPLocationGetParamsHTTPVersion string
const ( HTTPLocationGetParamsHTTPVersionHttPv1 HTTPLocationGetParamsHTTPVersion = "HTTPv1" HTTPLocationGetParamsHTTPVersionHttPv2 HTTPLocationGetParamsHTTPVersion = "HTTPv2" HTTPLocationGetParamsHTTPVersionHttPv3 HTTPLocationGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationGetParamsIPVersion ¶
type HTTPLocationGetParamsIPVersion string
const ( HTTPLocationGetParamsIPVersionIPv4 HTTPLocationGetParamsIPVersion = "IPv4" HTTPLocationGetParamsIPVersionIPv6 HTTPLocationGetParamsIPVersion = "IPv6" )
func (HTTPLocationGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationGetParamsTLSVersion) IsKnown() bool
type HTTPLocationGetResponse ¶
type HTTPLocationGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationGetResponseMetaUnit `json:"units,required"`
JSON httpLocationGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationGetResponseMetaConfidenceInfo ¶
type HTTPLocationGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPLocationGetResponseMetaNormalization ¶
type HTTPLocationGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationGetResponseMetaNormalizationPercentage HTTPLocationGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationGetResponseMetaNormalizationMin0Max HTTPLocationGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationGetResponseMetaNormalizationMinMax HTTPLocationGetResponseMetaNormalization = "MIN_MAX" HTTPLocationGetResponseMetaNormalizationRawValues HTTPLocationGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationGetResponseMetaNormalizationPercentageChange HTTPLocationGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationGetResponseMetaNormalizationRollingAverage HTTPLocationGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationGetResponseMetaNormalizationOverlappedPercentage HTTPLocationGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationGetResponseMetaNormalizationRatio HTTPLocationGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationGetResponseMetaUnit ¶
type HTTPLocationGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationGetResponseTop0 ¶
type HTTPLocationGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
Value string `json:"value,required"`
JSON httpLocationGetResponseTop0JSON `json:"-"`
}
func (*HTTPLocationGetResponseTop0) UnmarshalJSON ¶
func (r *HTTPLocationGetResponseTop0) UnmarshalJSON(data []byte) (err error)
type HTTPLocationHTTPMethodGetParams ¶
type HTTPLocationHTTPMethodGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationHTTPMethodGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationHTTPMethodGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationHTTPMethodGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationHTTPMethodGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationHTTPMethodGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationHTTPMethodGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPLocationHTTPMethodGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPLocationHTTPMethodGetParamsBotClass) IsKnown() bool
type HTTPLocationHTTPMethodGetParamsBrowserFamily ¶
type HTTPLocationHTTPMethodGetParamsBrowserFamily string
const ( HTTPLocationHTTPMethodGetParamsBrowserFamilyChrome HTTPLocationHTTPMethodGetParamsBrowserFamily = "CHROME" HTTPLocationHTTPMethodGetParamsBrowserFamilyEdge HTTPLocationHTTPMethodGetParamsBrowserFamily = "EDGE" HTTPLocationHTTPMethodGetParamsBrowserFamilyFirefox HTTPLocationHTTPMethodGetParamsBrowserFamily = "FIREFOX" HTTPLocationHTTPMethodGetParamsBrowserFamilySafari HTTPLocationHTTPMethodGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationHTTPMethodGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationHTTPMethodGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationHTTPMethodGetParamsDeviceType ¶
type HTTPLocationHTTPMethodGetParamsDeviceType string
const ( HTTPLocationHTTPMethodGetParamsDeviceTypeDesktop HTTPLocationHTTPMethodGetParamsDeviceType = "DESKTOP" HTTPLocationHTTPMethodGetParamsDeviceTypeMobile HTTPLocationHTTPMethodGetParamsDeviceType = "MOBILE" HTTPLocationHTTPMethodGetParamsDeviceTypeOther HTTPLocationHTTPMethodGetParamsDeviceType = "OTHER" )
func (HTTPLocationHTTPMethodGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationHTTPMethodGetParamsDeviceType) IsKnown() bool
type HTTPLocationHTTPMethodGetParamsFormat ¶
type HTTPLocationHTTPMethodGetParamsFormat string
Format in which results will be returned.
const ( HTTPLocationHTTPMethodGetParamsFormatJson HTTPLocationHTTPMethodGetParamsFormat = "JSON" HTTPLocationHTTPMethodGetParamsFormatCsv HTTPLocationHTTPMethodGetParamsFormat = "CSV" )
func (HTTPLocationHTTPMethodGetParamsFormat) IsKnown ¶
func (r HTTPLocationHTTPMethodGetParamsFormat) IsKnown() bool
type HTTPLocationHTTPMethodGetParamsHTTPProtocol ¶
type HTTPLocationHTTPMethodGetParamsHTTPProtocol string
const ( HTTPLocationHTTPMethodGetParamsHTTPProtocolHTTP HTTPLocationHTTPMethodGetParamsHTTPProtocol = "HTTP" HTTPLocationHTTPMethodGetParamsHTTPProtocolHTTPS HTTPLocationHTTPMethodGetParamsHTTPProtocol = "HTTPS" )
func (HTTPLocationHTTPMethodGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPLocationHTTPMethodGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationHTTPMethodGetParamsHTTPVersion ¶
type HTTPLocationHTTPMethodGetParamsHTTPVersion string
HTTP version.
const ( HTTPLocationHTTPMethodGetParamsHTTPVersionHttPv1 HTTPLocationHTTPMethodGetParamsHTTPVersion = "HTTPv1" HTTPLocationHTTPMethodGetParamsHTTPVersionHttPv2 HTTPLocationHTTPMethodGetParamsHTTPVersion = "HTTPv2" HTTPLocationHTTPMethodGetParamsHTTPVersionHttPv3 HTTPLocationHTTPMethodGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationHTTPMethodGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationHTTPMethodGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationHTTPMethodGetParamsIPVersion ¶
type HTTPLocationHTTPMethodGetParamsIPVersion string
const ( HTTPLocationHTTPMethodGetParamsIPVersionIPv4 HTTPLocationHTTPMethodGetParamsIPVersion = "IPv4" HTTPLocationHTTPMethodGetParamsIPVersionIPv6 HTTPLocationHTTPMethodGetParamsIPVersion = "IPv6" )
func (HTTPLocationHTTPMethodGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationHTTPMethodGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationHTTPMethodGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPLocationHTTPMethodGetParamsTLSVersion) IsKnown() bool
type HTTPLocationHTTPMethodGetResponse ¶
type HTTPLocationHTTPMethodGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationHTTPMethodGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationHTTPMethodGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationHTTPMethodGetResponseMetaUnit `json:"units,required"`
JSON httpLocationHTTPMethodGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationHTTPMethodGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationHTTPMethodGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo ¶
type HTTPLocationHTTPMethodGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPLocationHTTPMethodGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPLocationHTTPMethodGetResponseMetaNormalization ¶
type HTTPLocationHTTPMethodGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationHTTPMethodGetResponseMetaNormalizationPercentage HTTPLocationHTTPMethodGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationHTTPMethodGetResponseMetaNormalizationMin0Max HTTPLocationHTTPMethodGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationHTTPMethodGetResponseMetaNormalizationMinMax HTTPLocationHTTPMethodGetResponseMetaNormalization = "MIN_MAX" HTTPLocationHTTPMethodGetResponseMetaNormalizationRawValues HTTPLocationHTTPMethodGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationHTTPMethodGetResponseMetaNormalizationPercentageChange HTTPLocationHTTPMethodGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationHTTPMethodGetResponseMetaNormalizationRollingAverage HTTPLocationHTTPMethodGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationHTTPMethodGetResponseMetaNormalizationOverlappedPercentage HTTPLocationHTTPMethodGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationHTTPMethodGetResponseMetaNormalizationRatio HTTPLocationHTTPMethodGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationHTTPMethodGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationHTTPMethodGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationHTTPMethodGetResponseMetaUnit ¶
type HTTPLocationHTTPMethodGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationHTTPMethodGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationHTTPMethodGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationHTTPMethodGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationHTTPMethodGetResponseTop0 ¶
type HTTPLocationHTTPMethodGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationHTTPMethodService) Get(ctx context.Context, httpVersion HTTPLocationHTTPMethodGetParamsHTTPVersion, query HTTPLocationHTTPMethodGetParams, opts ...option.RequestOption) (res *HTTPLocationHTTPMethodGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested HTTP version.
type HTTPLocationHTTPProtocolGetParams ¶
type HTTPLocationHTTPProtocolGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationHTTPProtocolGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationHTTPProtocolGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationHTTPProtocolGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationHTTPProtocolGetParamsFormat] `query:"format"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationHTTPProtocolGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationHTTPProtocolGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPLocationHTTPProtocolGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPLocationHTTPProtocolGetParamsBotClass) IsKnown() bool
type HTTPLocationHTTPProtocolGetParamsBrowserFamily ¶
type HTTPLocationHTTPProtocolGetParamsBrowserFamily string
const ( HTTPLocationHTTPProtocolGetParamsBrowserFamilyChrome HTTPLocationHTTPProtocolGetParamsBrowserFamily = "CHROME" HTTPLocationHTTPProtocolGetParamsBrowserFamilyEdge HTTPLocationHTTPProtocolGetParamsBrowserFamily = "EDGE" HTTPLocationHTTPProtocolGetParamsBrowserFamilyFirefox HTTPLocationHTTPProtocolGetParamsBrowserFamily = "FIREFOX" HTTPLocationHTTPProtocolGetParamsBrowserFamilySafari HTTPLocationHTTPProtocolGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationHTTPProtocolGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationHTTPProtocolGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationHTTPProtocolGetParamsDeviceType ¶
type HTTPLocationHTTPProtocolGetParamsDeviceType string
const ( HTTPLocationHTTPProtocolGetParamsDeviceTypeDesktop HTTPLocationHTTPProtocolGetParamsDeviceType = "DESKTOP" HTTPLocationHTTPProtocolGetParamsDeviceTypeMobile HTTPLocationHTTPProtocolGetParamsDeviceType = "MOBILE" HTTPLocationHTTPProtocolGetParamsDeviceTypeOther HTTPLocationHTTPProtocolGetParamsDeviceType = "OTHER" )
func (HTTPLocationHTTPProtocolGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationHTTPProtocolGetParamsDeviceType) IsKnown() bool
type HTTPLocationHTTPProtocolGetParamsFormat ¶
type HTTPLocationHTTPProtocolGetParamsFormat string
Format in which results will be returned.
const ( HTTPLocationHTTPProtocolGetParamsFormatJson HTTPLocationHTTPProtocolGetParamsFormat = "JSON" HTTPLocationHTTPProtocolGetParamsFormatCsv HTTPLocationHTTPProtocolGetParamsFormat = "CSV" )
func (HTTPLocationHTTPProtocolGetParamsFormat) IsKnown ¶
func (r HTTPLocationHTTPProtocolGetParamsFormat) IsKnown() bool
type HTTPLocationHTTPProtocolGetParamsHTTPProtocol ¶
type HTTPLocationHTTPProtocolGetParamsHTTPProtocol string
HTTP protocol (HTTP vs. HTTPS).
const ( HTTPLocationHTTPProtocolGetParamsHTTPProtocolHTTP HTTPLocationHTTPProtocolGetParamsHTTPProtocol = "HTTP" HTTPLocationHTTPProtocolGetParamsHTTPProtocolHTTPS HTTPLocationHTTPProtocolGetParamsHTTPProtocol = "HTTPS" )
func (HTTPLocationHTTPProtocolGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPLocationHTTPProtocolGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationHTTPProtocolGetParamsHTTPVersion ¶
type HTTPLocationHTTPProtocolGetParamsHTTPVersion string
const ( HTTPLocationHTTPProtocolGetParamsHTTPVersionHttPv1 HTTPLocationHTTPProtocolGetParamsHTTPVersion = "HTTPv1" HTTPLocationHTTPProtocolGetParamsHTTPVersionHttPv2 HTTPLocationHTTPProtocolGetParamsHTTPVersion = "HTTPv2" HTTPLocationHTTPProtocolGetParamsHTTPVersionHttPv3 HTTPLocationHTTPProtocolGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationHTTPProtocolGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationHTTPProtocolGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationHTTPProtocolGetParamsIPVersion ¶
type HTTPLocationHTTPProtocolGetParamsIPVersion string
const ( HTTPLocationHTTPProtocolGetParamsIPVersionIPv4 HTTPLocationHTTPProtocolGetParamsIPVersion = "IPv4" HTTPLocationHTTPProtocolGetParamsIPVersionIPv6 HTTPLocationHTTPProtocolGetParamsIPVersion = "IPv6" )
func (HTTPLocationHTTPProtocolGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationHTTPProtocolGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationHTTPProtocolGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPLocationHTTPProtocolGetParamsTLSVersion) IsKnown() bool
type HTTPLocationHTTPProtocolGetResponse ¶
type HTTPLocationHTTPProtocolGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationHTTPProtocolGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationHTTPProtocolGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationHTTPProtocolGetResponseMetaUnit `json:"units,required"`
JSON httpLocationHTTPProtocolGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationHTTPProtocolGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationHTTPProtocolGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo ¶
type HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPLocationHTTPProtocolGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPLocationHTTPProtocolGetResponseMetaNormalization ¶
type HTTPLocationHTTPProtocolGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationHTTPProtocolGetResponseMetaNormalizationPercentage HTTPLocationHTTPProtocolGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationHTTPProtocolGetResponseMetaNormalizationMin0Max HTTPLocationHTTPProtocolGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationHTTPProtocolGetResponseMetaNormalizationMinMax HTTPLocationHTTPProtocolGetResponseMetaNormalization = "MIN_MAX" HTTPLocationHTTPProtocolGetResponseMetaNormalizationRawValues HTTPLocationHTTPProtocolGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationHTTPProtocolGetResponseMetaNormalizationPercentageChange HTTPLocationHTTPProtocolGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationHTTPProtocolGetResponseMetaNormalizationRollingAverage HTTPLocationHTTPProtocolGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationHTTPProtocolGetResponseMetaNormalizationOverlappedPercentage HTTPLocationHTTPProtocolGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationHTTPProtocolGetResponseMetaNormalizationRatio HTTPLocationHTTPProtocolGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationHTTPProtocolGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationHTTPProtocolGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationHTTPProtocolGetResponseMetaUnit ¶
type HTTPLocationHTTPProtocolGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationHTTPProtocolGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationHTTPProtocolGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationHTTPProtocolGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationHTTPProtocolGetResponseTop0 ¶
type HTTPLocationHTTPProtocolGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationHTTPProtocolService) Get(ctx context.Context, httpProtocol HTTPLocationHTTPProtocolGetParamsHTTPProtocol, query HTTPLocationHTTPProtocolGetParams, opts ...option.RequestOption) (res *HTTPLocationHTTPProtocolGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested HTTP protocol.
type HTTPLocationIPVersionGetParams ¶
type HTTPLocationIPVersionGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationIPVersionGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationIPVersionGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationIPVersionGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationIPVersionGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationIPVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationIPVersionGetParamsHTTPVersion] `query:"httpVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPLocationIPVersionGetParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPLocationIPVersionGetParamsBotClass) IsKnown() bool
type HTTPLocationIPVersionGetParamsBrowserFamily ¶
type HTTPLocationIPVersionGetParamsBrowserFamily string
const ( HTTPLocationIPVersionGetParamsBrowserFamilyChrome HTTPLocationIPVersionGetParamsBrowserFamily = "CHROME" HTTPLocationIPVersionGetParamsBrowserFamilyEdge HTTPLocationIPVersionGetParamsBrowserFamily = "EDGE" HTTPLocationIPVersionGetParamsBrowserFamilyFirefox HTTPLocationIPVersionGetParamsBrowserFamily = "FIREFOX" HTTPLocationIPVersionGetParamsBrowserFamilySafari HTTPLocationIPVersionGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationIPVersionGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationIPVersionGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationIPVersionGetParamsDeviceType ¶
type HTTPLocationIPVersionGetParamsDeviceType string
const ( HTTPLocationIPVersionGetParamsDeviceTypeDesktop HTTPLocationIPVersionGetParamsDeviceType = "DESKTOP" HTTPLocationIPVersionGetParamsDeviceTypeMobile HTTPLocationIPVersionGetParamsDeviceType = "MOBILE" HTTPLocationIPVersionGetParamsDeviceTypeOther HTTPLocationIPVersionGetParamsDeviceType = "OTHER" )
func (HTTPLocationIPVersionGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationIPVersionGetParamsDeviceType) IsKnown() bool
type HTTPLocationIPVersionGetParamsFormat ¶
type HTTPLocationIPVersionGetParamsFormat string
Format in which results will be returned.
const ( HTTPLocationIPVersionGetParamsFormatJson HTTPLocationIPVersionGetParamsFormat = "JSON" HTTPLocationIPVersionGetParamsFormatCsv HTTPLocationIPVersionGetParamsFormat = "CSV" )
func (HTTPLocationIPVersionGetParamsFormat) IsKnown ¶
func (r HTTPLocationIPVersionGetParamsFormat) IsKnown() bool
type HTTPLocationIPVersionGetParamsHTTPProtocol ¶
type HTTPLocationIPVersionGetParamsHTTPProtocol string
const ( HTTPLocationIPVersionGetParamsHTTPProtocolHTTP HTTPLocationIPVersionGetParamsHTTPProtocol = "HTTP" HTTPLocationIPVersionGetParamsHTTPProtocolHTTPS HTTPLocationIPVersionGetParamsHTTPProtocol = "HTTPS" )
func (HTTPLocationIPVersionGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPLocationIPVersionGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationIPVersionGetParamsHTTPVersion ¶
type HTTPLocationIPVersionGetParamsHTTPVersion string
const ( HTTPLocationIPVersionGetParamsHTTPVersionHttPv1 HTTPLocationIPVersionGetParamsHTTPVersion = "HTTPv1" HTTPLocationIPVersionGetParamsHTTPVersionHttPv2 HTTPLocationIPVersionGetParamsHTTPVersion = "HTTPv2" HTTPLocationIPVersionGetParamsHTTPVersionHttPv3 HTTPLocationIPVersionGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationIPVersionGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationIPVersionGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationIPVersionGetParamsIPVersion ¶
type HTTPLocationIPVersionGetParamsIPVersion string
IP version.
const ( HTTPLocationIPVersionGetParamsIPVersionIPv4 HTTPLocationIPVersionGetParamsIPVersion = "IPv4" HTTPLocationIPVersionGetParamsIPVersionIPv6 HTTPLocationIPVersionGetParamsIPVersion = "IPv6" )
func (HTTPLocationIPVersionGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationIPVersionGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationIPVersionGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPLocationIPVersionGetParamsTLSVersion) IsKnown() bool
type HTTPLocationIPVersionGetResponse ¶
type HTTPLocationIPVersionGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationIPVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationIPVersionGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationIPVersionGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationIPVersionGetResponseMetaUnit `json:"units,required"`
JSON httpLocationIPVersionGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationIPVersionGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationIPVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationIPVersionGetResponseMetaConfidenceInfo ¶
type HTTPLocationIPVersionGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationIPVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPLocationIPVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPLocationIPVersionGetResponseMetaNormalization ¶
type HTTPLocationIPVersionGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationIPVersionGetResponseMetaNormalizationPercentage HTTPLocationIPVersionGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationIPVersionGetResponseMetaNormalizationMin0Max HTTPLocationIPVersionGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationIPVersionGetResponseMetaNormalizationMinMax HTTPLocationIPVersionGetResponseMetaNormalization = "MIN_MAX" HTTPLocationIPVersionGetResponseMetaNormalizationRawValues HTTPLocationIPVersionGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationIPVersionGetResponseMetaNormalizationPercentageChange HTTPLocationIPVersionGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationIPVersionGetResponseMetaNormalizationRollingAverage HTTPLocationIPVersionGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationIPVersionGetResponseMetaNormalizationOverlappedPercentage HTTPLocationIPVersionGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationIPVersionGetResponseMetaNormalizationRatio HTTPLocationIPVersionGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationIPVersionGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationIPVersionGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationIPVersionGetResponseMetaUnit ¶
type HTTPLocationIPVersionGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationIPVersionGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationIPVersionGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationIPVersionGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationIPVersionGetResponseTop0 ¶
type HTTPLocationIPVersionGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationIPVersionService) Get(ctx context.Context, ipVersion HTTPLocationIPVersionGetParamsIPVersion, query HTTPLocationIPVersionGetParams, opts ...option.RequestOption) (res *HTTPLocationIPVersionGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested IP version.
type HTTPLocationOSGetParams ¶
type HTTPLocationOSGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationOSGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationOSGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationOSGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationOSGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationOSGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationOSGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationOSGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by 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 ¶
func (r HTTPLocationOSGetParamsBotClass) IsKnown() bool
type HTTPLocationOSGetParamsBrowserFamily ¶
type HTTPLocationOSGetParamsBrowserFamily string
const ( HTTPLocationOSGetParamsBrowserFamilyChrome HTTPLocationOSGetParamsBrowserFamily = "CHROME" HTTPLocationOSGetParamsBrowserFamilyEdge HTTPLocationOSGetParamsBrowserFamily = "EDGE" HTTPLocationOSGetParamsBrowserFamilyFirefox HTTPLocationOSGetParamsBrowserFamily = "FIREFOX" HTTPLocationOSGetParamsBrowserFamilySafari HTTPLocationOSGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationOSGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationOSGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationOSGetParamsDeviceType ¶
type HTTPLocationOSGetParamsDeviceType string
const ( HTTPLocationOSGetParamsDeviceTypeDesktop HTTPLocationOSGetParamsDeviceType = "DESKTOP" HTTPLocationOSGetParamsDeviceTypeMobile HTTPLocationOSGetParamsDeviceType = "MOBILE" HTTPLocationOSGetParamsDeviceTypeOther HTTPLocationOSGetParamsDeviceType = "OTHER" )
func (HTTPLocationOSGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationOSGetParamsDeviceType) IsKnown() bool
type HTTPLocationOSGetParamsFormat ¶
type HTTPLocationOSGetParamsFormat string
Format in which results will be returned.
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 ¶
func (r HTTPLocationOSGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationOSGetParamsHTTPVersion ¶
type HTTPLocationOSGetParamsHTTPVersion string
const ( HTTPLocationOSGetParamsHTTPVersionHttPv1 HTTPLocationOSGetParamsHTTPVersion = "HTTPv1" HTTPLocationOSGetParamsHTTPVersionHttPv2 HTTPLocationOSGetParamsHTTPVersion = "HTTPv2" HTTPLocationOSGetParamsHTTPVersionHttPv3 HTTPLocationOSGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationOSGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationOSGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationOSGetParamsIPVersion ¶
type HTTPLocationOSGetParamsIPVersion string
const ( HTTPLocationOSGetParamsIPVersionIPv4 HTTPLocationOSGetParamsIPVersion = "IPv4" HTTPLocationOSGetParamsIPVersionIPv6 HTTPLocationOSGetParamsIPVersion = "IPv6" )
func (HTTPLocationOSGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationOSGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationOSGetParamsTLSVersion) IsKnown() bool
type HTTPLocationOSGetResponse ¶
type HTTPLocationOSGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationOSGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationOSGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationOSGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationOSGetResponseMetaUnit `json:"units,required"`
JSON httpLocationOSGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationOSGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationOSGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationOSGetResponseMetaConfidenceInfo ¶
type HTTPLocationOSGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationOSGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPLocationOSGetResponseMetaNormalization ¶
type HTTPLocationOSGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationOSGetResponseMetaNormalizationPercentage HTTPLocationOSGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationOSGetResponseMetaNormalizationMin0Max HTTPLocationOSGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationOSGetResponseMetaNormalizationMinMax HTTPLocationOSGetResponseMetaNormalization = "MIN_MAX" HTTPLocationOSGetResponseMetaNormalizationRawValues HTTPLocationOSGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationOSGetResponseMetaNormalizationPercentageChange HTTPLocationOSGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationOSGetResponseMetaNormalizationRollingAverage HTTPLocationOSGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationOSGetResponseMetaNormalizationOverlappedPercentage HTTPLocationOSGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationOSGetResponseMetaNormalizationRatio HTTPLocationOSGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationOSGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationOSGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationOSGetResponseMetaUnit ¶
type HTTPLocationOSGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationOSGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationOSGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationOSGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationOSGetResponseTop0 ¶
type HTTPLocationOSGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationOSService) Get(ctx context.Context, os HTTPLocationOSGetParamsOS, query HTTPLocationOSGetParams, opts ...option.RequestOption) (res *HTTPLocationOSGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested operating system.
type HTTPLocationService ¶
type HTTPLocationService struct {
Options []option.RequestOption
BotClass *HTTPLocationBotClassService
DeviceType *HTTPLocationDeviceTypeService
HTTPProtocol *HTTPLocationHTTPProtocolService
HTTPMethod *HTTPLocationHTTPMethodService
IPVersion *HTTPLocationIPVersionService
OS *HTTPLocationOSService
TLSVersion *HTTPLocationTLSVersionService
BrowserFamily *HTTPLocationBrowserFamilyService
}
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 ¶
func (r *HTTPLocationService) Get(ctx context.Context, query HTTPLocationGetParams, opts ...option.RequestOption) (res *HTTPLocationGetResponse, err error)
Retrieves the top locations by HTTP requests.
type HTTPLocationTLSVersionGetParams ¶
type HTTPLocationTLSVersionGetParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPLocationTLSVersionGetParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPLocationTLSVersionGetParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPLocationTLSVersionGetParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPLocationTLSVersionGetParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPLocationTLSVersionGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPLocationTLSVersionGetParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPLocationTLSVersionGetParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
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 ¶
func (r HTTPLocationTLSVersionGetParamsBotClass) IsKnown() bool
type HTTPLocationTLSVersionGetParamsBrowserFamily ¶
type HTTPLocationTLSVersionGetParamsBrowserFamily string
const ( HTTPLocationTLSVersionGetParamsBrowserFamilyChrome HTTPLocationTLSVersionGetParamsBrowserFamily = "CHROME" HTTPLocationTLSVersionGetParamsBrowserFamilyEdge HTTPLocationTLSVersionGetParamsBrowserFamily = "EDGE" HTTPLocationTLSVersionGetParamsBrowserFamilyFirefox HTTPLocationTLSVersionGetParamsBrowserFamily = "FIREFOX" HTTPLocationTLSVersionGetParamsBrowserFamilySafari HTTPLocationTLSVersionGetParamsBrowserFamily = "SAFARI" )
func (HTTPLocationTLSVersionGetParamsBrowserFamily) IsKnown ¶
func (r HTTPLocationTLSVersionGetParamsBrowserFamily) IsKnown() bool
type HTTPLocationTLSVersionGetParamsDeviceType ¶
type HTTPLocationTLSVersionGetParamsDeviceType string
const ( HTTPLocationTLSVersionGetParamsDeviceTypeDesktop HTTPLocationTLSVersionGetParamsDeviceType = "DESKTOP" HTTPLocationTLSVersionGetParamsDeviceTypeMobile HTTPLocationTLSVersionGetParamsDeviceType = "MOBILE" HTTPLocationTLSVersionGetParamsDeviceTypeOther HTTPLocationTLSVersionGetParamsDeviceType = "OTHER" )
func (HTTPLocationTLSVersionGetParamsDeviceType) IsKnown ¶
func (r HTTPLocationTLSVersionGetParamsDeviceType) IsKnown() bool
type HTTPLocationTLSVersionGetParamsFormat ¶
type HTTPLocationTLSVersionGetParamsFormat string
Format in which results will be returned.
const ( HTTPLocationTLSVersionGetParamsFormatJson HTTPLocationTLSVersionGetParamsFormat = "JSON" HTTPLocationTLSVersionGetParamsFormatCsv HTTPLocationTLSVersionGetParamsFormat = "CSV" )
func (HTTPLocationTLSVersionGetParamsFormat) IsKnown ¶
func (r HTTPLocationTLSVersionGetParamsFormat) IsKnown() bool
type HTTPLocationTLSVersionGetParamsHTTPProtocol ¶
type HTTPLocationTLSVersionGetParamsHTTPProtocol string
const ( HTTPLocationTLSVersionGetParamsHTTPProtocolHTTP HTTPLocationTLSVersionGetParamsHTTPProtocol = "HTTP" HTTPLocationTLSVersionGetParamsHTTPProtocolHTTPS HTTPLocationTLSVersionGetParamsHTTPProtocol = "HTTPS" )
func (HTTPLocationTLSVersionGetParamsHTTPProtocol) IsKnown ¶
func (r HTTPLocationTLSVersionGetParamsHTTPProtocol) IsKnown() bool
type HTTPLocationTLSVersionGetParamsHTTPVersion ¶
type HTTPLocationTLSVersionGetParamsHTTPVersion string
const ( HTTPLocationTLSVersionGetParamsHTTPVersionHttPv1 HTTPLocationTLSVersionGetParamsHTTPVersion = "HTTPv1" HTTPLocationTLSVersionGetParamsHTTPVersionHttPv2 HTTPLocationTLSVersionGetParamsHTTPVersion = "HTTPv2" HTTPLocationTLSVersionGetParamsHTTPVersionHttPv3 HTTPLocationTLSVersionGetParamsHTTPVersion = "HTTPv3" )
func (HTTPLocationTLSVersionGetParamsHTTPVersion) IsKnown ¶
func (r HTTPLocationTLSVersionGetParamsHTTPVersion) IsKnown() bool
type HTTPLocationTLSVersionGetParamsIPVersion ¶
type HTTPLocationTLSVersionGetParamsIPVersion string
const ( HTTPLocationTLSVersionGetParamsIPVersionIPv4 HTTPLocationTLSVersionGetParamsIPVersion = "IPv4" HTTPLocationTLSVersionGetParamsIPVersionIPv6 HTTPLocationTLSVersionGetParamsIPVersion = "IPv6" )
func (HTTPLocationTLSVersionGetParamsIPVersion) IsKnown ¶
func (r HTTPLocationTLSVersionGetParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPLocationTLSVersionGetParamsOS) IsKnown() bool
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 ¶
func (r HTTPLocationTLSVersionGetParamsTLSVersion) IsKnown() bool
type HTTPLocationTLSVersionGetResponse ¶
type HTTPLocationTLSVersionGetResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPLocationTLSVersionGetResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPLocationTLSVersionGetResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPLocationTLSVersionGetResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPLocationTLSVersionGetResponseMetaUnit `json:"units,required"`
JSON httpLocationTLSVersionGetResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPLocationTLSVersionGetResponseMeta) UnmarshalJSON ¶
func (r *HTTPLocationTLSVersionGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPLocationTLSVersionGetResponseMetaConfidenceInfo ¶
type HTTPLocationTLSVersionGetResponseMetaConfidenceInfo struct {
Annotations []HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpLocationTLSVersionGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPLocationTLSVersionGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPLocationTLSVersionGetResponseMetaNormalization ¶
type HTTPLocationTLSVersionGetResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPLocationTLSVersionGetResponseMetaNormalizationPercentage HTTPLocationTLSVersionGetResponseMetaNormalization = "PERCENTAGE" HTTPLocationTLSVersionGetResponseMetaNormalizationMin0Max HTTPLocationTLSVersionGetResponseMetaNormalization = "MIN0_MAX" HTTPLocationTLSVersionGetResponseMetaNormalizationMinMax HTTPLocationTLSVersionGetResponseMetaNormalization = "MIN_MAX" HTTPLocationTLSVersionGetResponseMetaNormalizationRawValues HTTPLocationTLSVersionGetResponseMetaNormalization = "RAW_VALUES" HTTPLocationTLSVersionGetResponseMetaNormalizationPercentageChange HTTPLocationTLSVersionGetResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPLocationTLSVersionGetResponseMetaNormalizationRollingAverage HTTPLocationTLSVersionGetResponseMetaNormalization = "ROLLING_AVERAGE" HTTPLocationTLSVersionGetResponseMetaNormalizationOverlappedPercentage HTTPLocationTLSVersionGetResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPLocationTLSVersionGetResponseMetaNormalizationRatio HTTPLocationTLSVersionGetResponseMetaNormalization = "RATIO" )
func (HTTPLocationTLSVersionGetResponseMetaNormalization) IsKnown ¶
func (r HTTPLocationTLSVersionGetResponseMetaNormalization) IsKnown() bool
type HTTPLocationTLSVersionGetResponseMetaUnit ¶
type HTTPLocationTLSVersionGetResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpLocationTLSVersionGetResponseMetaUnitJSON `json:"-"`
}
func (*HTTPLocationTLSVersionGetResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPLocationTLSVersionGetResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPLocationTLSVersionGetResponseTop0 ¶
type HTTPLocationTLSVersionGetResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *HTTPLocationTLSVersionService) Get(ctx context.Context, tlsVersion HTTPLocationTLSVersionGetParamsTLSVersion, query HTTPLocationTLSVersionGetParams, opts ...option.RequestOption) (res *HTTPLocationTLSVersionGetResponse, err error)
Retrieves the top locations, by HTTP requests, of the requested TLS protocol version.
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)
Retrieves the HTTP requests over time.
type HTTPSummaryBotClassParams ¶
type HTTPSummaryBotClassParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryBotClassParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPSummaryBotClassParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryBotClassParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPSummaryBotClassParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPSummaryBotClassParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPSummaryBotClassParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPSummaryBotClassParamsOS] `query:"os"`
// Filters results by 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 HTTPSummaryBotClassParamsBrowserFamily ¶
type HTTPSummaryBotClassParamsBrowserFamily string
const ( HTTPSummaryBotClassParamsBrowserFamilyChrome HTTPSummaryBotClassParamsBrowserFamily = "CHROME" HTTPSummaryBotClassParamsBrowserFamilyEdge HTTPSummaryBotClassParamsBrowserFamily = "EDGE" HTTPSummaryBotClassParamsBrowserFamilyFirefox HTTPSummaryBotClassParamsBrowserFamily = "FIREFOX" HTTPSummaryBotClassParamsBrowserFamilySafari HTTPSummaryBotClassParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryBotClassParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryBotClassParamsBrowserFamily) IsKnown() bool
type HTTPSummaryBotClassParamsDeviceType ¶
type HTTPSummaryBotClassParamsDeviceType string
const ( HTTPSummaryBotClassParamsDeviceTypeDesktop HTTPSummaryBotClassParamsDeviceType = "DESKTOP" HTTPSummaryBotClassParamsDeviceTypeMobile HTTPSummaryBotClassParamsDeviceType = "MOBILE" HTTPSummaryBotClassParamsDeviceTypeOther HTTPSummaryBotClassParamsDeviceType = "OTHER" )
func (HTTPSummaryBotClassParamsDeviceType) IsKnown ¶
func (r HTTPSummaryBotClassParamsDeviceType) IsKnown() bool
type HTTPSummaryBotClassParamsFormat ¶
type HTTPSummaryBotClassParamsFormat string
Format in which results will be returned.
const ( HTTPSummaryBotClassParamsFormatJson HTTPSummaryBotClassParamsFormat = "JSON" HTTPSummaryBotClassParamsFormatCsv HTTPSummaryBotClassParamsFormat = "CSV" )
func (HTTPSummaryBotClassParamsFormat) IsKnown ¶
func (r HTTPSummaryBotClassParamsFormat) IsKnown() bool
type HTTPSummaryBotClassParamsHTTPProtocol ¶
type HTTPSummaryBotClassParamsHTTPProtocol string
const ( HTTPSummaryBotClassParamsHTTPProtocolHTTP HTTPSummaryBotClassParamsHTTPProtocol = "HTTP" HTTPSummaryBotClassParamsHTTPProtocolHTTPS HTTPSummaryBotClassParamsHTTPProtocol = "HTTPS" )
func (HTTPSummaryBotClassParamsHTTPProtocol) IsKnown ¶
func (r HTTPSummaryBotClassParamsHTTPProtocol) IsKnown() bool
type HTTPSummaryBotClassParamsHTTPVersion ¶
type HTTPSummaryBotClassParamsHTTPVersion string
const ( HTTPSummaryBotClassParamsHTTPVersionHttPv1 HTTPSummaryBotClassParamsHTTPVersion = "HTTPv1" HTTPSummaryBotClassParamsHTTPVersionHttPv2 HTTPSummaryBotClassParamsHTTPVersion = "HTTPv2" HTTPSummaryBotClassParamsHTTPVersionHttPv3 HTTPSummaryBotClassParamsHTTPVersion = "HTTPv3" )
func (HTTPSummaryBotClassParamsHTTPVersion) IsKnown ¶
func (r HTTPSummaryBotClassParamsHTTPVersion) IsKnown() bool
type HTTPSummaryBotClassParamsIPVersion ¶
type HTTPSummaryBotClassParamsIPVersion string
const ( HTTPSummaryBotClassParamsIPVersionIPv4 HTTPSummaryBotClassParamsIPVersion = "IPv4" HTTPSummaryBotClassParamsIPVersionIPv6 HTTPSummaryBotClassParamsIPVersion = "IPv6" )
func (HTTPSummaryBotClassParamsIPVersion) IsKnown ¶
func (r HTTPSummaryBotClassParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPSummaryBotClassParamsTLSVersion) IsKnown() bool
type HTTPSummaryBotClassResponse ¶
type HTTPSummaryBotClassResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryBotClassResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryBotClassResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryBotClassResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryBotClassResponseMetaUnit `json:"units,required"`
JSON httpSummaryBotClassResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryBotClassResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryBotClassResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryBotClassResponseMetaConfidenceInfo ¶
type HTTPSummaryBotClassResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryBotClassResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPSummaryBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPSummaryBotClassResponseMetaNormalization ¶
type HTTPSummaryBotClassResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryBotClassResponseMetaNormalizationPercentage HTTPSummaryBotClassResponseMetaNormalization = "PERCENTAGE" HTTPSummaryBotClassResponseMetaNormalizationMin0Max HTTPSummaryBotClassResponseMetaNormalization = "MIN0_MAX" HTTPSummaryBotClassResponseMetaNormalizationMinMax HTTPSummaryBotClassResponseMetaNormalization = "MIN_MAX" HTTPSummaryBotClassResponseMetaNormalizationRawValues HTTPSummaryBotClassResponseMetaNormalization = "RAW_VALUES" HTTPSummaryBotClassResponseMetaNormalizationPercentageChange HTTPSummaryBotClassResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryBotClassResponseMetaNormalizationRollingAverage HTTPSummaryBotClassResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryBotClassResponseMetaNormalizationOverlappedPercentage HTTPSummaryBotClassResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryBotClassResponseMetaNormalizationRatio HTTPSummaryBotClassResponseMetaNormalization = "RATIO" )
func (HTTPSummaryBotClassResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryBotClassResponseMetaNormalization) IsKnown() bool
type HTTPSummaryBotClassResponseMetaUnit ¶
type HTTPSummaryBotClassResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryBotClassResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryBotClassResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryBotClassResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryBotClassResponseSummary0 ¶
type HTTPSummaryBotClassResponseSummary0 struct {
// A numeric string.
Bot string `json:"bot,required"`
// A numeric string.
Human string `json:"human,required"`
JSON httpSummaryBotClassResponseSummary0JSON `json:"-"`
}
func (*HTTPSummaryBotClassResponseSummary0) UnmarshalJSON ¶
func (r *HTTPSummaryBotClassResponseSummary0) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryDeviceTypeParams ¶
type HTTPSummaryDeviceTypeParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPSummaryDeviceTypeParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryDeviceTypeParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryDeviceTypeParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPSummaryDeviceTypeParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPSummaryDeviceTypeParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPSummaryDeviceTypeParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPSummaryDeviceTypeParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPSummaryDeviceTypeParamsBotClass) IsKnown() bool
type HTTPSummaryDeviceTypeParamsBrowserFamily ¶
type HTTPSummaryDeviceTypeParamsBrowserFamily string
const ( HTTPSummaryDeviceTypeParamsBrowserFamilyChrome HTTPSummaryDeviceTypeParamsBrowserFamily = "CHROME" HTTPSummaryDeviceTypeParamsBrowserFamilyEdge HTTPSummaryDeviceTypeParamsBrowserFamily = "EDGE" HTTPSummaryDeviceTypeParamsBrowserFamilyFirefox HTTPSummaryDeviceTypeParamsBrowserFamily = "FIREFOX" HTTPSummaryDeviceTypeParamsBrowserFamilySafari HTTPSummaryDeviceTypeParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryDeviceTypeParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryDeviceTypeParamsBrowserFamily) IsKnown() bool
type HTTPSummaryDeviceTypeParamsFormat ¶
type HTTPSummaryDeviceTypeParamsFormat string
Format in which results will be returned.
const ( HTTPSummaryDeviceTypeParamsFormatJson HTTPSummaryDeviceTypeParamsFormat = "JSON" HTTPSummaryDeviceTypeParamsFormatCsv HTTPSummaryDeviceTypeParamsFormat = "CSV" )
func (HTTPSummaryDeviceTypeParamsFormat) IsKnown ¶
func (r HTTPSummaryDeviceTypeParamsFormat) IsKnown() bool
type HTTPSummaryDeviceTypeParamsHTTPProtocol ¶
type HTTPSummaryDeviceTypeParamsHTTPProtocol string
const ( HTTPSummaryDeviceTypeParamsHTTPProtocolHTTP HTTPSummaryDeviceTypeParamsHTTPProtocol = "HTTP" HTTPSummaryDeviceTypeParamsHTTPProtocolHTTPS HTTPSummaryDeviceTypeParamsHTTPProtocol = "HTTPS" )
func (HTTPSummaryDeviceTypeParamsHTTPProtocol) IsKnown ¶
func (r HTTPSummaryDeviceTypeParamsHTTPProtocol) IsKnown() bool
type HTTPSummaryDeviceTypeParamsHTTPVersion ¶
type HTTPSummaryDeviceTypeParamsHTTPVersion string
const ( HTTPSummaryDeviceTypeParamsHTTPVersionHttPv1 HTTPSummaryDeviceTypeParamsHTTPVersion = "HTTPv1" HTTPSummaryDeviceTypeParamsHTTPVersionHttPv2 HTTPSummaryDeviceTypeParamsHTTPVersion = "HTTPv2" HTTPSummaryDeviceTypeParamsHTTPVersionHttPv3 HTTPSummaryDeviceTypeParamsHTTPVersion = "HTTPv3" )
func (HTTPSummaryDeviceTypeParamsHTTPVersion) IsKnown ¶
func (r HTTPSummaryDeviceTypeParamsHTTPVersion) IsKnown() bool
type HTTPSummaryDeviceTypeParamsIPVersion ¶
type HTTPSummaryDeviceTypeParamsIPVersion string
const ( HTTPSummaryDeviceTypeParamsIPVersionIPv4 HTTPSummaryDeviceTypeParamsIPVersion = "IPv4" HTTPSummaryDeviceTypeParamsIPVersionIPv6 HTTPSummaryDeviceTypeParamsIPVersion = "IPv6" )
func (HTTPSummaryDeviceTypeParamsIPVersion) IsKnown ¶
func (r HTTPSummaryDeviceTypeParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPSummaryDeviceTypeParamsTLSVersion) IsKnown() bool
type HTTPSummaryDeviceTypeResponse ¶
type HTTPSummaryDeviceTypeResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryDeviceTypeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryDeviceTypeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryDeviceTypeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryDeviceTypeResponseMetaUnit `json:"units,required"`
JSON httpSummaryDeviceTypeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryDeviceTypeResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryDeviceTypeResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryDeviceTypeResponseMetaConfidenceInfo ¶
type HTTPSummaryDeviceTypeResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryDeviceTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPSummaryDeviceTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPSummaryDeviceTypeResponseMetaNormalization ¶
type HTTPSummaryDeviceTypeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryDeviceTypeResponseMetaNormalizationPercentage HTTPSummaryDeviceTypeResponseMetaNormalization = "PERCENTAGE" HTTPSummaryDeviceTypeResponseMetaNormalizationMin0Max HTTPSummaryDeviceTypeResponseMetaNormalization = "MIN0_MAX" HTTPSummaryDeviceTypeResponseMetaNormalizationMinMax HTTPSummaryDeviceTypeResponseMetaNormalization = "MIN_MAX" HTTPSummaryDeviceTypeResponseMetaNormalizationRawValues HTTPSummaryDeviceTypeResponseMetaNormalization = "RAW_VALUES" HTTPSummaryDeviceTypeResponseMetaNormalizationPercentageChange HTTPSummaryDeviceTypeResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryDeviceTypeResponseMetaNormalizationRollingAverage HTTPSummaryDeviceTypeResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryDeviceTypeResponseMetaNormalizationOverlappedPercentage HTTPSummaryDeviceTypeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryDeviceTypeResponseMetaNormalizationRatio HTTPSummaryDeviceTypeResponseMetaNormalization = "RATIO" )
func (HTTPSummaryDeviceTypeResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryDeviceTypeResponseMetaNormalization) IsKnown() bool
type HTTPSummaryDeviceTypeResponseMetaUnit ¶
type HTTPSummaryDeviceTypeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryDeviceTypeResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryDeviceTypeResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryDeviceTypeResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryDeviceTypeResponseSummary0 ¶
type HTTPSummaryDeviceTypeResponseSummary0 struct {
// A numeric string.
Desktop string `json:"desktop,required"`
// A numeric string.
Mobile string `json:"mobile,required"`
// A numeric string.
Other string `json:"other,required"`
JSON httpSummaryDeviceTypeResponseSummary0JSON `json:"-"`
}
func (*HTTPSummaryDeviceTypeResponseSummary0) UnmarshalJSON ¶
func (r *HTTPSummaryDeviceTypeResponseSummary0) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryHTTPProtocolParams ¶
type HTTPSummaryHTTPProtocolParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPSummaryHTTPProtocolParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryHTTPProtocolParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPSummaryHTTPProtocolParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryHTTPProtocolParamsFormat] `query:"format"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPSummaryHTTPProtocolParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPSummaryHTTPProtocolParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPSummaryHTTPProtocolParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPSummaryHTTPProtocolParamsBotClass) IsKnown() bool
type HTTPSummaryHTTPProtocolParamsBrowserFamily ¶
type HTTPSummaryHTTPProtocolParamsBrowserFamily string
const ( HTTPSummaryHTTPProtocolParamsBrowserFamilyChrome HTTPSummaryHTTPProtocolParamsBrowserFamily = "CHROME" HTTPSummaryHTTPProtocolParamsBrowserFamilyEdge HTTPSummaryHTTPProtocolParamsBrowserFamily = "EDGE" HTTPSummaryHTTPProtocolParamsBrowserFamilyFirefox HTTPSummaryHTTPProtocolParamsBrowserFamily = "FIREFOX" HTTPSummaryHTTPProtocolParamsBrowserFamilySafari HTTPSummaryHTTPProtocolParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryHTTPProtocolParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryHTTPProtocolParamsBrowserFamily) IsKnown() bool
type HTTPSummaryHTTPProtocolParamsDeviceType ¶
type HTTPSummaryHTTPProtocolParamsDeviceType string
const ( HTTPSummaryHTTPProtocolParamsDeviceTypeDesktop HTTPSummaryHTTPProtocolParamsDeviceType = "DESKTOP" HTTPSummaryHTTPProtocolParamsDeviceTypeMobile HTTPSummaryHTTPProtocolParamsDeviceType = "MOBILE" HTTPSummaryHTTPProtocolParamsDeviceTypeOther HTTPSummaryHTTPProtocolParamsDeviceType = "OTHER" )
func (HTTPSummaryHTTPProtocolParamsDeviceType) IsKnown ¶
func (r HTTPSummaryHTTPProtocolParamsDeviceType) IsKnown() bool
type HTTPSummaryHTTPProtocolParamsFormat ¶
type HTTPSummaryHTTPProtocolParamsFormat string
Format in which results will be returned.
const ( HTTPSummaryHTTPProtocolParamsFormatJson HTTPSummaryHTTPProtocolParamsFormat = "JSON" HTTPSummaryHTTPProtocolParamsFormatCsv HTTPSummaryHTTPProtocolParamsFormat = "CSV" )
func (HTTPSummaryHTTPProtocolParamsFormat) IsKnown ¶
func (r HTTPSummaryHTTPProtocolParamsFormat) IsKnown() bool
type HTTPSummaryHTTPProtocolParamsHTTPVersion ¶
type HTTPSummaryHTTPProtocolParamsHTTPVersion string
const ( HTTPSummaryHTTPProtocolParamsHTTPVersionHttPv1 HTTPSummaryHTTPProtocolParamsHTTPVersion = "HTTPv1" HTTPSummaryHTTPProtocolParamsHTTPVersionHttPv2 HTTPSummaryHTTPProtocolParamsHTTPVersion = "HTTPv2" HTTPSummaryHTTPProtocolParamsHTTPVersionHttPv3 HTTPSummaryHTTPProtocolParamsHTTPVersion = "HTTPv3" )
func (HTTPSummaryHTTPProtocolParamsHTTPVersion) IsKnown ¶
func (r HTTPSummaryHTTPProtocolParamsHTTPVersion) IsKnown() bool
type HTTPSummaryHTTPProtocolParamsIPVersion ¶
type HTTPSummaryHTTPProtocolParamsIPVersion string
const ( HTTPSummaryHTTPProtocolParamsIPVersionIPv4 HTTPSummaryHTTPProtocolParamsIPVersion = "IPv4" HTTPSummaryHTTPProtocolParamsIPVersionIPv6 HTTPSummaryHTTPProtocolParamsIPVersion = "IPv6" )
func (HTTPSummaryHTTPProtocolParamsIPVersion) IsKnown ¶
func (r HTTPSummaryHTTPProtocolParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPSummaryHTTPProtocolParamsOS) IsKnown() bool
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 ¶
func (r HTTPSummaryHTTPProtocolParamsTLSVersion) IsKnown() bool
type HTTPSummaryHTTPProtocolResponse ¶
type HTTPSummaryHTTPProtocolResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryHTTPProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryHTTPProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryHTTPProtocolResponseMetaUnit `json:"units,required"`
JSON httpSummaryHTTPProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryHTTPProtocolResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryHTTPProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo ¶
type HTTPSummaryHTTPProtocolResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPSummaryHTTPProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPSummaryHTTPProtocolResponseMetaNormalization ¶
type HTTPSummaryHTTPProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryHTTPProtocolResponseMetaNormalizationPercentage HTTPSummaryHTTPProtocolResponseMetaNormalization = "PERCENTAGE" HTTPSummaryHTTPProtocolResponseMetaNormalizationMin0Max HTTPSummaryHTTPProtocolResponseMetaNormalization = "MIN0_MAX" HTTPSummaryHTTPProtocolResponseMetaNormalizationMinMax HTTPSummaryHTTPProtocolResponseMetaNormalization = "MIN_MAX" HTTPSummaryHTTPProtocolResponseMetaNormalizationRawValues HTTPSummaryHTTPProtocolResponseMetaNormalization = "RAW_VALUES" HTTPSummaryHTTPProtocolResponseMetaNormalizationPercentageChange HTTPSummaryHTTPProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryHTTPProtocolResponseMetaNormalizationRollingAverage HTTPSummaryHTTPProtocolResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryHTTPProtocolResponseMetaNormalizationOverlappedPercentage HTTPSummaryHTTPProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryHTTPProtocolResponseMetaNormalizationRatio HTTPSummaryHTTPProtocolResponseMetaNormalization = "RATIO" )
func (HTTPSummaryHTTPProtocolResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryHTTPProtocolResponseMetaNormalization) IsKnown() bool
type HTTPSummaryHTTPProtocolResponseMetaUnit ¶
type HTTPSummaryHTTPProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryHTTPProtocolResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryHTTPProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryHTTPProtocolResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryHTTPProtocolResponseSummary0 ¶
type HTTPSummaryHTTPProtocolResponseSummary0 struct {
// A numeric string.
HTTP string `json:"http,required"`
// A numeric string.
HTTPS string `json:"https,required"`
JSON httpSummaryHTTPProtocolResponseSummary0JSON `json:"-"`
}
func (*HTTPSummaryHTTPProtocolResponseSummary0) UnmarshalJSON ¶
func (r *HTTPSummaryHTTPProtocolResponseSummary0) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryHTTPVersionParams ¶
type HTTPSummaryHTTPVersionParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPSummaryHTTPVersionParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryHTTPVersionParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPSummaryHTTPVersionParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryHTTPVersionParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPSummaryHTTPVersionParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPSummaryHTTPVersionParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPSummaryHTTPVersionParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPSummaryHTTPVersionParamsBotClass) IsKnown() bool
type HTTPSummaryHTTPVersionParamsBrowserFamily ¶
type HTTPSummaryHTTPVersionParamsBrowserFamily string
const ( HTTPSummaryHTTPVersionParamsBrowserFamilyChrome HTTPSummaryHTTPVersionParamsBrowserFamily = "CHROME" HTTPSummaryHTTPVersionParamsBrowserFamilyEdge HTTPSummaryHTTPVersionParamsBrowserFamily = "EDGE" HTTPSummaryHTTPVersionParamsBrowserFamilyFirefox HTTPSummaryHTTPVersionParamsBrowserFamily = "FIREFOX" HTTPSummaryHTTPVersionParamsBrowserFamilySafari HTTPSummaryHTTPVersionParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryHTTPVersionParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryHTTPVersionParamsBrowserFamily) IsKnown() bool
type HTTPSummaryHTTPVersionParamsDeviceType ¶
type HTTPSummaryHTTPVersionParamsDeviceType string
const ( HTTPSummaryHTTPVersionParamsDeviceTypeDesktop HTTPSummaryHTTPVersionParamsDeviceType = "DESKTOP" HTTPSummaryHTTPVersionParamsDeviceTypeMobile HTTPSummaryHTTPVersionParamsDeviceType = "MOBILE" HTTPSummaryHTTPVersionParamsDeviceTypeOther HTTPSummaryHTTPVersionParamsDeviceType = "OTHER" )
func (HTTPSummaryHTTPVersionParamsDeviceType) IsKnown ¶
func (r HTTPSummaryHTTPVersionParamsDeviceType) IsKnown() bool
type HTTPSummaryHTTPVersionParamsFormat ¶
type HTTPSummaryHTTPVersionParamsFormat string
Format in which results will be returned.
const ( HTTPSummaryHTTPVersionParamsFormatJson HTTPSummaryHTTPVersionParamsFormat = "JSON" HTTPSummaryHTTPVersionParamsFormatCsv HTTPSummaryHTTPVersionParamsFormat = "CSV" )
func (HTTPSummaryHTTPVersionParamsFormat) IsKnown ¶
func (r HTTPSummaryHTTPVersionParamsFormat) IsKnown() bool
type HTTPSummaryHTTPVersionParamsHTTPProtocol ¶
type HTTPSummaryHTTPVersionParamsHTTPProtocol string
const ( HTTPSummaryHTTPVersionParamsHTTPProtocolHTTP HTTPSummaryHTTPVersionParamsHTTPProtocol = "HTTP" HTTPSummaryHTTPVersionParamsHTTPProtocolHTTPS HTTPSummaryHTTPVersionParamsHTTPProtocol = "HTTPS" )
func (HTTPSummaryHTTPVersionParamsHTTPProtocol) IsKnown ¶
func (r HTTPSummaryHTTPVersionParamsHTTPProtocol) IsKnown() bool
type HTTPSummaryHTTPVersionParamsIPVersion ¶
type HTTPSummaryHTTPVersionParamsIPVersion string
const ( HTTPSummaryHTTPVersionParamsIPVersionIPv4 HTTPSummaryHTTPVersionParamsIPVersion = "IPv4" HTTPSummaryHTTPVersionParamsIPVersionIPv6 HTTPSummaryHTTPVersionParamsIPVersion = "IPv6" )
func (HTTPSummaryHTTPVersionParamsIPVersion) IsKnown ¶
func (r HTTPSummaryHTTPVersionParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPSummaryHTTPVersionParamsOS) IsKnown() bool
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 ¶
func (r HTTPSummaryHTTPVersionParamsTLSVersion) IsKnown() bool
type HTTPSummaryHTTPVersionResponse ¶
type HTTPSummaryHTTPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryHTTPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryHTTPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryHTTPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryHTTPVersionResponseMetaUnit `json:"units,required"`
JSON httpSummaryHTTPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryHTTPVersionResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryHTTPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryHTTPVersionResponseMetaConfidenceInfo ¶
type HTTPSummaryHTTPVersionResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryHTTPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPSummaryHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPSummaryHTTPVersionResponseMetaNormalization ¶
type HTTPSummaryHTTPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryHTTPVersionResponseMetaNormalizationPercentage HTTPSummaryHTTPVersionResponseMetaNormalization = "PERCENTAGE" HTTPSummaryHTTPVersionResponseMetaNormalizationMin0Max HTTPSummaryHTTPVersionResponseMetaNormalization = "MIN0_MAX" HTTPSummaryHTTPVersionResponseMetaNormalizationMinMax HTTPSummaryHTTPVersionResponseMetaNormalization = "MIN_MAX" HTTPSummaryHTTPVersionResponseMetaNormalizationRawValues HTTPSummaryHTTPVersionResponseMetaNormalization = "RAW_VALUES" HTTPSummaryHTTPVersionResponseMetaNormalizationPercentageChange HTTPSummaryHTTPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryHTTPVersionResponseMetaNormalizationRollingAverage HTTPSummaryHTTPVersionResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryHTTPVersionResponseMetaNormalizationOverlappedPercentage HTTPSummaryHTTPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryHTTPVersionResponseMetaNormalizationRatio HTTPSummaryHTTPVersionResponseMetaNormalization = "RATIO" )
func (HTTPSummaryHTTPVersionResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryHTTPVersionResponseMetaNormalization) IsKnown() bool
type HTTPSummaryHTTPVersionResponseMetaUnit ¶
type HTTPSummaryHTTPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryHTTPVersionResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryHTTPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryHTTPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryHTTPVersionResponseSummary0 ¶
type HTTPSummaryHTTPVersionResponseSummary0 struct {
// A numeric string.
HTTP1X string `json:"HTTP/1.x,required"`
// A numeric string.
HTTP2 string `json:"HTTP/2,required"`
// A numeric string.
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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPSummaryIPVersionParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryIPVersionParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPSummaryIPVersionParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryIPVersionParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPSummaryIPVersionParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPSummaryIPVersionParamsHTTPVersion] `query:"httpVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPSummaryIPVersionParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPSummaryIPVersionParamsBotClass) IsKnown() bool
type HTTPSummaryIPVersionParamsBrowserFamily ¶
type HTTPSummaryIPVersionParamsBrowserFamily string
const ( HTTPSummaryIPVersionParamsBrowserFamilyChrome HTTPSummaryIPVersionParamsBrowserFamily = "CHROME" HTTPSummaryIPVersionParamsBrowserFamilyEdge HTTPSummaryIPVersionParamsBrowserFamily = "EDGE" HTTPSummaryIPVersionParamsBrowserFamilyFirefox HTTPSummaryIPVersionParamsBrowserFamily = "FIREFOX" HTTPSummaryIPVersionParamsBrowserFamilySafari HTTPSummaryIPVersionParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryIPVersionParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryIPVersionParamsBrowserFamily) IsKnown() bool
type HTTPSummaryIPVersionParamsDeviceType ¶
type HTTPSummaryIPVersionParamsDeviceType string
const ( HTTPSummaryIPVersionParamsDeviceTypeDesktop HTTPSummaryIPVersionParamsDeviceType = "DESKTOP" HTTPSummaryIPVersionParamsDeviceTypeMobile HTTPSummaryIPVersionParamsDeviceType = "MOBILE" HTTPSummaryIPVersionParamsDeviceTypeOther HTTPSummaryIPVersionParamsDeviceType = "OTHER" )
func (HTTPSummaryIPVersionParamsDeviceType) IsKnown ¶
func (r HTTPSummaryIPVersionParamsDeviceType) IsKnown() bool
type HTTPSummaryIPVersionParamsFormat ¶
type HTTPSummaryIPVersionParamsFormat string
Format in which results will be returned.
const ( HTTPSummaryIPVersionParamsFormatJson HTTPSummaryIPVersionParamsFormat = "JSON" HTTPSummaryIPVersionParamsFormatCsv HTTPSummaryIPVersionParamsFormat = "CSV" )
func (HTTPSummaryIPVersionParamsFormat) IsKnown ¶
func (r HTTPSummaryIPVersionParamsFormat) IsKnown() bool
type HTTPSummaryIPVersionParamsHTTPProtocol ¶
type HTTPSummaryIPVersionParamsHTTPProtocol string
const ( HTTPSummaryIPVersionParamsHTTPProtocolHTTP HTTPSummaryIPVersionParamsHTTPProtocol = "HTTP" HTTPSummaryIPVersionParamsHTTPProtocolHTTPS HTTPSummaryIPVersionParamsHTTPProtocol = "HTTPS" )
func (HTTPSummaryIPVersionParamsHTTPProtocol) IsKnown ¶
func (r HTTPSummaryIPVersionParamsHTTPProtocol) IsKnown() bool
type HTTPSummaryIPVersionParamsHTTPVersion ¶
type HTTPSummaryIPVersionParamsHTTPVersion string
const ( HTTPSummaryIPVersionParamsHTTPVersionHttPv1 HTTPSummaryIPVersionParamsHTTPVersion = "HTTPv1" HTTPSummaryIPVersionParamsHTTPVersionHttPv2 HTTPSummaryIPVersionParamsHTTPVersion = "HTTPv2" HTTPSummaryIPVersionParamsHTTPVersionHttPv3 HTTPSummaryIPVersionParamsHTTPVersion = "HTTPv3" )
func (HTTPSummaryIPVersionParamsHTTPVersion) IsKnown ¶
func (r HTTPSummaryIPVersionParamsHTTPVersion) IsKnown() bool
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 ¶
func (r HTTPSummaryIPVersionParamsTLSVersion) IsKnown() bool
type HTTPSummaryIPVersionResponse ¶
type HTTPSummaryIPVersionResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryIPVersionResponseMetaUnit `json:"units,required"`
JSON httpSummaryIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryIPVersionResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryIPVersionResponseMetaConfidenceInfo ¶
type HTTPSummaryIPVersionResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPSummaryIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPSummaryIPVersionResponseMetaNormalization ¶
type HTTPSummaryIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryIPVersionResponseMetaNormalizationPercentage HTTPSummaryIPVersionResponseMetaNormalization = "PERCENTAGE" HTTPSummaryIPVersionResponseMetaNormalizationMin0Max HTTPSummaryIPVersionResponseMetaNormalization = "MIN0_MAX" HTTPSummaryIPVersionResponseMetaNormalizationMinMax HTTPSummaryIPVersionResponseMetaNormalization = "MIN_MAX" HTTPSummaryIPVersionResponseMetaNormalizationRawValues HTTPSummaryIPVersionResponseMetaNormalization = "RAW_VALUES" HTTPSummaryIPVersionResponseMetaNormalizationPercentageChange HTTPSummaryIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryIPVersionResponseMetaNormalizationRollingAverage HTTPSummaryIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryIPVersionResponseMetaNormalizationOverlappedPercentage HTTPSummaryIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryIPVersionResponseMetaNormalizationRatio HTTPSummaryIPVersionResponseMetaNormalization = "RATIO" )
func (HTTPSummaryIPVersionResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryIPVersionResponseMetaNormalization) IsKnown() bool
type HTTPSummaryIPVersionResponseMetaUnit ¶
type HTTPSummaryIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryIPVersionResponseSummary0 ¶
type HTTPSummaryIPVersionResponseSummary0 struct {
// A numeric string.
IPv4 string `json:"IPv4,required"`
// A numeric string.
IPv6 string `json:"IPv6,required"`
JSON httpSummaryIPVersionResponseSummary0JSON `json:"-"`
}
func (*HTTPSummaryIPVersionResponseSummary0) UnmarshalJSON ¶
func (r *HTTPSummaryIPVersionResponseSummary0) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryOSParams ¶
type HTTPSummaryOSParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPSummaryOSParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryOSParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPSummaryOSParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryOSParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPSummaryOSParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPSummaryOSParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPSummaryOSParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by 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 HTTPSummaryOSParamsBrowserFamily ¶
type HTTPSummaryOSParamsBrowserFamily string
const ( HTTPSummaryOSParamsBrowserFamilyChrome HTTPSummaryOSParamsBrowserFamily = "CHROME" HTTPSummaryOSParamsBrowserFamilyEdge HTTPSummaryOSParamsBrowserFamily = "EDGE" HTTPSummaryOSParamsBrowserFamilyFirefox HTTPSummaryOSParamsBrowserFamily = "FIREFOX" HTTPSummaryOSParamsBrowserFamilySafari HTTPSummaryOSParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryOSParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryOSParamsBrowserFamily) 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 in which results will be returned.
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 ¶
func (r HTTPSummaryOSParamsHTTPProtocol) IsKnown() bool
type HTTPSummaryOSParamsHTTPVersion ¶
type HTTPSummaryOSParamsHTTPVersion string
const ( HTTPSummaryOSParamsHTTPVersionHttPv1 HTTPSummaryOSParamsHTTPVersion = "HTTPv1" HTTPSummaryOSParamsHTTPVersionHttPv2 HTTPSummaryOSParamsHTTPVersion = "HTTPv2" HTTPSummaryOSParamsHTTPVersionHttPv3 HTTPSummaryOSParamsHTTPVersion = "HTTPv3" )
func (HTTPSummaryOSParamsHTTPVersion) IsKnown ¶
func (r HTTPSummaryOSParamsHTTPVersion) IsKnown() bool
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 {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryOSResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryOSResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryOSResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryOSResponseMetaUnit `json:"units,required"`
JSON httpSummaryOSResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryOSResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryOSResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryOSResponseMetaConfidenceInfo ¶
type HTTPSummaryOSResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryOSResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryOSResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPSummaryOSResponseMetaNormalization ¶
type HTTPSummaryOSResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryOSResponseMetaNormalizationPercentage HTTPSummaryOSResponseMetaNormalization = "PERCENTAGE" HTTPSummaryOSResponseMetaNormalizationMin0Max HTTPSummaryOSResponseMetaNormalization = "MIN0_MAX" HTTPSummaryOSResponseMetaNormalizationMinMax HTTPSummaryOSResponseMetaNormalization = "MIN_MAX" HTTPSummaryOSResponseMetaNormalizationRawValues HTTPSummaryOSResponseMetaNormalization = "RAW_VALUES" HTTPSummaryOSResponseMetaNormalizationPercentageChange HTTPSummaryOSResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryOSResponseMetaNormalizationRollingAverage HTTPSummaryOSResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryOSResponseMetaNormalizationOverlappedPercentage HTTPSummaryOSResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryOSResponseMetaNormalizationRatio HTTPSummaryOSResponseMetaNormalization = "RATIO" )
func (HTTPSummaryOSResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryOSResponseMetaNormalization) IsKnown() bool
type HTTPSummaryOSResponseMetaUnit ¶
type HTTPSummaryOSResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryOSResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryOSResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryOSResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryOSResponseSummary0 ¶
type HTTPSummaryOSResponseSummary0 struct {
// A numeric string.
Android string `json:"ANDROID,required"`
// A numeric string.
Ios string `json:"IOS,required"`
JSON httpSummaryOSResponseSummary0JSON `json:"-"`
}
func (*HTTPSummaryOSResponseSummary0) UnmarshalJSON ¶
func (r *HTTPSummaryOSResponseSummary0) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryPostQuantumParams ¶
type HTTPSummaryPostQuantumParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPSummaryPostQuantumParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryPostQuantumParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPSummaryPostQuantumParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryPostQuantumParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPSummaryPostQuantumParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPSummaryPostQuantumParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPSummaryPostQuantumParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPSummaryPostQuantumParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPSummaryPostQuantumParamsBotClass) IsKnown() bool
type HTTPSummaryPostQuantumParamsBrowserFamily ¶
type HTTPSummaryPostQuantumParamsBrowserFamily string
const ( HTTPSummaryPostQuantumParamsBrowserFamilyChrome HTTPSummaryPostQuantumParamsBrowserFamily = "CHROME" HTTPSummaryPostQuantumParamsBrowserFamilyEdge HTTPSummaryPostQuantumParamsBrowserFamily = "EDGE" HTTPSummaryPostQuantumParamsBrowserFamilyFirefox HTTPSummaryPostQuantumParamsBrowserFamily = "FIREFOX" HTTPSummaryPostQuantumParamsBrowserFamilySafari HTTPSummaryPostQuantumParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryPostQuantumParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryPostQuantumParamsBrowserFamily) IsKnown() bool
type HTTPSummaryPostQuantumParamsDeviceType ¶
type HTTPSummaryPostQuantumParamsDeviceType string
const ( HTTPSummaryPostQuantumParamsDeviceTypeDesktop HTTPSummaryPostQuantumParamsDeviceType = "DESKTOP" HTTPSummaryPostQuantumParamsDeviceTypeMobile HTTPSummaryPostQuantumParamsDeviceType = "MOBILE" HTTPSummaryPostQuantumParamsDeviceTypeOther HTTPSummaryPostQuantumParamsDeviceType = "OTHER" )
func (HTTPSummaryPostQuantumParamsDeviceType) IsKnown ¶
func (r HTTPSummaryPostQuantumParamsDeviceType) IsKnown() bool
type HTTPSummaryPostQuantumParamsFormat ¶
type HTTPSummaryPostQuantumParamsFormat string
Format in which results will be returned.
const ( HTTPSummaryPostQuantumParamsFormatJson HTTPSummaryPostQuantumParamsFormat = "JSON" HTTPSummaryPostQuantumParamsFormatCsv HTTPSummaryPostQuantumParamsFormat = "CSV" )
func (HTTPSummaryPostQuantumParamsFormat) IsKnown ¶
func (r HTTPSummaryPostQuantumParamsFormat) IsKnown() bool
type HTTPSummaryPostQuantumParamsHTTPProtocol ¶
type HTTPSummaryPostQuantumParamsHTTPProtocol string
const ( HTTPSummaryPostQuantumParamsHTTPProtocolHTTP HTTPSummaryPostQuantumParamsHTTPProtocol = "HTTP" HTTPSummaryPostQuantumParamsHTTPProtocolHTTPS HTTPSummaryPostQuantumParamsHTTPProtocol = "HTTPS" )
func (HTTPSummaryPostQuantumParamsHTTPProtocol) IsKnown ¶
func (r HTTPSummaryPostQuantumParamsHTTPProtocol) IsKnown() bool
type HTTPSummaryPostQuantumParamsHTTPVersion ¶
type HTTPSummaryPostQuantumParamsHTTPVersion string
const ( HTTPSummaryPostQuantumParamsHTTPVersionHttPv1 HTTPSummaryPostQuantumParamsHTTPVersion = "HTTPv1" HTTPSummaryPostQuantumParamsHTTPVersionHttPv2 HTTPSummaryPostQuantumParamsHTTPVersion = "HTTPv2" HTTPSummaryPostQuantumParamsHTTPVersionHttPv3 HTTPSummaryPostQuantumParamsHTTPVersion = "HTTPv3" )
func (HTTPSummaryPostQuantumParamsHTTPVersion) IsKnown ¶
func (r HTTPSummaryPostQuantumParamsHTTPVersion) IsKnown() bool
type HTTPSummaryPostQuantumParamsIPVersion ¶
type HTTPSummaryPostQuantumParamsIPVersion string
const ( HTTPSummaryPostQuantumParamsIPVersionIPv4 HTTPSummaryPostQuantumParamsIPVersion = "IPv4" HTTPSummaryPostQuantumParamsIPVersionIPv6 HTTPSummaryPostQuantumParamsIPVersion = "IPv6" )
func (HTTPSummaryPostQuantumParamsIPVersion) IsKnown ¶
func (r HTTPSummaryPostQuantumParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPSummaryPostQuantumParamsOS) IsKnown() bool
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 ¶
func (r HTTPSummaryPostQuantumParamsTLSVersion) IsKnown() bool
type HTTPSummaryPostQuantumResponse ¶
type HTTPSummaryPostQuantumResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryPostQuantumResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryPostQuantumResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryPostQuantumResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryPostQuantumResponseMetaUnit `json:"units,required"`
JSON httpSummaryPostQuantumResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryPostQuantumResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryPostQuantumResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryPostQuantumResponseMetaConfidenceInfo ¶
type HTTPSummaryPostQuantumResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryPostQuantumResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPSummaryPostQuantumResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPSummaryPostQuantumResponseMetaNormalization ¶
type HTTPSummaryPostQuantumResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryPostQuantumResponseMetaNormalizationPercentage HTTPSummaryPostQuantumResponseMetaNormalization = "PERCENTAGE" HTTPSummaryPostQuantumResponseMetaNormalizationMin0Max HTTPSummaryPostQuantumResponseMetaNormalization = "MIN0_MAX" HTTPSummaryPostQuantumResponseMetaNormalizationMinMax HTTPSummaryPostQuantumResponseMetaNormalization = "MIN_MAX" HTTPSummaryPostQuantumResponseMetaNormalizationRawValues HTTPSummaryPostQuantumResponseMetaNormalization = "RAW_VALUES" HTTPSummaryPostQuantumResponseMetaNormalizationPercentageChange HTTPSummaryPostQuantumResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryPostQuantumResponseMetaNormalizationRollingAverage HTTPSummaryPostQuantumResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryPostQuantumResponseMetaNormalizationOverlappedPercentage HTTPSummaryPostQuantumResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryPostQuantumResponseMetaNormalizationRatio HTTPSummaryPostQuantumResponseMetaNormalization = "RATIO" )
func (HTTPSummaryPostQuantumResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryPostQuantumResponseMetaNormalization) IsKnown() bool
type HTTPSummaryPostQuantumResponseMetaUnit ¶
type HTTPSummaryPostQuantumResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryPostQuantumResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryPostQuantumResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryPostQuantumResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryPostQuantumResponseSummary0 ¶
type HTTPSummaryPostQuantumResponseSummary0 struct {
// A numeric string.
NotSupported string `json:"NOT_SUPPORTED,required"`
// A numeric string.
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 ¶
func (r *HTTPSummaryService) BotClass(ctx context.Context, query HTTPSummaryBotClassParams, opts ...option.RequestOption) (res *HTTPSummaryBotClassResponse, err error)
Retrieves the distribution of bot-generated HTTP requests to genuine human traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.
func (*HTTPSummaryService) DeviceType ¶
func (r *HTTPSummaryService) DeviceType(ctx context.Context, query HTTPSummaryDeviceTypeParams, opts ...option.RequestOption) (res *HTTPSummaryDeviceTypeResponse, err error)
Retrieves the distribution of HTTP requests generated by mobile, desktop, and other types of devices.
func (*HTTPSummaryService) HTTPProtocol ¶
func (r *HTTPSummaryService) HTTPProtocol(ctx context.Context, query HTTPSummaryHTTPProtocolParams, opts ...option.RequestOption) (res *HTTPSummaryHTTPProtocolResponse, err error)
Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS).
func (*HTTPSummaryService) HTTPVersion ¶
func (r *HTTPSummaryService) HTTPVersion(ctx context.Context, query HTTPSummaryHTTPVersionParams, opts ...option.RequestOption) (res *HTTPSummaryHTTPVersionResponse, err error)
Retrieves the distribution of HTTP requests by HTTP version.
func (*HTTPSummaryService) IPVersion ¶
func (r *HTTPSummaryService) IPVersion(ctx context.Context, query HTTPSummaryIPVersionParams, opts ...option.RequestOption) (res *HTTPSummaryIPVersionResponse, err error)
Retrieves the distribution of HTTP requests by IP version.
func (*HTTPSummaryService) OS ¶
func (r *HTTPSummaryService) OS(ctx context.Context, query HTTPSummaryOSParams, opts ...option.RequestOption) (res *HTTPSummaryOSResponse, err error)
Retrieves the distribution of HTTP requests by operating system (Windows, macOS, Android, iOS, and others).
func (*HTTPSummaryService) PostQuantum ¶
func (r *HTTPSummaryService) PostQuantum(ctx context.Context, query HTTPSummaryPostQuantumParams, opts ...option.RequestOption) (res *HTTPSummaryPostQuantumResponse, err error)
Retrieves the distribution of HTTP requests by post-quantum support.
func (*HTTPSummaryService) TLSVersion ¶
func (r *HTTPSummaryService) TLSVersion(ctx context.Context, query HTTPSummaryTLSVersionParams, opts ...option.RequestOption) (res *HTTPSummaryTLSVersionResponse, err error)
Retrieves the distribution of HTTP requests by TLS version.
type HTTPSummaryTLSVersionParams ¶
type HTTPSummaryTLSVersionParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPSummaryTLSVersionParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPSummaryTLSVersionParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPSummaryTLSVersionParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPSummaryTLSVersionParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPSummaryTLSVersionParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPSummaryTLSVersionParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPSummaryTLSVersionParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
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 ¶
func (r HTTPSummaryTLSVersionParamsBotClass) IsKnown() bool
type HTTPSummaryTLSVersionParamsBrowserFamily ¶
type HTTPSummaryTLSVersionParamsBrowserFamily string
const ( HTTPSummaryTLSVersionParamsBrowserFamilyChrome HTTPSummaryTLSVersionParamsBrowserFamily = "CHROME" HTTPSummaryTLSVersionParamsBrowserFamilyEdge HTTPSummaryTLSVersionParamsBrowserFamily = "EDGE" HTTPSummaryTLSVersionParamsBrowserFamilyFirefox HTTPSummaryTLSVersionParamsBrowserFamily = "FIREFOX" HTTPSummaryTLSVersionParamsBrowserFamilySafari HTTPSummaryTLSVersionParamsBrowserFamily = "SAFARI" )
func (HTTPSummaryTLSVersionParamsBrowserFamily) IsKnown ¶
func (r HTTPSummaryTLSVersionParamsBrowserFamily) IsKnown() bool
type HTTPSummaryTLSVersionParamsDeviceType ¶
type HTTPSummaryTLSVersionParamsDeviceType string
const ( HTTPSummaryTLSVersionParamsDeviceTypeDesktop HTTPSummaryTLSVersionParamsDeviceType = "DESKTOP" HTTPSummaryTLSVersionParamsDeviceTypeMobile HTTPSummaryTLSVersionParamsDeviceType = "MOBILE" HTTPSummaryTLSVersionParamsDeviceTypeOther HTTPSummaryTLSVersionParamsDeviceType = "OTHER" )
func (HTTPSummaryTLSVersionParamsDeviceType) IsKnown ¶
func (r HTTPSummaryTLSVersionParamsDeviceType) IsKnown() bool
type HTTPSummaryTLSVersionParamsFormat ¶
type HTTPSummaryTLSVersionParamsFormat string
Format in which results will be returned.
const ( HTTPSummaryTLSVersionParamsFormatJson HTTPSummaryTLSVersionParamsFormat = "JSON" HTTPSummaryTLSVersionParamsFormatCsv HTTPSummaryTLSVersionParamsFormat = "CSV" )
func (HTTPSummaryTLSVersionParamsFormat) IsKnown ¶
func (r HTTPSummaryTLSVersionParamsFormat) IsKnown() bool
type HTTPSummaryTLSVersionParamsHTTPProtocol ¶
type HTTPSummaryTLSVersionParamsHTTPProtocol string
const ( HTTPSummaryTLSVersionParamsHTTPProtocolHTTP HTTPSummaryTLSVersionParamsHTTPProtocol = "HTTP" HTTPSummaryTLSVersionParamsHTTPProtocolHTTPS HTTPSummaryTLSVersionParamsHTTPProtocol = "HTTPS" )
func (HTTPSummaryTLSVersionParamsHTTPProtocol) IsKnown ¶
func (r HTTPSummaryTLSVersionParamsHTTPProtocol) IsKnown() bool
type HTTPSummaryTLSVersionParamsHTTPVersion ¶
type HTTPSummaryTLSVersionParamsHTTPVersion string
const ( HTTPSummaryTLSVersionParamsHTTPVersionHttPv1 HTTPSummaryTLSVersionParamsHTTPVersion = "HTTPv1" HTTPSummaryTLSVersionParamsHTTPVersionHttPv2 HTTPSummaryTLSVersionParamsHTTPVersion = "HTTPv2" HTTPSummaryTLSVersionParamsHTTPVersionHttPv3 HTTPSummaryTLSVersionParamsHTTPVersion = "HTTPv3" )
func (HTTPSummaryTLSVersionParamsHTTPVersion) IsKnown ¶
func (r HTTPSummaryTLSVersionParamsHTTPVersion) IsKnown() bool
type HTTPSummaryTLSVersionParamsIPVersion ¶
type HTTPSummaryTLSVersionParamsIPVersion string
const ( HTTPSummaryTLSVersionParamsIPVersionIPv4 HTTPSummaryTLSVersionParamsIPVersion = "IPv4" HTTPSummaryTLSVersionParamsIPVersionIPv6 HTTPSummaryTLSVersionParamsIPVersion = "IPv6" )
func (HTTPSummaryTLSVersionParamsIPVersion) IsKnown ¶
func (r HTTPSummaryTLSVersionParamsIPVersion) IsKnown() bool
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 {
// Metadata for the results.
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 {
ConfidenceInfo HTTPSummaryTLSVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPSummaryTLSVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPSummaryTLSVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPSummaryTLSVersionResponseMetaUnit `json:"units,required"`
JSON httpSummaryTLSVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPSummaryTLSVersionResponseMeta) UnmarshalJSON ¶
func (r *HTTPSummaryTLSVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryTLSVersionResponseMetaConfidenceInfo ¶
type HTTPSummaryTLSVersionResponseMetaConfidenceInfo struct {
Annotations []HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpSummaryTLSVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPSummaryTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPSummaryTLSVersionResponseMetaNormalization ¶
type HTTPSummaryTLSVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPSummaryTLSVersionResponseMetaNormalizationPercentage HTTPSummaryTLSVersionResponseMetaNormalization = "PERCENTAGE" HTTPSummaryTLSVersionResponseMetaNormalizationMin0Max HTTPSummaryTLSVersionResponseMetaNormalization = "MIN0_MAX" HTTPSummaryTLSVersionResponseMetaNormalizationMinMax HTTPSummaryTLSVersionResponseMetaNormalization = "MIN_MAX" HTTPSummaryTLSVersionResponseMetaNormalizationRawValues HTTPSummaryTLSVersionResponseMetaNormalization = "RAW_VALUES" HTTPSummaryTLSVersionResponseMetaNormalizationPercentageChange HTTPSummaryTLSVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPSummaryTLSVersionResponseMetaNormalizationRollingAverage HTTPSummaryTLSVersionResponseMetaNormalization = "ROLLING_AVERAGE" HTTPSummaryTLSVersionResponseMetaNormalizationOverlappedPercentage HTTPSummaryTLSVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPSummaryTLSVersionResponseMetaNormalizationRatio HTTPSummaryTLSVersionResponseMetaNormalization = "RATIO" )
func (HTTPSummaryTLSVersionResponseMetaNormalization) IsKnown ¶
func (r HTTPSummaryTLSVersionResponseMetaNormalization) IsKnown() bool
type HTTPSummaryTLSVersionResponseMetaUnit ¶
type HTTPSummaryTLSVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpSummaryTLSVersionResponseMetaUnitJSON `json:"-"`
}
func (*HTTPSummaryTLSVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPSummaryTLSVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPSummaryTLSVersionResponseSummary0 ¶
type HTTPSummaryTLSVersionResponseSummary0 struct {
// A numeric string.
TLS1_0 string `json:"TLS 1.0,required"`
// A numeric string.
TLS1_1 string `json:"TLS 1.1,required"`
// A numeric string.
TLS1_2 string `json:"TLS 1.2,required"`
// A numeric string.
TLS1_3 string `json:"TLS 1.3,required"`
// A numeric string.
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupBotClassParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupBotClassParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupBotClassParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupBotClassParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupBotClassParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupBotClassParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupBotClassParamsOS] `query:"os"`
// Filters results by 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 of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupBotClassParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupBotClassParamsBrowserFamily ¶
type HTTPTimeseriesGroupBotClassParamsBrowserFamily string
const ( HTTPTimeseriesGroupBotClassParamsBrowserFamilyChrome HTTPTimeseriesGroupBotClassParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupBotClassParamsBrowserFamilyEdge HTTPTimeseriesGroupBotClassParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupBotClassParamsBrowserFamilyFirefox HTTPTimeseriesGroupBotClassParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupBotClassParamsBrowserFamilySafari HTTPTimeseriesGroupBotClassParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupBotClassParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupBotClassParamsDeviceType ¶
type HTTPTimeseriesGroupBotClassParamsDeviceType string
const ( HTTPTimeseriesGroupBotClassParamsDeviceTypeDesktop HTTPTimeseriesGroupBotClassParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupBotClassParamsDeviceTypeMobile HTTPTimeseriesGroupBotClassParamsDeviceType = "MOBILE" HTTPTimeseriesGroupBotClassParamsDeviceTypeOther HTTPTimeseriesGroupBotClassParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupBotClassParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupBotClassParamsFormat ¶
type HTTPTimeseriesGroupBotClassParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupBotClassParamsFormatJson HTTPTimeseriesGroupBotClassParamsFormat = "JSON" HTTPTimeseriesGroupBotClassParamsFormatCsv HTTPTimeseriesGroupBotClassParamsFormat = "CSV" )
func (HTTPTimeseriesGroupBotClassParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupBotClassParamsHTTPProtocol ¶
type HTTPTimeseriesGroupBotClassParamsHTTPProtocol string
const ( HTTPTimeseriesGroupBotClassParamsHTTPProtocolHTTP HTTPTimeseriesGroupBotClassParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupBotClassParamsHTTPProtocolHTTPS HTTPTimeseriesGroupBotClassParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupBotClassParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupBotClassParamsHTTPVersion ¶
type HTTPTimeseriesGroupBotClassParamsHTTPVersion string
const ( HTTPTimeseriesGroupBotClassParamsHTTPVersionHttPv1 HTTPTimeseriesGroupBotClassParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupBotClassParamsHTTPVersionHttPv2 HTTPTimeseriesGroupBotClassParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupBotClassParamsHTTPVersionHttPv3 HTTPTimeseriesGroupBotClassParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupBotClassParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupBotClassParamsIPVersion ¶
type HTTPTimeseriesGroupBotClassParamsIPVersion string
const ( HTTPTimeseriesGroupBotClassParamsIPVersionIPv4 HTTPTimeseriesGroupBotClassParamsIPVersion = "IPv4" HTTPTimeseriesGroupBotClassParamsIPVersionIPv6 HTTPTimeseriesGroupBotClassParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupBotClassParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupBotClassParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupBotClassParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupBotClassResponse ¶
type HTTPTimeseriesGroupBotClassResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupBotClassResponseMeta `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 HTTPTimeseriesGroupBotClassResponseMeta ¶
type HTTPTimeseriesGroupBotClassResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupBotClassResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupBotClassResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupBotClassResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupBotClassResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupBotClassResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupBotClassResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBotClassResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBotClassResponseMetaAggInterval ¶
type HTTPTimeseriesGroupBotClassResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupBotClassResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupBotClassResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupBotClassResponseMetaAggIntervalOneHour HTTPTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupBotClassResponseMetaAggIntervalOneDay HTTPTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupBotClassResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupBotClassResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupBotClassResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupBotClassResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBotClassResponseMetaDateRange ¶
type HTTPTimeseriesGroupBotClassResponseMetaDateRange 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 httpTimeseriesGroupBotClassResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBotClassResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBotClassResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBotClassResponseMetaNormalization ¶
type HTTPTimeseriesGroupBotClassResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupBotClassResponseMetaNormalizationPercentage HTTPTimeseriesGroupBotClassResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupBotClassResponseMetaNormalizationMin0Max HTTPTimeseriesGroupBotClassResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupBotClassResponseMetaNormalizationMinMax HTTPTimeseriesGroupBotClassResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupBotClassResponseMetaNormalizationRawValues HTTPTimeseriesGroupBotClassResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupBotClassResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupBotClassResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupBotClassResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupBotClassResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupBotClassResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupBotClassResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupBotClassResponseMetaNormalizationRatio HTTPTimeseriesGroupBotClassResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupBotClassResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupBotClassResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupBotClassResponseMetaUnit ¶
type HTTPTimeseriesGroupBotClassResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupBotClassResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBotClassResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBotClassResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBotClassResponseSerie0 ¶
type HTTPTimeseriesGroupBotClassResponseSerie0 struct {
Bot []string `json:"bot,required"`
Human []string `json:"human,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON httpTimeseriesGroupBotClassResponseSerie0JSON `json:"-"`
}
func (*HTTPTimeseriesGroupBotClassResponseSerie0) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBotClassResponseSerie0) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserFamilyParams ¶
type HTTPTimeseriesGroupBrowserFamilyParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsBotClass] `query:"botClass"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupBrowserFamilyParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion] `query:"tlsVersion"`
}
func (HTTPTimeseriesGroupBrowserFamilyParams) URLQuery ¶
func (r HTTPTimeseriesGroupBrowserFamilyParams) URLQuery() (v url.Values)
URLQuery serializes HTTPTimeseriesGroupBrowserFamilyParams's query parameters as `url.Values`.
type HTTPTimeseriesGroupBrowserFamilyParamsAggInterval ¶
type HTTPTimeseriesGroupBrowserFamilyParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyParamsBotClass ¶
type HTTPTimeseriesGroupBrowserFamilyParamsBotClass string
const ( HTTPTimeseriesGroupBrowserFamilyParamsBotClassLikelyAutomated HTTPTimeseriesGroupBrowserFamilyParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupBrowserFamilyParamsBotClassLikelyHuman HTTPTimeseriesGroupBrowserFamilyParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupBrowserFamilyParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyParamsDeviceType ¶
type HTTPTimeseriesGroupBrowserFamilyParamsDeviceType string
const ( HTTPTimeseriesGroupBrowserFamilyParamsDeviceTypeDesktop HTTPTimeseriesGroupBrowserFamilyParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupBrowserFamilyParamsDeviceTypeMobile HTTPTimeseriesGroupBrowserFamilyParamsDeviceType = "MOBILE" HTTPTimeseriesGroupBrowserFamilyParamsDeviceTypeOther HTTPTimeseriesGroupBrowserFamilyParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupBrowserFamilyParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyParamsFormat ¶
type HTTPTimeseriesGroupBrowserFamilyParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupBrowserFamilyParamsFormatJson HTTPTimeseriesGroupBrowserFamilyParamsFormat = "JSON" HTTPTimeseriesGroupBrowserFamilyParamsFormatCsv HTTPTimeseriesGroupBrowserFamilyParamsFormat = "CSV" )
func (HTTPTimeseriesGroupBrowserFamilyParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol ¶
type HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol string
const ( HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocolHTTP HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocolHTTPS HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion ¶
type HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion string
const ( HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersionHttPv1 HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersionHttPv2 HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersionHttPv3 HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyParamsIPVersion ¶
type HTTPTimeseriesGroupBrowserFamilyParamsIPVersion string
const ( HTTPTimeseriesGroupBrowserFamilyParamsIPVersionIPv4 HTTPTimeseriesGroupBrowserFamilyParamsIPVersion = "IPv4" HTTPTimeseriesGroupBrowserFamilyParamsIPVersionIPv6 HTTPTimeseriesGroupBrowserFamilyParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupBrowserFamilyParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupBrowserFamilyParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyResponse ¶
type HTTPTimeseriesGroupBrowserFamilyResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupBrowserFamilyResponseMeta `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 HTTPTimeseriesGroupBrowserFamilyResponseMeta ¶
type HTTPTimeseriesGroupBrowserFamilyResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupBrowserFamilyResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupBrowserFamilyResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupBrowserFamilyResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupBrowserFamilyResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserFamilyResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval ¶
type HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupBrowserFamilyResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupBrowserFamilyResponseMetaAggIntervalOneHour HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupBrowserFamilyResponseMetaAggIntervalOneDay HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupBrowserFamilyResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupBrowserFamilyResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserFamilyResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserFamilyResponseMetaDateRange ¶
type HTTPTimeseriesGroupBrowserFamilyResponseMetaDateRange 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 httpTimeseriesGroupBrowserFamilyResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBrowserFamilyResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserFamilyResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization ¶
type HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationPercentage HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationMin0Max HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationMinMax HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationRawValues HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalizationRatio HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserFamilyResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupBrowserFamilyResponseMetaUnit ¶
type HTTPTimeseriesGroupBrowserFamilyResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupBrowserFamilyResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBrowserFamilyResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserFamilyResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserFamilyResponseSerie0 ¶
type HTTPTimeseriesGroupBrowserFamilyResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupBrowserParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupBrowserParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupBrowserParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupBrowserParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupBrowserParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupBrowserParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupBrowserParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects per group to the top items within the specified
// time range. When item count exceeds the limit, extra items appear grouped under
// an "other" category.
LimitPerGroup param.Field[int64] `query:"limitPerGroup"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupBrowserParamsOS] `query:"os"`
// Filters results by 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 of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupBrowserParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupBrowserParamsBotClass ¶
type HTTPTimeseriesGroupBrowserParamsBotClass string
const ( HTTPTimeseriesGroupBrowserParamsBotClassLikelyAutomated HTTPTimeseriesGroupBrowserParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupBrowserParamsBotClassLikelyHuman HTTPTimeseriesGroupBrowserParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupBrowserParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupBrowserParamsBrowserFamily ¶
type HTTPTimeseriesGroupBrowserParamsBrowserFamily string
const ( HTTPTimeseriesGroupBrowserParamsBrowserFamilyChrome HTTPTimeseriesGroupBrowserParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupBrowserParamsBrowserFamilyEdge HTTPTimeseriesGroupBrowserParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupBrowserParamsBrowserFamilyFirefox HTTPTimeseriesGroupBrowserParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupBrowserParamsBrowserFamilySafari HTTPTimeseriesGroupBrowserParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupBrowserParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupBrowserParamsDeviceType ¶
type HTTPTimeseriesGroupBrowserParamsDeviceType string
const ( HTTPTimeseriesGroupBrowserParamsDeviceTypeDesktop HTTPTimeseriesGroupBrowserParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupBrowserParamsDeviceTypeMobile HTTPTimeseriesGroupBrowserParamsDeviceType = "MOBILE" HTTPTimeseriesGroupBrowserParamsDeviceTypeOther HTTPTimeseriesGroupBrowserParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupBrowserParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupBrowserParamsFormat ¶
type HTTPTimeseriesGroupBrowserParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupBrowserParamsFormatJson HTTPTimeseriesGroupBrowserParamsFormat = "JSON" HTTPTimeseriesGroupBrowserParamsFormatCsv HTTPTimeseriesGroupBrowserParamsFormat = "CSV" )
func (HTTPTimeseriesGroupBrowserParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupBrowserParamsHTTPProtocol ¶
type HTTPTimeseriesGroupBrowserParamsHTTPProtocol string
const ( HTTPTimeseriesGroupBrowserParamsHTTPProtocolHTTP HTTPTimeseriesGroupBrowserParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupBrowserParamsHTTPProtocolHTTPS HTTPTimeseriesGroupBrowserParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupBrowserParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupBrowserParamsHTTPVersion ¶
type HTTPTimeseriesGroupBrowserParamsHTTPVersion string
const ( HTTPTimeseriesGroupBrowserParamsHTTPVersionHttPv1 HTTPTimeseriesGroupBrowserParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupBrowserParamsHTTPVersionHttPv2 HTTPTimeseriesGroupBrowserParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupBrowserParamsHTTPVersionHttPv3 HTTPTimeseriesGroupBrowserParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupBrowserParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupBrowserParamsIPVersion ¶
type HTTPTimeseriesGroupBrowserParamsIPVersion string
const ( HTTPTimeseriesGroupBrowserParamsIPVersionIPv4 HTTPTimeseriesGroupBrowserParamsIPVersion = "IPv4" HTTPTimeseriesGroupBrowserParamsIPVersionIPv6 HTTPTimeseriesGroupBrowserParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupBrowserParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupBrowserParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupBrowserParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupBrowserResponse ¶
type HTTPTimeseriesGroupBrowserResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupBrowserResponseMeta `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 HTTPTimeseriesGroupBrowserResponseMeta ¶
type HTTPTimeseriesGroupBrowserResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupBrowserResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupBrowserResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupBrowserResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupBrowserResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupBrowserResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupBrowserResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserResponseMetaAggInterval ¶
type HTTPTimeseriesGroupBrowserResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupBrowserResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupBrowserResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupBrowserResponseMetaAggIntervalOneHour HTTPTimeseriesGroupBrowserResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupBrowserResponseMetaAggIntervalOneDay HTTPTimeseriesGroupBrowserResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupBrowserResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupBrowserResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupBrowserResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupBrowserResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupBrowserResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupBrowserResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupBrowserResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserResponseMetaDateRange ¶
type HTTPTimeseriesGroupBrowserResponseMetaDateRange 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 httpTimeseriesGroupBrowserResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBrowserResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserResponseMetaNormalization ¶
type HTTPTimeseriesGroupBrowserResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupBrowserResponseMetaNormalizationPercentage HTTPTimeseriesGroupBrowserResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupBrowserResponseMetaNormalizationMin0Max HTTPTimeseriesGroupBrowserResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupBrowserResponseMetaNormalizationMinMax HTTPTimeseriesGroupBrowserResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupBrowserResponseMetaNormalizationRawValues HTTPTimeseriesGroupBrowserResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupBrowserResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupBrowserResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupBrowserResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupBrowserResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupBrowserResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupBrowserResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupBrowserResponseMetaNormalizationRatio HTTPTimeseriesGroupBrowserResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupBrowserResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupBrowserResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupBrowserResponseMetaUnit ¶
type HTTPTimeseriesGroupBrowserResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupBrowserResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupBrowserResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupBrowserResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupBrowserResponseSerie0 ¶
type HTTPTimeseriesGroupBrowserResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupDeviceTypeParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPTimeseriesGroupDeviceTypeParamsTLSVersion] `query:"tlsVersion"`
}
func (HTTPTimeseriesGroupDeviceTypeParams) URLQuery ¶
func (r HTTPTimeseriesGroupDeviceTypeParams) URLQuery() (v url.Values)
URLQuery serializes HTTPTimeseriesGroupDeviceTypeParams's query parameters as `url.Values`.
type HTTPTimeseriesGroupDeviceTypeParamsAggInterval ¶
type HTTPTimeseriesGroupDeviceTypeParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeParamsBotClass ¶
type HTTPTimeseriesGroupDeviceTypeParamsBotClass string
const ( HTTPTimeseriesGroupDeviceTypeParamsBotClassLikelyAutomated HTTPTimeseriesGroupDeviceTypeParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupDeviceTypeParamsBotClassLikelyHuman HTTPTimeseriesGroupDeviceTypeParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupDeviceTypeParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily ¶
type HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily string
const ( HTTPTimeseriesGroupDeviceTypeParamsBrowserFamilyChrome HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupDeviceTypeParamsBrowserFamilyEdge HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupDeviceTypeParamsBrowserFamilyFirefox HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupDeviceTypeParamsBrowserFamilySafari HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeParamsFormat ¶
type HTTPTimeseriesGroupDeviceTypeParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupDeviceTypeParamsFormatJson HTTPTimeseriesGroupDeviceTypeParamsFormat = "JSON" HTTPTimeseriesGroupDeviceTypeParamsFormatCsv HTTPTimeseriesGroupDeviceTypeParamsFormat = "CSV" )
func (HTTPTimeseriesGroupDeviceTypeParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol ¶
type HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol string
const ( HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocolHTTP HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocolHTTPS HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion ¶
type HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion string
const ( HTTPTimeseriesGroupDeviceTypeParamsHTTPVersionHttPv1 HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupDeviceTypeParamsHTTPVersionHttPv2 HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupDeviceTypeParamsHTTPVersionHttPv3 HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeParamsIPVersion ¶
type HTTPTimeseriesGroupDeviceTypeParamsIPVersion string
const ( HTTPTimeseriesGroupDeviceTypeParamsIPVersionIPv4 HTTPTimeseriesGroupDeviceTypeParamsIPVersion = "IPv4" HTTPTimeseriesGroupDeviceTypeParamsIPVersionIPv6 HTTPTimeseriesGroupDeviceTypeParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupDeviceTypeParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupDeviceTypeParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeResponse ¶
type HTTPTimeseriesGroupDeviceTypeResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupDeviceTypeResponseMeta `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 HTTPTimeseriesGroupDeviceTypeResponseMeta ¶
type HTTPTimeseriesGroupDeviceTypeResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupDeviceTypeResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupDeviceTypeResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupDeviceTypeResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupDeviceTypeResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupDeviceTypeResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval ¶
type HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupDeviceTypeResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupDeviceTypeResponseMetaAggIntervalOneHour HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupDeviceTypeResponseMetaAggIntervalOneDay HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupDeviceTypeResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupDeviceTypeResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupDeviceTypeResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupDeviceTypeResponseMetaDateRange ¶
type HTTPTimeseriesGroupDeviceTypeResponseMetaDateRange 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 httpTimeseriesGroupDeviceTypeResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupDeviceTypeResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupDeviceTypeResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization ¶
type HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationPercentage HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationMin0Max HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationMinMax HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationRawValues HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupDeviceTypeResponseMetaNormalizationRatio HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupDeviceTypeResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupDeviceTypeResponseMetaUnit ¶
type HTTPTimeseriesGroupDeviceTypeResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupDeviceTypeResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupDeviceTypeResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupDeviceTypeResponseMetaUnit) 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 []time.Time `json:"timestamps,required" format:"date-time"`
JSON httpTimeseriesGroupDeviceTypeResponseSerie0JSON `json:"-"`
}
func (*HTTPTimeseriesGroupDeviceTypeResponseSerie0) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupDeviceTypeResponseSerie0) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPProtocolParams ¶
type HTTPTimeseriesGroupHTTPProtocolParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupHTTPProtocolParamsFormat] `query:"format"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion] `query:"tlsVersion"`
}
func (HTTPTimeseriesGroupHTTPProtocolParams) URLQuery ¶
func (r HTTPTimeseriesGroupHTTPProtocolParams) URLQuery() (v url.Values)
URLQuery serializes HTTPTimeseriesGroupHTTPProtocolParams's query parameters as `url.Values`.
type HTTPTimeseriesGroupHTTPProtocolParamsAggInterval ¶
type HTTPTimeseriesGroupHTTPProtocolParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolParamsBotClass ¶
type HTTPTimeseriesGroupHTTPProtocolParamsBotClass string
const ( HTTPTimeseriesGroupHTTPProtocolParamsBotClassLikelyAutomated HTTPTimeseriesGroupHTTPProtocolParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupHTTPProtocolParamsBotClassLikelyHuman HTTPTimeseriesGroupHTTPProtocolParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupHTTPProtocolParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily ¶
type HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily string
const ( HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamilyChrome HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamilyEdge HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamilyFirefox HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamilySafari HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolParamsDeviceType ¶
type HTTPTimeseriesGroupHTTPProtocolParamsDeviceType string
const ( HTTPTimeseriesGroupHTTPProtocolParamsDeviceTypeDesktop HTTPTimeseriesGroupHTTPProtocolParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupHTTPProtocolParamsDeviceTypeMobile HTTPTimeseriesGroupHTTPProtocolParamsDeviceType = "MOBILE" HTTPTimeseriesGroupHTTPProtocolParamsDeviceTypeOther HTTPTimeseriesGroupHTTPProtocolParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupHTTPProtocolParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolParamsFormat ¶
type HTTPTimeseriesGroupHTTPProtocolParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupHTTPProtocolParamsFormatJson HTTPTimeseriesGroupHTTPProtocolParamsFormat = "JSON" HTTPTimeseriesGroupHTTPProtocolParamsFormatCsv HTTPTimeseriesGroupHTTPProtocolParamsFormat = "CSV" )
func (HTTPTimeseriesGroupHTTPProtocolParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion ¶
type HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion string
const ( HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersionHttPv1 HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersionHttPv2 HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersionHttPv3 HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolParamsIPVersion ¶
type HTTPTimeseriesGroupHTTPProtocolParamsIPVersion string
const ( HTTPTimeseriesGroupHTTPProtocolParamsIPVersionIPv4 HTTPTimeseriesGroupHTTPProtocolParamsIPVersion = "IPv4" HTTPTimeseriesGroupHTTPProtocolParamsIPVersionIPv6 HTTPTimeseriesGroupHTTPProtocolParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupHTTPProtocolParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupHTTPProtocolParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolResponse ¶
type HTTPTimeseriesGroupHTTPProtocolResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupHTTPProtocolResponseMeta `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 HTTPTimeseriesGroupHTTPProtocolResponseMeta ¶
type HTTPTimeseriesGroupHTTPProtocolResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupHTTPProtocolResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupHTTPProtocolResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupHTTPProtocolResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupHTTPProtocolResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPProtocolResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval ¶
type HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupHTTPProtocolResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupHTTPProtocolResponseMetaAggIntervalOneHour HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupHTTPProtocolResponseMetaAggIntervalOneDay HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupHTTPProtocolResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupHTTPProtocolResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPProtocolResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPProtocolResponseMetaDateRange ¶
type HTTPTimeseriesGroupHTTPProtocolResponseMetaDateRange 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 httpTimeseriesGroupHTTPProtocolResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPProtocolResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPProtocolResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization ¶
type HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationPercentage HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationMin0Max HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationMinMax HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationRawValues HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalizationRatio HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPProtocolResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupHTTPProtocolResponseMetaUnit ¶
type HTTPTimeseriesGroupHTTPProtocolResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupHTTPProtocolResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPProtocolResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPProtocolResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPProtocolResponseSerie0 ¶
type HTTPTimeseriesGroupHTTPProtocolResponseSerie0 struct {
HTTP []string `json:"http,required"`
HTTPS []string `json:"https,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON httpTimeseriesGroupHTTPProtocolResponseSerie0JSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPProtocolResponseSerie0) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPProtocolResponseSerie0) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPVersionParams ¶
type HTTPTimeseriesGroupHTTPVersionParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupHTTPVersionParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPTimeseriesGroupHTTPVersionParamsTLSVersion] `query:"tlsVersion"`
}
func (HTTPTimeseriesGroupHTTPVersionParams) URLQuery ¶
func (r HTTPTimeseriesGroupHTTPVersionParams) URLQuery() (v url.Values)
URLQuery serializes HTTPTimeseriesGroupHTTPVersionParams's query parameters as `url.Values`.
type HTTPTimeseriesGroupHTTPVersionParamsAggInterval ¶
type HTTPTimeseriesGroupHTTPVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionParamsBotClass ¶
type HTTPTimeseriesGroupHTTPVersionParamsBotClass string
const ( HTTPTimeseriesGroupHTTPVersionParamsBotClassLikelyAutomated HTTPTimeseriesGroupHTTPVersionParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupHTTPVersionParamsBotClassLikelyHuman HTTPTimeseriesGroupHTTPVersionParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupHTTPVersionParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily ¶
type HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily string
const ( HTTPTimeseriesGroupHTTPVersionParamsBrowserFamilyChrome HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupHTTPVersionParamsBrowserFamilyEdge HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupHTTPVersionParamsBrowserFamilyFirefox HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupHTTPVersionParamsBrowserFamilySafari HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionParamsDeviceType ¶
type HTTPTimeseriesGroupHTTPVersionParamsDeviceType string
const ( HTTPTimeseriesGroupHTTPVersionParamsDeviceTypeDesktop HTTPTimeseriesGroupHTTPVersionParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupHTTPVersionParamsDeviceTypeMobile HTTPTimeseriesGroupHTTPVersionParamsDeviceType = "MOBILE" HTTPTimeseriesGroupHTTPVersionParamsDeviceTypeOther HTTPTimeseriesGroupHTTPVersionParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupHTTPVersionParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionParamsFormat ¶
type HTTPTimeseriesGroupHTTPVersionParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupHTTPVersionParamsFormatJson HTTPTimeseriesGroupHTTPVersionParamsFormat = "JSON" HTTPTimeseriesGroupHTTPVersionParamsFormatCsv HTTPTimeseriesGroupHTTPVersionParamsFormat = "CSV" )
func (HTTPTimeseriesGroupHTTPVersionParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol ¶
type HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol string
const ( HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocolHTTP HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocolHTTPS HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionParamsIPVersion ¶
type HTTPTimeseriesGroupHTTPVersionParamsIPVersion string
const ( HTTPTimeseriesGroupHTTPVersionParamsIPVersionIPv4 HTTPTimeseriesGroupHTTPVersionParamsIPVersion = "IPv4" HTTPTimeseriesGroupHTTPVersionParamsIPVersionIPv6 HTTPTimeseriesGroupHTTPVersionParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupHTTPVersionParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupHTTPVersionParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionResponse ¶
type HTTPTimeseriesGroupHTTPVersionResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupHTTPVersionResponseMeta `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 HTTPTimeseriesGroupHTTPVersionResponseMeta ¶
type HTTPTimeseriesGroupHTTPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupHTTPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupHTTPVersionResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupHTTPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupHTTPVersionResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval ¶
type HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupHTTPVersionResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupHTTPVersionResponseMetaAggIntervalOneHour HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupHTTPVersionResponseMetaAggIntervalOneDay HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupHTTPVersionResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupHTTPVersionResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPVersionResponseMetaDateRange ¶
type HTTPTimeseriesGroupHTTPVersionResponseMetaDateRange 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 httpTimeseriesGroupHTTPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization ¶
type HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationPercentage HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationMin0Max HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationMinMax HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationRawValues HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupHTTPVersionResponseMetaNormalizationRatio HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupHTTPVersionResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupHTTPVersionResponseMetaUnit ¶
type HTTPTimeseriesGroupHTTPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupHTTPVersionResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPVersionResponseMetaUnit) 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 []time.Time `json:"timestamps,required" format:"date-time"`
JSON httpTimeseriesGroupHTTPVersionResponseSerie0JSON `json:"-"`
}
func (*HTTPTimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupHTTPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupIPVersionParams ¶
type HTTPTimeseriesGroupIPVersionParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupIPVersionParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupIPVersionParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupIPVersionParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupIPVersionParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupIPVersionParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupIPVersionParamsHTTPVersion] `query:"httpVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupIPVersionParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPTimeseriesGroupIPVersionParamsTLSVersion] `query:"tlsVersion"`
}
func (HTTPTimeseriesGroupIPVersionParams) URLQuery ¶
func (r HTTPTimeseriesGroupIPVersionParams) URLQuery() (v url.Values)
URLQuery serializes HTTPTimeseriesGroupIPVersionParams's query parameters as `url.Values`.
type HTTPTimeseriesGroupIPVersionParamsAggInterval ¶
type HTTPTimeseriesGroupIPVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupIPVersionParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupIPVersionParamsBotClass ¶
type HTTPTimeseriesGroupIPVersionParamsBotClass string
const ( HTTPTimeseriesGroupIPVersionParamsBotClassLikelyAutomated HTTPTimeseriesGroupIPVersionParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupIPVersionParamsBotClassLikelyHuman HTTPTimeseriesGroupIPVersionParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupIPVersionParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupIPVersionParamsBrowserFamily ¶
type HTTPTimeseriesGroupIPVersionParamsBrowserFamily string
const ( HTTPTimeseriesGroupIPVersionParamsBrowserFamilyChrome HTTPTimeseriesGroupIPVersionParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupIPVersionParamsBrowserFamilyEdge HTTPTimeseriesGroupIPVersionParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupIPVersionParamsBrowserFamilyFirefox HTTPTimeseriesGroupIPVersionParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupIPVersionParamsBrowserFamilySafari HTTPTimeseriesGroupIPVersionParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupIPVersionParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupIPVersionParamsDeviceType ¶
type HTTPTimeseriesGroupIPVersionParamsDeviceType string
const ( HTTPTimeseriesGroupIPVersionParamsDeviceTypeDesktop HTTPTimeseriesGroupIPVersionParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupIPVersionParamsDeviceTypeMobile HTTPTimeseriesGroupIPVersionParamsDeviceType = "MOBILE" HTTPTimeseriesGroupIPVersionParamsDeviceTypeOther HTTPTimeseriesGroupIPVersionParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupIPVersionParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupIPVersionParamsFormat ¶
type HTTPTimeseriesGroupIPVersionParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupIPVersionParamsFormatJson HTTPTimeseriesGroupIPVersionParamsFormat = "JSON" HTTPTimeseriesGroupIPVersionParamsFormatCsv HTTPTimeseriesGroupIPVersionParamsFormat = "CSV" )
func (HTTPTimeseriesGroupIPVersionParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupIPVersionParamsHTTPProtocol ¶
type HTTPTimeseriesGroupIPVersionParamsHTTPProtocol string
const ( HTTPTimeseriesGroupIPVersionParamsHTTPProtocolHTTP HTTPTimeseriesGroupIPVersionParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupIPVersionParamsHTTPProtocolHTTPS HTTPTimeseriesGroupIPVersionParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupIPVersionParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupIPVersionParamsHTTPVersion ¶
type HTTPTimeseriesGroupIPVersionParamsHTTPVersion string
const ( HTTPTimeseriesGroupIPVersionParamsHTTPVersionHttPv1 HTTPTimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupIPVersionParamsHTTPVersionHttPv2 HTTPTimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupIPVersionParamsHTTPVersionHttPv3 HTTPTimeseriesGroupIPVersionParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupIPVersionParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionParamsHTTPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupIPVersionParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupIPVersionParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupIPVersionResponse ¶
type HTTPTimeseriesGroupIPVersionResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupIPVersionResponseMeta `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 HTTPTimeseriesGroupIPVersionResponseMeta ¶
type HTTPTimeseriesGroupIPVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupIPVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupIPVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupIPVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupIPVersionResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupIPVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupIPVersionResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupIPVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupIPVersionResponseMetaAggInterval ¶
type HTTPTimeseriesGroupIPVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupIPVersionResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupIPVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupIPVersionResponseMetaAggIntervalOneHour HTTPTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupIPVersionResponseMetaAggIntervalOneDay HTTPTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupIPVersionResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupIPVersionResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupIPVersionResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupIPVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupIPVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupIPVersionResponseMetaDateRange ¶
type HTTPTimeseriesGroupIPVersionResponseMetaDateRange 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 httpTimeseriesGroupIPVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupIPVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupIPVersionResponseMetaNormalization ¶
type HTTPTimeseriesGroupIPVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupIPVersionResponseMetaNormalizationPercentage HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupIPVersionResponseMetaNormalizationMin0Max HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupIPVersionResponseMetaNormalizationMinMax HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupIPVersionResponseMetaNormalizationRawValues HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupIPVersionResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupIPVersionResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupIPVersionResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupIPVersionResponseMetaNormalizationRatio HTTPTimeseriesGroupIPVersionResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupIPVersionResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupIPVersionResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupIPVersionResponseMetaUnit ¶
type HTTPTimeseriesGroupIPVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupIPVersionResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupIPVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupIPVersionResponseSerie0 ¶
type HTTPTimeseriesGroupIPVersionResponseSerie0 struct {
IPv4 []string `json:"IPv4,required"`
IPv6 []string `json:"IPv6,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON httpTimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}
func (*HTTPTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupOSParams ¶
type HTTPTimeseriesGroupOSParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupOSParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupOSParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupOSParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupOSParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupOSParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupOSParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupOSParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by 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 of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupOSParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupOSParamsBotClass ¶
type HTTPTimeseriesGroupOSParamsBotClass string
const ( HTTPTimeseriesGroupOSParamsBotClassLikelyAutomated HTTPTimeseriesGroupOSParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupOSParamsBotClassLikelyHuman HTTPTimeseriesGroupOSParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupOSParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupOSParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupOSParamsBrowserFamily ¶
type HTTPTimeseriesGroupOSParamsBrowserFamily string
const ( HTTPTimeseriesGroupOSParamsBrowserFamilyChrome HTTPTimeseriesGroupOSParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupOSParamsBrowserFamilyEdge HTTPTimeseriesGroupOSParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupOSParamsBrowserFamilyFirefox HTTPTimeseriesGroupOSParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupOSParamsBrowserFamilySafari HTTPTimeseriesGroupOSParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupOSParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupOSParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupOSParamsDeviceType ¶
type HTTPTimeseriesGroupOSParamsDeviceType string
const ( HTTPTimeseriesGroupOSParamsDeviceTypeDesktop HTTPTimeseriesGroupOSParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupOSParamsDeviceTypeMobile HTTPTimeseriesGroupOSParamsDeviceType = "MOBILE" HTTPTimeseriesGroupOSParamsDeviceTypeOther HTTPTimeseriesGroupOSParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupOSParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupOSParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupOSParamsFormat ¶
type HTTPTimeseriesGroupOSParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupOSParamsFormatJson HTTPTimeseriesGroupOSParamsFormat = "JSON" HTTPTimeseriesGroupOSParamsFormatCsv HTTPTimeseriesGroupOSParamsFormat = "CSV" )
func (HTTPTimeseriesGroupOSParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupOSParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupOSParamsHTTPProtocol ¶
type HTTPTimeseriesGroupOSParamsHTTPProtocol string
const ( HTTPTimeseriesGroupOSParamsHTTPProtocolHTTP HTTPTimeseriesGroupOSParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupOSParamsHTTPProtocolHTTPS HTTPTimeseriesGroupOSParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupOSParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupOSParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupOSParamsHTTPVersion ¶
type HTTPTimeseriesGroupOSParamsHTTPVersion string
const ( HTTPTimeseriesGroupOSParamsHTTPVersionHttPv1 HTTPTimeseriesGroupOSParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupOSParamsHTTPVersionHttPv2 HTTPTimeseriesGroupOSParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupOSParamsHTTPVersionHttPv3 HTTPTimeseriesGroupOSParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupOSParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupOSParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupOSParamsIPVersion ¶
type HTTPTimeseriesGroupOSParamsIPVersion string
const ( HTTPTimeseriesGroupOSParamsIPVersionIPv4 HTTPTimeseriesGroupOSParamsIPVersion = "IPv4" HTTPTimeseriesGroupOSParamsIPVersionIPv6 HTTPTimeseriesGroupOSParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupOSParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupOSParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupOSParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupOSResponse ¶
type HTTPTimeseriesGroupOSResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupOSResponseMeta `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 HTTPTimeseriesGroupOSResponseMeta ¶
type HTTPTimeseriesGroupOSResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupOSResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupOSResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupOSResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupOSResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupOSResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupOSResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupOSResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupOSResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupOSResponseMetaAggInterval ¶
type HTTPTimeseriesGroupOSResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupOSResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupOSResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupOSResponseMetaAggIntervalOneHour HTTPTimeseriesGroupOSResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupOSResponseMetaAggIntervalOneDay HTTPTimeseriesGroupOSResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupOSResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupOSResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupOSResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupOSResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupOSResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupOSResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupOSResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupOSResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupOSResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupOSResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupOSResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupOSResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupOSResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupOSResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupOSResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupOSResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupOSResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupOSResponseMetaDateRange ¶
type HTTPTimeseriesGroupOSResponseMetaDateRange 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 httpTimeseriesGroupOSResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupOSResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupOSResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupOSResponseMetaNormalization ¶
type HTTPTimeseriesGroupOSResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupOSResponseMetaNormalizationPercentage HTTPTimeseriesGroupOSResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupOSResponseMetaNormalizationMin0Max HTTPTimeseriesGroupOSResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupOSResponseMetaNormalizationMinMax HTTPTimeseriesGroupOSResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupOSResponseMetaNormalizationRawValues HTTPTimeseriesGroupOSResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupOSResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupOSResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupOSResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupOSResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupOSResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupOSResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupOSResponseMetaNormalizationRatio HTTPTimeseriesGroupOSResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupOSResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupOSResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupOSResponseMetaUnit ¶
type HTTPTimeseriesGroupOSResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupOSResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupOSResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupOSResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupOSResponseSerie0 ¶
type HTTPTimeseriesGroupOSResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupPostQuantumParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupPostQuantumParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupPostQuantumParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupPostQuantumParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupPostQuantumParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupPostQuantumParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupPostQuantumParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPTimeseriesGroupPostQuantumParamsTLSVersion] `query:"tlsVersion"`
}
func (HTTPTimeseriesGroupPostQuantumParams) URLQuery ¶
func (r HTTPTimeseriesGroupPostQuantumParams) URLQuery() (v url.Values)
URLQuery serializes HTTPTimeseriesGroupPostQuantumParams's query parameters as `url.Values`.
type HTTPTimeseriesGroupPostQuantumParamsAggInterval ¶
type HTTPTimeseriesGroupPostQuantumParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupPostQuantumParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumParamsBotClass ¶
type HTTPTimeseriesGroupPostQuantumParamsBotClass string
const ( HTTPTimeseriesGroupPostQuantumParamsBotClassLikelyAutomated HTTPTimeseriesGroupPostQuantumParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupPostQuantumParamsBotClassLikelyHuman HTTPTimeseriesGroupPostQuantumParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupPostQuantumParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumParamsBrowserFamily ¶
type HTTPTimeseriesGroupPostQuantumParamsBrowserFamily string
const ( HTTPTimeseriesGroupPostQuantumParamsBrowserFamilyChrome HTTPTimeseriesGroupPostQuantumParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupPostQuantumParamsBrowserFamilyEdge HTTPTimeseriesGroupPostQuantumParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupPostQuantumParamsBrowserFamilyFirefox HTTPTimeseriesGroupPostQuantumParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupPostQuantumParamsBrowserFamilySafari HTTPTimeseriesGroupPostQuantumParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupPostQuantumParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumParamsDeviceType ¶
type HTTPTimeseriesGroupPostQuantumParamsDeviceType string
const ( HTTPTimeseriesGroupPostQuantumParamsDeviceTypeDesktop HTTPTimeseriesGroupPostQuantumParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupPostQuantumParamsDeviceTypeMobile HTTPTimeseriesGroupPostQuantumParamsDeviceType = "MOBILE" HTTPTimeseriesGroupPostQuantumParamsDeviceTypeOther HTTPTimeseriesGroupPostQuantumParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupPostQuantumParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumParamsFormat ¶
type HTTPTimeseriesGroupPostQuantumParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupPostQuantumParamsFormatJson HTTPTimeseriesGroupPostQuantumParamsFormat = "JSON" HTTPTimeseriesGroupPostQuantumParamsFormatCsv HTTPTimeseriesGroupPostQuantumParamsFormat = "CSV" )
func (HTTPTimeseriesGroupPostQuantumParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol ¶
type HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol string
const ( HTTPTimeseriesGroupPostQuantumParamsHTTPProtocolHTTP HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupPostQuantumParamsHTTPProtocolHTTPS HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumParamsHTTPVersion ¶
type HTTPTimeseriesGroupPostQuantumParamsHTTPVersion string
const ( HTTPTimeseriesGroupPostQuantumParamsHTTPVersionHttPv1 HTTPTimeseriesGroupPostQuantumParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupPostQuantumParamsHTTPVersionHttPv2 HTTPTimeseriesGroupPostQuantumParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupPostQuantumParamsHTTPVersionHttPv3 HTTPTimeseriesGroupPostQuantumParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupPostQuantumParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumParamsIPVersion ¶
type HTTPTimeseriesGroupPostQuantumParamsIPVersion string
const ( HTTPTimeseriesGroupPostQuantumParamsIPVersionIPv4 HTTPTimeseriesGroupPostQuantumParamsIPVersion = "IPv4" HTTPTimeseriesGroupPostQuantumParamsIPVersionIPv6 HTTPTimeseriesGroupPostQuantumParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupPostQuantumParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupPostQuantumParamsOS) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupPostQuantumParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumResponse ¶
type HTTPTimeseriesGroupPostQuantumResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupPostQuantumResponseMeta `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 HTTPTimeseriesGroupPostQuantumResponseMeta ¶
type HTTPTimeseriesGroupPostQuantumResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupPostQuantumResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupPostQuantumResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupPostQuantumResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupPostQuantumResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupPostQuantumResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupPostQuantumResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval ¶
type HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupPostQuantumResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupPostQuantumResponseMetaAggIntervalOneHour HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupPostQuantumResponseMetaAggIntervalOneDay HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupPostQuantumResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupPostQuantumResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupPostQuantumResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupPostQuantumResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupPostQuantumResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupPostQuantumResponseMetaDateRange ¶
type HTTPTimeseriesGroupPostQuantumResponseMetaDateRange 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 httpTimeseriesGroupPostQuantumResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupPostQuantumResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupPostQuantumResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupPostQuantumResponseMetaNormalization ¶
type HTTPTimeseriesGroupPostQuantumResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationPercentage HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationMin0Max HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationMinMax HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationRawValues HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupPostQuantumResponseMetaNormalizationRatio HTTPTimeseriesGroupPostQuantumResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupPostQuantumResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupPostQuantumResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupPostQuantumResponseMetaUnit ¶
type HTTPTimeseriesGroupPostQuantumResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupPostQuantumResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupPostQuantumResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupPostQuantumResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupPostQuantumResponseSerie0 ¶
type HTTPTimeseriesGroupPostQuantumResponseSerie0 struct {
NotSupported []string `json:"NOT_SUPPORTED,required"`
Supported []string `json:"SUPPORTED,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 ¶
func (r *HTTPTimeseriesGroupService) BotClass(ctx context.Context, query HTTPTimeseriesGroupBotClassParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupBotClassResponse, err error)
Retrieves the distribution of HTTP requests classified as automated or human over time. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information.
func (*HTTPTimeseriesGroupService) Browser ¶
func (r *HTTPTimeseriesGroupService) Browser(ctx context.Context, query HTTPTimeseriesGroupBrowserParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupBrowserResponse, err error)
Retrieves the distribution of HTTP requests by user agent over time.
func (*HTTPTimeseriesGroupService) BrowserFamily ¶
func (r *HTTPTimeseriesGroupService) BrowserFamily(ctx context.Context, query HTTPTimeseriesGroupBrowserFamilyParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupBrowserFamilyResponse, err error)
Retrieves the distribution of HTTP requests by user agent family over time.
func (*HTTPTimeseriesGroupService) DeviceType ¶
func (r *HTTPTimeseriesGroupService) DeviceType(ctx context.Context, query HTTPTimeseriesGroupDeviceTypeParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupDeviceTypeResponse, err error)
Retrieves the distribution of HTTP requests by device type over time.
func (*HTTPTimeseriesGroupService) HTTPProtocol ¶
func (r *HTTPTimeseriesGroupService) HTTPProtocol(ctx context.Context, query HTTPTimeseriesGroupHTTPProtocolParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupHTTPProtocolResponse, err error)
Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. HTTPS) over time.
func (*HTTPTimeseriesGroupService) HTTPVersion ¶
func (r *HTTPTimeseriesGroupService) HTTPVersion(ctx context.Context, query HTTPTimeseriesGroupHTTPVersionParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupHTTPVersionResponse, err error)
Retrieves the distribution of HTTP requests by HTTP version over time.
func (*HTTPTimeseriesGroupService) IPVersion ¶
func (r *HTTPTimeseriesGroupService) IPVersion(ctx context.Context, query HTTPTimeseriesGroupIPVersionParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupIPVersionResponse, err error)
Retrieves the distribution of HTTP requests by IP version over time.
func (*HTTPTimeseriesGroupService) OS ¶
func (r *HTTPTimeseriesGroupService) OS(ctx context.Context, query HTTPTimeseriesGroupOSParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupOSResponse, err error)
Retrieves the distribution of HTTP requests by operating system over time.
func (*HTTPTimeseriesGroupService) PostQuantum ¶
func (r *HTTPTimeseriesGroupService) PostQuantum(ctx context.Context, query HTTPTimeseriesGroupPostQuantumParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupPostQuantumResponse, err error)
Retrieves the distribution of HTTP requests by post-quantum support over time.
func (*HTTPTimeseriesGroupService) TLSVersion ¶
func (r *HTTPTimeseriesGroupService) TLSVersion(ctx context.Context, query HTTPTimeseriesGroupTLSVersionParams, opts ...option.RequestOption) (res *HTTPTimeseriesGroupTLSVersionResponse, err error)
Retrieves the distribution of HTTP requests by TLS version over time.
type HTTPTimeseriesGroupTLSVersionParams ¶
type HTTPTimeseriesGroupTLSVersionParams struct {
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesGroupTLSVersionParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesGroupTLSVersionParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesGroupTLSVersionParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesGroupTLSVersionParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesGroupTLSVersionParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesGroupTLSVersionParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesGroupTLSVersionParamsOS] `query:"os"`
}
func (HTTPTimeseriesGroupTLSVersionParams) URLQuery ¶
func (r HTTPTimeseriesGroupTLSVersionParams) URLQuery() (v url.Values)
URLQuery serializes HTTPTimeseriesGroupTLSVersionParams's query parameters as `url.Values`.
type HTTPTimeseriesGroupTLSVersionParamsAggInterval ¶
type HTTPTimeseriesGroupTLSVersionParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r HTTPTimeseriesGroupTLSVersionParamsAggInterval) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionParamsBotClass ¶
type HTTPTimeseriesGroupTLSVersionParamsBotClass string
const ( HTTPTimeseriesGroupTLSVersionParamsBotClassLikelyAutomated HTTPTimeseriesGroupTLSVersionParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesGroupTLSVersionParamsBotClassLikelyHuman HTTPTimeseriesGroupTLSVersionParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesGroupTLSVersionParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionParamsBotClass) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionParamsBrowserFamily ¶
type HTTPTimeseriesGroupTLSVersionParamsBrowserFamily string
const ( HTTPTimeseriesGroupTLSVersionParamsBrowserFamilyChrome HTTPTimeseriesGroupTLSVersionParamsBrowserFamily = "CHROME" HTTPTimeseriesGroupTLSVersionParamsBrowserFamilyEdge HTTPTimeseriesGroupTLSVersionParamsBrowserFamily = "EDGE" HTTPTimeseriesGroupTLSVersionParamsBrowserFamilyFirefox HTTPTimeseriesGroupTLSVersionParamsBrowserFamily = "FIREFOX" HTTPTimeseriesGroupTLSVersionParamsBrowserFamilySafari HTTPTimeseriesGroupTLSVersionParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesGroupTLSVersionParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionParamsDeviceType ¶
type HTTPTimeseriesGroupTLSVersionParamsDeviceType string
const ( HTTPTimeseriesGroupTLSVersionParamsDeviceTypeDesktop HTTPTimeseriesGroupTLSVersionParamsDeviceType = "DESKTOP" HTTPTimeseriesGroupTLSVersionParamsDeviceTypeMobile HTTPTimeseriesGroupTLSVersionParamsDeviceType = "MOBILE" HTTPTimeseriesGroupTLSVersionParamsDeviceTypeOther HTTPTimeseriesGroupTLSVersionParamsDeviceType = "OTHER" )
func (HTTPTimeseriesGroupTLSVersionParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionParamsDeviceType) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionParamsFormat ¶
type HTTPTimeseriesGroupTLSVersionParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesGroupTLSVersionParamsFormatJson HTTPTimeseriesGroupTLSVersionParamsFormat = "JSON" HTTPTimeseriesGroupTLSVersionParamsFormatCsv HTTPTimeseriesGroupTLSVersionParamsFormat = "CSV" )
func (HTTPTimeseriesGroupTLSVersionParamsFormat) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionParamsFormat) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol ¶
type HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol string
const ( HTTPTimeseriesGroupTLSVersionParamsHTTPProtocolHTTP HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol = "HTTP" HTTPTimeseriesGroupTLSVersionParamsHTTPProtocolHTTPS HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionParamsHTTPVersion ¶
type HTTPTimeseriesGroupTLSVersionParamsHTTPVersion string
const ( HTTPTimeseriesGroupTLSVersionParamsHTTPVersionHttPv1 HTTPTimeseriesGroupTLSVersionParamsHTTPVersion = "HTTPv1" HTTPTimeseriesGroupTLSVersionParamsHTTPVersionHttPv2 HTTPTimeseriesGroupTLSVersionParamsHTTPVersion = "HTTPv2" HTTPTimeseriesGroupTLSVersionParamsHTTPVersionHttPv3 HTTPTimeseriesGroupTLSVersionParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesGroupTLSVersionParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionParamsIPVersion ¶
type HTTPTimeseriesGroupTLSVersionParamsIPVersion string
const ( HTTPTimeseriesGroupTLSVersionParamsIPVersionIPv4 HTTPTimeseriesGroupTLSVersionParamsIPVersion = "IPv4" HTTPTimeseriesGroupTLSVersionParamsIPVersionIPv6 HTTPTimeseriesGroupTLSVersionParamsIPVersion = "IPv6" )
func (HTTPTimeseriesGroupTLSVersionParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTimeseriesGroupTLSVersionParamsOS) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionResponse ¶
type HTTPTimeseriesGroupTLSVersionResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesGroupTLSVersionResponseMeta `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 HTTPTimeseriesGroupTLSVersionResponseMeta ¶
type HTTPTimeseriesGroupTLSVersionResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesGroupTLSVersionResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesGroupTLSVersionResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesGroupTLSVersionResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesGroupTLSVersionResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesGroupTLSVersionResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupTLSVersionResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval ¶
type HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesGroupTLSVersionResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesGroupTLSVersionResponseMetaAggIntervalOneHour HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesGroupTLSVersionResponseMetaAggIntervalOneDay HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesGroupTLSVersionResponseMetaAggIntervalOneWeek HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesGroupTLSVersionResponseMetaAggIntervalOneMonth HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfo ¶
type HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON httpTimeseriesGroupTLSVersionResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation ¶
type HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupTLSVersionResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupTLSVersionResponseMetaDateRange ¶
type HTTPTimeseriesGroupTLSVersionResponseMetaDateRange 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 httpTimeseriesGroupTLSVersionResponseMetaDateRangeJSON `json:"-"`
}
func (*HTTPTimeseriesGroupTLSVersionResponseMetaDateRange) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupTLSVersionResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupTLSVersionResponseMetaNormalization ¶
type HTTPTimeseriesGroupTLSVersionResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationPercentage HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationMin0Max HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationMinMax HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationRawValues HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationPercentageChange HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationRollingAverage HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesGroupTLSVersionResponseMetaNormalizationRatio HTTPTimeseriesGroupTLSVersionResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesGroupTLSVersionResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesGroupTLSVersionResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesGroupTLSVersionResponseMetaUnit ¶
type HTTPTimeseriesGroupTLSVersionResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesGroupTLSVersionResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesGroupTLSVersionResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesGroupTLSVersionResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesGroupTLSVersionResponseSerie0 ¶
type HTTPTimeseriesGroupTLSVersionResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTimeseriesParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTimeseriesParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTimeseriesParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTimeseriesParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTimeseriesParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTimeseriesParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTimeseriesParamsIPVersion] `query:"ipVersion"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[HTTPTimeseriesParamsNormalization] `query:"normalization"`
// Filters results by operating system.
OS param.Field[[]HTTPTimeseriesParamsOS] `query:"os"`
// Filters results by TLS version.
TLSVersion param.Field[[]HTTPTimeseriesParamsTLSVersion] `query:"tlsVersion"`
}
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 of the results (e.g., 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 ¶
func (r HTTPTimeseriesParamsAggInterval) IsKnown() bool
type HTTPTimeseriesParamsBotClass ¶
type HTTPTimeseriesParamsBotClass string
const ( HTTPTimeseriesParamsBotClassLikelyAutomated HTTPTimeseriesParamsBotClass = "LIKELY_AUTOMATED" HTTPTimeseriesParamsBotClassLikelyHuman HTTPTimeseriesParamsBotClass = "LIKELY_HUMAN" )
func (HTTPTimeseriesParamsBotClass) IsKnown ¶
func (r HTTPTimeseriesParamsBotClass) IsKnown() bool
type HTTPTimeseriesParamsBrowserFamily ¶
type HTTPTimeseriesParamsBrowserFamily string
const ( HTTPTimeseriesParamsBrowserFamilyChrome HTTPTimeseriesParamsBrowserFamily = "CHROME" HTTPTimeseriesParamsBrowserFamilyEdge HTTPTimeseriesParamsBrowserFamily = "EDGE" HTTPTimeseriesParamsBrowserFamilyFirefox HTTPTimeseriesParamsBrowserFamily = "FIREFOX" HTTPTimeseriesParamsBrowserFamilySafari HTTPTimeseriesParamsBrowserFamily = "SAFARI" )
func (HTTPTimeseriesParamsBrowserFamily) IsKnown ¶
func (r HTTPTimeseriesParamsBrowserFamily) IsKnown() bool
type HTTPTimeseriesParamsDeviceType ¶
type HTTPTimeseriesParamsDeviceType string
const ( HTTPTimeseriesParamsDeviceTypeDesktop HTTPTimeseriesParamsDeviceType = "DESKTOP" HTTPTimeseriesParamsDeviceTypeMobile HTTPTimeseriesParamsDeviceType = "MOBILE" HTTPTimeseriesParamsDeviceTypeOther HTTPTimeseriesParamsDeviceType = "OTHER" )
func (HTTPTimeseriesParamsDeviceType) IsKnown ¶
func (r HTTPTimeseriesParamsDeviceType) IsKnown() bool
type HTTPTimeseriesParamsFormat ¶
type HTTPTimeseriesParamsFormat string
Format in which results will be returned.
const ( HTTPTimeseriesParamsFormatJson HTTPTimeseriesParamsFormat = "JSON" HTTPTimeseriesParamsFormatCsv HTTPTimeseriesParamsFormat = "CSV" )
func (HTTPTimeseriesParamsFormat) IsKnown ¶
func (r HTTPTimeseriesParamsFormat) IsKnown() bool
type HTTPTimeseriesParamsHTTPProtocol ¶
type HTTPTimeseriesParamsHTTPProtocol string
const ( HTTPTimeseriesParamsHTTPProtocolHTTP HTTPTimeseriesParamsHTTPProtocol = "HTTP" HTTPTimeseriesParamsHTTPProtocolHTTPS HTTPTimeseriesParamsHTTPProtocol = "HTTPS" )
func (HTTPTimeseriesParamsHTTPProtocol) IsKnown ¶
func (r HTTPTimeseriesParamsHTTPProtocol) IsKnown() bool
type HTTPTimeseriesParamsHTTPVersion ¶
type HTTPTimeseriesParamsHTTPVersion string
const ( HTTPTimeseriesParamsHTTPVersionHttPv1 HTTPTimeseriesParamsHTTPVersion = "HTTPv1" HTTPTimeseriesParamsHTTPVersionHttPv2 HTTPTimeseriesParamsHTTPVersion = "HTTPv2" HTTPTimeseriesParamsHTTPVersionHttPv3 HTTPTimeseriesParamsHTTPVersion = "HTTPv3" )
func (HTTPTimeseriesParamsHTTPVersion) IsKnown ¶
func (r HTTPTimeseriesParamsHTTPVersion) IsKnown() bool
type HTTPTimeseriesParamsIPVersion ¶
type HTTPTimeseriesParamsIPVersion string
const ( HTTPTimeseriesParamsIPVersionIPv4 HTTPTimeseriesParamsIPVersion = "IPv4" HTTPTimeseriesParamsIPVersionIPv6 HTTPTimeseriesParamsIPVersion = "IPv6" )
func (HTTPTimeseriesParamsIPVersion) IsKnown ¶
func (r HTTPTimeseriesParamsIPVersion) IsKnown() bool
type HTTPTimeseriesParamsNormalization ¶
type HTTPTimeseriesParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesParamsNormalizationPercentageChange HTTPTimeseriesParamsNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesParamsNormalizationMin0Max HTTPTimeseriesParamsNormalization = "MIN0_MAX" )
func (HTTPTimeseriesParamsNormalization) IsKnown ¶
func (r HTTPTimeseriesParamsNormalization) IsKnown() bool
type HTTPTimeseriesParamsOS ¶
type HTTPTimeseriesParamsOS string
const ( HTTPTimeseriesParamsOSWindows HTTPTimeseriesParamsOS = "WINDOWS" HTTPTimeseriesParamsOSMacosx HTTPTimeseriesParamsOS = "MACOSX" HTTPTimeseriesParamsOSIos HTTPTimeseriesParamsOS = "IOS" HTTPTimeseriesParamsOSAndroid HTTPTimeseriesParamsOS = "ANDROID" HTTPTimeseriesParamsOSChromeos HTTPTimeseriesParamsOS = "CHROMEOS" HTTPTimeseriesParamsOSLinux HTTPTimeseriesParamsOS = "LINUX" HTTPTimeseriesParamsOSSmartTv HTTPTimeseriesParamsOS = "SMART_TV" )
func (HTTPTimeseriesParamsOS) IsKnown ¶
func (r HTTPTimeseriesParamsOS) IsKnown() bool
type HTTPTimeseriesParamsTLSVersion ¶
type HTTPTimeseriesParamsTLSVersion string
const ( HTTPTimeseriesParamsTLSVersionTlSv1_0 HTTPTimeseriesParamsTLSVersion = "TLSv1_0" HTTPTimeseriesParamsTLSVersionTlSv1_1 HTTPTimeseriesParamsTLSVersion = "TLSv1_1" HTTPTimeseriesParamsTLSVersionTlSv1_2 HTTPTimeseriesParamsTLSVersion = "TLSv1_2" HTTPTimeseriesParamsTLSVersionTlSv1_3 HTTPTimeseriesParamsTLSVersion = "TLSv1_3" HTTPTimeseriesParamsTLSVersionTlSvQuic HTTPTimeseriesParamsTLSVersion = "TLSvQUIC" )
func (HTTPTimeseriesParamsTLSVersion) IsKnown ¶
func (r HTTPTimeseriesParamsTLSVersion) IsKnown() bool
type HTTPTimeseriesResponse ¶
type HTTPTimeseriesResponse struct {
// Metadata for the results.
Meta HTTPTimeseriesResponseMeta `json:"meta,required"`
ExtraFields map[string]HTTPTimeseriesResponse `json:"-,extras"`
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 {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval HTTPTimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo HTTPTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []HTTPTimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTimeseriesResponseMetaUnit `json:"units,required"`
JSON httpTimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTimeseriesResponseMeta) UnmarshalJSON ¶
func (r *HTTPTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTimeseriesResponseMetaAggInterval ¶
type HTTPTimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( HTTPTimeseriesResponseMetaAggIntervalFifteenMinutes HTTPTimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" HTTPTimeseriesResponseMetaAggIntervalOneHour HTTPTimeseriesResponseMetaAggInterval = "ONE_HOUR" HTTPTimeseriesResponseMetaAggIntervalOneDay HTTPTimeseriesResponseMetaAggInterval = "ONE_DAY" HTTPTimeseriesResponseMetaAggIntervalOneWeek HTTPTimeseriesResponseMetaAggInterval = "ONE_WEEK" HTTPTimeseriesResponseMetaAggIntervalOneMonth HTTPTimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (HTTPTimeseriesResponseMetaAggInterval) IsKnown ¶
func (r HTTPTimeseriesResponseMetaAggInterval) IsKnown() bool
type HTTPTimeseriesResponseMetaConfidenceInfo ¶
type HTTPTimeseriesResponseMetaConfidenceInfo struct {
Annotations []HTTPTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPTimeseriesResponseMetaNormalization ¶
type HTTPTimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTimeseriesResponseMetaNormalizationPercentage HTTPTimeseriesResponseMetaNormalization = "PERCENTAGE" HTTPTimeseriesResponseMetaNormalizationMin0Max HTTPTimeseriesResponseMetaNormalization = "MIN0_MAX" HTTPTimeseriesResponseMetaNormalizationMinMax HTTPTimeseriesResponseMetaNormalization = "MIN_MAX" HTTPTimeseriesResponseMetaNormalizationRawValues HTTPTimeseriesResponseMetaNormalization = "RAW_VALUES" HTTPTimeseriesResponseMetaNormalizationPercentageChange HTTPTimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTimeseriesResponseMetaNormalizationRollingAverage HTTPTimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTimeseriesResponseMetaNormalizationOverlappedPercentage HTTPTimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTimeseriesResponseMetaNormalizationRatio HTTPTimeseriesResponseMetaNormalization = "RATIO" )
func (HTTPTimeseriesResponseMetaNormalization) IsKnown ¶
func (r HTTPTimeseriesResponseMetaNormalization) IsKnown() bool
type HTTPTimeseriesResponseMetaUnit ¶
type HTTPTimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTimeseriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type HTTPTopBrowserFamilyParams ¶
type HTTPTopBrowserFamilyParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTopBrowserFamilyParamsBotClass] `query:"botClass"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTopBrowserFamilyParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTopBrowserFamilyParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTopBrowserFamilyParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTopBrowserFamilyParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTopBrowserFamilyParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTopBrowserFamilyParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPTopBrowserFamilyParamsBotClass) IsKnown() bool
type HTTPTopBrowserFamilyParamsDeviceType ¶
type HTTPTopBrowserFamilyParamsDeviceType string
const ( HTTPTopBrowserFamilyParamsDeviceTypeDesktop HTTPTopBrowserFamilyParamsDeviceType = "DESKTOP" HTTPTopBrowserFamilyParamsDeviceTypeMobile HTTPTopBrowserFamilyParamsDeviceType = "MOBILE" HTTPTopBrowserFamilyParamsDeviceTypeOther HTTPTopBrowserFamilyParamsDeviceType = "OTHER" )
func (HTTPTopBrowserFamilyParamsDeviceType) IsKnown ¶
func (r HTTPTopBrowserFamilyParamsDeviceType) IsKnown() bool
type HTTPTopBrowserFamilyParamsFormat ¶
type HTTPTopBrowserFamilyParamsFormat string
Format in which results will be returned.
const ( HTTPTopBrowserFamilyParamsFormatJson HTTPTopBrowserFamilyParamsFormat = "JSON" HTTPTopBrowserFamilyParamsFormatCsv HTTPTopBrowserFamilyParamsFormat = "CSV" )
func (HTTPTopBrowserFamilyParamsFormat) IsKnown ¶
func (r HTTPTopBrowserFamilyParamsFormat) IsKnown() bool
type HTTPTopBrowserFamilyParamsHTTPProtocol ¶
type HTTPTopBrowserFamilyParamsHTTPProtocol string
const ( HTTPTopBrowserFamilyParamsHTTPProtocolHTTP HTTPTopBrowserFamilyParamsHTTPProtocol = "HTTP" HTTPTopBrowserFamilyParamsHTTPProtocolHTTPS HTTPTopBrowserFamilyParamsHTTPProtocol = "HTTPS" )
func (HTTPTopBrowserFamilyParamsHTTPProtocol) IsKnown ¶
func (r HTTPTopBrowserFamilyParamsHTTPProtocol) IsKnown() bool
type HTTPTopBrowserFamilyParamsHTTPVersion ¶
type HTTPTopBrowserFamilyParamsHTTPVersion string
const ( HTTPTopBrowserFamilyParamsHTTPVersionHttPv1 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv1" HTTPTopBrowserFamilyParamsHTTPVersionHttPv2 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv2" HTTPTopBrowserFamilyParamsHTTPVersionHttPv3 HTTPTopBrowserFamilyParamsHTTPVersion = "HTTPv3" )
func (HTTPTopBrowserFamilyParamsHTTPVersion) IsKnown ¶
func (r HTTPTopBrowserFamilyParamsHTTPVersion) IsKnown() bool
type HTTPTopBrowserFamilyParamsIPVersion ¶
type HTTPTopBrowserFamilyParamsIPVersion string
const ( HTTPTopBrowserFamilyParamsIPVersionIPv4 HTTPTopBrowserFamilyParamsIPVersion = "IPv4" HTTPTopBrowserFamilyParamsIPVersionIPv6 HTTPTopBrowserFamilyParamsIPVersion = "IPv6" )
func (HTTPTopBrowserFamilyParamsIPVersion) IsKnown ¶
func (r HTTPTopBrowserFamilyParamsIPVersion) IsKnown() bool
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 ¶
func (r HTTPTopBrowserFamilyParamsTLSVersion) IsKnown() bool
type HTTPTopBrowserFamilyResponse ¶
type HTTPTopBrowserFamilyResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPTopBrowserFamilyResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPTopBrowserFamilyResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTopBrowserFamilyResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTopBrowserFamilyResponseMetaUnit `json:"units,required"`
JSON httpTopBrowserFamilyResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTopBrowserFamilyResponseMeta) UnmarshalJSON ¶
func (r *HTTPTopBrowserFamilyResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTopBrowserFamilyResponseMetaConfidenceInfo ¶
type HTTPTopBrowserFamilyResponseMetaConfidenceInfo struct {
Annotations []HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTopBrowserFamilyResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *HTTPTopBrowserFamilyResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 HTTPTopBrowserFamilyResponseMetaNormalization ¶
type HTTPTopBrowserFamilyResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTopBrowserFamilyResponseMetaNormalizationPercentage HTTPTopBrowserFamilyResponseMetaNormalization = "PERCENTAGE" HTTPTopBrowserFamilyResponseMetaNormalizationMin0Max HTTPTopBrowserFamilyResponseMetaNormalization = "MIN0_MAX" HTTPTopBrowserFamilyResponseMetaNormalizationMinMax HTTPTopBrowserFamilyResponseMetaNormalization = "MIN_MAX" HTTPTopBrowserFamilyResponseMetaNormalizationRawValues HTTPTopBrowserFamilyResponseMetaNormalization = "RAW_VALUES" HTTPTopBrowserFamilyResponseMetaNormalizationPercentageChange HTTPTopBrowserFamilyResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTopBrowserFamilyResponseMetaNormalizationRollingAverage HTTPTopBrowserFamilyResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTopBrowserFamilyResponseMetaNormalizationOverlappedPercentage HTTPTopBrowserFamilyResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTopBrowserFamilyResponseMetaNormalizationRatio HTTPTopBrowserFamilyResponseMetaNormalization = "RATIO" )
func (HTTPTopBrowserFamilyResponseMetaNormalization) IsKnown ¶
func (r HTTPTopBrowserFamilyResponseMetaNormalization) IsKnown() bool
type HTTPTopBrowserFamilyResponseMetaUnit ¶
type HTTPTopBrowserFamilyResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTopBrowserFamilyResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTopBrowserFamilyResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTopBrowserFamilyResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]HTTPTopBrowserParamsBotClass] `query:"botClass"`
// Filters results by browser family.
BrowserFamily param.Field[[]HTTPTopBrowserParamsBrowserFamily] `query:"browserFamily"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by device type.
DeviceType param.Field[[]HTTPTopBrowserParamsDeviceType] `query:"deviceType"`
// Format in which results will be returned.
Format param.Field[HTTPTopBrowserParamsFormat] `query:"format"`
// Filters results by HTTP protocol (HTTP vs. HTTPS).
HTTPProtocol param.Field[[]HTTPTopBrowserParamsHTTPProtocol] `query:"httpProtocol"`
// Filters results by HTTP version.
HTTPVersion param.Field[[]HTTPTopBrowserParamsHTTPVersion] `query:"httpVersion"`
// Filters results by IP version (Ipv4 vs. IPv6).
IPVersion param.Field[[]HTTPTopBrowserParamsIPVersion] `query:"ipVersion"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by operating system.
OS param.Field[[]HTTPTopBrowserParamsOS] `query:"os"`
// Filters results by 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 ¶
func (r HTTPTopBrowserParamsBrowserFamily) IsKnown() bool
type HTTPTopBrowserParamsDeviceType ¶
type HTTPTopBrowserParamsDeviceType string
const ( HTTPTopBrowserParamsDeviceTypeDesktop HTTPTopBrowserParamsDeviceType = "DESKTOP" HTTPTopBrowserParamsDeviceTypeMobile HTTPTopBrowserParamsDeviceType = "MOBILE" HTTPTopBrowserParamsDeviceTypeOther HTTPTopBrowserParamsDeviceType = "OTHER" )
func (HTTPTopBrowserParamsDeviceType) IsKnown ¶
func (r HTTPTopBrowserParamsDeviceType) IsKnown() bool
type HTTPTopBrowserParamsFormat ¶
type HTTPTopBrowserParamsFormat string
Format in which results will be returned.
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 ¶
func (r HTTPTopBrowserParamsHTTPProtocol) IsKnown() bool
type HTTPTopBrowserParamsHTTPVersion ¶
type HTTPTopBrowserParamsHTTPVersion string
const ( HTTPTopBrowserParamsHTTPVersionHttPv1 HTTPTopBrowserParamsHTTPVersion = "HTTPv1" HTTPTopBrowserParamsHTTPVersionHttPv2 HTTPTopBrowserParamsHTTPVersion = "HTTPv2" HTTPTopBrowserParamsHTTPVersionHttPv3 HTTPTopBrowserParamsHTTPVersion = "HTTPv3" )
func (HTTPTopBrowserParamsHTTPVersion) IsKnown ¶
func (r HTTPTopBrowserParamsHTTPVersion) IsKnown() bool
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 ¶
func (r HTTPTopBrowserParamsTLSVersion) IsKnown() bool
type HTTPTopBrowserResponse ¶
type HTTPTopBrowserResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo HTTPTopBrowserResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []HTTPTopBrowserResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization HTTPTopBrowserResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []HTTPTopBrowserResponseMetaUnit `json:"units,required"`
JSON httpTopBrowserResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*HTTPTopBrowserResponseMeta) UnmarshalJSON ¶
func (r *HTTPTopBrowserResponseMeta) UnmarshalJSON(data []byte) (err error)
type HTTPTopBrowserResponseMetaConfidenceInfo ¶
type HTTPTopBrowserResponseMetaConfidenceInfo struct {
Annotations []HTTPTopBrowserResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON httpTopBrowserResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 HTTPTopBrowserResponseMetaNormalization ¶
type HTTPTopBrowserResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( HTTPTopBrowserResponseMetaNormalizationPercentage HTTPTopBrowserResponseMetaNormalization = "PERCENTAGE" HTTPTopBrowserResponseMetaNormalizationMin0Max HTTPTopBrowserResponseMetaNormalization = "MIN0_MAX" HTTPTopBrowserResponseMetaNormalizationMinMax HTTPTopBrowserResponseMetaNormalization = "MIN_MAX" HTTPTopBrowserResponseMetaNormalizationRawValues HTTPTopBrowserResponseMetaNormalization = "RAW_VALUES" HTTPTopBrowserResponseMetaNormalizationPercentageChange HTTPTopBrowserResponseMetaNormalization = "PERCENTAGE_CHANGE" HTTPTopBrowserResponseMetaNormalizationRollingAverage HTTPTopBrowserResponseMetaNormalization = "ROLLING_AVERAGE" HTTPTopBrowserResponseMetaNormalizationOverlappedPercentage HTTPTopBrowserResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" HTTPTopBrowserResponseMetaNormalizationRatio HTTPTopBrowserResponseMetaNormalization = "RATIO" )
func (HTTPTopBrowserResponseMetaNormalization) IsKnown ¶
func (r HTTPTopBrowserResponseMetaNormalization) IsKnown() bool
type HTTPTopBrowserResponseMetaUnit ¶
type HTTPTopBrowserResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON httpTopBrowserResponseMetaUnitJSON `json:"-"`
}
func (*HTTPTopBrowserResponseMetaUnit) UnmarshalJSON ¶
func (r *HTTPTopBrowserResponseMetaUnit) 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 ¶
func (r *HTTPTopService) Browser(ctx context.Context, query HTTPTopBrowserParams, opts ...option.RequestOption) (res *HTTPTopBrowserResponse, err error)
Retrieves the top user agents by HTTP requests.
func (*HTTPTopService) BrowserFamily ¶
func (r *HTTPTopService) BrowserFamily(ctx context.Context, query HTTPTopBrowserFamilyParams, opts ...option.RequestOption) (res *HTTPTopBrowserFamilyResponse, err error)
Retrieves the top user agents, aggregated in families, by HTTP requests.
type LeakedCredentialService ¶
type LeakedCredentialService struct {
Options []option.RequestOption
Summary *LeakedCredentialSummaryService
TimeseriesGroups *LeakedCredentialTimeseriesGroupService
}
LeakedCredentialService 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 NewLeakedCredentialService method instead.
func NewLeakedCredentialService ¶
func NewLeakedCredentialService(opts ...option.RequestOption) (r *LeakedCredentialService)
NewLeakedCredentialService 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 LeakedCredentialSummaryBotClassParams ¶
type LeakedCredentialSummaryBotClassParams struct {
// Filters results by compromised credential status (clean vs. compromised).
Compromised param.Field[[]LeakedCredentialSummaryBotClassParamsCompromised] `query:"compromised"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[LeakedCredentialSummaryBotClassParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (LeakedCredentialSummaryBotClassParams) URLQuery ¶
func (r LeakedCredentialSummaryBotClassParams) URLQuery() (v url.Values)
URLQuery serializes LeakedCredentialSummaryBotClassParams's query parameters as `url.Values`.
type LeakedCredentialSummaryBotClassParamsCompromised ¶
type LeakedCredentialSummaryBotClassParamsCompromised string
const ( LeakedCredentialSummaryBotClassParamsCompromisedClean LeakedCredentialSummaryBotClassParamsCompromised = "CLEAN" LeakedCredentialSummaryBotClassParamsCompromisedCompromised LeakedCredentialSummaryBotClassParamsCompromised = "COMPROMISED" )
func (LeakedCredentialSummaryBotClassParamsCompromised) IsKnown ¶
func (r LeakedCredentialSummaryBotClassParamsCompromised) IsKnown() bool
type LeakedCredentialSummaryBotClassParamsFormat ¶
type LeakedCredentialSummaryBotClassParamsFormat string
Format in which results will be returned.
const ( LeakedCredentialSummaryBotClassParamsFormatJson LeakedCredentialSummaryBotClassParamsFormat = "JSON" LeakedCredentialSummaryBotClassParamsFormatCsv LeakedCredentialSummaryBotClassParamsFormat = "CSV" )
func (LeakedCredentialSummaryBotClassParamsFormat) IsKnown ¶
func (r LeakedCredentialSummaryBotClassParamsFormat) IsKnown() bool
type LeakedCredentialSummaryBotClassResponse ¶
type LeakedCredentialSummaryBotClassResponse struct {
// Metadata for the results.
Meta LeakedCredentialSummaryBotClassResponseMeta `json:"meta,required"`
Summary0 LeakedCredentialSummaryBotClassResponseSummary0 `json:"summary_0,required"`
JSON leakedCredentialSummaryBotClassResponseJSON `json:"-"`
}
func (*LeakedCredentialSummaryBotClassResponse) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponse) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryBotClassResponseEnvelope ¶
type LeakedCredentialSummaryBotClassResponseEnvelope struct {
Result LeakedCredentialSummaryBotClassResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON leakedCredentialSummaryBotClassResponseEnvelopeJSON `json:"-"`
}
func (*LeakedCredentialSummaryBotClassResponseEnvelope) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryBotClassResponseMeta ¶
type LeakedCredentialSummaryBotClassResponseMeta struct {
ConfidenceInfo LeakedCredentialSummaryBotClassResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []LeakedCredentialSummaryBotClassResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization LeakedCredentialSummaryBotClassResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []LeakedCredentialSummaryBotClassResponseMetaUnit `json:"units,required"`
JSON leakedCredentialSummaryBotClassResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*LeakedCredentialSummaryBotClassResponseMeta) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponseMeta) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryBotClassResponseMetaConfidenceInfo ¶
type LeakedCredentialSummaryBotClassResponseMetaConfidenceInfo struct {
Annotations []LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON leakedCredentialSummaryBotClassResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*LeakedCredentialSummaryBotClassResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotation ¶
type LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON leakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryBotClassResponseMetaDateRange ¶
type LeakedCredentialSummaryBotClassResponseMetaDateRange 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 leakedCredentialSummaryBotClassResponseMetaDateRangeJSON `json:"-"`
}
func (*LeakedCredentialSummaryBotClassResponseMetaDateRange) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryBotClassResponseMetaNormalization ¶
type LeakedCredentialSummaryBotClassResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( LeakedCredentialSummaryBotClassResponseMetaNormalizationPercentage LeakedCredentialSummaryBotClassResponseMetaNormalization = "PERCENTAGE" LeakedCredentialSummaryBotClassResponseMetaNormalizationMin0Max LeakedCredentialSummaryBotClassResponseMetaNormalization = "MIN0_MAX" LeakedCredentialSummaryBotClassResponseMetaNormalizationMinMax LeakedCredentialSummaryBotClassResponseMetaNormalization = "MIN_MAX" LeakedCredentialSummaryBotClassResponseMetaNormalizationRawValues LeakedCredentialSummaryBotClassResponseMetaNormalization = "RAW_VALUES" LeakedCredentialSummaryBotClassResponseMetaNormalizationPercentageChange LeakedCredentialSummaryBotClassResponseMetaNormalization = "PERCENTAGE_CHANGE" LeakedCredentialSummaryBotClassResponseMetaNormalizationRollingAverage LeakedCredentialSummaryBotClassResponseMetaNormalization = "ROLLING_AVERAGE" LeakedCredentialSummaryBotClassResponseMetaNormalizationOverlappedPercentage LeakedCredentialSummaryBotClassResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" LeakedCredentialSummaryBotClassResponseMetaNormalizationRatio LeakedCredentialSummaryBotClassResponseMetaNormalization = "RATIO" )
func (LeakedCredentialSummaryBotClassResponseMetaNormalization) IsKnown ¶
func (r LeakedCredentialSummaryBotClassResponseMetaNormalization) IsKnown() bool
type LeakedCredentialSummaryBotClassResponseMetaUnit ¶
type LeakedCredentialSummaryBotClassResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON leakedCredentialSummaryBotClassResponseMetaUnitJSON `json:"-"`
}
func (*LeakedCredentialSummaryBotClassResponseMetaUnit) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryBotClassResponseSummary0 ¶
type LeakedCredentialSummaryBotClassResponseSummary0 struct {
// A numeric string.
Bot string `json:"bot,required"`
// A numeric string.
Human string `json:"human,required"`
JSON leakedCredentialSummaryBotClassResponseSummary0JSON `json:"-"`
}
func (*LeakedCredentialSummaryBotClassResponseSummary0) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryBotClassResponseSummary0) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedParams ¶
type LeakedCredentialSummaryCompromisedParams struct {
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]LeakedCredentialSummaryCompromisedParamsBotClass] `query:"botClass"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[LeakedCredentialSummaryCompromisedParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (LeakedCredentialSummaryCompromisedParams) URLQuery ¶
func (r LeakedCredentialSummaryCompromisedParams) URLQuery() (v url.Values)
URLQuery serializes LeakedCredentialSummaryCompromisedParams's query parameters as `url.Values`.
type LeakedCredentialSummaryCompromisedParamsBotClass ¶
type LeakedCredentialSummaryCompromisedParamsBotClass string
const ( LeakedCredentialSummaryCompromisedParamsBotClassLikelyAutomated LeakedCredentialSummaryCompromisedParamsBotClass = "LIKELY_AUTOMATED" LeakedCredentialSummaryCompromisedParamsBotClassLikelyHuman LeakedCredentialSummaryCompromisedParamsBotClass = "LIKELY_HUMAN" )
func (LeakedCredentialSummaryCompromisedParamsBotClass) IsKnown ¶
func (r LeakedCredentialSummaryCompromisedParamsBotClass) IsKnown() bool
type LeakedCredentialSummaryCompromisedParamsFormat ¶
type LeakedCredentialSummaryCompromisedParamsFormat string
Format in which results will be returned.
const ( LeakedCredentialSummaryCompromisedParamsFormatJson LeakedCredentialSummaryCompromisedParamsFormat = "JSON" LeakedCredentialSummaryCompromisedParamsFormatCsv LeakedCredentialSummaryCompromisedParamsFormat = "CSV" )
func (LeakedCredentialSummaryCompromisedParamsFormat) IsKnown ¶
func (r LeakedCredentialSummaryCompromisedParamsFormat) IsKnown() bool
type LeakedCredentialSummaryCompromisedResponse ¶
type LeakedCredentialSummaryCompromisedResponse struct {
// Metadata for the results.
Meta LeakedCredentialSummaryCompromisedResponseMeta `json:"meta,required"`
Summary0 LeakedCredentialSummaryCompromisedResponseSummary0 `json:"summary_0,required"`
JSON leakedCredentialSummaryCompromisedResponseJSON `json:"-"`
}
func (*LeakedCredentialSummaryCompromisedResponse) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponse) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedResponseEnvelope ¶
type LeakedCredentialSummaryCompromisedResponseEnvelope struct {
Result LeakedCredentialSummaryCompromisedResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON leakedCredentialSummaryCompromisedResponseEnvelopeJSON `json:"-"`
}
func (*LeakedCredentialSummaryCompromisedResponseEnvelope) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedResponseMeta ¶
type LeakedCredentialSummaryCompromisedResponseMeta struct {
ConfidenceInfo LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []LeakedCredentialSummaryCompromisedResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization LeakedCredentialSummaryCompromisedResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []LeakedCredentialSummaryCompromisedResponseMetaUnit `json:"units,required"`
JSON leakedCredentialSummaryCompromisedResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*LeakedCredentialSummaryCompromisedResponseMeta) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponseMeta) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfo ¶
type LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfo struct {
Annotations []LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON leakedCredentialSummaryCompromisedResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotation ¶
type LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON leakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedResponseMetaDateRange ¶
type LeakedCredentialSummaryCompromisedResponseMetaDateRange 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 leakedCredentialSummaryCompromisedResponseMetaDateRangeJSON `json:"-"`
}
func (*LeakedCredentialSummaryCompromisedResponseMetaDateRange) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedResponseMetaNormalization ¶
type LeakedCredentialSummaryCompromisedResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( LeakedCredentialSummaryCompromisedResponseMetaNormalizationPercentage LeakedCredentialSummaryCompromisedResponseMetaNormalization = "PERCENTAGE" LeakedCredentialSummaryCompromisedResponseMetaNormalizationMin0Max LeakedCredentialSummaryCompromisedResponseMetaNormalization = "MIN0_MAX" LeakedCredentialSummaryCompromisedResponseMetaNormalizationMinMax LeakedCredentialSummaryCompromisedResponseMetaNormalization = "MIN_MAX" LeakedCredentialSummaryCompromisedResponseMetaNormalizationRawValues LeakedCredentialSummaryCompromisedResponseMetaNormalization = "RAW_VALUES" LeakedCredentialSummaryCompromisedResponseMetaNormalizationPercentageChange LeakedCredentialSummaryCompromisedResponseMetaNormalization = "PERCENTAGE_CHANGE" LeakedCredentialSummaryCompromisedResponseMetaNormalizationRollingAverage LeakedCredentialSummaryCompromisedResponseMetaNormalization = "ROLLING_AVERAGE" LeakedCredentialSummaryCompromisedResponseMetaNormalizationOverlappedPercentage LeakedCredentialSummaryCompromisedResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" LeakedCredentialSummaryCompromisedResponseMetaNormalizationRatio LeakedCredentialSummaryCompromisedResponseMetaNormalization = "RATIO" )
func (LeakedCredentialSummaryCompromisedResponseMetaNormalization) IsKnown ¶
func (r LeakedCredentialSummaryCompromisedResponseMetaNormalization) IsKnown() bool
type LeakedCredentialSummaryCompromisedResponseMetaUnit ¶
type LeakedCredentialSummaryCompromisedResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON leakedCredentialSummaryCompromisedResponseMetaUnitJSON `json:"-"`
}
func (*LeakedCredentialSummaryCompromisedResponseMetaUnit) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryCompromisedResponseSummary0 ¶
type LeakedCredentialSummaryCompromisedResponseSummary0 struct {
// A numeric string.
Clean string `json:"CLEAN,required"`
// A numeric string.
Compromised string `json:"COMPROMISED,required"`
JSON leakedCredentialSummaryCompromisedResponseSummary0JSON `json:"-"`
}
func (*LeakedCredentialSummaryCompromisedResponseSummary0) UnmarshalJSON ¶
func (r *LeakedCredentialSummaryCompromisedResponseSummary0) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialSummaryService ¶
type LeakedCredentialSummaryService struct {
Options []option.RequestOption
}
LeakedCredentialSummaryService 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 NewLeakedCredentialSummaryService method instead.
func NewLeakedCredentialSummaryService ¶
func NewLeakedCredentialSummaryService(opts ...option.RequestOption) (r *LeakedCredentialSummaryService)
NewLeakedCredentialSummaryService 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 (*LeakedCredentialSummaryService) BotClass ¶
func (r *LeakedCredentialSummaryService) BotClass(ctx context.Context, query LeakedCredentialSummaryBotClassParams, opts ...option.RequestOption) (res *LeakedCredentialSummaryBotClassResponse, err error)
Retrieves the distribution of HTTP authentication requests by bot class.
func (*LeakedCredentialSummaryService) Compromised ¶
func (r *LeakedCredentialSummaryService) Compromised(ctx context.Context, query LeakedCredentialSummaryCompromisedParams, opts ...option.RequestOption) (res *LeakedCredentialSummaryCompromisedResponse, err error)
Retrieves the distribution of HTTP authentication requests by compromised credential status.
type LeakedCredentialTimeseriesGroupBotClassParams ¶
type LeakedCredentialTimeseriesGroupBotClassParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[LeakedCredentialTimeseriesGroupBotClassParamsAggInterval] `query:"aggInterval"`
// Filters results by compromised credential status (clean vs. compromised).
Compromised param.Field[[]LeakedCredentialTimeseriesGroupBotClassParamsCompromised] `query:"compromised"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[LeakedCredentialTimeseriesGroupBotClassParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (LeakedCredentialTimeseriesGroupBotClassParams) URLQuery ¶
func (r LeakedCredentialTimeseriesGroupBotClassParams) URLQuery() (v url.Values)
URLQuery serializes LeakedCredentialTimeseriesGroupBotClassParams's query parameters as `url.Values`.
type LeakedCredentialTimeseriesGroupBotClassParamsAggInterval ¶
type LeakedCredentialTimeseriesGroupBotClassParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( LeakedCredentialTimeseriesGroupBotClassParamsAggInterval15m LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "15m" LeakedCredentialTimeseriesGroupBotClassParamsAggInterval1h LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "1h" LeakedCredentialTimeseriesGroupBotClassParamsAggInterval1d LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "1d" LeakedCredentialTimeseriesGroupBotClassParamsAggInterval1w LeakedCredentialTimeseriesGroupBotClassParamsAggInterval = "1w" )
func (LeakedCredentialTimeseriesGroupBotClassParamsAggInterval) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupBotClassParamsAggInterval) IsKnown() bool
type LeakedCredentialTimeseriesGroupBotClassParamsCompromised ¶
type LeakedCredentialTimeseriesGroupBotClassParamsCompromised string
const ( LeakedCredentialTimeseriesGroupBotClassParamsCompromisedClean LeakedCredentialTimeseriesGroupBotClassParamsCompromised = "CLEAN" LeakedCredentialTimeseriesGroupBotClassParamsCompromisedCompromised LeakedCredentialTimeseriesGroupBotClassParamsCompromised = "COMPROMISED" )
func (LeakedCredentialTimeseriesGroupBotClassParamsCompromised) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupBotClassParamsCompromised) IsKnown() bool
type LeakedCredentialTimeseriesGroupBotClassParamsFormat ¶
type LeakedCredentialTimeseriesGroupBotClassParamsFormat string
Format in which results will be returned.
const ( LeakedCredentialTimeseriesGroupBotClassParamsFormatJson LeakedCredentialTimeseriesGroupBotClassParamsFormat = "JSON" LeakedCredentialTimeseriesGroupBotClassParamsFormatCsv LeakedCredentialTimeseriesGroupBotClassParamsFormat = "CSV" )
func (LeakedCredentialTimeseriesGroupBotClassParamsFormat) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupBotClassParamsFormat) IsKnown() bool
type LeakedCredentialTimeseriesGroupBotClassResponse ¶
type LeakedCredentialTimeseriesGroupBotClassResponse struct {
// Metadata for the results.
Meta LeakedCredentialTimeseriesGroupBotClassResponseMeta `json:"meta,required"`
Serie0 LeakedCredentialTimeseriesGroupBotClassResponseSerie0 `json:"serie_0,required"`
JSON leakedCredentialTimeseriesGroupBotClassResponseJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupBotClassResponse) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponse) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupBotClassResponseEnvelope ¶
type LeakedCredentialTimeseriesGroupBotClassResponseEnvelope struct {
Result LeakedCredentialTimeseriesGroupBotClassResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON leakedCredentialTimeseriesGroupBotClassResponseEnvelopeJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupBotClassResponseEnvelope) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupBotClassResponseMeta ¶
type LeakedCredentialTimeseriesGroupBotClassResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []LeakedCredentialTimeseriesGroupBotClassResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []LeakedCredentialTimeseriesGroupBotClassResponseMetaUnit `json:"units,required"`
JSON leakedCredentialTimeseriesGroupBotClassResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*LeakedCredentialTimeseriesGroupBotClassResponseMeta) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponseMeta) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval ¶
type LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalFifteenMinutes LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "FIFTEEN_MINUTES" LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneHour LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_HOUR" LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneDay LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_DAY" LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneWeek LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_WEEK" LeakedCredentialTimeseriesGroupBotClassResponseMetaAggIntervalOneMonth LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval = "ONE_MONTH" )
func (LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupBotClassResponseMetaAggInterval) IsKnown() bool
type LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfo ¶
type LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfo struct {
Annotations []LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON leakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation ¶
type LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON leakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupBotClassResponseMetaDateRange ¶
type LeakedCredentialTimeseriesGroupBotClassResponseMetaDateRange 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 leakedCredentialTimeseriesGroupBotClassResponseMetaDateRangeJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupBotClassResponseMetaDateRange) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization ¶
type LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationPercentage LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "PERCENTAGE" LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationMin0Max LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "MIN0_MAX" LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationMinMax LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "MIN_MAX" LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationRawValues LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "RAW_VALUES" LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationPercentageChange LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "PERCENTAGE_CHANGE" LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationRollingAverage LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "ROLLING_AVERAGE" LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationOverlappedPercentage LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalizationRatio LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization = "RATIO" )
func (LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupBotClassResponseMetaNormalization) IsKnown() bool
type LeakedCredentialTimeseriesGroupBotClassResponseMetaUnit ¶
type LeakedCredentialTimeseriesGroupBotClassResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON leakedCredentialTimeseriesGroupBotClassResponseMetaUnitJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupBotClassResponseMetaUnit) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupBotClassResponseSerie0 ¶
type LeakedCredentialTimeseriesGroupBotClassResponseSerie0 struct {
Bot []string `json:"bot,required"`
Human []string `json:"human,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON leakedCredentialTimeseriesGroupBotClassResponseSerie0JSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupBotClassResponseSerie0) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupBotClassResponseSerie0) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedParams ¶
type LeakedCredentialTimeseriesGroupCompromisedParams struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval] `query:"aggInterval"`
// Filters results by bot class. Refer to
// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
BotClass param.Field[[]LeakedCredentialTimeseriesGroupCompromisedParamsBotClass] `query:"botClass"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[LeakedCredentialTimeseriesGroupCompromisedParamsFormat] `query:"format"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (LeakedCredentialTimeseriesGroupCompromisedParams) URLQuery ¶
func (r LeakedCredentialTimeseriesGroupCompromisedParams) URLQuery() (v url.Values)
URLQuery serializes LeakedCredentialTimeseriesGroupCompromisedParams's query parameters as `url.Values`.
type LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval ¶
type LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval15m LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "15m" LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval1h LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "1h" LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval1d LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "1d" LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval1w LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval = "1w" )
func (LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupCompromisedParamsAggInterval) IsKnown() bool
type LeakedCredentialTimeseriesGroupCompromisedParamsBotClass ¶
type LeakedCredentialTimeseriesGroupCompromisedParamsBotClass string
const ( LeakedCredentialTimeseriesGroupCompromisedParamsBotClassLikelyAutomated LeakedCredentialTimeseriesGroupCompromisedParamsBotClass = "LIKELY_AUTOMATED" LeakedCredentialTimeseriesGroupCompromisedParamsBotClassLikelyHuman LeakedCredentialTimeseriesGroupCompromisedParamsBotClass = "LIKELY_HUMAN" )
func (LeakedCredentialTimeseriesGroupCompromisedParamsBotClass) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupCompromisedParamsBotClass) IsKnown() bool
type LeakedCredentialTimeseriesGroupCompromisedParamsFormat ¶
type LeakedCredentialTimeseriesGroupCompromisedParamsFormat string
Format in which results will be returned.
const ( LeakedCredentialTimeseriesGroupCompromisedParamsFormatJson LeakedCredentialTimeseriesGroupCompromisedParamsFormat = "JSON" LeakedCredentialTimeseriesGroupCompromisedParamsFormatCsv LeakedCredentialTimeseriesGroupCompromisedParamsFormat = "CSV" )
func (LeakedCredentialTimeseriesGroupCompromisedParamsFormat) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupCompromisedParamsFormat) IsKnown() bool
type LeakedCredentialTimeseriesGroupCompromisedResponse ¶
type LeakedCredentialTimeseriesGroupCompromisedResponse struct {
// Metadata for the results.
Meta LeakedCredentialTimeseriesGroupCompromisedResponseMeta `json:"meta,required"`
Serie0 LeakedCredentialTimeseriesGroupCompromisedResponseSerie0 `json:"serie_0,required"`
JSON leakedCredentialTimeseriesGroupCompromisedResponseJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupCompromisedResponse) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponse) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedResponseEnvelope ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseEnvelope struct {
Result LeakedCredentialTimeseriesGroupCompromisedResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON leakedCredentialTimeseriesGroupCompromisedResponseEnvelopeJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupCompromisedResponseEnvelope) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedResponseMeta ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []LeakedCredentialTimeseriesGroupCompromisedResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []LeakedCredentialTimeseriesGroupCompromisedResponseMetaUnit `json:"units,required"`
JSON leakedCredentialTimeseriesGroupCompromisedResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*LeakedCredentialTimeseriesGroupCompromisedResponseMeta) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponseMeta) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalFifteenMinutes LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "FIFTEEN_MINUTES" LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneHour LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_HOUR" LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneDay LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_DAY" LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneWeek LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_WEEK" LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggIntervalOneMonth LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval = "ONE_MONTH" )
func (LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupCompromisedResponseMetaAggInterval) IsKnown() bool
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfo ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfo struct {
Annotations []LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON leakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotation ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON leakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaDateRange ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaDateRange 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 leakedCredentialTimeseriesGroupCompromisedResponseMetaDateRangeJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupCompromisedResponseMetaDateRange) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationPercentage LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "PERCENTAGE" LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationMin0Max LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "MIN0_MAX" LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationMinMax LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "MIN_MAX" LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationRawValues LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "RAW_VALUES" LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationPercentageChange LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "PERCENTAGE_CHANGE" LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationRollingAverage LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "ROLLING_AVERAGE" LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationOverlappedPercentage LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalizationRatio LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization = "RATIO" )
func (LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization) IsKnown ¶
func (r LeakedCredentialTimeseriesGroupCompromisedResponseMetaNormalization) IsKnown() bool
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaUnit ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON leakedCredentialTimeseriesGroupCompromisedResponseMetaUnitJSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupCompromisedResponseMetaUnit) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupCompromisedResponseSerie0 ¶
type LeakedCredentialTimeseriesGroupCompromisedResponseSerie0 struct {
Clean []string `json:"CLEAN,required"`
Compromised []string `json:"COMPROMISED,required"`
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
JSON leakedCredentialTimeseriesGroupCompromisedResponseSerie0JSON `json:"-"`
}
func (*LeakedCredentialTimeseriesGroupCompromisedResponseSerie0) UnmarshalJSON ¶
func (r *LeakedCredentialTimeseriesGroupCompromisedResponseSerie0) UnmarshalJSON(data []byte) (err error)
type LeakedCredentialTimeseriesGroupService ¶
type LeakedCredentialTimeseriesGroupService struct {
Options []option.RequestOption
}
LeakedCredentialTimeseriesGroupService 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 NewLeakedCredentialTimeseriesGroupService method instead.
func NewLeakedCredentialTimeseriesGroupService ¶
func NewLeakedCredentialTimeseriesGroupService(opts ...option.RequestOption) (r *LeakedCredentialTimeseriesGroupService)
NewLeakedCredentialTimeseriesGroupService 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 (*LeakedCredentialTimeseriesGroupService) BotClass ¶
func (r *LeakedCredentialTimeseriesGroupService) BotClass(ctx context.Context, query LeakedCredentialTimeseriesGroupBotClassParams, opts ...option.RequestOption) (res *LeakedCredentialTimeseriesGroupBotClassResponse, err error)
Retrieves the distribution of HTTP authentication requests by bot class over time.
func (*LeakedCredentialTimeseriesGroupService) Compromised ¶
func (r *LeakedCredentialTimeseriesGroupService) Compromised(ctx context.Context, query LeakedCredentialTimeseriesGroupCompromisedParams, opts ...option.RequestOption) (res *LeakedCredentialTimeseriesGroupCompromisedResponse, err error)
Retrieves the distribution of HTTP authentication requests by compromised credential status over time.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
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 MemberUser ¶
type MemberUser = shared.MemberUser
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 ¶
func (r *NetflowService) Summary(ctx context.Context, query NetflowSummaryParams, opts ...option.RequestOption) (res *NetflowSummaryResponse, err error)
Retrieves the distribution of network traffic (NetFlows) by HTTP vs other protocols.
func (*NetflowService) Timeseries ¶
func (r *NetflowService) Timeseries(ctx context.Context, query NetflowTimeseriesParams, opts ...option.RequestOption) (res *NetflowTimeseriesResponse, err error)
Retrieves network traffic (NetFlows) over time.
type NetflowSummaryParams ¶
type NetflowSummaryParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[NetflowSummaryParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( NetflowSummaryParamsFormatJson NetflowSummaryParamsFormat = "JSON" NetflowSummaryParamsFormatCsv NetflowSummaryParamsFormat = "CSV" )
func (NetflowSummaryParamsFormat) IsKnown ¶
func (r NetflowSummaryParamsFormat) IsKnown() bool
type NetflowSummaryResponse ¶
type NetflowSummaryResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo NetflowSummaryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []NetflowSummaryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization NetflowSummaryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []NetflowSummaryResponseMetaUnit `json:"units,required"`
JSON netflowSummaryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*NetflowSummaryResponseMeta) UnmarshalJSON ¶
func (r *NetflowSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)
type NetflowSummaryResponseMetaConfidenceInfo ¶
type NetflowSummaryResponseMetaConfidenceInfo struct {
Annotations []NetflowSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON netflowSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 NetflowSummaryResponseMetaNormalization ¶
type NetflowSummaryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( NetflowSummaryResponseMetaNormalizationPercentage NetflowSummaryResponseMetaNormalization = "PERCENTAGE" NetflowSummaryResponseMetaNormalizationMin0Max NetflowSummaryResponseMetaNormalization = "MIN0_MAX" NetflowSummaryResponseMetaNormalizationMinMax NetflowSummaryResponseMetaNormalization = "MIN_MAX" NetflowSummaryResponseMetaNormalizationRawValues NetflowSummaryResponseMetaNormalization = "RAW_VALUES" NetflowSummaryResponseMetaNormalizationPercentageChange NetflowSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE" NetflowSummaryResponseMetaNormalizationRollingAverage NetflowSummaryResponseMetaNormalization = "ROLLING_AVERAGE" NetflowSummaryResponseMetaNormalizationOverlappedPercentage NetflowSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" NetflowSummaryResponseMetaNormalizationRatio NetflowSummaryResponseMetaNormalization = "RATIO" )
func (NetflowSummaryResponseMetaNormalization) IsKnown ¶
func (r NetflowSummaryResponseMetaNormalization) IsKnown() bool
type NetflowSummaryResponseMetaUnit ¶
type NetflowSummaryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON netflowSummaryResponseMetaUnitJSON `json:"-"`
}
func (*NetflowSummaryResponseMetaUnit) UnmarshalJSON ¶
func (r *NetflowSummaryResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type NetflowSummaryResponseSummary0 ¶
type NetflowSummaryResponseSummary0 struct {
// A numeric string.
HTTP string `json:"HTTP,required"`
// A numeric string.
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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[NetflowTimeseriesParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization param.Field[NetflowTimeseriesParamsNormalization] `query:"normalization"`
// Filters the results by 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 of the results (e.g., 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 ¶
func (r NetflowTimeseriesParamsAggInterval) IsKnown() bool
type NetflowTimeseriesParamsFormat ¶
type NetflowTimeseriesParamsFormat string
Format in which results will be returned.
const ( NetflowTimeseriesParamsFormatJson NetflowTimeseriesParamsFormat = "JSON" NetflowTimeseriesParamsFormatCsv NetflowTimeseriesParamsFormat = "CSV" )
func (NetflowTimeseriesParamsFormat) IsKnown ¶
func (r NetflowTimeseriesParamsFormat) IsKnown() bool
type NetflowTimeseriesParamsNormalization ¶
type NetflowTimeseriesParamsNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( NetflowTimeseriesParamsNormalizationPercentageChange NetflowTimeseriesParamsNormalization = "PERCENTAGE_CHANGE" NetflowTimeseriesParamsNormalizationMin0Max NetflowTimeseriesParamsNormalization = "MIN0_MAX" )
func (NetflowTimeseriesParamsNormalization) IsKnown ¶
func (r NetflowTimeseriesParamsNormalization) IsKnown() bool
type NetflowTimeseriesParamsProduct ¶
type NetflowTimeseriesParamsProduct string
const ( NetflowTimeseriesParamsProductHTTP NetflowTimeseriesParamsProduct = "HTTP" NetflowTimeseriesParamsProductAll NetflowTimeseriesParamsProduct = "ALL" )
func (NetflowTimeseriesParamsProduct) IsKnown ¶
func (r NetflowTimeseriesParamsProduct) IsKnown() bool
type NetflowTimeseriesResponse ¶
type NetflowTimeseriesResponse struct {
// Metadata for the results.
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 {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval NetflowTimeseriesResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo NetflowTimeseriesResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []NetflowTimeseriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization NetflowTimeseriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []NetflowTimeseriesResponseMetaUnit `json:"units,required"`
JSON netflowTimeseriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*NetflowTimeseriesResponseMeta) UnmarshalJSON ¶
func (r *NetflowTimeseriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type NetflowTimeseriesResponseMetaAggInterval ¶
type NetflowTimeseriesResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( NetflowTimeseriesResponseMetaAggIntervalFifteenMinutes NetflowTimeseriesResponseMetaAggInterval = "FIFTEEN_MINUTES" NetflowTimeseriesResponseMetaAggIntervalOneHour NetflowTimeseriesResponseMetaAggInterval = "ONE_HOUR" NetflowTimeseriesResponseMetaAggIntervalOneDay NetflowTimeseriesResponseMetaAggInterval = "ONE_DAY" NetflowTimeseriesResponseMetaAggIntervalOneWeek NetflowTimeseriesResponseMetaAggInterval = "ONE_WEEK" NetflowTimeseriesResponseMetaAggIntervalOneMonth NetflowTimeseriesResponseMetaAggInterval = "ONE_MONTH" )
func (NetflowTimeseriesResponseMetaAggInterval) IsKnown ¶
func (r NetflowTimeseriesResponseMetaAggInterval) IsKnown() bool
type NetflowTimeseriesResponseMetaConfidenceInfo ¶
type NetflowTimeseriesResponseMetaConfidenceInfo struct {
Annotations []NetflowTimeseriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON netflowTimeseriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 NetflowTimeseriesResponseMetaNormalization ¶
type NetflowTimeseriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( NetflowTimeseriesResponseMetaNormalizationPercentage NetflowTimeseriesResponseMetaNormalization = "PERCENTAGE" NetflowTimeseriesResponseMetaNormalizationMin0Max NetflowTimeseriesResponseMetaNormalization = "MIN0_MAX" NetflowTimeseriesResponseMetaNormalizationMinMax NetflowTimeseriesResponseMetaNormalization = "MIN_MAX" NetflowTimeseriesResponseMetaNormalizationRawValues NetflowTimeseriesResponseMetaNormalization = "RAW_VALUES" NetflowTimeseriesResponseMetaNormalizationPercentageChange NetflowTimeseriesResponseMetaNormalization = "PERCENTAGE_CHANGE" NetflowTimeseriesResponseMetaNormalizationRollingAverage NetflowTimeseriesResponseMetaNormalization = "ROLLING_AVERAGE" NetflowTimeseriesResponseMetaNormalizationOverlappedPercentage NetflowTimeseriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" NetflowTimeseriesResponseMetaNormalizationRatio NetflowTimeseriesResponseMetaNormalization = "RATIO" )
func (NetflowTimeseriesResponseMetaNormalization) IsKnown ¶
func (r NetflowTimeseriesResponseMetaNormalization) IsKnown() bool
type NetflowTimeseriesResponseMetaUnit ¶
type NetflowTimeseriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON netflowTimeseriesResponseMetaUnitJSON `json:"-"`
}
func (*NetflowTimeseriesResponseMetaUnit) UnmarshalJSON ¶
func (r *NetflowTimeseriesResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[NetflowTopAsesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( NetflowTopAsesParamsFormatJson NetflowTopAsesParamsFormat = "JSON" NetflowTopAsesParamsFormatCsv NetflowTopAsesParamsFormat = "CSV" )
func (NetflowTopAsesParamsFormat) IsKnown ¶
func (r NetflowTopAsesParamsFormat) IsKnown() bool
type NetflowTopAsesResponse ¶
type NetflowTopAsesResponse struct {
// Metadata for the results.
Meta NetflowTopAsesResponseMeta `json:"meta,required"`
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 NetflowTopAsesResponseMeta ¶
type NetflowTopAsesResponseMeta struct {
ConfidenceInfo NetflowTopAsesResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []NetflowTopAsesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization NetflowTopAsesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []NetflowTopAsesResponseMetaUnit `json:"units,required"`
JSON netflowTopAsesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*NetflowTopAsesResponseMeta) UnmarshalJSON ¶
func (r *NetflowTopAsesResponseMeta) UnmarshalJSON(data []byte) (err error)
type NetflowTopAsesResponseMetaConfidenceInfo ¶
type NetflowTopAsesResponseMetaConfidenceInfo struct {
Annotations []NetflowTopAsesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON netflowTopAsesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*NetflowTopAsesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *NetflowTopAsesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type NetflowTopAsesResponseMetaConfidenceInfoAnnotation ¶
type NetflowTopAsesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON netflowTopAsesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*NetflowTopAsesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *NetflowTopAsesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type NetflowTopAsesResponseMetaDateRange ¶
type NetflowTopAsesResponseMetaDateRange 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 netflowTopAsesResponseMetaDateRangeJSON `json:"-"`
}
func (*NetflowTopAsesResponseMetaDateRange) UnmarshalJSON ¶
func (r *NetflowTopAsesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type NetflowTopAsesResponseMetaNormalization ¶
type NetflowTopAsesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( NetflowTopAsesResponseMetaNormalizationPercentage NetflowTopAsesResponseMetaNormalization = "PERCENTAGE" NetflowTopAsesResponseMetaNormalizationMin0Max NetflowTopAsesResponseMetaNormalization = "MIN0_MAX" NetflowTopAsesResponseMetaNormalizationMinMax NetflowTopAsesResponseMetaNormalization = "MIN_MAX" NetflowTopAsesResponseMetaNormalizationRawValues NetflowTopAsesResponseMetaNormalization = "RAW_VALUES" NetflowTopAsesResponseMetaNormalizationPercentageChange NetflowTopAsesResponseMetaNormalization = "PERCENTAGE_CHANGE" NetflowTopAsesResponseMetaNormalizationRollingAverage NetflowTopAsesResponseMetaNormalization = "ROLLING_AVERAGE" NetflowTopAsesResponseMetaNormalizationOverlappedPercentage NetflowTopAsesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" NetflowTopAsesResponseMetaNormalizationRatio NetflowTopAsesResponseMetaNormalization = "RATIO" )
func (NetflowTopAsesResponseMetaNormalization) IsKnown ¶
func (r NetflowTopAsesResponseMetaNormalization) IsKnown() bool
type NetflowTopAsesResponseMetaUnit ¶
type NetflowTopAsesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON netflowTopAsesResponseMetaUnitJSON `json:"-"`
}
func (*NetflowTopAsesResponseMetaUnit) UnmarshalJSON ¶
func (r *NetflowTopAsesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type NetflowTopAsesResponseTop0 ¶
type NetflowTopAsesResponseTop0 struct {
ClientASN float64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
// A numeric string.
Value string `json:"value,required"`
JSON netflowTopAsesResponseTop0JSON `json:"-"`
}
func (*NetflowTopAsesResponseTop0) UnmarshalJSON ¶
func (r *NetflowTopAsesResponseTop0) UnmarshalJSON(data []byte) (err error)
type NetflowTopLocationsParams ¶
type NetflowTopLocationsParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[NetflowTopLocationsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( NetflowTopLocationsParamsFormatJson NetflowTopLocationsParamsFormat = "JSON" NetflowTopLocationsParamsFormatCsv NetflowTopLocationsParamsFormat = "CSV" )
func (NetflowTopLocationsParamsFormat) IsKnown ¶
func (r NetflowTopLocationsParamsFormat) IsKnown() bool
type NetflowTopLocationsResponse ¶
type NetflowTopLocationsResponse struct {
// Metadata for the results.
Meta NetflowTopLocationsResponseMeta `json:"meta,required"`
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 NetflowTopLocationsResponseMeta ¶
type NetflowTopLocationsResponseMeta struct {
ConfidenceInfo NetflowTopLocationsResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []NetflowTopLocationsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization NetflowTopLocationsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []NetflowTopLocationsResponseMetaUnit `json:"units,required"`
JSON netflowTopLocationsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*NetflowTopLocationsResponseMeta) UnmarshalJSON ¶
func (r *NetflowTopLocationsResponseMeta) UnmarshalJSON(data []byte) (err error)
type NetflowTopLocationsResponseMetaConfidenceInfo ¶
type NetflowTopLocationsResponseMetaConfidenceInfo struct {
Annotations []NetflowTopLocationsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON netflowTopLocationsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*NetflowTopLocationsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *NetflowTopLocationsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type NetflowTopLocationsResponseMetaConfidenceInfoAnnotation ¶
type NetflowTopLocationsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON netflowTopLocationsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*NetflowTopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *NetflowTopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type NetflowTopLocationsResponseMetaDateRange ¶
type NetflowTopLocationsResponseMetaDateRange 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 netflowTopLocationsResponseMetaDateRangeJSON `json:"-"`
}
func (*NetflowTopLocationsResponseMetaDateRange) UnmarshalJSON ¶
func (r *NetflowTopLocationsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type NetflowTopLocationsResponseMetaNormalization ¶
type NetflowTopLocationsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( NetflowTopLocationsResponseMetaNormalizationPercentage NetflowTopLocationsResponseMetaNormalization = "PERCENTAGE" NetflowTopLocationsResponseMetaNormalizationMin0Max NetflowTopLocationsResponseMetaNormalization = "MIN0_MAX" NetflowTopLocationsResponseMetaNormalizationMinMax NetflowTopLocationsResponseMetaNormalization = "MIN_MAX" NetflowTopLocationsResponseMetaNormalizationRawValues NetflowTopLocationsResponseMetaNormalization = "RAW_VALUES" NetflowTopLocationsResponseMetaNormalizationPercentageChange NetflowTopLocationsResponseMetaNormalization = "PERCENTAGE_CHANGE" NetflowTopLocationsResponseMetaNormalizationRollingAverage NetflowTopLocationsResponseMetaNormalization = "ROLLING_AVERAGE" NetflowTopLocationsResponseMetaNormalizationOverlappedPercentage NetflowTopLocationsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" NetflowTopLocationsResponseMetaNormalizationRatio NetflowTopLocationsResponseMetaNormalization = "RATIO" )
func (NetflowTopLocationsResponseMetaNormalization) IsKnown ¶
func (r NetflowTopLocationsResponseMetaNormalization) IsKnown() bool
type NetflowTopLocationsResponseMetaUnit ¶
type NetflowTopLocationsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON netflowTopLocationsResponseMetaUnitJSON `json:"-"`
}
func (*NetflowTopLocationsResponseMetaUnit) UnmarshalJSON ¶
func (r *NetflowTopLocationsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type NetflowTopLocationsResponseTop0 ¶
type NetflowTopLocationsResponseTop0 struct {
ClientCountryAlpha2 string `json:"clientCountryAlpha2,required"`
ClientCountryName string `json:"clientCountryName,required"`
// A numeric string.
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 ¶
func (r *NetflowTopService) Ases(ctx context.Context, query NetflowTopAsesParams, opts ...option.RequestOption) (res *NetflowTopAsesResponse, err error)
Retrieves the top autonomous systems by network traffic (NetFlows).
func (*NetflowTopService) Locations ¶
func (r *NetflowTopService) Locations(ctx context.Context, query NetflowTopLocationsParams, opts ...option.RequestOption) (res *NetflowTopLocationsResponse, err error)
Retrieves the top locations by network traffic (NetFlows).
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 ¶
func (r *QualityIQIService) Summary(ctx context.Context, query QualityIQISummaryParams, opts ...option.RequestOption) (res *QualityIQISummaryResponse, err error)
Retrieves a summary (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI).
func (*QualityIQIService) TimeseriesGroups ¶
func (r *QualityIQIService) TimeseriesGroups(ctx context.Context, query QualityIQITimeseriesGroupsParams, opts ...option.RequestOption) (res *QualityIQITimeseriesGroupsResponse, err error)
Retrieves a time series (percentiles) of bandwidth, latency, or DNS response time from the Radar Internet Quality Index (IQI).
type QualityIQISummaryParams ¶
type QualityIQISummaryParams struct {
// Defines which metric to return (bandwidth, latency, or DNS response time).
Metric param.Field[QualityIQISummaryParamsMetric] `query:"metric,required"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[QualityIQISummaryParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( QualityIQISummaryParamsFormatJson QualityIQISummaryParamsFormat = "JSON" QualityIQISummaryParamsFormatCsv QualityIQISummaryParamsFormat = "CSV" )
func (QualityIQISummaryParamsFormat) IsKnown ¶
func (r QualityIQISummaryParamsFormat) IsKnown() bool
type QualityIQISummaryParamsMetric ¶
type QualityIQISummaryParamsMetric string
Defines 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 {
// Metadata for the results.
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 {
ConfidenceInfo QualityIQISummaryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []QualityIQISummaryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization QualityIQISummaryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []QualityIQISummaryResponseMetaUnit `json:"units,required"`
JSON qualityIQISummaryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*QualityIQISummaryResponseMeta) UnmarshalJSON ¶
func (r *QualityIQISummaryResponseMeta) UnmarshalJSON(data []byte) (err error)
type QualityIQISummaryResponseMetaConfidenceInfo ¶
type QualityIQISummaryResponseMetaConfidenceInfo struct {
Annotations []QualityIQISummaryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON qualityIQISummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 QualityIQISummaryResponseMetaNormalization ¶
type QualityIQISummaryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( QualityIQISummaryResponseMetaNormalizationPercentage QualityIQISummaryResponseMetaNormalization = "PERCENTAGE" QualityIQISummaryResponseMetaNormalizationMin0Max QualityIQISummaryResponseMetaNormalization = "MIN0_MAX" QualityIQISummaryResponseMetaNormalizationMinMax QualityIQISummaryResponseMetaNormalization = "MIN_MAX" QualityIQISummaryResponseMetaNormalizationRawValues QualityIQISummaryResponseMetaNormalization = "RAW_VALUES" QualityIQISummaryResponseMetaNormalizationPercentageChange QualityIQISummaryResponseMetaNormalization = "PERCENTAGE_CHANGE" QualityIQISummaryResponseMetaNormalizationRollingAverage QualityIQISummaryResponseMetaNormalization = "ROLLING_AVERAGE" QualityIQISummaryResponseMetaNormalizationOverlappedPercentage QualityIQISummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" QualityIQISummaryResponseMetaNormalizationRatio QualityIQISummaryResponseMetaNormalization = "RATIO" )
func (QualityIQISummaryResponseMetaNormalization) IsKnown ¶
func (r QualityIQISummaryResponseMetaNormalization) IsKnown() bool
type QualityIQISummaryResponseMetaUnit ¶
type QualityIQISummaryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON qualityIQISummaryResponseMetaUnitJSON `json:"-"`
}
func (*QualityIQISummaryResponseMetaUnit) UnmarshalJSON ¶
func (r *QualityIQISummaryResponseMetaUnit) 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 {
// Defines which metric to return (bandwidth, latency, or DNS response time).
Metric param.Field[QualityIQITimeseriesGroupsParamsMetric] `query:"metric,required"`
// Aggregation interval of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[QualityIQITimeseriesGroupsParamsFormat] `query:"format"`
// Enables interpolation for all series (using the average).
Interpolation param.Field[bool] `query:"interpolation"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 of the results (e.g., 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 ¶
func (r QualityIQITimeseriesGroupsParamsAggInterval) IsKnown() bool
type QualityIQITimeseriesGroupsParamsFormat ¶
type QualityIQITimeseriesGroupsParamsFormat string
Format in which results will be returned.
const ( QualityIQITimeseriesGroupsParamsFormatJson QualityIQITimeseriesGroupsParamsFormat = "JSON" QualityIQITimeseriesGroupsParamsFormatCsv QualityIQITimeseriesGroupsParamsFormat = "CSV" )
func (QualityIQITimeseriesGroupsParamsFormat) IsKnown ¶
func (r QualityIQITimeseriesGroupsParamsFormat) IsKnown() bool
type QualityIQITimeseriesGroupsParamsMetric ¶
type QualityIQITimeseriesGroupsParamsMetric string
Defines which metric to return (bandwidth, latency, or DNS response time).
const ( QualityIQITimeseriesGroupsParamsMetricBandwidth QualityIQITimeseriesGroupsParamsMetric = "BANDWIDTH" QualityIQITimeseriesGroupsParamsMetricDNS QualityIQITimeseriesGroupsParamsMetric = "DNS" QualityIQITimeseriesGroupsParamsMetricLatency QualityIQITimeseriesGroupsParamsMetric = "LATENCY" )
func (QualityIQITimeseriesGroupsParamsMetric) IsKnown ¶
func (r QualityIQITimeseriesGroupsParamsMetric) IsKnown() bool
type QualityIQITimeseriesGroupsResponse ¶
type QualityIQITimeseriesGroupsResponse struct {
// Metadata for the results.
Meta QualityIQITimeseriesGroupsResponseMeta `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 QualityIQITimeseriesGroupsResponseMeta ¶
type QualityIQITimeseriesGroupsResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval QualityIQITimeseriesGroupsResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo QualityIQITimeseriesGroupsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []QualityIQITimeseriesGroupsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization QualityIQITimeseriesGroupsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []QualityIQITimeseriesGroupsResponseMetaUnit `json:"units,required"`
JSON qualityIQITimeseriesGroupsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*QualityIQITimeseriesGroupsResponseMeta) UnmarshalJSON ¶
func (r *QualityIQITimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)
type QualityIQITimeseriesGroupsResponseMetaAggInterval ¶
type QualityIQITimeseriesGroupsResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( QualityIQITimeseriesGroupsResponseMetaAggIntervalFifteenMinutes QualityIQITimeseriesGroupsResponseMetaAggInterval = "FIFTEEN_MINUTES" QualityIQITimeseriesGroupsResponseMetaAggIntervalOneHour QualityIQITimeseriesGroupsResponseMetaAggInterval = "ONE_HOUR" QualityIQITimeseriesGroupsResponseMetaAggIntervalOneDay QualityIQITimeseriesGroupsResponseMetaAggInterval = "ONE_DAY" QualityIQITimeseriesGroupsResponseMetaAggIntervalOneWeek QualityIQITimeseriesGroupsResponseMetaAggInterval = "ONE_WEEK" QualityIQITimeseriesGroupsResponseMetaAggIntervalOneMonth QualityIQITimeseriesGroupsResponseMetaAggInterval = "ONE_MONTH" )
func (QualityIQITimeseriesGroupsResponseMetaAggInterval) IsKnown ¶
func (r QualityIQITimeseriesGroupsResponseMetaAggInterval) IsKnown() bool
type QualityIQITimeseriesGroupsResponseMetaConfidenceInfo ¶
type QualityIQITimeseriesGroupsResponseMetaConfidenceInfo struct {
Annotations []QualityIQITimeseriesGroupsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON qualityIQITimeseriesGroupsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*QualityIQITimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *QualityIQITimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type QualityIQITimeseriesGroupsResponseMetaConfidenceInfoAnnotation ¶
type QualityIQITimeseriesGroupsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON qualityIQITimeseriesGroupsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*QualityIQITimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *QualityIQITimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type QualityIQITimeseriesGroupsResponseMetaDateRange ¶
type QualityIQITimeseriesGroupsResponseMetaDateRange 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 qualityIQITimeseriesGroupsResponseMetaDateRangeJSON `json:"-"`
}
func (*QualityIQITimeseriesGroupsResponseMetaDateRange) UnmarshalJSON ¶
func (r *QualityIQITimeseriesGroupsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type QualityIQITimeseriesGroupsResponseMetaNormalization ¶
type QualityIQITimeseriesGroupsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( QualityIQITimeseriesGroupsResponseMetaNormalizationPercentage QualityIQITimeseriesGroupsResponseMetaNormalization = "PERCENTAGE" QualityIQITimeseriesGroupsResponseMetaNormalizationMin0Max QualityIQITimeseriesGroupsResponseMetaNormalization = "MIN0_MAX" QualityIQITimeseriesGroupsResponseMetaNormalizationMinMax QualityIQITimeseriesGroupsResponseMetaNormalization = "MIN_MAX" QualityIQITimeseriesGroupsResponseMetaNormalizationRawValues QualityIQITimeseriesGroupsResponseMetaNormalization = "RAW_VALUES" QualityIQITimeseriesGroupsResponseMetaNormalizationPercentageChange QualityIQITimeseriesGroupsResponseMetaNormalization = "PERCENTAGE_CHANGE" QualityIQITimeseriesGroupsResponseMetaNormalizationRollingAverage QualityIQITimeseriesGroupsResponseMetaNormalization = "ROLLING_AVERAGE" QualityIQITimeseriesGroupsResponseMetaNormalizationOverlappedPercentage QualityIQITimeseriesGroupsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" QualityIQITimeseriesGroupsResponseMetaNormalizationRatio QualityIQITimeseriesGroupsResponseMetaNormalization = "RATIO" )
func (QualityIQITimeseriesGroupsResponseMetaNormalization) IsKnown ¶
func (r QualityIQITimeseriesGroupsResponseMetaNormalization) IsKnown() bool
type QualityIQITimeseriesGroupsResponseMetaUnit ¶
type QualityIQITimeseriesGroupsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON qualityIQITimeseriesGroupsResponseMetaUnitJSON `json:"-"`
}
func (*QualityIQITimeseriesGroupsResponseMetaUnit) UnmarshalJSON ¶
func (r *QualityIQITimeseriesGroupsResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Specifies the width for every bucket in the histogram.
BucketSize param.Field[int64] `query:"bucketSize"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Format in which results will be returned.
Format param.Field[QualitySpeedHistogramParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( QualitySpeedHistogramParamsFormatJson QualitySpeedHistogramParamsFormat = "JSON" QualitySpeedHistogramParamsFormatCsv QualitySpeedHistogramParamsFormat = "CSV" )
func (QualitySpeedHistogramParamsFormat) IsKnown ¶
func (r QualitySpeedHistogramParamsFormat) IsKnown() bool
type QualitySpeedHistogramParamsMetricGroup ¶
type QualitySpeedHistogramParamsMetricGroup string
Metrics to be returned.
const ( QualitySpeedHistogramParamsMetricGroupBandwidth QualitySpeedHistogramParamsMetricGroup = "BANDWIDTH" QualitySpeedHistogramParamsMetricGroupLatency QualitySpeedHistogramParamsMetricGroup = "LATENCY" QualitySpeedHistogramParamsMetricGroupJitter QualitySpeedHistogramParamsMetricGroup = "JITTER" )
func (QualitySpeedHistogramParamsMetricGroup) IsKnown ¶
func (r QualitySpeedHistogramParamsMetricGroup) IsKnown() bool
type QualitySpeedHistogramResponse ¶
type QualitySpeedHistogramResponse struct {
Histogram0 QualitySpeedHistogramResponseHistogram0 `json:"histogram_0,required"`
// Metadata for the results.
Meta QualitySpeedHistogramResponseMeta `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 QualitySpeedHistogramResponseMeta ¶
type QualitySpeedHistogramResponseMeta struct {
// The width for every bucket in the histogram.
BucketSize int64 `json:"bucketSize,required"`
ConfidenceInfo QualitySpeedHistogramResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []QualitySpeedHistogramResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization QualitySpeedHistogramResponseMetaNormalization `json:"normalization,required"`
TotalTests []int64 `json:"totalTests,required"`
// Measurement units for the results.
Units []QualitySpeedHistogramResponseMetaUnit `json:"units,required"`
JSON qualitySpeedHistogramResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*QualitySpeedHistogramResponseMeta) UnmarshalJSON ¶
func (r *QualitySpeedHistogramResponseMeta) UnmarshalJSON(data []byte) (err error)
type QualitySpeedHistogramResponseMetaConfidenceInfo ¶
type QualitySpeedHistogramResponseMetaConfidenceInfo struct {
Annotations []QualitySpeedHistogramResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON qualitySpeedHistogramResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*QualitySpeedHistogramResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *QualitySpeedHistogramResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type QualitySpeedHistogramResponseMetaConfidenceInfoAnnotation ¶
type QualitySpeedHistogramResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON qualitySpeedHistogramResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*QualitySpeedHistogramResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *QualitySpeedHistogramResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type QualitySpeedHistogramResponseMetaDateRange ¶
type QualitySpeedHistogramResponseMetaDateRange 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 qualitySpeedHistogramResponseMetaDateRangeJSON `json:"-"`
}
func (*QualitySpeedHistogramResponseMetaDateRange) UnmarshalJSON ¶
func (r *QualitySpeedHistogramResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type QualitySpeedHistogramResponseMetaNormalization ¶
type QualitySpeedHistogramResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( QualitySpeedHistogramResponseMetaNormalizationPercentage QualitySpeedHistogramResponseMetaNormalization = "PERCENTAGE" QualitySpeedHistogramResponseMetaNormalizationMin0Max QualitySpeedHistogramResponseMetaNormalization = "MIN0_MAX" QualitySpeedHistogramResponseMetaNormalizationMinMax QualitySpeedHistogramResponseMetaNormalization = "MIN_MAX" QualitySpeedHistogramResponseMetaNormalizationRawValues QualitySpeedHistogramResponseMetaNormalization = "RAW_VALUES" QualitySpeedHistogramResponseMetaNormalizationPercentageChange QualitySpeedHistogramResponseMetaNormalization = "PERCENTAGE_CHANGE" QualitySpeedHistogramResponseMetaNormalizationRollingAverage QualitySpeedHistogramResponseMetaNormalization = "ROLLING_AVERAGE" QualitySpeedHistogramResponseMetaNormalizationOverlappedPercentage QualitySpeedHistogramResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" QualitySpeedHistogramResponseMetaNormalizationRatio QualitySpeedHistogramResponseMetaNormalization = "RATIO" )
func (QualitySpeedHistogramResponseMetaNormalization) IsKnown ¶
func (r QualitySpeedHistogramResponseMetaNormalization) IsKnown() bool
type QualitySpeedHistogramResponseMetaUnit ¶
type QualitySpeedHistogramResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON qualitySpeedHistogramResponseMetaUnitJSON `json:"-"`
}
func (*QualitySpeedHistogramResponseMetaUnit) UnmarshalJSON ¶
func (r *QualitySpeedHistogramResponseMetaUnit) 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 ¶
func (r *QualitySpeedService) Histogram(ctx context.Context, query QualitySpeedHistogramParams, opts ...option.RequestOption) (res *QualitySpeedHistogramResponse, err error)
Retrieves a 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 ¶
func (r *QualitySpeedService) Summary(ctx context.Context, query QualitySpeedSummaryParams, opts ...option.RequestOption) (res *QualitySpeedSummaryResponse, err error)
Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the previous 90 days of Cloudflare Speed Test data.
type QualitySpeedSummaryParams ¶
type QualitySpeedSummaryParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Format in which results will be returned.
Format param.Field[QualitySpeedSummaryParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( QualitySpeedSummaryParamsFormatJson QualitySpeedSummaryParamsFormat = "JSON" QualitySpeedSummaryParamsFormatCsv QualitySpeedSummaryParamsFormat = "CSV" )
func (QualitySpeedSummaryParamsFormat) IsKnown ¶
func (r QualitySpeedSummaryParamsFormat) IsKnown() bool
type QualitySpeedSummaryResponse ¶
type QualitySpeedSummaryResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo QualitySpeedSummaryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []QualitySpeedSummaryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization QualitySpeedSummaryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []QualitySpeedSummaryResponseMetaUnit `json:"units,required"`
JSON qualitySpeedSummaryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*QualitySpeedSummaryResponseMeta) UnmarshalJSON ¶
func (r *QualitySpeedSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)
type QualitySpeedSummaryResponseMetaConfidenceInfo ¶
type QualitySpeedSummaryResponseMetaConfidenceInfo struct {
Annotations []QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON qualitySpeedSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 QualitySpeedSummaryResponseMetaNormalization ¶
type QualitySpeedSummaryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( QualitySpeedSummaryResponseMetaNormalizationPercentage QualitySpeedSummaryResponseMetaNormalization = "PERCENTAGE" QualitySpeedSummaryResponseMetaNormalizationMin0Max QualitySpeedSummaryResponseMetaNormalization = "MIN0_MAX" QualitySpeedSummaryResponseMetaNormalizationMinMax QualitySpeedSummaryResponseMetaNormalization = "MIN_MAX" QualitySpeedSummaryResponseMetaNormalizationRawValues QualitySpeedSummaryResponseMetaNormalization = "RAW_VALUES" QualitySpeedSummaryResponseMetaNormalizationPercentageChange QualitySpeedSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE" QualitySpeedSummaryResponseMetaNormalizationRollingAverage QualitySpeedSummaryResponseMetaNormalization = "ROLLING_AVERAGE" QualitySpeedSummaryResponseMetaNormalizationOverlappedPercentage QualitySpeedSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" QualitySpeedSummaryResponseMetaNormalizationRatio QualitySpeedSummaryResponseMetaNormalization = "RATIO" )
func (QualitySpeedSummaryResponseMetaNormalization) IsKnown ¶
func (r QualitySpeedSummaryResponseMetaNormalization) IsKnown() bool
type QualitySpeedSummaryResponseMetaUnit ¶
type QualitySpeedSummaryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON qualitySpeedSummaryResponseMetaUnitJSON `json:"-"`
}
func (*QualitySpeedSummaryResponseMetaUnit) UnmarshalJSON ¶
func (r *QualitySpeedSummaryResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Format in which results will be returned.
Format param.Field[QualitySpeedTopAsesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies the metric to order the results by.
OrderBy param.Field[QualitySpeedTopAsesParamsOrderBy] `query:"orderBy"`
// Reverses 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 in which results will be returned.
const ( QualitySpeedTopAsesParamsFormatJson QualitySpeedTopAsesParamsFormat = "JSON" QualitySpeedTopAsesParamsFormatCsv QualitySpeedTopAsesParamsFormat = "CSV" )
func (QualitySpeedTopAsesParamsFormat) IsKnown ¶
func (r QualitySpeedTopAsesParamsFormat) IsKnown() bool
type QualitySpeedTopAsesParamsOrderBy ¶
type QualitySpeedTopAsesParamsOrderBy string
Specifies the 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 ¶
func (r QualitySpeedTopAsesParamsOrderBy) IsKnown() bool
type QualitySpeedTopAsesResponse ¶
type QualitySpeedTopAsesResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo QualitySpeedTopAsesResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []QualitySpeedTopAsesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization QualitySpeedTopAsesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []QualitySpeedTopAsesResponseMetaUnit `json:"units,required"`
JSON qualitySpeedTopAsesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*QualitySpeedTopAsesResponseMeta) UnmarshalJSON ¶
func (r *QualitySpeedTopAsesResponseMeta) UnmarshalJSON(data []byte) (err error)
type QualitySpeedTopAsesResponseMetaConfidenceInfo ¶
type QualitySpeedTopAsesResponseMetaConfidenceInfo struct {
Annotations []QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON qualitySpeedTopAsesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *QualitySpeedTopAsesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 QualitySpeedTopAsesResponseMetaNormalization ¶
type QualitySpeedTopAsesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( QualitySpeedTopAsesResponseMetaNormalizationPercentage QualitySpeedTopAsesResponseMetaNormalization = "PERCENTAGE" QualitySpeedTopAsesResponseMetaNormalizationMin0Max QualitySpeedTopAsesResponseMetaNormalization = "MIN0_MAX" QualitySpeedTopAsesResponseMetaNormalizationMinMax QualitySpeedTopAsesResponseMetaNormalization = "MIN_MAX" QualitySpeedTopAsesResponseMetaNormalizationRawValues QualitySpeedTopAsesResponseMetaNormalization = "RAW_VALUES" QualitySpeedTopAsesResponseMetaNormalizationPercentageChange QualitySpeedTopAsesResponseMetaNormalization = "PERCENTAGE_CHANGE" QualitySpeedTopAsesResponseMetaNormalizationRollingAverage QualitySpeedTopAsesResponseMetaNormalization = "ROLLING_AVERAGE" QualitySpeedTopAsesResponseMetaNormalizationOverlappedPercentage QualitySpeedTopAsesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" QualitySpeedTopAsesResponseMetaNormalizationRatio QualitySpeedTopAsesResponseMetaNormalization = "RATIO" )
func (QualitySpeedTopAsesResponseMetaNormalization) IsKnown ¶
func (r QualitySpeedTopAsesResponseMetaNormalization) IsKnown() bool
type QualitySpeedTopAsesResponseMetaUnit ¶
type QualitySpeedTopAsesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON qualitySpeedTopAsesResponseMetaUnitJSON `json:"-"`
}
func (*QualitySpeedTopAsesResponseMetaUnit) UnmarshalJSON ¶
func (r *QualitySpeedTopAsesResponseMetaUnit) 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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Format in which results will be returned.
Format param.Field[QualitySpeedTopLocationsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Specifies the metric to order the results by.
OrderBy param.Field[QualitySpeedTopLocationsParamsOrderBy] `query:"orderBy"`
// Reverses 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 in which results will be returned.
const ( QualitySpeedTopLocationsParamsFormatJson QualitySpeedTopLocationsParamsFormat = "JSON" QualitySpeedTopLocationsParamsFormatCsv QualitySpeedTopLocationsParamsFormat = "CSV" )
func (QualitySpeedTopLocationsParamsFormat) IsKnown ¶
func (r QualitySpeedTopLocationsParamsFormat) IsKnown() bool
type QualitySpeedTopLocationsParamsOrderBy ¶
type QualitySpeedTopLocationsParamsOrderBy string
Specifies the 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 ¶
func (r QualitySpeedTopLocationsParamsOrderBy) IsKnown() bool
type QualitySpeedTopLocationsResponse ¶
type QualitySpeedTopLocationsResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo QualitySpeedTopLocationsResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []QualitySpeedTopLocationsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization QualitySpeedTopLocationsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []QualitySpeedTopLocationsResponseMetaUnit `json:"units,required"`
JSON qualitySpeedTopLocationsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*QualitySpeedTopLocationsResponseMeta) UnmarshalJSON ¶
func (r *QualitySpeedTopLocationsResponseMeta) UnmarshalJSON(data []byte) (err error)
type QualitySpeedTopLocationsResponseMetaConfidenceInfo ¶
type QualitySpeedTopLocationsResponseMetaConfidenceInfo struct {
Annotations []QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON qualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *QualitySpeedTopLocationsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 QualitySpeedTopLocationsResponseMetaNormalization ¶
type QualitySpeedTopLocationsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( QualitySpeedTopLocationsResponseMetaNormalizationPercentage QualitySpeedTopLocationsResponseMetaNormalization = "PERCENTAGE" QualitySpeedTopLocationsResponseMetaNormalizationMin0Max QualitySpeedTopLocationsResponseMetaNormalization = "MIN0_MAX" QualitySpeedTopLocationsResponseMetaNormalizationMinMax QualitySpeedTopLocationsResponseMetaNormalization = "MIN_MAX" QualitySpeedTopLocationsResponseMetaNormalizationRawValues QualitySpeedTopLocationsResponseMetaNormalization = "RAW_VALUES" QualitySpeedTopLocationsResponseMetaNormalizationPercentageChange QualitySpeedTopLocationsResponseMetaNormalization = "PERCENTAGE_CHANGE" QualitySpeedTopLocationsResponseMetaNormalizationRollingAverage QualitySpeedTopLocationsResponseMetaNormalization = "ROLLING_AVERAGE" QualitySpeedTopLocationsResponseMetaNormalizationOverlappedPercentage QualitySpeedTopLocationsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" QualitySpeedTopLocationsResponseMetaNormalizationRatio QualitySpeedTopLocationsResponseMetaNormalization = "RATIO" )
func (QualitySpeedTopLocationsResponseMetaNormalization) IsKnown ¶
func (r QualitySpeedTopLocationsResponseMetaNormalization) IsKnown() bool
type QualitySpeedTopLocationsResponseMetaUnit ¶
type QualitySpeedTopLocationsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON qualitySpeedTopLocationsResponseMetaUnitJSON `json:"-"`
}
func (*QualitySpeedTopLocationsResponseMetaUnit) UnmarshalJSON ¶
func (r *QualitySpeedTopLocationsResponseMetaUnit) 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 ¶
func (r *QualitySpeedTopService) Ases(ctx context.Context, query QualitySpeedTopAsesParams, opts ...option.RequestOption) (res *QualitySpeedTopAsesResponse, err error)
Retrieves the top autonomous systems by bandwidth, latency, jitter, or packet loss, from the previous 90 days of Cloudflare Speed Test data.
func (*QualitySpeedTopService) Locations ¶
func (r *QualitySpeedTopService) Locations(ctx context.Context, query QualitySpeedTopLocationsParams, opts ...option.RequestOption) (res *QualitySpeedTopLocationsResponse, err error)
Retrieves 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 {
// A numeric string.
Fail string `json:"FAIL,required"`
// A numeric string.
None string `json:"NONE,required"`
// A numeric string.
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
Bots *BotService
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
RobotsTXT *RobotsTXTService
LeakedCredentials *LeakedCredentialService
}
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 {
// Filters results by the specified array of dates.
Date param.Field[[]time.Time] `query:"date" format:"date"`
// Format in which results will be returned.
Format param.Field[RankingDomainGetParamsFormat] `query:"format"`
// Includes top locations in the response.
IncludeTopLocations param.Field[bool] `query:"includeTopLocations"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
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 in which results will be returned.
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 ¶
func (r RankingDomainGetParamsRankingType) IsKnown() bool
type RankingDomainGetResponse ¶
type RankingDomainGetResponse struct {
Details0 RankingDomainGetResponseDetails0 `json:"details_0,required"`
Meta RankingDomainGetResponseMeta `json:"meta,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"`
// Only available in POPULAR ranking for the most recent ranking.
Bucket string `json:"bucket"`
Rank int64 `json:"rank"`
TopLocations []RankingDomainGetResponseDetails0TopLocation `json:"top_locations"`
JSON rankingDomainGetResponseDetails0JSON `json:"-"`
}
func (*RankingDomainGetResponseDetails0) UnmarshalJSON ¶
func (r *RankingDomainGetResponseDetails0) UnmarshalJSON(data []byte) (err error)
type RankingDomainGetResponseDetails0Category ¶
type RankingDomainGetResponseDetails0Category struct {
ID int64 `json:"id,required"`
Name string `json:"name,required"`
SuperCategoryID int64 `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 RankingDomainGetResponseMeta ¶
type RankingDomainGetResponseMeta struct {
DateRange []RankingDomainGetResponseMetaDateRange `json:"dateRange,required"`
JSON rankingDomainGetResponseMetaJSON `json:"-"`
}
func (*RankingDomainGetResponseMeta) UnmarshalJSON ¶
func (r *RankingDomainGetResponseMeta) UnmarshalJSON(data []byte) (err error)
type RankingDomainGetResponseMetaDateRange ¶
type RankingDomainGetResponseMetaDateRange 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 rankingDomainGetResponseMetaDateRangeJSON `json:"-"`
}
func (*RankingDomainGetResponseMetaDateRange) UnmarshalJSON ¶
func (r *RankingDomainGetResponseMetaDateRange) 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 ¶
func (r *RankingDomainService) Get(ctx context.Context, domain string, query RankingDomainGetParams, opts ...option.RequestOption) (res *RankingDomainGetResponse, err error)
Retrieves domain 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 RankingInternetServiceCategoriesParams ¶
type RankingInternetServiceCategoriesParams struct {
// Filters results by the specified array of dates.
Date param.Field[[]time.Time] `query:"date" format:"date"`
// Format in which results will be returned.
Format param.Field[RankingInternetServiceCategoriesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (RankingInternetServiceCategoriesParams) URLQuery ¶
func (r RankingInternetServiceCategoriesParams) URLQuery() (v url.Values)
URLQuery serializes RankingInternetServiceCategoriesParams's query parameters as `url.Values`.
type RankingInternetServiceCategoriesParamsFormat ¶
type RankingInternetServiceCategoriesParamsFormat string
Format in which results will be returned.
const ( RankingInternetServiceCategoriesParamsFormatJson RankingInternetServiceCategoriesParamsFormat = "JSON" RankingInternetServiceCategoriesParamsFormatCsv RankingInternetServiceCategoriesParamsFormat = "CSV" )
func (RankingInternetServiceCategoriesParamsFormat) IsKnown ¶
func (r RankingInternetServiceCategoriesParamsFormat) IsKnown() bool
type RankingInternetServiceCategoriesResponse ¶
type RankingInternetServiceCategoriesResponse struct {
Categories0 []RankingInternetServiceCategoriesResponseCategories0 `json:"categories_0,required"`
JSON rankingInternetServiceCategoriesResponseJSON `json:"-"`
}
func (*RankingInternetServiceCategoriesResponse) UnmarshalJSON ¶
func (r *RankingInternetServiceCategoriesResponse) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceCategoriesResponseCategories0 ¶
type RankingInternetServiceCategoriesResponseCategories0 struct {
Name string `json:"name,required"`
JSON rankingInternetServiceCategoriesResponseCategories0JSON `json:"-"`
}
func (*RankingInternetServiceCategoriesResponseCategories0) UnmarshalJSON ¶
func (r *RankingInternetServiceCategoriesResponseCategories0) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceCategoriesResponseEnvelope ¶
type RankingInternetServiceCategoriesResponseEnvelope struct {
Result RankingInternetServiceCategoriesResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON rankingInternetServiceCategoriesResponseEnvelopeJSON `json:"-"`
}
func (*RankingInternetServiceCategoriesResponseEnvelope) UnmarshalJSON ¶
func (r *RankingInternetServiceCategoriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceService ¶
type RankingInternetServiceService struct {
Options []option.RequestOption
}
RankingInternetServiceService 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 NewRankingInternetServiceService method instead.
func NewRankingInternetServiceService ¶
func NewRankingInternetServiceService(opts ...option.RequestOption) (r *RankingInternetServiceService)
NewRankingInternetServiceService 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 (*RankingInternetServiceService) Categories ¶
func (r *RankingInternetServiceService) Categories(ctx context.Context, query RankingInternetServiceCategoriesParams, opts ...option.RequestOption) (res *RankingInternetServiceCategoriesResponse, err error)
Retrieves the list of Internet services categories.
func (*RankingInternetServiceService) TimeseriesGroups ¶
func (r *RankingInternetServiceService) TimeseriesGroups(ctx context.Context, query RankingInternetServiceTimeseriesGroupsParams, opts ...option.RequestOption) (res *RankingInternetServiceTimeseriesGroupsResponse, err error)
Retrieves Internet Services rank update changes over time.
func (*RankingInternetServiceService) Top ¶
func (r *RankingInternetServiceService) Top(ctx context.Context, query RankingInternetServiceTopParams, opts ...option.RequestOption) (res *RankingInternetServiceTopResponse, err error)
Retrieves top Internet services based on their rank.
type RankingInternetServiceTimeseriesGroupsParams ¶
type RankingInternetServiceTimeseriesGroupsParams struct {
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[RankingInternetServiceTimeseriesGroupsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by Internet service category.
ServiceCategory param.Field[[]string] `query:"serviceCategory"`
}
func (RankingInternetServiceTimeseriesGroupsParams) URLQuery ¶
func (r RankingInternetServiceTimeseriesGroupsParams) URLQuery() (v url.Values)
URLQuery serializes RankingInternetServiceTimeseriesGroupsParams's query parameters as `url.Values`.
type RankingInternetServiceTimeseriesGroupsParamsFormat ¶
type RankingInternetServiceTimeseriesGroupsParamsFormat string
Format in which results will be returned.
const ( RankingInternetServiceTimeseriesGroupsParamsFormatJson RankingInternetServiceTimeseriesGroupsParamsFormat = "JSON" RankingInternetServiceTimeseriesGroupsParamsFormatCsv RankingInternetServiceTimeseriesGroupsParamsFormat = "CSV" )
func (RankingInternetServiceTimeseriesGroupsParamsFormat) IsKnown ¶
func (r RankingInternetServiceTimeseriesGroupsParamsFormat) IsKnown() bool
type RankingInternetServiceTimeseriesGroupsResponse ¶
type RankingInternetServiceTimeseriesGroupsResponse struct {
// Metadata for the results.
Meta RankingInternetServiceTimeseriesGroupsResponseMeta `json:"meta,required"`
Serie0 RankingInternetServiceTimeseriesGroupsResponseSerie0 `json:"serie_0,required"`
JSON rankingInternetServiceTimeseriesGroupsResponseJSON `json:"-"`
}
func (*RankingInternetServiceTimeseriesGroupsResponse) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponse) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseEnvelope ¶
type RankingInternetServiceTimeseriesGroupsResponseEnvelope struct {
Result RankingInternetServiceTimeseriesGroupsResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON rankingInternetServiceTimeseriesGroupsResponseEnvelopeJSON `json:"-"`
}
func (*RankingInternetServiceTimeseriesGroupsResponseEnvelope) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseMeta ¶
type RankingInternetServiceTimeseriesGroupsResponseMeta struct {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []RankingInternetServiceTimeseriesGroupsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization RankingInternetServiceTimeseriesGroupsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []RankingInternetServiceTimeseriesGroupsResponseMetaUnit `json:"units,required"`
JSON rankingInternetServiceTimeseriesGroupsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*RankingInternetServiceTimeseriesGroupsResponseMeta) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval ¶
type RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( RankingInternetServiceTimeseriesGroupsResponseMetaAggIntervalFifteenMinutes RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval = "FIFTEEN_MINUTES" RankingInternetServiceTimeseriesGroupsResponseMetaAggIntervalOneHour RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval = "ONE_HOUR" RankingInternetServiceTimeseriesGroupsResponseMetaAggIntervalOneDay RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval = "ONE_DAY" RankingInternetServiceTimeseriesGroupsResponseMetaAggIntervalOneWeek RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval = "ONE_WEEK" RankingInternetServiceTimeseriesGroupsResponseMetaAggIntervalOneMonth RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval = "ONE_MONTH" )
func (RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval) IsKnown ¶
func (r RankingInternetServiceTimeseriesGroupsResponseMetaAggInterval) IsKnown() bool
type RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfo ¶
type RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfo struct {
Annotations []RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON rankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoAnnotation ¶
type RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON rankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseMetaDateRange ¶
type RankingInternetServiceTimeseriesGroupsResponseMetaDateRange 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 rankingInternetServiceTimeseriesGroupsResponseMetaDateRangeJSON `json:"-"`
}
func (*RankingInternetServiceTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseMetaNormalization ¶
type RankingInternetServiceTimeseriesGroupsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationPercentage RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE" RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationMin0Max RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "MIN0_MAX" RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationMinMax RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "MIN_MAX" RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationRawValues RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "RAW_VALUES" RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationPercentageChange RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE_CHANGE" RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationRollingAverage RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "ROLLING_AVERAGE" RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationOverlappedPercentage RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" RankingInternetServiceTimeseriesGroupsResponseMetaNormalizationRatio RankingInternetServiceTimeseriesGroupsResponseMetaNormalization = "RATIO" )
func (RankingInternetServiceTimeseriesGroupsResponseMetaNormalization) IsKnown ¶
func (r RankingInternetServiceTimeseriesGroupsResponseMetaNormalization) IsKnown() bool
type RankingInternetServiceTimeseriesGroupsResponseMetaUnit ¶
type RankingInternetServiceTimeseriesGroupsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON rankingInternetServiceTimeseriesGroupsResponseMetaUnitJSON `json:"-"`
}
func (*RankingInternetServiceTimeseriesGroupsResponseMetaUnit) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseSerie0 ¶
type RankingInternetServiceTimeseriesGroupsResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
ExtraFields map[string][]RankingInternetServiceTimeseriesGroupsResponseSerie0Union `json:"-,extras"`
JSON rankingInternetServiceTimeseriesGroupsResponseSerie0JSON `json:"-"`
}
func (*RankingInternetServiceTimeseriesGroupsResponseSerie0) UnmarshalJSON ¶
func (r *RankingInternetServiceTimeseriesGroupsResponseSerie0) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTimeseriesGroupsResponseSerie0Union ¶
type RankingInternetServiceTimeseriesGroupsResponseSerie0Union interface {
ImplementsRankingInternetServiceTimeseriesGroupsResponseSerie0Union()
}
A numeric string.
Union satisfied by shared.UnionString or shared.UnionFloat.
type RankingInternetServiceTopParams ¶
type RankingInternetServiceTopParams struct {
// Filters results by the specified array of dates.
Date param.Field[[]time.Time] `query:"date" format:"date"`
// Format in which results will be returned.
Format param.Field[RankingInternetServiceTopParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by Internet service category.
ServiceCategory param.Field[[]string] `query:"serviceCategory"`
}
func (RankingInternetServiceTopParams) URLQuery ¶
func (r RankingInternetServiceTopParams) URLQuery() (v url.Values)
URLQuery serializes RankingInternetServiceTopParams's query parameters as `url.Values`.
type RankingInternetServiceTopParamsFormat ¶
type RankingInternetServiceTopParamsFormat string
Format in which results will be returned.
const ( RankingInternetServiceTopParamsFormatJson RankingInternetServiceTopParamsFormat = "JSON" RankingInternetServiceTopParamsFormatCsv RankingInternetServiceTopParamsFormat = "CSV" )
func (RankingInternetServiceTopParamsFormat) IsKnown ¶
func (r RankingInternetServiceTopParamsFormat) IsKnown() bool
type RankingInternetServiceTopResponse ¶
type RankingInternetServiceTopResponse struct {
Meta RankingInternetServiceTopResponseMeta `json:"meta,required"`
Top0 []RankingInternetServiceTopResponseTop0 `json:"top_0,required"`
JSON rankingInternetServiceTopResponseJSON `json:"-"`
}
func (*RankingInternetServiceTopResponse) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponse) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTopResponseEnvelope ¶
type RankingInternetServiceTopResponseEnvelope struct {
Result RankingInternetServiceTopResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON rankingInternetServiceTopResponseEnvelopeJSON `json:"-"`
}
func (*RankingInternetServiceTopResponseEnvelope) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTopResponseMeta ¶
type RankingInternetServiceTopResponseMeta struct {
ConfidenceInfo RankingInternetServiceTopResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []RankingInternetServiceTopResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization RankingInternetServiceTopResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []RankingInternetServiceTopResponseMetaUnit `json:"units,required"`
JSON rankingInternetServiceTopResponseMetaJSON `json:"-"`
}
func (*RankingInternetServiceTopResponseMeta) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponseMeta) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTopResponseMetaConfidenceInfo ¶
type RankingInternetServiceTopResponseMetaConfidenceInfo struct {
Annotations []RankingInternetServiceTopResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON rankingInternetServiceTopResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*RankingInternetServiceTopResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTopResponseMetaConfidenceInfoAnnotation ¶
type RankingInternetServiceTopResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON rankingInternetServiceTopResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*RankingInternetServiceTopResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTopResponseMetaDateRange ¶
type RankingInternetServiceTopResponseMetaDateRange 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 rankingInternetServiceTopResponseMetaDateRangeJSON `json:"-"`
}
func (*RankingInternetServiceTopResponseMetaDateRange) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTopResponseMetaNormalization ¶
type RankingInternetServiceTopResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( RankingInternetServiceTopResponseMetaNormalizationPercentage RankingInternetServiceTopResponseMetaNormalization = "PERCENTAGE" RankingInternetServiceTopResponseMetaNormalizationMin0Max RankingInternetServiceTopResponseMetaNormalization = "MIN0_MAX" RankingInternetServiceTopResponseMetaNormalizationMinMax RankingInternetServiceTopResponseMetaNormalization = "MIN_MAX" RankingInternetServiceTopResponseMetaNormalizationRawValues RankingInternetServiceTopResponseMetaNormalization = "RAW_VALUES" RankingInternetServiceTopResponseMetaNormalizationPercentageChange RankingInternetServiceTopResponseMetaNormalization = "PERCENTAGE_CHANGE" RankingInternetServiceTopResponseMetaNormalizationRollingAverage RankingInternetServiceTopResponseMetaNormalization = "ROLLING_AVERAGE" RankingInternetServiceTopResponseMetaNormalizationOverlappedPercentage RankingInternetServiceTopResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" RankingInternetServiceTopResponseMetaNormalizationRatio RankingInternetServiceTopResponseMetaNormalization = "RATIO" )
func (RankingInternetServiceTopResponseMetaNormalization) IsKnown ¶
func (r RankingInternetServiceTopResponseMetaNormalization) IsKnown() bool
type RankingInternetServiceTopResponseMetaUnit ¶
type RankingInternetServiceTopResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON rankingInternetServiceTopResponseMetaUnitJSON `json:"-"`
}
func (*RankingInternetServiceTopResponseMetaUnit) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type RankingInternetServiceTopResponseTop0 ¶
type RankingInternetServiceTopResponseTop0 struct {
Rank int64 `json:"rank,required"`
Service string `json:"service,required"`
JSON rankingInternetServiceTopResponseTop0JSON `json:"-"`
}
func (*RankingInternetServiceTopResponseTop0) UnmarshalJSON ¶
func (r *RankingInternetServiceTopResponseTop0) UnmarshalJSON(data []byte) (err error)
type RankingService ¶
type RankingService struct {
Options []option.RequestOption
Domain *RankingDomainService
InternetServices *RankingInternetServiceService
}
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 ¶
func (r *RankingService) TimeseriesGroups(ctx context.Context, query RankingTimeseriesGroupsParams, opts ...option.RequestOption) (res *RankingTimeseriesGroupsResponse, err error)
Retrieves domains rank over time.
func (*RankingService) Top ¶
func (r *RankingService) Top(ctx context.Context, query RankingTopParams, opts ...option.RequestOption) (res *RankingTopResponse, err error)
Retrieves the 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"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filters results by domain category.
DomainCategory param.Field[[]string] `query:"domainCategory"`
// Filters results by domain name. Specify a comma-separated list of domain names.
Domains param.Field[[]string] `query:"domains"`
// Format in which results will be returned.
Format param.Field[RankingTimeseriesGroupsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 location
// codes.
Location param.Field[[]string] `query:"location"`
// Array of names used to label the series in the response.
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 in which results will be returned.
const ( RankingTimeseriesGroupsParamsFormatJson RankingTimeseriesGroupsParamsFormat = "JSON" RankingTimeseriesGroupsParamsFormatCsv RankingTimeseriesGroupsParamsFormat = "CSV" )
func (RankingTimeseriesGroupsParamsFormat) IsKnown ¶
func (r RankingTimeseriesGroupsParamsFormat) IsKnown() bool
type RankingTimeseriesGroupsParamsRankingType ¶
type RankingTimeseriesGroupsParamsRankingType string
The ranking type.
const ( RankingTimeseriesGroupsParamsRankingTypePopular RankingTimeseriesGroupsParamsRankingType = "POPULAR" RankingTimeseriesGroupsParamsRankingTypeTrendingRise RankingTimeseriesGroupsParamsRankingType = "TRENDING_RISE" RankingTimeseriesGroupsParamsRankingTypeTrendingSteady RankingTimeseriesGroupsParamsRankingType = "TRENDING_STEADY" )
func (RankingTimeseriesGroupsParamsRankingType) IsKnown ¶
func (r RankingTimeseriesGroupsParamsRankingType) IsKnown() bool
type RankingTimeseriesGroupsResponse ¶
type RankingTimeseriesGroupsResponse struct {
// Metadata for the results.
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 {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval RankingTimeseriesGroupsResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo RankingTimeseriesGroupsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []RankingTimeseriesGroupsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization RankingTimeseriesGroupsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []RankingTimeseriesGroupsResponseMetaUnit `json:"units,required"`
JSON rankingTimeseriesGroupsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*RankingTimeseriesGroupsResponseMeta) UnmarshalJSON ¶
func (r *RankingTimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)
type RankingTimeseriesGroupsResponseMetaAggInterval ¶
type RankingTimeseriesGroupsResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( RankingTimeseriesGroupsResponseMetaAggIntervalFifteenMinutes RankingTimeseriesGroupsResponseMetaAggInterval = "FIFTEEN_MINUTES" RankingTimeseriesGroupsResponseMetaAggIntervalOneHour RankingTimeseriesGroupsResponseMetaAggInterval = "ONE_HOUR" RankingTimeseriesGroupsResponseMetaAggIntervalOneDay RankingTimeseriesGroupsResponseMetaAggInterval = "ONE_DAY" RankingTimeseriesGroupsResponseMetaAggIntervalOneWeek RankingTimeseriesGroupsResponseMetaAggInterval = "ONE_WEEK" RankingTimeseriesGroupsResponseMetaAggIntervalOneMonth RankingTimeseriesGroupsResponseMetaAggInterval = "ONE_MONTH" )
func (RankingTimeseriesGroupsResponseMetaAggInterval) IsKnown ¶
func (r RankingTimeseriesGroupsResponseMetaAggInterval) IsKnown() bool
type RankingTimeseriesGroupsResponseMetaConfidenceInfo ¶
type RankingTimeseriesGroupsResponseMetaConfidenceInfo struct {
Annotations []RankingTimeseriesGroupsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON rankingTimeseriesGroupsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*RankingTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *RankingTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type RankingTimeseriesGroupsResponseMetaConfidenceInfoAnnotation ¶
type RankingTimeseriesGroupsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON rankingTimeseriesGroupsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*RankingTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *RankingTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) 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 RankingTimeseriesGroupsResponseMetaNormalization ¶
type RankingTimeseriesGroupsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( RankingTimeseriesGroupsResponseMetaNormalizationPercentage RankingTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE" RankingTimeseriesGroupsResponseMetaNormalizationMin0Max RankingTimeseriesGroupsResponseMetaNormalization = "MIN0_MAX" RankingTimeseriesGroupsResponseMetaNormalizationMinMax RankingTimeseriesGroupsResponseMetaNormalization = "MIN_MAX" RankingTimeseriesGroupsResponseMetaNormalizationRawValues RankingTimeseriesGroupsResponseMetaNormalization = "RAW_VALUES" RankingTimeseriesGroupsResponseMetaNormalizationPercentageChange RankingTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE_CHANGE" RankingTimeseriesGroupsResponseMetaNormalizationRollingAverage RankingTimeseriesGroupsResponseMetaNormalization = "ROLLING_AVERAGE" RankingTimeseriesGroupsResponseMetaNormalizationOverlappedPercentage RankingTimeseriesGroupsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" RankingTimeseriesGroupsResponseMetaNormalizationRatio RankingTimeseriesGroupsResponseMetaNormalization = "RATIO" )
func (RankingTimeseriesGroupsResponseMetaNormalization) IsKnown ¶
func (r RankingTimeseriesGroupsResponseMetaNormalization) IsKnown() bool
type RankingTimeseriesGroupsResponseMetaUnit ¶
type RankingTimeseriesGroupsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON rankingTimeseriesGroupsResponseMetaUnitJSON `json:"-"`
}
func (*RankingTimeseriesGroupsResponseMetaUnit) UnmarshalJSON ¶
func (r *RankingTimeseriesGroupsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type RankingTimeseriesGroupsResponseSerie0 ¶
type RankingTimeseriesGroupsResponseSerie0 struct {
Timestamps []time.Time `json:"timestamps,required" format:"date-time"`
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 {
ImplementsRankingTimeseriesGroupsResponseSerie0Union()
}
A numeric string.
Union satisfied by shared.UnionString or shared.UnionFloat.
type RankingTopParams ¶
type RankingTopParams struct {
// Filters results by the specified array of dates.
Date param.Field[[]time.Time] `query:"date" format:"date"`
// Filters results by domain category.
DomainCategory param.Field[[]string] `query:"domainCategory"`
// Format in which results will be returned.
Format param.Field[RankingTopParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 location
// codes.
Location param.Field[[]string] `query:"location"`
// Array of names used to label the series in the response.
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 in which results will be returned.
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 {
ConfidenceInfo RankingTopResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []RankingTopResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization RankingTopResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []RankingTopResponseMetaUnit `json:"units,required"`
JSON rankingTopResponseMetaJSON `json:"-"`
}
func (*RankingTopResponseMeta) UnmarshalJSON ¶
func (r *RankingTopResponseMeta) UnmarshalJSON(data []byte) (err error)
type RankingTopResponseMetaConfidenceInfo ¶
type RankingTopResponseMetaConfidenceInfo struct {
Annotations []RankingTopResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON rankingTopResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*RankingTopResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *RankingTopResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type RankingTopResponseMetaConfidenceInfoAnnotation ¶
type RankingTopResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON rankingTopResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*RankingTopResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *RankingTopResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type RankingTopResponseMetaDateRange ¶
type RankingTopResponseMetaDateRange 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 rankingTopResponseMetaDateRangeJSON `json:"-"`
}
func (*RankingTopResponseMetaDateRange) UnmarshalJSON ¶
func (r *RankingTopResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type RankingTopResponseMetaNormalization ¶
type RankingTopResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( RankingTopResponseMetaNormalizationPercentage RankingTopResponseMetaNormalization = "PERCENTAGE" RankingTopResponseMetaNormalizationMin0Max RankingTopResponseMetaNormalization = "MIN0_MAX" RankingTopResponseMetaNormalizationMinMax RankingTopResponseMetaNormalization = "MIN_MAX" RankingTopResponseMetaNormalizationRawValues RankingTopResponseMetaNormalization = "RAW_VALUES" RankingTopResponseMetaNormalizationPercentageChange RankingTopResponseMetaNormalization = "PERCENTAGE_CHANGE" RankingTopResponseMetaNormalizationRollingAverage RankingTopResponseMetaNormalization = "ROLLING_AVERAGE" RankingTopResponseMetaNormalizationOverlappedPercentage RankingTopResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" RankingTopResponseMetaNormalizationRatio RankingTopResponseMetaNormalization = "RATIO" )
func (RankingTopResponseMetaNormalization) IsKnown ¶
func (r RankingTopResponseMetaNormalization) IsKnown() bool
type RankingTopResponseMetaUnit ¶
type RankingTopResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON rankingTopResponseMetaUnitJSON `json:"-"`
}
func (*RankingTopResponseMetaUnit) UnmarshalJSON ¶
func (r *RankingTopResponseMetaUnit) 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 RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
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 ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RobotsTXTService ¶
type RobotsTXTService struct {
Options []option.RequestOption
Top *RobotsTXTTopService
}
RobotsTXTService 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 NewRobotsTXTService method instead.
func NewRobotsTXTService ¶
func NewRobotsTXTService(opts ...option.RequestOption) (r *RobotsTXTService)
NewRobotsTXTService 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 RobotsTXTTopDomainCategoriesParams ¶
type RobotsTXTTopDomainCategoriesParams struct {
// Filters results by the specified array of dates.
Date param.Field[[]time.Time] `query:"date" format:"date"`
// Format in which results will be returned.
Format param.Field[RobotsTXTTopDomainCategoriesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by user agent category.
UserAgentCategory param.Field[RobotsTXTTopDomainCategoriesParamsUserAgentCategory] `query:"userAgentCategory"`
}
func (RobotsTXTTopDomainCategoriesParams) URLQuery ¶
func (r RobotsTXTTopDomainCategoriesParams) URLQuery() (v url.Values)
URLQuery serializes RobotsTXTTopDomainCategoriesParams's query parameters as `url.Values`.
type RobotsTXTTopDomainCategoriesParamsFormat ¶
type RobotsTXTTopDomainCategoriesParamsFormat string
Format in which results will be returned.
const ( RobotsTXTTopDomainCategoriesParamsFormatJson RobotsTXTTopDomainCategoriesParamsFormat = "JSON" RobotsTXTTopDomainCategoriesParamsFormatCsv RobotsTXTTopDomainCategoriesParamsFormat = "CSV" )
func (RobotsTXTTopDomainCategoriesParamsFormat) IsKnown ¶
func (r RobotsTXTTopDomainCategoriesParamsFormat) IsKnown() bool
type RobotsTXTTopDomainCategoriesParamsUserAgentCategory ¶
type RobotsTXTTopDomainCategoriesParamsUserAgentCategory string
Filters results by user agent category.
const (
RobotsTXTTopDomainCategoriesParamsUserAgentCategoryAI RobotsTXTTopDomainCategoriesParamsUserAgentCategory = "AI"
)
func (RobotsTXTTopDomainCategoriesParamsUserAgentCategory) IsKnown ¶
func (r RobotsTXTTopDomainCategoriesParamsUserAgentCategory) IsKnown() bool
type RobotsTXTTopDomainCategoriesResponse ¶
type RobotsTXTTopDomainCategoriesResponse struct {
// Metadata for the results.
Meta RobotsTXTTopDomainCategoriesResponseMeta `json:"meta,required"`
Top0 []RobotsTXTTopDomainCategoriesResponseTop0 `json:"top_0,required"`
JSON robotsTXTTopDomainCategoriesResponseJSON `json:"-"`
}
func (*RobotsTXTTopDomainCategoriesResponse) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponse) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopDomainCategoriesResponseEnvelope ¶
type RobotsTXTTopDomainCategoriesResponseEnvelope struct {
Result RobotsTXTTopDomainCategoriesResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON robotsTXTTopDomainCategoriesResponseEnvelopeJSON `json:"-"`
}
func (*RobotsTXTTopDomainCategoriesResponseEnvelope) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopDomainCategoriesResponseMeta ¶
type RobotsTXTTopDomainCategoriesResponseMeta struct {
ConfidenceInfo RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []RobotsTXTTopDomainCategoriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization RobotsTXTTopDomainCategoriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []RobotsTXTTopDomainCategoriesResponseMetaUnit `json:"units,required"`
JSON robotsTXTTopDomainCategoriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*RobotsTXTTopDomainCategoriesResponseMeta) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfo ¶
type RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfo struct {
Annotations []RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON robotsTXTTopDomainCategoriesResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfoAnnotation ¶
type RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON robotsTXTTopDomainCategoriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopDomainCategoriesResponseMetaDateRange ¶
type RobotsTXTTopDomainCategoriesResponseMetaDateRange 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 robotsTXTTopDomainCategoriesResponseMetaDateRangeJSON `json:"-"`
}
func (*RobotsTXTTopDomainCategoriesResponseMetaDateRange) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopDomainCategoriesResponseMetaNormalization ¶
type RobotsTXTTopDomainCategoriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( RobotsTXTTopDomainCategoriesResponseMetaNormalizationPercentage RobotsTXTTopDomainCategoriesResponseMetaNormalization = "PERCENTAGE" RobotsTXTTopDomainCategoriesResponseMetaNormalizationMin0Max RobotsTXTTopDomainCategoriesResponseMetaNormalization = "MIN0_MAX" RobotsTXTTopDomainCategoriesResponseMetaNormalizationMinMax RobotsTXTTopDomainCategoriesResponseMetaNormalization = "MIN_MAX" RobotsTXTTopDomainCategoriesResponseMetaNormalizationRawValues RobotsTXTTopDomainCategoriesResponseMetaNormalization = "RAW_VALUES" RobotsTXTTopDomainCategoriesResponseMetaNormalizationPercentageChange RobotsTXTTopDomainCategoriesResponseMetaNormalization = "PERCENTAGE_CHANGE" RobotsTXTTopDomainCategoriesResponseMetaNormalizationRollingAverage RobotsTXTTopDomainCategoriesResponseMetaNormalization = "ROLLING_AVERAGE" RobotsTXTTopDomainCategoriesResponseMetaNormalizationOverlappedPercentage RobotsTXTTopDomainCategoriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" RobotsTXTTopDomainCategoriesResponseMetaNormalizationRatio RobotsTXTTopDomainCategoriesResponseMetaNormalization = "RATIO" )
func (RobotsTXTTopDomainCategoriesResponseMetaNormalization) IsKnown ¶
func (r RobotsTXTTopDomainCategoriesResponseMetaNormalization) IsKnown() bool
type RobotsTXTTopDomainCategoriesResponseMetaUnit ¶
type RobotsTXTTopDomainCategoriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON robotsTXTTopDomainCategoriesResponseMetaUnitJSON `json:"-"`
}
func (*RobotsTXTTopDomainCategoriesResponseMetaUnit) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopDomainCategoriesResponseTop0 ¶
type RobotsTXTTopDomainCategoriesResponseTop0 struct {
Name string `json:"name,required"`
Value int64 `json:"value,required"`
JSON robotsTXTTopDomainCategoriesResponseTop0JSON `json:"-"`
}
func (*RobotsTXTTopDomainCategoriesResponseTop0) UnmarshalJSON ¶
func (r *RobotsTXTTopDomainCategoriesResponseTop0) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopService ¶
type RobotsTXTTopService struct {
Options []option.RequestOption
UserAgents *RobotsTXTTopUserAgentService
}
RobotsTXTTopService 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 NewRobotsTXTTopService method instead.
func NewRobotsTXTTopService ¶
func NewRobotsTXTTopService(opts ...option.RequestOption) (r *RobotsTXTTopService)
NewRobotsTXTTopService 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 (*RobotsTXTTopService) DomainCategories ¶
func (r *RobotsTXTTopService) DomainCategories(ctx context.Context, query RobotsTXTTopDomainCategoriesParams, opts ...option.RequestOption) (res *RobotsTXTTopDomainCategoriesResponse, err error)
Retrieves the top domain categories by the number of robots.txt files parsed.
type RobotsTXTTopUserAgentDirectiveParams ¶
type RobotsTXTTopUserAgentDirectiveParams struct {
// Filters results by the specified array of dates.
Date param.Field[[]time.Time] `query:"date" format:"date"`
// Filters results by robots.txt directive.
Directive param.Field[RobotsTXTTopUserAgentDirectiveParamsDirective] `query:"directive"`
// Filters results by domain category.
DomainCategory param.Field[[]string] `query:"domainCategory"`
// Format in which results will be returned.
Format param.Field[RobotsTXTTopUserAgentDirectiveParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Array of names used to label the series in the response.
Name param.Field[[]string] `query:"name"`
// Filters results by user agent category.
UserAgentCategory param.Field[RobotsTXTTopUserAgentDirectiveParamsUserAgentCategory] `query:"userAgentCategory"`
}
func (RobotsTXTTopUserAgentDirectiveParams) URLQuery ¶
func (r RobotsTXTTopUserAgentDirectiveParams) URLQuery() (v url.Values)
URLQuery serializes RobotsTXTTopUserAgentDirectiveParams's query parameters as `url.Values`.
type RobotsTXTTopUserAgentDirectiveParamsDirective ¶
type RobotsTXTTopUserAgentDirectiveParamsDirective string
Filters results by robots.txt directive.
const ( RobotsTXTTopUserAgentDirectiveParamsDirectiveAllow RobotsTXTTopUserAgentDirectiveParamsDirective = "ALLOW" RobotsTXTTopUserAgentDirectiveParamsDirectiveDisallow RobotsTXTTopUserAgentDirectiveParamsDirective = "DISALLOW" )
func (RobotsTXTTopUserAgentDirectiveParamsDirective) IsKnown ¶
func (r RobotsTXTTopUserAgentDirectiveParamsDirective) IsKnown() bool
type RobotsTXTTopUserAgentDirectiveParamsFormat ¶
type RobotsTXTTopUserAgentDirectiveParamsFormat string
Format in which results will be returned.
const ( RobotsTXTTopUserAgentDirectiveParamsFormatJson RobotsTXTTopUserAgentDirectiveParamsFormat = "JSON" RobotsTXTTopUserAgentDirectiveParamsFormatCsv RobotsTXTTopUserAgentDirectiveParamsFormat = "CSV" )
func (RobotsTXTTopUserAgentDirectiveParamsFormat) IsKnown ¶
func (r RobotsTXTTopUserAgentDirectiveParamsFormat) IsKnown() bool
type RobotsTXTTopUserAgentDirectiveParamsUserAgentCategory ¶
type RobotsTXTTopUserAgentDirectiveParamsUserAgentCategory string
Filters results by user agent category.
const (
RobotsTXTTopUserAgentDirectiveParamsUserAgentCategoryAI RobotsTXTTopUserAgentDirectiveParamsUserAgentCategory = "AI"
)
func (RobotsTXTTopUserAgentDirectiveParamsUserAgentCategory) IsKnown ¶
func (r RobotsTXTTopUserAgentDirectiveParamsUserAgentCategory) IsKnown() bool
type RobotsTXTTopUserAgentDirectiveResponse ¶
type RobotsTXTTopUserAgentDirectiveResponse struct {
// Metadata for the results.
Meta RobotsTXTTopUserAgentDirectiveResponseMeta `json:"meta,required"`
Top0 []RobotsTXTTopUserAgentDirectiveResponseTop0 `json:"top_0,required"`
JSON robotsTXTTopUserAgentDirectiveResponseJSON `json:"-"`
}
func (*RobotsTXTTopUserAgentDirectiveResponse) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponse) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentDirectiveResponseEnvelope ¶
type RobotsTXTTopUserAgentDirectiveResponseEnvelope struct {
Result RobotsTXTTopUserAgentDirectiveResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON robotsTXTTopUserAgentDirectiveResponseEnvelopeJSON `json:"-"`
}
func (*RobotsTXTTopUserAgentDirectiveResponseEnvelope) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentDirectiveResponseMeta ¶
type RobotsTXTTopUserAgentDirectiveResponseMeta struct {
ConfidenceInfo RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []RobotsTXTTopUserAgentDirectiveResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization RobotsTXTTopUserAgentDirectiveResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []RobotsTXTTopUserAgentDirectiveResponseMetaUnit `json:"units,required"`
JSON robotsTXTTopUserAgentDirectiveResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*RobotsTXTTopUserAgentDirectiveResponseMeta) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponseMeta) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfo ¶
type RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfo struct {
Annotations []RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON robotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoAnnotation ¶
type RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON robotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentDirectiveResponseMetaDateRange ¶
type RobotsTXTTopUserAgentDirectiveResponseMetaDateRange 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 robotsTXTTopUserAgentDirectiveResponseMetaDateRangeJSON `json:"-"`
}
func (*RobotsTXTTopUserAgentDirectiveResponseMetaDateRange) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponseMetaDateRange) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentDirectiveResponseMetaNormalization ¶
type RobotsTXTTopUserAgentDirectiveResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationPercentage RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "PERCENTAGE" RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationMin0Max RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "MIN0_MAX" RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationMinMax RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "MIN_MAX" RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationRawValues RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "RAW_VALUES" RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationPercentageChange RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "PERCENTAGE_CHANGE" RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationRollingAverage RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "ROLLING_AVERAGE" RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationOverlappedPercentage RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" RobotsTXTTopUserAgentDirectiveResponseMetaNormalizationRatio RobotsTXTTopUserAgentDirectiveResponseMetaNormalization = "RATIO" )
func (RobotsTXTTopUserAgentDirectiveResponseMetaNormalization) IsKnown ¶
func (r RobotsTXTTopUserAgentDirectiveResponseMetaNormalization) IsKnown() bool
type RobotsTXTTopUserAgentDirectiveResponseMetaUnit ¶
type RobotsTXTTopUserAgentDirectiveResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON robotsTXTTopUserAgentDirectiveResponseMetaUnitJSON `json:"-"`
}
func (*RobotsTXTTopUserAgentDirectiveResponseMetaUnit) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentDirectiveResponseTop0 ¶
type RobotsTXTTopUserAgentDirectiveResponseTop0 struct {
Name string `json:"name,required"`
Value int64 `json:"value,required"`
Fully int64 `json:"fully"`
Partially int64 `json:"partially"`
JSON robotsTXTTopUserAgentDirectiveResponseTop0JSON `json:"-"`
}
func (*RobotsTXTTopUserAgentDirectiveResponseTop0) UnmarshalJSON ¶
func (r *RobotsTXTTopUserAgentDirectiveResponseTop0) UnmarshalJSON(data []byte) (err error)
type RobotsTXTTopUserAgentService ¶
type RobotsTXTTopUserAgentService struct {
Options []option.RequestOption
}
RobotsTXTTopUserAgentService 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 NewRobotsTXTTopUserAgentService method instead.
func NewRobotsTXTTopUserAgentService ¶
func NewRobotsTXTTopUserAgentService(opts ...option.RequestOption) (r *RobotsTXTTopUserAgentService)
NewRobotsTXTTopUserAgentService 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 (*RobotsTXTTopUserAgentService) Directive ¶
func (r *RobotsTXTTopUserAgentService) Directive(ctx context.Context, query RobotsTXTTopUserAgentDirectiveParams, opts ...option.RequestOption) (res *RobotsTXTTopUserAgentDirectiveResponse, err error)
Retrieves the top user agents on robots.txt files.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SearchGlobalParams ¶
type SearchGlobalParams struct {
// String used to perform the search operation.
Query param.Field[string] `query:"query,required"`
// Search types excluded from results.
Exclude param.Field[[]SearchGlobalParamsExclude] `query:"exclude"`
// Format in which results will be returned.
Format param.Field[SearchGlobalParamsFormat] `query:"format"`
// Search types included in results.
Include param.Field[[]SearchGlobalParamsInclude] `query:"include"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Limits 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 ( SearchGlobalParamsExcludeASNs SearchGlobalParamsExclude = "ASNS" SearchGlobalParamsExcludeBots SearchGlobalParamsExclude = "BOTS" SearchGlobalParamsExcludeCertificateAuthorities SearchGlobalParamsExclude = "CERTIFICATE_AUTHORITIES" SearchGlobalParamsExcludeCertificateLogs SearchGlobalParamsExclude = "CERTIFICATE_LOGS" SearchGlobalParamsExcludeLocations SearchGlobalParamsExclude = "LOCATIONS" SearchGlobalParamsExcludeNotebooks SearchGlobalParamsExclude = "NOTEBOOKS" )
func (SearchGlobalParamsExclude) IsKnown ¶
func (r SearchGlobalParamsExclude) IsKnown() bool
type SearchGlobalParamsFormat ¶
type SearchGlobalParamsFormat string
Format in which results will be returned.
const ( SearchGlobalParamsFormatJson SearchGlobalParamsFormat = "JSON" SearchGlobalParamsFormatCsv SearchGlobalParamsFormat = "CSV" )
func (SearchGlobalParamsFormat) IsKnown ¶
func (r SearchGlobalParamsFormat) IsKnown() bool
type SearchGlobalParamsInclude ¶
type SearchGlobalParamsInclude string
const ( SearchGlobalParamsIncludeASNs SearchGlobalParamsInclude = "ASNS" SearchGlobalParamsIncludeBots SearchGlobalParamsInclude = "BOTS" SearchGlobalParamsIncludeCertificateAuthorities SearchGlobalParamsInclude = "CERTIFICATE_AUTHORITIES" SearchGlobalParamsIncludeCertificateLogs SearchGlobalParamsInclude = "CERTIFICATE_LOGS" SearchGlobalParamsIncludeLocations SearchGlobalParamsInclude = "LOCATIONS" SearchGlobalParamsIncludeNotebooks SearchGlobalParamsInclude = "NOTEBOOKS" )
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 ¶
func (r *SearchService) Global(ctx context.Context, query SearchGlobalParams, opts ...option.RequestOption) (res *SearchGlobalResponse, err error)
Searches for locations, autonomous systems, reports, bots, certificate logs, and certificate authorities.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
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 ¶
func (r *TCPResetsTimeoutService) Summary(ctx context.Context, query TCPResetsTimeoutSummaryParams, opts ...option.RequestOption) (res *TCPResetsTimeoutSummaryResponse, err error)
Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout.
func (*TCPResetsTimeoutService) TimeseriesGroups ¶
func (r *TCPResetsTimeoutService) TimeseriesGroups(ctx context.Context, query TCPResetsTimeoutTimeseriesGroupsParams, opts ...option.RequestOption) (res *TCPResetsTimeoutTimeseriesGroupsResponse, err error)
Retrieves the distribution of connection stage by TCP connections terminated within the first 10 packets by a reset or timeout over time.
type TCPResetsTimeoutSummaryParams ¶
type TCPResetsTimeoutSummaryParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[TCPResetsTimeoutSummaryParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( TCPResetsTimeoutSummaryParamsFormatJson TCPResetsTimeoutSummaryParamsFormat = "JSON" TCPResetsTimeoutSummaryParamsFormatCsv TCPResetsTimeoutSummaryParamsFormat = "CSV" )
func (TCPResetsTimeoutSummaryParamsFormat) IsKnown ¶
func (r TCPResetsTimeoutSummaryParamsFormat) IsKnown() bool
type TCPResetsTimeoutSummaryResponse ¶
type TCPResetsTimeoutSummaryResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo TCPResetsTimeoutSummaryResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []TCPResetsTimeoutSummaryResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization TCPResetsTimeoutSummaryResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []TCPResetsTimeoutSummaryResponseMetaUnit `json:"units,required"`
JSON tcpResetsTimeoutSummaryResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*TCPResetsTimeoutSummaryResponseMeta) UnmarshalJSON ¶
func (r *TCPResetsTimeoutSummaryResponseMeta) UnmarshalJSON(data []byte) (err error)
type TCPResetsTimeoutSummaryResponseMetaConfidenceInfo ¶
type TCPResetsTimeoutSummaryResponseMetaConfidenceInfo struct {
Annotations []TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON tcpResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *TCPResetsTimeoutSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 TCPResetsTimeoutSummaryResponseMetaNormalization ¶
type TCPResetsTimeoutSummaryResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( TCPResetsTimeoutSummaryResponseMetaNormalizationPercentage TCPResetsTimeoutSummaryResponseMetaNormalization = "PERCENTAGE" TCPResetsTimeoutSummaryResponseMetaNormalizationMin0Max TCPResetsTimeoutSummaryResponseMetaNormalization = "MIN0_MAX" TCPResetsTimeoutSummaryResponseMetaNormalizationMinMax TCPResetsTimeoutSummaryResponseMetaNormalization = "MIN_MAX" TCPResetsTimeoutSummaryResponseMetaNormalizationRawValues TCPResetsTimeoutSummaryResponseMetaNormalization = "RAW_VALUES" TCPResetsTimeoutSummaryResponseMetaNormalizationPercentageChange TCPResetsTimeoutSummaryResponseMetaNormalization = "PERCENTAGE_CHANGE" TCPResetsTimeoutSummaryResponseMetaNormalizationRollingAverage TCPResetsTimeoutSummaryResponseMetaNormalization = "ROLLING_AVERAGE" TCPResetsTimeoutSummaryResponseMetaNormalizationOverlappedPercentage TCPResetsTimeoutSummaryResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" TCPResetsTimeoutSummaryResponseMetaNormalizationRatio TCPResetsTimeoutSummaryResponseMetaNormalization = "RATIO" )
func (TCPResetsTimeoutSummaryResponseMetaNormalization) IsKnown ¶
func (r TCPResetsTimeoutSummaryResponseMetaNormalization) IsKnown() bool
type TCPResetsTimeoutSummaryResponseMetaUnit ¶
type TCPResetsTimeoutSummaryResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON tcpResetsTimeoutSummaryResponseMetaUnitJSON `json:"-"`
}
func (*TCPResetsTimeoutSummaryResponseMetaUnit) UnmarshalJSON ¶
func (r *TCPResetsTimeoutSummaryResponseMetaUnit) 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 of the results (e.g., 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"`
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[TCPResetsTimeoutTimeseriesGroupsParamsFormat] `query:"format"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
Name param.Field[[]string] `query:"name"`
}
func (TCPResetsTimeoutTimeseriesGroupsParams) URLQuery ¶
func (r TCPResetsTimeoutTimeseriesGroupsParams) URLQuery() (v url.Values)
URLQuery serializes TCPResetsTimeoutTimeseriesGroupsParams's query parameters as `url.Values`.
type TCPResetsTimeoutTimeseriesGroupsParamsAggInterval ¶
type TCPResetsTimeoutTimeseriesGroupsParamsAggInterval string
Aggregation interval of the results (e.g., 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 ¶
func (r TCPResetsTimeoutTimeseriesGroupsParamsAggInterval) IsKnown() bool
type TCPResetsTimeoutTimeseriesGroupsParamsFormat ¶
type TCPResetsTimeoutTimeseriesGroupsParamsFormat string
Format in which results will be returned.
const ( TCPResetsTimeoutTimeseriesGroupsParamsFormatJson TCPResetsTimeoutTimeseriesGroupsParamsFormat = "JSON" TCPResetsTimeoutTimeseriesGroupsParamsFormatCsv TCPResetsTimeoutTimeseriesGroupsParamsFormat = "CSV" )
func (TCPResetsTimeoutTimeseriesGroupsParamsFormat) IsKnown ¶
func (r TCPResetsTimeoutTimeseriesGroupsParamsFormat) IsKnown() bool
type TCPResetsTimeoutTimeseriesGroupsResponse ¶
type TCPResetsTimeoutTimeseriesGroupsResponse struct {
// Metadata for the results.
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 {
// Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals).
// Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval `json:"aggInterval,required"`
ConfidenceInfo TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo `json:"confidenceInfo,required"`
DateRange []TCPResetsTimeoutTimeseriesGroupsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []TCPResetsTimeoutTimeseriesGroupsResponseMetaUnit `json:"units,required"`
JSON tcpResetsTimeoutTimeseriesGroupsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*TCPResetsTimeoutTimeseriesGroupsResponseMeta) UnmarshalJSON ¶
func (r *TCPResetsTimeoutTimeseriesGroupsResponseMeta) UnmarshalJSON(data []byte) (err error)
type TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval ¶
type TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval string
Aggregation interval of the results (e.g., in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
const ( TCPResetsTimeoutTimeseriesGroupsResponseMetaAggIntervalFifteenMinutes TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval = "FIFTEEN_MINUTES" TCPResetsTimeoutTimeseriesGroupsResponseMetaAggIntervalOneHour TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval = "ONE_HOUR" TCPResetsTimeoutTimeseriesGroupsResponseMetaAggIntervalOneDay TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval = "ONE_DAY" TCPResetsTimeoutTimeseriesGroupsResponseMetaAggIntervalOneWeek TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval = "ONE_WEEK" TCPResetsTimeoutTimeseriesGroupsResponseMetaAggIntervalOneMonth TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval = "ONE_MONTH" )
func (TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval) IsKnown ¶
func (r TCPResetsTimeoutTimeseriesGroupsResponseMetaAggInterval) IsKnown() bool
type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo ¶
type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo struct {
Annotations []TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
JSON tcpResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoJSON `json:"-"`
}
func (*TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON ¶
func (r *TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error)
type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation ¶
type TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON tcpResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *TCPResetsTimeoutTimeseriesGroupsResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization ¶
type TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationPercentage TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE" TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationMin0Max TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "MIN0_MAX" TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationMinMax TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "MIN_MAX" TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationRawValues TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "RAW_VALUES" TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationPercentageChange TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "PERCENTAGE_CHANGE" TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationRollingAverage TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "ROLLING_AVERAGE" TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationOverlappedPercentage TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalizationRatio TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization = "RATIO" )
func (TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization) IsKnown ¶
func (r TCPResetsTimeoutTimeseriesGroupsResponseMetaNormalization) IsKnown() bool
type TCPResetsTimeoutTimeseriesGroupsResponseMetaUnit ¶
type TCPResetsTimeoutTimeseriesGroupsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON tcpResetsTimeoutTimeseriesGroupsResponseMetaUnitJSON `json:"-"`
}
func (*TCPResetsTimeoutTimeseriesGroupsResponseMetaUnit) UnmarshalJSON ¶
func (r *TCPResetsTimeoutTimeseriesGroupsResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type TCPResetsTimeoutTimeseriesGroupsResponseSerie0 ¶
type TCPResetsTimeoutTimeseriesGroupsResponseSerie0 struct {
LaterInFlow []string `json:"later_in_flow,required"`
NoMatch []string `json:"no_match,required"`
PostAck []string `json:"post_ack,required"`
PostPsh []string `json:"post_psh,required"`
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 TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.
type TrafficAnomalyGetParams ¶
type TrafficAnomalyGetParams struct {
// Filters results by Autonomous System. Specify a single Autonomous System Number
// (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"`
// Filters results by date range.
DateRange param.Field[string] `query:"dateRange"`
// Start of the date range (inclusive).
DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[TrafficAnomalyGetParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify an alpha-2 location code.
Location param.Field[string] `query:"location"`
// Skips the specified number of objects before fetching the 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 in which results will be returned.
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 ¶
func (r *TrafficAnomalyGetResponseTrafficAnomaliesASNDetailsLocations) UnmarshalJSON(data []byte) (err error)
type TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails ¶
type TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails struct {
Code string `json:"code,required"`
Name string `json:"name,required"`
JSON trafficAnomalyGetResponseTrafficAnomaliesLocationDetailsJSON `json:"-"`
}
func (*TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails) UnmarshalJSON ¶
func (r *TrafficAnomalyGetResponseTrafficAnomaliesLocationDetails) UnmarshalJSON(data []byte) (err error)
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 time.Time `json:"endDate" format:"date-time"`
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"`
// Filters results by date range.
DateRange param.Field[string] `query:"dateRange"`
// Start of the date range (inclusive).
DateStart param.Field[time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[TrafficAnomalyLocationGetParamsFormat] `query:"format"`
// Limits the number of objects returned 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 in which results will be returned.
const ( TrafficAnomalyLocationGetParamsFormatJson TrafficAnomalyLocationGetParamsFormat = "JSON" TrafficAnomalyLocationGetParamsFormatCsv TrafficAnomalyLocationGetParamsFormat = "CSV" )
func (TrafficAnomalyLocationGetParamsFormat) IsKnown ¶
func (r TrafficAnomalyLocationGetParamsFormat) IsKnown() bool
type TrafficAnomalyLocationGetParamsStatus ¶
type TrafficAnomalyLocationGetParamsStatus string
const ( TrafficAnomalyLocationGetParamsStatusVerified TrafficAnomalyLocationGetParamsStatus = "VERIFIED" TrafficAnomalyLocationGetParamsStatusUnverified TrafficAnomalyLocationGetParamsStatus = "UNVERIFIED" )
func (TrafficAnomalyLocationGetParamsStatus) IsKnown ¶
func (r TrafficAnomalyLocationGetParamsStatus) IsKnown() bool
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"`
// A numeric string.
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 ¶
func (r *TrafficAnomalyLocationService) Get(ctx context.Context, query TrafficAnomalyLocationGetParams, opts ...option.RequestOption) (res *TrafficAnomalyLocationGetResponse, err error)
Retrieves the sum of Internet traffic anomalies, grouped by location. These anomalies are signals that might indicate an outage, automatically detected by Radar and manually verified by our team.
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 ¶
func (r *TrafficAnomalyService) Get(ctx context.Context, query TrafficAnomalyGetParams, opts ...option.RequestOption) (res *TrafficAnomalyGetResponse, err error)
Retrieves the latest Internet traffic anomalies, which are signals that might indicate an outage. These alerts are automatically detected by Radar and manually verified by our team.
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 {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[VerifiedBotTopBotsParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( VerifiedBotTopBotsParamsFormatJson VerifiedBotTopBotsParamsFormat = "JSON" VerifiedBotTopBotsParamsFormatCsv VerifiedBotTopBotsParamsFormat = "CSV" )
func (VerifiedBotTopBotsParamsFormat) IsKnown ¶
func (r VerifiedBotTopBotsParamsFormat) IsKnown() bool
type VerifiedBotTopBotsResponse ¶
type VerifiedBotTopBotsResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo VerifiedBotTopBotsResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []VerifiedBotTopBotsResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization VerifiedBotTopBotsResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []VerifiedBotTopBotsResponseMetaUnit `json:"units,required"`
JSON verifiedBotTopBotsResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*VerifiedBotTopBotsResponseMeta) UnmarshalJSON ¶
func (r *VerifiedBotTopBotsResponseMeta) UnmarshalJSON(data []byte) (err error)
type VerifiedBotTopBotsResponseMetaConfidenceInfo ¶
type VerifiedBotTopBotsResponseMetaConfidenceInfo struct {
Annotations []VerifiedBotTopBotsResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON verifiedBotTopBotsResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
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 VerifiedBotTopBotsResponseMetaNormalization ¶
type VerifiedBotTopBotsResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( VerifiedBotTopBotsResponseMetaNormalizationPercentage VerifiedBotTopBotsResponseMetaNormalization = "PERCENTAGE" VerifiedBotTopBotsResponseMetaNormalizationMin0Max VerifiedBotTopBotsResponseMetaNormalization = "MIN0_MAX" VerifiedBotTopBotsResponseMetaNormalizationMinMax VerifiedBotTopBotsResponseMetaNormalization = "MIN_MAX" VerifiedBotTopBotsResponseMetaNormalizationRawValues VerifiedBotTopBotsResponseMetaNormalization = "RAW_VALUES" VerifiedBotTopBotsResponseMetaNormalizationPercentageChange VerifiedBotTopBotsResponseMetaNormalization = "PERCENTAGE_CHANGE" VerifiedBotTopBotsResponseMetaNormalizationRollingAverage VerifiedBotTopBotsResponseMetaNormalization = "ROLLING_AVERAGE" VerifiedBotTopBotsResponseMetaNormalizationOverlappedPercentage VerifiedBotTopBotsResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" VerifiedBotTopBotsResponseMetaNormalizationRatio VerifiedBotTopBotsResponseMetaNormalization = "RATIO" )
func (VerifiedBotTopBotsResponseMetaNormalization) IsKnown ¶
func (r VerifiedBotTopBotsResponseMetaNormalization) IsKnown() bool
type VerifiedBotTopBotsResponseMetaUnit ¶
type VerifiedBotTopBotsResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON verifiedBotTopBotsResponseMetaUnitJSON `json:"-"`
}
func (*VerifiedBotTopBotsResponseMetaUnit) UnmarshalJSON ¶
func (r *VerifiedBotTopBotsResponseMetaUnit) 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"`
// A numeric string.
Value string `json:"value,required"`
JSON verifiedBotTopBotsResponseTop0JSON `json:"-"`
}
func (*VerifiedBotTopBotsResponseTop0) UnmarshalJSON ¶
func (r *VerifiedBotTopBotsResponseTop0) UnmarshalJSON(data []byte) (err error)
type VerifiedBotTopCategoriesParams ¶
type VerifiedBotTopCategoriesParams struct {
// Filters results by Autonomous System. Specify one or more Autonomous System
// Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
// results. For example, `-174, 3356` excludes results from AS174, but includes
// results from AS3356.
ASN param.Field[[]string] `query:"asn"`
// Filters results by continent. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude continents from results. For example, `-EU,NA`
// excludes results from EU, but includes results from NA.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Filters results by date range. 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"`
// Start of the date range.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Format in which results will be returned.
Format param.Field[VerifiedBotTopCategoriesParamsFormat] `query:"format"`
// Limits the number of objects returned in the response.
Limit param.Field[int64] `query:"limit"`
// Filters results by location. Specify a comma-separated list of alpha-2 codes.
// Prefix with `-` to exclude locations 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 used to label the series in the response.
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 in which results will be returned.
const ( VerifiedBotTopCategoriesParamsFormatJson VerifiedBotTopCategoriesParamsFormat = "JSON" VerifiedBotTopCategoriesParamsFormatCsv VerifiedBotTopCategoriesParamsFormat = "CSV" )
func (VerifiedBotTopCategoriesParamsFormat) IsKnown ¶
func (r VerifiedBotTopCategoriesParamsFormat) IsKnown() bool
type VerifiedBotTopCategoriesResponse ¶
type VerifiedBotTopCategoriesResponse struct {
// Metadata for the results.
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 {
ConfidenceInfo VerifiedBotTopCategoriesResponseMetaConfidenceInfo `json:"confidenceInfo,required,nullable"`
DateRange []VerifiedBotTopCategoriesResponseMetaDateRange `json:"dateRange,required"`
// Timestamp of the last dataset update.
LastUpdated time.Time `json:"lastUpdated,required" format:"date-time"`
// Normalization method applied to the results. Refer to
// [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
Normalization VerifiedBotTopCategoriesResponseMetaNormalization `json:"normalization,required"`
// Measurement units for the results.
Units []VerifiedBotTopCategoriesResponseMetaUnit `json:"units,required"`
JSON verifiedBotTopCategoriesResponseMetaJSON `json:"-"`
}
Metadata for the results.
func (*VerifiedBotTopCategoriesResponseMeta) UnmarshalJSON ¶
func (r *VerifiedBotTopCategoriesResponseMeta) UnmarshalJSON(data []byte) (err error)
type VerifiedBotTopCategoriesResponseMetaConfidenceInfo ¶
type VerifiedBotTopCategoriesResponseMetaConfidenceInfo struct {
Annotations []VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation `json:"annotations,required"`
// Provides an indication of how much confidence Cloudflare has in the data.
Level int64 `json:"level,required"`
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"`
EndDate time.Time `json:"endDate,required" format:"date-time"`
EventType string `json:"eventType,required"`
// Whether event is a single point in time or a time range.
IsInstantaneous bool `json:"isInstantaneous,required"`
LinkedURL string `json:"linkedUrl,required" format:"uri"`
StartDate time.Time `json:"startDate,required" format:"date-time"`
JSON verifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
Annotation associated with the result (e.g. outage or other type of event).
func (*VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON ¶
func (r *VerifiedBotTopCategoriesResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error)
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 VerifiedBotTopCategoriesResponseMetaNormalization ¶
type VerifiedBotTopCategoriesResponseMetaNormalization string
Normalization method applied to the results. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
const ( VerifiedBotTopCategoriesResponseMetaNormalizationPercentage VerifiedBotTopCategoriesResponseMetaNormalization = "PERCENTAGE" VerifiedBotTopCategoriesResponseMetaNormalizationMin0Max VerifiedBotTopCategoriesResponseMetaNormalization = "MIN0_MAX" VerifiedBotTopCategoriesResponseMetaNormalizationMinMax VerifiedBotTopCategoriesResponseMetaNormalization = "MIN_MAX" VerifiedBotTopCategoriesResponseMetaNormalizationRawValues VerifiedBotTopCategoriesResponseMetaNormalization = "RAW_VALUES" VerifiedBotTopCategoriesResponseMetaNormalizationPercentageChange VerifiedBotTopCategoriesResponseMetaNormalization = "PERCENTAGE_CHANGE" VerifiedBotTopCategoriesResponseMetaNormalizationRollingAverage VerifiedBotTopCategoriesResponseMetaNormalization = "ROLLING_AVERAGE" VerifiedBotTopCategoriesResponseMetaNormalizationOverlappedPercentage VerifiedBotTopCategoriesResponseMetaNormalization = "OVERLAPPED_PERCENTAGE" VerifiedBotTopCategoriesResponseMetaNormalizationRatio VerifiedBotTopCategoriesResponseMetaNormalization = "RATIO" )
func (VerifiedBotTopCategoriesResponseMetaNormalization) IsKnown ¶
func (r VerifiedBotTopCategoriesResponseMetaNormalization) IsKnown() bool
type VerifiedBotTopCategoriesResponseMetaUnit ¶
type VerifiedBotTopCategoriesResponseMetaUnit struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON verifiedBotTopCategoriesResponseMetaUnitJSON `json:"-"`
}
func (*VerifiedBotTopCategoriesResponseMetaUnit) UnmarshalJSON ¶
func (r *VerifiedBotTopCategoriesResponseMetaUnit) UnmarshalJSON(data []byte) (err error)
type VerifiedBotTopCategoriesResponseTop0 ¶
type VerifiedBotTopCategoriesResponseTop0 struct {
BotCategory string `json:"botCategory,required"`
// A numeric string.
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
deprecated
func (r *VerifiedBotTopService) Bots(ctx context.Context, query VerifiedBotTopBotsParams, opts ...option.RequestOption) (res *VerifiedBotTopBotsResponse, err error)
Retrieves the top verified bots by HTTP requests, with owner and category.
Deprecated: Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead.
func (*VerifiedBotTopService) Categories
deprecated
func (r *VerifiedBotTopService) Categories(ctx context.Context, query VerifiedBotTopCategoriesParams, opts ...option.RequestOption) (res *VerifiedBotTopCategoriesResponse, err error)
Retrieves the top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.
Deprecated: Use [Radar Bots API](https://developers.cloudflare.com/api/resources/radar/subresources/bots/) instead.
Source Files
¶
- ai.go
- aibot.go
- aibotsummary.go
- aiinference.go
- aiinferencesummary.go
- aiinferencetimeseriesgroup.go
- aiinferencetimeseriesgroupsummary.go
- aitimeseriesgroup.go
- aitomarkdown.go
- aliases.go
- annotation.go
- annotationoutage.go
- as112.go
- as112summary.go
- as112timeseriesgroup.go
- as112top.go
- attack.go
- attacklayer3.go
- attacklayer3summary.go
- attacklayer3timeseriesgroup.go
- attacklayer3top.go
- attacklayer3toplocation.go
- attacklayer7.go
- attacklayer7summary.go
- attacklayer7timeseriesgroup.go
- attacklayer7top.go
- attacklayer7topase.go
- attacklayer7toplocation.go
- bgp.go
- bgphijack.go
- bgphijackevent.go
- bgpip.go
- bgpleak.go
- bgpleakevent.go
- bgproute.go
- bgptop.go
- bgptopase.go
- bot.go
- botwebcrawler.go
- dataset.go
- dns.go
- dnssummary.go
- dnstimeseriesgroup.go
- dnstop.go
- email.go
- emailrouting.go
- emailroutingsummary.go
- emailroutingtimeseriesgroup.go
- emailsecurity.go
- emailsecuritysummary.go
- emailsecuritytimeseriesgroup.go
- emailsecuritytop.go
- emailsecuritytoptld.go
- emailsecuritytoptldmalicious.go
- emailsecuritytoptldspam.go
- emailsecuritytoptldspoof.go
- entity.go
- entityasn.go
- entitylocation.go
- http.go
- httpase.go
- httpasebotclass.go
- httpasebrowserfamily.go
- httpasedevicetype.go
- httpasehttpmethod.go
- httpasehttpprotocol.go
- httpaseipversion.go
- httpaseos.go
- httpasetlsversion.go
- httplocation.go
- httplocationbotclass.go
- httplocationbrowserfamily.go
- httplocationdevicetype.go
- httplocationhttpmethod.go
- httplocationhttpprotocol.go
- httplocationipversion.go
- httplocationos.go
- httplocationtlsversion.go
- httpsummary.go
- httptimeseriesgroup.go
- httptop.go
- leakedcredential.go
- leakedcredentialsummary.go
- leakedcredentialtimeseriesgroup.go
- netflow.go
- netflowtop.go
- quality.go
- qualityiqi.go
- qualityspeed.go
- qualityspeedtop.go
- radar.go
- ranking.go
- rankingdomain.go
- rankinginternetservice.go
- robotstxt.go
- robotstxttop.go
- robotstxttopuseragent.go
- search.go
- tcpresetstimeout.go
- trafficanomaly.go
- trafficanomalylocation.go
- verifiedbot.go
- verifiedbottop.go