logpush

package
v4.6.0 Latest Latest
Warning

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

Go to latest
Published: Jul 10, 2025 License: Apache-2.0 Imports: 12 Imported by: 2

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type 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 DatasetFieldGetParams

type DatasetFieldGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type DatasetFieldGetParamsDatasetID added in v4.3.0

type DatasetFieldGetParamsDatasetID string

Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).

const (
	DatasetFieldGetParamsDatasetIDAccessRequests           DatasetFieldGetParamsDatasetID = "access_requests"
	DatasetFieldGetParamsDatasetIDAuditLogs                DatasetFieldGetParamsDatasetID = "audit_logs"
	DatasetFieldGetParamsDatasetIDBISOUserActions          DatasetFieldGetParamsDatasetID = "biso_user_actions"
	DatasetFieldGetParamsDatasetIDCasbFindings             DatasetFieldGetParamsDatasetID = "casb_findings"
	DatasetFieldGetParamsDatasetIDDevicePostureResults     DatasetFieldGetParamsDatasetID = "device_posture_results"
	DatasetFieldGetParamsDatasetIDDLPForensicCopies        DatasetFieldGetParamsDatasetID = "dlp_forensic_copies"
	DatasetFieldGetParamsDatasetIDDNSFirewallLogs          DatasetFieldGetParamsDatasetID = "dns_firewall_logs"
	DatasetFieldGetParamsDatasetIDDNSLogs                  DatasetFieldGetParamsDatasetID = "dns_logs"
	DatasetFieldGetParamsDatasetIDEmailSecurityAlerts      DatasetFieldGetParamsDatasetID = "email_security_alerts"
	DatasetFieldGetParamsDatasetIDFirewallEvents           DatasetFieldGetParamsDatasetID = "firewall_events"
	DatasetFieldGetParamsDatasetIDGatewayDNS               DatasetFieldGetParamsDatasetID = "gateway_dns"
	DatasetFieldGetParamsDatasetIDGatewayHTTP              DatasetFieldGetParamsDatasetID = "gateway_http"
	DatasetFieldGetParamsDatasetIDGatewayNetwork           DatasetFieldGetParamsDatasetID = "gateway_network"
	DatasetFieldGetParamsDatasetIDHTTPRequests             DatasetFieldGetParamsDatasetID = "http_requests"
	DatasetFieldGetParamsDatasetIDMagicIDsDetections       DatasetFieldGetParamsDatasetID = "magic_ids_detections"
	DatasetFieldGetParamsDatasetIDNELReports               DatasetFieldGetParamsDatasetID = "nel_reports"
	DatasetFieldGetParamsDatasetIDNetworkAnalyticsLogs     DatasetFieldGetParamsDatasetID = "network_analytics_logs"
	DatasetFieldGetParamsDatasetIDPageShieldEvents         DatasetFieldGetParamsDatasetID = "page_shield_events"
	DatasetFieldGetParamsDatasetIDSinkholeHTTPLogs         DatasetFieldGetParamsDatasetID = "sinkhole_http_logs"
	DatasetFieldGetParamsDatasetIDSpectrumEvents           DatasetFieldGetParamsDatasetID = "spectrum_events"
	DatasetFieldGetParamsDatasetIDSSHLogs                  DatasetFieldGetParamsDatasetID = "ssh_logs"
	DatasetFieldGetParamsDatasetIDWorkersTraceEvents       DatasetFieldGetParamsDatasetID = "workers_trace_events"
	DatasetFieldGetParamsDatasetIDZarazEvents              DatasetFieldGetParamsDatasetID = "zaraz_events"
	DatasetFieldGetParamsDatasetIDZeroTrustNetworkSessions DatasetFieldGetParamsDatasetID = "zero_trust_network_sessions"
)

func (DatasetFieldGetParamsDatasetID) IsKnown added in v4.3.0

type DatasetFieldGetResponse

type DatasetFieldGetResponse = interface{}

type DatasetFieldGetResponseEnvelope

type DatasetFieldGetResponseEnvelope struct {
	Errors   []DatasetFieldGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DatasetFieldGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success DatasetFieldGetResponseEnvelopeSuccess `json:"success,required"`
	Result  DatasetFieldGetResponse                `json:"result"`
	JSON    datasetFieldGetResponseEnvelopeJSON    `json:"-"`
}

func (*DatasetFieldGetResponseEnvelope) UnmarshalJSON

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

type DatasetFieldGetResponseEnvelopeErrors added in v4.3.0

type DatasetFieldGetResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           DatasetFieldGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             datasetFieldGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DatasetFieldGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type DatasetFieldGetResponseEnvelopeErrorsSource added in v4.3.0

type DatasetFieldGetResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    datasetFieldGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DatasetFieldGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type DatasetFieldGetResponseEnvelopeMessages added in v4.3.0

type DatasetFieldGetResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           DatasetFieldGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             datasetFieldGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DatasetFieldGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type DatasetFieldGetResponseEnvelopeMessagesSource added in v4.3.0

type DatasetFieldGetResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    datasetFieldGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DatasetFieldGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type DatasetFieldGetResponseEnvelopeSuccess

type DatasetFieldGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DatasetFieldGetResponseEnvelopeSuccessTrue DatasetFieldGetResponseEnvelopeSuccess = true
)

func (DatasetFieldGetResponseEnvelopeSuccess) IsKnown

type DatasetFieldService

type DatasetFieldService struct {
	Options []option.RequestOption
}

DatasetFieldService 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 NewDatasetFieldService method instead.

func NewDatasetFieldService

func NewDatasetFieldService(opts ...option.RequestOption) (r *DatasetFieldService)

NewDatasetFieldService 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 (*DatasetFieldService) Get

Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.

type DatasetJobGetParams

type DatasetJobGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type DatasetJobGetParamsDatasetID added in v4.3.0

type DatasetJobGetParamsDatasetID string

Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).

const (
	DatasetJobGetParamsDatasetIDAccessRequests           DatasetJobGetParamsDatasetID = "access_requests"
	DatasetJobGetParamsDatasetIDAuditLogs                DatasetJobGetParamsDatasetID = "audit_logs"
	DatasetJobGetParamsDatasetIDBISOUserActions          DatasetJobGetParamsDatasetID = "biso_user_actions"
	DatasetJobGetParamsDatasetIDCasbFindings             DatasetJobGetParamsDatasetID = "casb_findings"
	DatasetJobGetParamsDatasetIDDevicePostureResults     DatasetJobGetParamsDatasetID = "device_posture_results"
	DatasetJobGetParamsDatasetIDDLPForensicCopies        DatasetJobGetParamsDatasetID = "dlp_forensic_copies"
	DatasetJobGetParamsDatasetIDDNSFirewallLogs          DatasetJobGetParamsDatasetID = "dns_firewall_logs"
	DatasetJobGetParamsDatasetIDDNSLogs                  DatasetJobGetParamsDatasetID = "dns_logs"
	DatasetJobGetParamsDatasetIDEmailSecurityAlerts      DatasetJobGetParamsDatasetID = "email_security_alerts"
	DatasetJobGetParamsDatasetIDFirewallEvents           DatasetJobGetParamsDatasetID = "firewall_events"
	DatasetJobGetParamsDatasetIDGatewayDNS               DatasetJobGetParamsDatasetID = "gateway_dns"
	DatasetJobGetParamsDatasetIDGatewayHTTP              DatasetJobGetParamsDatasetID = "gateway_http"
	DatasetJobGetParamsDatasetIDGatewayNetwork           DatasetJobGetParamsDatasetID = "gateway_network"
	DatasetJobGetParamsDatasetIDHTTPRequests             DatasetJobGetParamsDatasetID = "http_requests"
	DatasetJobGetParamsDatasetIDMagicIDsDetections       DatasetJobGetParamsDatasetID = "magic_ids_detections"
	DatasetJobGetParamsDatasetIDNELReports               DatasetJobGetParamsDatasetID = "nel_reports"
	DatasetJobGetParamsDatasetIDNetworkAnalyticsLogs     DatasetJobGetParamsDatasetID = "network_analytics_logs"
	DatasetJobGetParamsDatasetIDPageShieldEvents         DatasetJobGetParamsDatasetID = "page_shield_events"
	DatasetJobGetParamsDatasetIDSinkholeHTTPLogs         DatasetJobGetParamsDatasetID = "sinkhole_http_logs"
	DatasetJobGetParamsDatasetIDSpectrumEvents           DatasetJobGetParamsDatasetID = "spectrum_events"
	DatasetJobGetParamsDatasetIDSSHLogs                  DatasetJobGetParamsDatasetID = "ssh_logs"
	DatasetJobGetParamsDatasetIDWorkersTraceEvents       DatasetJobGetParamsDatasetID = "workers_trace_events"
	DatasetJobGetParamsDatasetIDZarazEvents              DatasetJobGetParamsDatasetID = "zaraz_events"
	DatasetJobGetParamsDatasetIDZeroTrustNetworkSessions DatasetJobGetParamsDatasetID = "zero_trust_network_sessions"
)

func (DatasetJobGetParamsDatasetID) IsKnown added in v4.3.0

func (r DatasetJobGetParamsDatasetID) IsKnown() bool

type DatasetJobService

type DatasetJobService struct {
	Options []option.RequestOption
}

DatasetJobService 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 NewDatasetJobService method instead.

func NewDatasetJobService

func NewDatasetJobService(opts ...option.RequestOption) (r *DatasetJobService)

NewDatasetJobService 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 (*DatasetJobService) Get

Lists Logpush jobs for an account or zone for a dataset.

func (*DatasetJobService) GetAutoPaging added in v4.1.0

Lists Logpush jobs for an account or zone for a dataset.

type DatasetService

type DatasetService struct {
	Options []option.RequestOption
	Fields  *DatasetFieldService
	Jobs    *DatasetJobService
}

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.

type EdgeGetParams

type EdgeGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type EdgeNewParams

type EdgeNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Comma-separated list of fields.
	Fields param.Field[string] `json:"fields"`
	// Filters to drill down into specific events.
	Filter param.Field[string] `json:"filter"`
	// The sample parameter is the sample rate of the records set by the client:
	// "sample": 1 is 100% of records "sample": 10 is 10% and so on.
	Sample param.Field[int64] `json:"sample"`
}

func (EdgeNewParams) MarshalJSON

func (r EdgeNewParams) MarshalJSON() (data []byte, err error)

type EdgeNewResponseEnvelope

type EdgeNewResponseEnvelope struct {
	Errors   []EdgeNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []EdgeNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success EdgeNewResponseEnvelopeSuccess `json:"success,required"`
	Result  InstantLogpushJob              `json:"result,nullable"`
	JSON    edgeNewResponseEnvelopeJSON    `json:"-"`
}

func (*EdgeNewResponseEnvelope) UnmarshalJSON

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

type EdgeNewResponseEnvelopeErrors added in v4.3.0

type EdgeNewResponseEnvelopeErrors struct {
	Code             int64                               `json:"code,required"`
	Message          string                              `json:"message,required"`
	DocumentationURL string                              `json:"documentation_url"`
	Source           EdgeNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             edgeNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*EdgeNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type EdgeNewResponseEnvelopeErrorsSource added in v4.3.0

type EdgeNewResponseEnvelopeErrorsSource struct {
	Pointer string                                  `json:"pointer"`
	JSON    edgeNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*EdgeNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type EdgeNewResponseEnvelopeMessages added in v4.3.0

type EdgeNewResponseEnvelopeMessages struct {
	Code             int64                                 `json:"code,required"`
	Message          string                                `json:"message,required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           EdgeNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             edgeNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*EdgeNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type EdgeNewResponseEnvelopeMessagesSource added in v4.3.0

type EdgeNewResponseEnvelopeMessagesSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    edgeNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*EdgeNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type EdgeNewResponseEnvelopeSuccess

type EdgeNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	EdgeNewResponseEnvelopeSuccessTrue EdgeNewResponseEnvelopeSuccess = true
)

func (EdgeNewResponseEnvelopeSuccess) IsKnown

type EdgeService

type EdgeService struct {
	Options []option.RequestOption
}

EdgeService 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 NewEdgeService method instead.

func NewEdgeService

func NewEdgeService(opts ...option.RequestOption) (r *EdgeService)

NewEdgeService 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 (*EdgeService) Get

Lists Instant Logs jobs for a zone.

func (*EdgeService) GetAutoPaging added in v4.1.0

Lists Instant Logs jobs for a zone.

func (*EdgeService) New

func (r *EdgeService) New(ctx context.Context, params EdgeNewParams, opts ...option.RequestOption) (res *InstantLogpushJob, err error)

Creates a new Instant Logs job for a zone.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource added in v4.2.0

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type InstantLogpushJob

type InstantLogpushJob struct {
	// Unique WebSocket address that will receive messages from Cloudflare’s edge.
	DestinationConf string `json:"destination_conf" format:"uri"`
	// Comma-separated list of fields.
	Fields string `json:"fields"`
	// Filters to drill down into specific events.
	Filter string `json:"filter"`
	// The sample parameter is the sample rate of the records set by the client:
	// "sample": 1 is 100% of records "sample": 10 is 10% and so on.
	Sample int64 `json:"sample"`
	// Unique session id of the job.
	SessionID string                `json:"session_id"`
	JSON      instantLogpushJobJSON `json:"-"`
}

func (*InstantLogpushJob) UnmarshalJSON

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

type JobDeleteParams

type JobDeleteParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type JobDeleteResponse

type JobDeleteResponse struct {
	// Unique id of the job.
	ID   int64                 `json:"id"`
	JSON jobDeleteResponseJSON `json:"-"`
}

func (*JobDeleteResponse) UnmarshalJSON

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

type JobDeleteResponseEnvelope

type JobDeleteResponseEnvelope struct {
	Errors   []JobDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []JobDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success JobDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  JobDeleteResponse                `json:"result"`
	JSON    jobDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*JobDeleteResponseEnvelope) UnmarshalJSON

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

type JobDeleteResponseEnvelopeErrors added in v4.3.0

type JobDeleteResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code,required"`
	Message          string                                `json:"message,required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           JobDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             jobDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*JobDeleteResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type JobDeleteResponseEnvelopeErrorsSource added in v4.3.0

type JobDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    jobDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*JobDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type JobDeleteResponseEnvelopeMessages added in v4.3.0

type JobDeleteResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           JobDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             jobDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*JobDeleteResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type JobDeleteResponseEnvelopeMessagesSource added in v4.3.0

type JobDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    jobDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*JobDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type JobDeleteResponseEnvelopeSuccess

type JobDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	JobDeleteResponseEnvelopeSuccessTrue JobDeleteResponseEnvelopeSuccess = true
)

func (JobDeleteResponseEnvelopeSuccess) IsKnown

type JobGetParams

type JobGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type JobGetResponseEnvelope

type JobGetResponseEnvelope struct {
	Errors   []JobGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []JobGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success JobGetResponseEnvelopeSuccess `json:"success,required"`
	Result  LogpushJob                    `json:"result,nullable"`
	JSON    jobGetResponseEnvelopeJSON    `json:"-"`
}

func (*JobGetResponseEnvelope) UnmarshalJSON

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

type JobGetResponseEnvelopeErrors added in v4.3.0

type JobGetResponseEnvelopeErrors struct {
	Code             int64                              `json:"code,required"`
	Message          string                             `json:"message,required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           JobGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             jobGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*JobGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type JobGetResponseEnvelopeErrorsSource added in v4.3.0

type JobGetResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    jobGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*JobGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type JobGetResponseEnvelopeMessages added in v4.3.0

type JobGetResponseEnvelopeMessages struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           JobGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             jobGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*JobGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type JobGetResponseEnvelopeMessagesSource added in v4.3.0

type JobGetResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    jobGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*JobGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type JobGetResponseEnvelopeSuccess

type JobGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	JobGetResponseEnvelopeSuccessTrue JobGetResponseEnvelopeSuccess = true
)

func (JobGetResponseEnvelopeSuccess) IsKnown

func (r JobGetResponseEnvelopeSuccess) IsKnown() bool

type JobListParams

type JobListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type JobNewParams

type JobNewParams struct {
	// Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
	// Additional configuration parameters supported by the destination may be
	// included.
	DestinationConf param.Field[string] `json:"destination_conf,required" format:"uri"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Name of the dataset. A list of supported datasets can be found on the
	// [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).
	Dataset param.Field[JobNewParamsDataset] `json:"dataset"`
	// Flag that indicates if the job is enabled.
	Enabled param.Field[bool] `json:"enabled"`
	// The filters to select the events to include and/or remove from your logs. For
	// more information, refer to
	// [Filters](https://developers.cloudflare.com/logs/reference/filters/).
	Filter param.Field[string] `json:"filter"`
	// This field is deprecated. Please use `max_upload_*` parameters instead. The
	// frequency at which Cloudflare sends batches of logs to your destination. Setting
	// frequency to high sends your logs in larger quantities of smaller files. Setting
	// frequency to low sends logs in smaller quantities of larger files.
	Frequency param.Field[JobNewParamsFrequency] `json:"frequency"`
	// The kind parameter (optional) is used to differentiate between Logpush and Edge
	// Log Delivery jobs (when supported by the dataset).
	Kind param.Field[JobNewParamsKind] `json:"kind"`
	// This field is deprecated. Use `output_options` instead. Configuration string. It
	// specifies things like requested fields and timestamp formats. If migrating from
	// the logpull api, copy the url (full url or just the query string) of your call
	// here, and logpush will keep on making this call for you, setting start and end
	// times appropriately.
	LogpullOptions param.Field[string] `json:"logpull_options" format:"uri-reference"`
	// The maximum uncompressed file size of a batch of logs. This setting value must
	// be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a
	// minimum file size; this means that log files may be much smaller than this batch
	// size.
	MaxUploadBytes param.Field[JobNewParamsMaxUploadBytes] `json:"max_upload_bytes"`
	// The maximum interval in seconds for log batches. This setting must be between 30
	// and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify
	// a minimum interval for log batches; this means that log files may be sent in
	// shorter intervals than this.
	MaxUploadIntervalSeconds param.Field[JobNewParamsMaxUploadIntervalSeconds] `json:"max_upload_interval_seconds"`
	// The maximum number of log lines per batch. This setting must be between 1000 and
	// 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum
	// number of log lines per batch; this means that log files may contain many fewer
	// lines than this.
	MaxUploadRecords param.Field[JobNewParamsMaxUploadRecords] `json:"max_upload_records"`
	// Optional human readable job name. Not unique. Cloudflare suggests that you set
	// this to a meaningful string, like the domain name, to make it easier to identify
	// your job.
	Name param.Field[string] `json:"name"`
	// The structured replacement for `logpull_options`. When including this field, the
	// `logpull_option` field will be ignored.
	OutputOptions param.Field[OutputOptionsParam] `json:"output_options"`
	// Ownership challenge token to prove destination ownership.
	OwnershipChallenge param.Field[string] `json:"ownership_challenge"`
}

func (JobNewParams) MarshalJSON

func (r JobNewParams) MarshalJSON() (data []byte, err error)

type JobNewParamsDataset added in v4.3.0

type JobNewParamsDataset string

Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).

const (
	JobNewParamsDatasetAccessRequests           JobNewParamsDataset = "access_requests"
	JobNewParamsDatasetAuditLogs                JobNewParamsDataset = "audit_logs"
	JobNewParamsDatasetBISOUserActions          JobNewParamsDataset = "biso_user_actions"
	JobNewParamsDatasetCasbFindings             JobNewParamsDataset = "casb_findings"
	JobNewParamsDatasetDevicePostureResults     JobNewParamsDataset = "device_posture_results"
	JobNewParamsDatasetDLPForensicCopies        JobNewParamsDataset = "dlp_forensic_copies"
	JobNewParamsDatasetDNSFirewallLogs          JobNewParamsDataset = "dns_firewall_logs"
	JobNewParamsDatasetDNSLogs                  JobNewParamsDataset = "dns_logs"
	JobNewParamsDatasetEmailSecurityAlerts      JobNewParamsDataset = "email_security_alerts"
	JobNewParamsDatasetFirewallEvents           JobNewParamsDataset = "firewall_events"
	JobNewParamsDatasetGatewayDNS               JobNewParamsDataset = "gateway_dns"
	JobNewParamsDatasetGatewayHTTP              JobNewParamsDataset = "gateway_http"
	JobNewParamsDatasetGatewayNetwork           JobNewParamsDataset = "gateway_network"
	JobNewParamsDatasetHTTPRequests             JobNewParamsDataset = "http_requests"
	JobNewParamsDatasetMagicIDsDetections       JobNewParamsDataset = "magic_ids_detections"
	JobNewParamsDatasetNELReports               JobNewParamsDataset = "nel_reports"
	JobNewParamsDatasetNetworkAnalyticsLogs     JobNewParamsDataset = "network_analytics_logs"
	JobNewParamsDatasetPageShieldEvents         JobNewParamsDataset = "page_shield_events"
	JobNewParamsDatasetSinkholeHTTPLogs         JobNewParamsDataset = "sinkhole_http_logs"
	JobNewParamsDatasetSpectrumEvents           JobNewParamsDataset = "spectrum_events"
	JobNewParamsDatasetSSHLogs                  JobNewParamsDataset = "ssh_logs"
	JobNewParamsDatasetWorkersTraceEvents       JobNewParamsDataset = "workers_trace_events"
	JobNewParamsDatasetZarazEvents              JobNewParamsDataset = "zaraz_events"
	JobNewParamsDatasetZeroTrustNetworkSessions JobNewParamsDataset = "zero_trust_network_sessions"
)

func (JobNewParamsDataset) IsKnown added in v4.3.0

func (r JobNewParamsDataset) IsKnown() bool

type JobNewParamsFrequency

type JobNewParamsFrequency string

This field is deprecated. Please use `max_upload_*` parameters instead. The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.

const (
	JobNewParamsFrequencyHigh JobNewParamsFrequency = "high"
	JobNewParamsFrequencyLow  JobNewParamsFrequency = "low"
)

func (JobNewParamsFrequency) IsKnown

func (r JobNewParamsFrequency) IsKnown() bool

type JobNewParamsKind

type JobNewParamsKind string

The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset).

const (
	JobNewParamsKindEmpty JobNewParamsKind = ""
	JobNewParamsKindEdge  JobNewParamsKind = "edge"
)

func (JobNewParamsKind) IsKnown

func (r JobNewParamsKind) IsKnown() bool

type JobNewParamsMaxUploadBytes added in v4.6.0

type JobNewParamsMaxUploadBytes float64

The maximum uncompressed file size of a batch of logs. This setting value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.

const (
	JobNewParamsMaxUploadBytes0 JobNewParamsMaxUploadBytes = 0
)

func (JobNewParamsMaxUploadBytes) IsKnown added in v4.6.0

func (r JobNewParamsMaxUploadBytes) IsKnown() bool

type JobNewParamsMaxUploadIntervalSeconds added in v4.6.0

type JobNewParamsMaxUploadIntervalSeconds float64

The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this.

const (
	JobNewParamsMaxUploadIntervalSeconds0 JobNewParamsMaxUploadIntervalSeconds = 0
)

func (JobNewParamsMaxUploadIntervalSeconds) IsKnown added in v4.6.0

type JobNewParamsMaxUploadRecords added in v4.6.0

type JobNewParamsMaxUploadRecords float64

The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.

const (
	JobNewParamsMaxUploadRecords0 JobNewParamsMaxUploadRecords = 0
)

func (JobNewParamsMaxUploadRecords) IsKnown added in v4.6.0

func (r JobNewParamsMaxUploadRecords) IsKnown() bool

type JobNewResponseEnvelope

type JobNewResponseEnvelope struct {
	Errors   []JobNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []JobNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success JobNewResponseEnvelopeSuccess `json:"success,required"`
	Result  LogpushJob                    `json:"result,nullable"`
	JSON    jobNewResponseEnvelopeJSON    `json:"-"`
}

func (*JobNewResponseEnvelope) UnmarshalJSON

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

type JobNewResponseEnvelopeErrors added in v4.3.0

type JobNewResponseEnvelopeErrors struct {
	Code             int64                              `json:"code,required"`
	Message          string                             `json:"message,required"`
	DocumentationURL string                             `json:"documentation_url"`
	Source           JobNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             jobNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*JobNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type JobNewResponseEnvelopeErrorsSource added in v4.3.0

type JobNewResponseEnvelopeErrorsSource struct {
	Pointer string                                 `json:"pointer"`
	JSON    jobNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*JobNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type JobNewResponseEnvelopeMessages added in v4.3.0

type JobNewResponseEnvelopeMessages struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           JobNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             jobNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*JobNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type JobNewResponseEnvelopeMessagesSource added in v4.3.0

type JobNewResponseEnvelopeMessagesSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    jobNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*JobNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type JobNewResponseEnvelopeSuccess

type JobNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	JobNewResponseEnvelopeSuccessTrue JobNewResponseEnvelopeSuccess = true
)

func (JobNewResponseEnvelopeSuccess) IsKnown

func (r JobNewResponseEnvelopeSuccess) IsKnown() bool

type JobService

type JobService struct {
	Options []option.RequestOption
}

JobService 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 NewJobService method instead.

func NewJobService

func NewJobService(opts ...option.RequestOption) (r *JobService)

NewJobService 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 (*JobService) Delete

func (r *JobService) Delete(ctx context.Context, jobID int64, body JobDeleteParams, opts ...option.RequestOption) (res *JobDeleteResponse, err error)

Deletes a Logpush job.

func (*JobService) Get

func (r *JobService) Get(ctx context.Context, jobID int64, query JobGetParams, opts ...option.RequestOption) (res *LogpushJob, err error)

Gets the details of a Logpush job.

func (*JobService) List

Lists Logpush jobs for an account or zone.

func (*JobService) ListAutoPaging

Lists Logpush jobs for an account or zone.

func (*JobService) New

func (r *JobService) New(ctx context.Context, params JobNewParams, opts ...option.RequestOption) (res *LogpushJob, err error)

Creates a new Logpush job for an account or zone.

func (*JobService) Update

func (r *JobService) Update(ctx context.Context, jobID int64, params JobUpdateParams, opts ...option.RequestOption) (res *LogpushJob, err error)

Updates a Logpush job.

type JobUpdateParams

type JobUpdateParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
	// Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
	// Additional configuration parameters supported by the destination may be
	// included.
	DestinationConf param.Field[string] `json:"destination_conf" format:"uri"`
	// Flag that indicates if the job is enabled.
	Enabled param.Field[bool] `json:"enabled"`
	// The filters to select the events to include and/or remove from your logs. For
	// more information, refer to
	// [Filters](https://developers.cloudflare.com/logs/reference/filters/).
	Filter param.Field[string] `json:"filter"`
	// This field is deprecated. Please use `max_upload_*` parameters instead. The
	// frequency at which Cloudflare sends batches of logs to your destination. Setting
	// frequency to high sends your logs in larger quantities of smaller files. Setting
	// frequency to low sends logs in smaller quantities of larger files.
	Frequency param.Field[JobUpdateParamsFrequency] `json:"frequency"`
	// The kind parameter (optional) is used to differentiate between Logpush and Edge
	// Log Delivery jobs (when supported by the dataset).
	Kind param.Field[JobUpdateParamsKind] `json:"kind"`
	// This field is deprecated. Use `output_options` instead. Configuration string. It
	// specifies things like requested fields and timestamp formats. If migrating from
	// the logpull api, copy the url (full url or just the query string) of your call
	// here, and logpush will keep on making this call for you, setting start and end
	// times appropriately.
	LogpullOptions param.Field[string] `json:"logpull_options" format:"uri-reference"`
	// The maximum uncompressed file size of a batch of logs. This setting value must
	// be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a
	// minimum file size; this means that log files may be much smaller than this batch
	// size.
	MaxUploadBytes param.Field[JobUpdateParamsMaxUploadBytes] `json:"max_upload_bytes"`
	// The maximum interval in seconds for log batches. This setting must be between 30
	// and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify
	// a minimum interval for log batches; this means that log files may be sent in
	// shorter intervals than this.
	MaxUploadIntervalSeconds param.Field[JobUpdateParamsMaxUploadIntervalSeconds] `json:"max_upload_interval_seconds"`
	// The maximum number of log lines per batch. This setting must be between 1000 and
	// 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum
	// number of log lines per batch; this means that log files may contain many fewer
	// lines than this.
	MaxUploadRecords param.Field[JobUpdateParamsMaxUploadRecords] `json:"max_upload_records"`
	// Optional human readable job name. Not unique. Cloudflare suggests that you set
	// this to a meaningful string, like the domain name, to make it easier to identify
	// your job.
	Name param.Field[string] `json:"name"`
	// The structured replacement for `logpull_options`. When including this field, the
	// `logpull_option` field will be ignored.
	OutputOptions param.Field[OutputOptionsParam] `json:"output_options"`
	// Ownership challenge token to prove destination ownership.
	OwnershipChallenge param.Field[string] `json:"ownership_challenge"`
}

func (JobUpdateParams) MarshalJSON

func (r JobUpdateParams) MarshalJSON() (data []byte, err error)

type JobUpdateParamsFrequency

type JobUpdateParamsFrequency string

This field is deprecated. Please use `max_upload_*` parameters instead. The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.

const (
	JobUpdateParamsFrequencyHigh JobUpdateParamsFrequency = "high"
	JobUpdateParamsFrequencyLow  JobUpdateParamsFrequency = "low"
)

func (JobUpdateParamsFrequency) IsKnown

func (r JobUpdateParamsFrequency) IsKnown() bool

type JobUpdateParamsKind

type JobUpdateParamsKind string

The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset).

const (
	JobUpdateParamsKindEmpty JobUpdateParamsKind = ""
	JobUpdateParamsKindEdge  JobUpdateParamsKind = "edge"
)

func (JobUpdateParamsKind) IsKnown

func (r JobUpdateParamsKind) IsKnown() bool

type JobUpdateParamsMaxUploadBytes added in v4.6.0

type JobUpdateParamsMaxUploadBytes float64

The maximum uncompressed file size of a batch of logs. This setting value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.

const (
	JobUpdateParamsMaxUploadBytes0 JobUpdateParamsMaxUploadBytes = 0
)

func (JobUpdateParamsMaxUploadBytes) IsKnown added in v4.6.0

func (r JobUpdateParamsMaxUploadBytes) IsKnown() bool

type JobUpdateParamsMaxUploadIntervalSeconds added in v4.6.0

type JobUpdateParamsMaxUploadIntervalSeconds float64

The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this.

const (
	JobUpdateParamsMaxUploadIntervalSeconds0 JobUpdateParamsMaxUploadIntervalSeconds = 0
)

func (JobUpdateParamsMaxUploadIntervalSeconds) IsKnown added in v4.6.0

type JobUpdateParamsMaxUploadRecords added in v4.6.0

type JobUpdateParamsMaxUploadRecords float64

The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.

const (
	JobUpdateParamsMaxUploadRecords0 JobUpdateParamsMaxUploadRecords = 0
)

func (JobUpdateParamsMaxUploadRecords) IsKnown added in v4.6.0

type JobUpdateResponseEnvelope

type JobUpdateResponseEnvelope struct {
	Errors   []JobUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []JobUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success JobUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  LogpushJob                       `json:"result,nullable"`
	JSON    jobUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*JobUpdateResponseEnvelope) UnmarshalJSON

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

type JobUpdateResponseEnvelopeErrors added in v4.3.0

type JobUpdateResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code,required"`
	Message          string                                `json:"message,required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           JobUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             jobUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*JobUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type JobUpdateResponseEnvelopeErrorsSource added in v4.3.0

type JobUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    jobUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*JobUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type JobUpdateResponseEnvelopeMessages added in v4.3.0

type JobUpdateResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           JobUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             jobUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*JobUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type JobUpdateResponseEnvelopeMessagesSource added in v4.3.0

type JobUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    jobUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*JobUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type JobUpdateResponseEnvelopeSuccess

type JobUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	JobUpdateResponseEnvelopeSuccessTrue JobUpdateResponseEnvelopeSuccess = true
)

func (JobUpdateResponseEnvelopeSuccess) IsKnown

type LogpushJob

type LogpushJob struct {
	// Unique id of the job.
	ID int64 `json:"id"`
	// Name of the dataset. A list of supported datasets can be found on the
	// [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).
	Dataset LogpushJobDataset `json:"dataset,nullable"`
	// Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
	// Additional configuration parameters supported by the destination may be
	// included.
	DestinationConf string `json:"destination_conf" format:"uri"`
	// Flag that indicates if the job is enabled.
	Enabled bool `json:"enabled"`
	// If not null, the job is currently failing. Failures are usually repetitive
	// (example: no permissions to write to destination bucket). Only the last failure
	// is recorded. On successful execution of a job the error_message and last_error
	// are set to null.
	ErrorMessage string `json:"error_message,nullable"`
	// This field is deprecated. Please use `max_upload_*` parameters instead. The
	// frequency at which Cloudflare sends batches of logs to your destination. Setting
	// frequency to high sends your logs in larger quantities of smaller files. Setting
	// frequency to low sends logs in smaller quantities of larger files.
	//
	// Deprecated: deprecated
	Frequency LogpushJobFrequency `json:"frequency,nullable"`
	// The kind parameter (optional) is used to differentiate between Logpush and Edge
	// Log Delivery jobs (when supported by the dataset).
	Kind LogpushJobKind `json:"kind"`
	// Records the last time for which logs have been successfully pushed. If the last
	// successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z
	// then the value of this field will be 2018-07-23T10:01:00Z. If the job has never
	// run or has just been enabled and hasn't run yet then the field will be empty.
	LastComplete time.Time `json:"last_complete,nullable" format:"date-time"`
	// Records the last time the job failed. If not null, the job is currently failing.
	// If null, the job has either never failed or has run successfully at least once
	// since last failure. See also the error_message field.
	LastError time.Time `json:"last_error,nullable" format:"date-time"`
	// This field is deprecated. Use `output_options` instead. Configuration string. It
	// specifies things like requested fields and timestamp formats. If migrating from
	// the logpull api, copy the url (full url or just the query string) of your call
	// here, and logpush will keep on making this call for you, setting start and end
	// times appropriately.
	//
	// Deprecated: deprecated
	LogpullOptions string `json:"logpull_options,nullable" format:"uri-reference"`
	// The maximum uncompressed file size of a batch of logs. This setting value must
	// be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a
	// minimum file size; this means that log files may be much smaller than this batch
	// size.
	MaxUploadBytes LogpushJobMaxUploadBytes `json:"max_upload_bytes,nullable"`
	// The maximum interval in seconds for log batches. This setting must be between 30
	// and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify
	// a minimum interval for log batches; this means that log files may be sent in
	// shorter intervals than this.
	MaxUploadIntervalSeconds LogpushJobMaxUploadIntervalSeconds `json:"max_upload_interval_seconds,nullable"`
	// The maximum number of log lines per batch. This setting must be between 1000 and
	// 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum
	// number of log lines per batch; this means that log files may contain many fewer
	// lines than this.
	MaxUploadRecords LogpushJobMaxUploadRecords `json:"max_upload_records,nullable"`
	// Optional human readable job name. Not unique. Cloudflare suggests that you set
	// this to a meaningful string, like the domain name, to make it easier to identify
	// your job.
	Name string `json:"name,nullable"`
	// The structured replacement for `logpull_options`. When including this field, the
	// `logpull_option` field will be ignored.
	OutputOptions OutputOptions  `json:"output_options,nullable"`
	JSON          logpushJobJSON `json:"-"`
}

func (*LogpushJob) UnmarshalJSON

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

type LogpushJobDataset added in v4.3.0

type LogpushJobDataset string

Name of the dataset. A list of supported datasets can be found on the [Developer Docs](https://developers.cloudflare.com/logs/reference/log-fields/).

const (
	LogpushJobDatasetAccessRequests           LogpushJobDataset = "access_requests"
	LogpushJobDatasetAuditLogs                LogpushJobDataset = "audit_logs"
	LogpushJobDatasetBISOUserActions          LogpushJobDataset = "biso_user_actions"
	LogpushJobDatasetCasbFindings             LogpushJobDataset = "casb_findings"
	LogpushJobDatasetDevicePostureResults     LogpushJobDataset = "device_posture_results"
	LogpushJobDatasetDLPForensicCopies        LogpushJobDataset = "dlp_forensic_copies"
	LogpushJobDatasetDNSFirewallLogs          LogpushJobDataset = "dns_firewall_logs"
	LogpushJobDatasetDNSLogs                  LogpushJobDataset = "dns_logs"
	LogpushJobDatasetEmailSecurityAlerts      LogpushJobDataset = "email_security_alerts"
	LogpushJobDatasetFirewallEvents           LogpushJobDataset = "firewall_events"
	LogpushJobDatasetGatewayDNS               LogpushJobDataset = "gateway_dns"
	LogpushJobDatasetGatewayHTTP              LogpushJobDataset = "gateway_http"
	LogpushJobDatasetGatewayNetwork           LogpushJobDataset = "gateway_network"
	LogpushJobDatasetHTTPRequests             LogpushJobDataset = "http_requests"
	LogpushJobDatasetMagicIDsDetections       LogpushJobDataset = "magic_ids_detections"
	LogpushJobDatasetNELReports               LogpushJobDataset = "nel_reports"
	LogpushJobDatasetNetworkAnalyticsLogs     LogpushJobDataset = "network_analytics_logs"
	LogpushJobDatasetPageShieldEvents         LogpushJobDataset = "page_shield_events"
	LogpushJobDatasetSinkholeHTTPLogs         LogpushJobDataset = "sinkhole_http_logs"
	LogpushJobDatasetSpectrumEvents           LogpushJobDataset = "spectrum_events"
	LogpushJobDatasetSSHLogs                  LogpushJobDataset = "ssh_logs"
	LogpushJobDatasetWorkersTraceEvents       LogpushJobDataset = "workers_trace_events"
	LogpushJobDatasetZarazEvents              LogpushJobDataset = "zaraz_events"
	LogpushJobDatasetZeroTrustNetworkSessions LogpushJobDataset = "zero_trust_network_sessions"
)

func (LogpushJobDataset) IsKnown added in v4.3.0

func (r LogpushJobDataset) IsKnown() bool

type LogpushJobFrequency

type LogpushJobFrequency string

This field is deprecated. Please use `max_upload_*` parameters instead. The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.

const (
	LogpushJobFrequencyHigh LogpushJobFrequency = "high"
	LogpushJobFrequencyLow  LogpushJobFrequency = "low"
)

func (LogpushJobFrequency) IsKnown

func (r LogpushJobFrequency) IsKnown() bool

type LogpushJobKind

type LogpushJobKind string

The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs (when supported by the dataset).

const (
	LogpushJobKindEmpty LogpushJobKind = ""
	LogpushJobKindEdge  LogpushJobKind = "edge"
)

func (LogpushJobKind) IsKnown

func (r LogpushJobKind) IsKnown() bool

type LogpushJobMaxUploadBytes added in v4.6.0

type LogpushJobMaxUploadBytes float64

The maximum uncompressed file size of a batch of logs. This setting value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.

const (
	LogpushJobMaxUploadBytes0 LogpushJobMaxUploadBytes = 0
)

func (LogpushJobMaxUploadBytes) IsKnown added in v4.6.0

func (r LogpushJobMaxUploadBytes) IsKnown() bool

type LogpushJobMaxUploadIntervalSeconds added in v4.6.0

type LogpushJobMaxUploadIntervalSeconds float64

The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this.

const (
	LogpushJobMaxUploadIntervalSeconds0 LogpushJobMaxUploadIntervalSeconds = 0
)

func (LogpushJobMaxUploadIntervalSeconds) IsKnown added in v4.6.0

type LogpushJobMaxUploadRecords added in v4.6.0

type LogpushJobMaxUploadRecords float64

The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.

const (
	LogpushJobMaxUploadRecords0 LogpushJobMaxUploadRecords = 0
)

func (LogpushJobMaxUploadRecords) IsKnown added in v4.6.0

func (r LogpushJobMaxUploadRecords) IsKnown() bool

type LogpushService

type LogpushService struct {
	Options   []option.RequestOption
	Datasets  *DatasetService
	Edge      *EdgeService
	Jobs      *JobService
	Ownership *OwnershipService
	Validate  *ValidateService
}

LogpushService 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 NewLogpushService method instead.

func NewLogpushService

func NewLogpushService(opts ...option.RequestOption) (r *LogpushService)

NewLogpushService 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 Member

type Member = shared.Member

This is an alias to an internal type.

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 MemberPolicy

type MemberPolicy = shared.MemberPolicy

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 OutputOptions

type OutputOptions struct {
	// String to be prepended before each batch.
	BatchPrefix string `json:"batch_prefix,nullable"`
	// String to be appended after each batch.
	BatchSuffix string `json:"batch_suffix,nullable"`
	// If set to true, will cause all occurrences of `${` in the generated files to be
	// replaced with `x{`.
	Cve2021_44228 bool `json:"CVE-2021-44228,nullable"`
	// String to join fields. This field be ignored when `record_template` is set.
	FieldDelimiter string `json:"field_delimiter,nullable"`
	// List of field names to be included in the Logpush output. For the moment, there
	// is no option to add all fields at once, so you must specify all the fields names
	// you are interested in.
	FieldNames []string `json:"field_names"`
	// Specifies the output type, such as `ndjson` or `csv`. This sets default values
	// for the rest of the settings, depending on the chosen output type. Some
	// formatting rules, like string quoting, are different between output types.
	OutputType OutputOptionsOutputType `json:"output_type"`
	// String to be inserted in-between the records as separator.
	RecordDelimiter string `json:"record_delimiter,nullable"`
	// String to be prepended before each record.
	RecordPrefix string `json:"record_prefix,nullable"`
	// String to be appended after each record.
	RecordSuffix string `json:"record_suffix,nullable"`
	// String to use as template for each record instead of the default json key value
	// mapping. All fields used in the template must be present in `field_names` as
	// well, otherwise they will end up as null. Format as a Go `text/template` without
	// any standard functions, like conditionals, loops, sub-templates, etc.
	RecordTemplate string `json:"record_template,nullable"`
	// Floating number to specify sampling rate. Sampling is applied on top of
	// filtering, and regardless of the current `sample_interval` of the data.
	SampleRate float64 `json:"sample_rate,nullable"`
	// String to specify the format for timestamps, such as `unixnano`, `unix`, or
	// `rfc3339`.
	TimestampFormat OutputOptionsTimestampFormat `json:"timestamp_format"`
	JSON            outputOptionsJSON            `json:"-"`
}

The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.

func (*OutputOptions) UnmarshalJSON

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

type OutputOptionsOutputType

type OutputOptionsOutputType string

Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types.

const (
	OutputOptionsOutputTypeNdjson OutputOptionsOutputType = "ndjson"
	OutputOptionsOutputTypeCsv    OutputOptionsOutputType = "csv"
)

func (OutputOptionsOutputType) IsKnown

func (r OutputOptionsOutputType) IsKnown() bool

type OutputOptionsParam

type OutputOptionsParam struct {
	// String to be prepended before each batch.
	BatchPrefix param.Field[string] `json:"batch_prefix"`
	// String to be appended after each batch.
	BatchSuffix param.Field[string] `json:"batch_suffix"`
	// If set to true, will cause all occurrences of `${` in the generated files to be
	// replaced with `x{`.
	Cve2021_44228 param.Field[bool] `json:"CVE-2021-44228"`
	// String to join fields. This field be ignored when `record_template` is set.
	FieldDelimiter param.Field[string] `json:"field_delimiter"`
	// List of field names to be included in the Logpush output. For the moment, there
	// is no option to add all fields at once, so you must specify all the fields names
	// you are interested in.
	FieldNames param.Field[[]string] `json:"field_names"`
	// Specifies the output type, such as `ndjson` or `csv`. This sets default values
	// for the rest of the settings, depending on the chosen output type. Some
	// formatting rules, like string quoting, are different between output types.
	OutputType param.Field[OutputOptionsOutputType] `json:"output_type"`
	// String to be inserted in-between the records as separator.
	RecordDelimiter param.Field[string] `json:"record_delimiter"`
	// String to be prepended before each record.
	RecordPrefix param.Field[string] `json:"record_prefix"`
	// String to be appended after each record.
	RecordSuffix param.Field[string] `json:"record_suffix"`
	// String to use as template for each record instead of the default json key value
	// mapping. All fields used in the template must be present in `field_names` as
	// well, otherwise they will end up as null. Format as a Go `text/template` without
	// any standard functions, like conditionals, loops, sub-templates, etc.
	RecordTemplate param.Field[string] `json:"record_template"`
	// Floating number to specify sampling rate. Sampling is applied on top of
	// filtering, and regardless of the current `sample_interval` of the data.
	SampleRate param.Field[float64] `json:"sample_rate"`
	// String to specify the format for timestamps, such as `unixnano`, `unix`, or
	// `rfc3339`.
	TimestampFormat param.Field[OutputOptionsTimestampFormat] `json:"timestamp_format"`
}

The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.

func (OutputOptionsParam) MarshalJSON

func (r OutputOptionsParam) MarshalJSON() (data []byte, err error)

type OutputOptionsTimestampFormat

type OutputOptionsTimestampFormat string

String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`.

const (
	OutputOptionsTimestampFormatUnixnano OutputOptionsTimestampFormat = "unixnano"
	OutputOptionsTimestampFormatUnix     OutputOptionsTimestampFormat = "unix"
	OutputOptionsTimestampFormatRfc3339  OutputOptionsTimestampFormat = "rfc3339"
)

func (OutputOptionsTimestampFormat) IsKnown

func (r OutputOptionsTimestampFormat) IsKnown() bool

type OwnershipNewParams

type OwnershipNewParams struct {
	// Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
	// Additional configuration parameters supported by the destination may be
	// included.
	DestinationConf param.Field[string] `json:"destination_conf,required" format:"uri"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (OwnershipNewParams) MarshalJSON

func (r OwnershipNewParams) MarshalJSON() (data []byte, err error)

type OwnershipNewResponse

type OwnershipNewResponse struct {
	Filename string                   `json:"filename"`
	Message  string                   `json:"message"`
	Valid    bool                     `json:"valid"`
	JSON     ownershipNewResponseJSON `json:"-"`
}

func (*OwnershipNewResponse) UnmarshalJSON

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

type OwnershipNewResponseEnvelope

type OwnershipNewResponseEnvelope struct {
	Errors   []OwnershipNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OwnershipNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success OwnershipNewResponseEnvelopeSuccess `json:"success,required"`
	Result  OwnershipNewResponse                `json:"result,nullable"`
	JSON    ownershipNewResponseEnvelopeJSON    `json:"-"`
}

func (*OwnershipNewResponseEnvelope) UnmarshalJSON

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

type OwnershipNewResponseEnvelopeErrors added in v4.3.0

type OwnershipNewResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           OwnershipNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             ownershipNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*OwnershipNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type OwnershipNewResponseEnvelopeErrorsSource added in v4.3.0

type OwnershipNewResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    ownershipNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*OwnershipNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type OwnershipNewResponseEnvelopeMessages added in v4.3.0

type OwnershipNewResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           OwnershipNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             ownershipNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*OwnershipNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type OwnershipNewResponseEnvelopeMessagesSource added in v4.3.0

type OwnershipNewResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    ownershipNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*OwnershipNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type OwnershipNewResponseEnvelopeSuccess

type OwnershipNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	OwnershipNewResponseEnvelopeSuccessTrue OwnershipNewResponseEnvelopeSuccess = true
)

func (OwnershipNewResponseEnvelopeSuccess) IsKnown

type OwnershipService

type OwnershipService struct {
	Options []option.RequestOption
}

OwnershipService 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 NewOwnershipService method instead.

func NewOwnershipService

func NewOwnershipService(opts ...option.RequestOption) (r *OwnershipService)

NewOwnershipService 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 (*OwnershipService) New

Gets a new ownership challenge sent to your destination.

func (*OwnershipService) Validate

Validates ownership challenge of the destination.

type OwnershipValidateParams

type OwnershipValidateParams struct {
	// Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
	// Additional configuration parameters supported by the destination may be
	// included.
	DestinationConf param.Field[string] `json:"destination_conf,required" format:"uri"`
	// Ownership challenge token to prove destination ownership.
	OwnershipChallenge param.Field[string] `json:"ownership_challenge,required"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (OwnershipValidateParams) MarshalJSON

func (r OwnershipValidateParams) MarshalJSON() (data []byte, err error)

type OwnershipValidateResponseEnvelope

type OwnershipValidateResponseEnvelope struct {
	Errors   []OwnershipValidateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []OwnershipValidateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success OwnershipValidateResponseEnvelopeSuccess `json:"success,required"`
	Result  OwnershipValidation                      `json:"result,nullable"`
	JSON    ownershipValidateResponseEnvelopeJSON    `json:"-"`
}

func (*OwnershipValidateResponseEnvelope) UnmarshalJSON

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

type OwnershipValidateResponseEnvelopeErrors added in v4.3.0

type OwnershipValidateResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           OwnershipValidateResponseEnvelopeErrorsSource `json:"source"`
	JSON             ownershipValidateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*OwnershipValidateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type OwnershipValidateResponseEnvelopeErrorsSource added in v4.3.0

type OwnershipValidateResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    ownershipValidateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*OwnershipValidateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type OwnershipValidateResponseEnvelopeMessages added in v4.3.0

type OwnershipValidateResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           OwnershipValidateResponseEnvelopeMessagesSource `json:"source"`
	JSON             ownershipValidateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*OwnershipValidateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type OwnershipValidateResponseEnvelopeMessagesSource added in v4.3.0

type OwnershipValidateResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    ownershipValidateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*OwnershipValidateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type OwnershipValidateResponseEnvelopeSuccess

type OwnershipValidateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	OwnershipValidateResponseEnvelopeSuccessTrue OwnershipValidateResponseEnvelopeSuccess = true
)

func (OwnershipValidateResponseEnvelopeSuccess) IsKnown

type OwnershipValidation

type OwnershipValidation struct {
	Valid bool                    `json:"valid"`
	JSON  ownershipValidationJSON `json:"-"`
}

func (*OwnershipValidation) UnmarshalJSON

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

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID added in v4.1.0

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 ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource added in v4.3.0

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

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 SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

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 TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

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 TokenPolicyResourcesMap added in v4.6.0

type TokenPolicyResourcesMap = shared.TokenPolicyResourcesMap

A nested permission grant for further scoping.

This is an alias to an internal type.

type TokenPolicyResourcesMapParam added in v4.6.0

type TokenPolicyResourcesMapParam = shared.TokenPolicyResourcesMapParam

A nested permission grant for further scoping.

This is an alias to an internal type.

type TokenPolicyResourcesUnion added in v4.6.0

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam added in v4.6.0

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A simple wildcard permission, e.g., "\*".

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 ValidateDestinationExistsParams added in v4.1.0

type ValidateDestinationExistsParams struct {
	// Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
	// Additional configuration parameters supported by the destination may be
	// included.
	DestinationConf param.Field[string] `json:"destination_conf,required" format:"uri"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (ValidateDestinationExistsParams) MarshalJSON added in v4.1.0

func (r ValidateDestinationExistsParams) MarshalJSON() (data []byte, err error)

type ValidateDestinationExistsResponse added in v4.1.0

type ValidateDestinationExistsResponse struct {
	Exists bool                                  `json:"exists"`
	JSON   validateDestinationExistsResponseJSON `json:"-"`
}

func (*ValidateDestinationExistsResponse) UnmarshalJSON added in v4.1.0

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

type ValidateDestinationExistsResponseEnvelope added in v4.1.0

type ValidateDestinationExistsResponseEnvelope struct {
	Errors   []ValidateDestinationExistsResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ValidateDestinationExistsResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ValidateDestinationExistsResponseEnvelopeSuccess `json:"success,required"`
	Result  ValidateDestinationExistsResponse                `json:"result,nullable"`
	JSON    validateDestinationExistsResponseEnvelopeJSON    `json:"-"`
}

func (*ValidateDestinationExistsResponseEnvelope) UnmarshalJSON added in v4.1.0

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

type ValidateDestinationExistsResponseEnvelopeErrors added in v4.3.0

type ValidateDestinationExistsResponseEnvelopeErrors struct {
	Code             int64                                                 `json:"code,required"`
	Message          string                                                `json:"message,required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           ValidateDestinationExistsResponseEnvelopeErrorsSource `json:"source"`
	JSON             validateDestinationExistsResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ValidateDestinationExistsResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ValidateDestinationExistsResponseEnvelopeErrorsSource added in v4.3.0

type ValidateDestinationExistsResponseEnvelopeErrorsSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    validateDestinationExistsResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ValidateDestinationExistsResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ValidateDestinationExistsResponseEnvelopeMessages added in v4.3.0

type ValidateDestinationExistsResponseEnvelopeMessages struct {
	Code             int64                                                   `json:"code,required"`
	Message          string                                                  `json:"message,required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           ValidateDestinationExistsResponseEnvelopeMessagesSource `json:"source"`
	JSON             validateDestinationExistsResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ValidateDestinationExistsResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ValidateDestinationExistsResponseEnvelopeMessagesSource added in v4.3.0

type ValidateDestinationExistsResponseEnvelopeMessagesSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    validateDestinationExistsResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ValidateDestinationExistsResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

type ValidateDestinationExistsResponseEnvelopeSuccess added in v4.1.0

type ValidateDestinationExistsResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ValidateDestinationExistsResponseEnvelopeSuccessTrue ValidateDestinationExistsResponseEnvelopeSuccess = true
)

func (ValidateDestinationExistsResponseEnvelopeSuccess) IsKnown added in v4.1.0

type ValidateDestinationParams

type ValidateDestinationParams struct {
	// Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
	// Additional configuration parameters supported by the destination may be
	// included.
	DestinationConf param.Field[string] `json:"destination_conf,required" format:"uri"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (ValidateDestinationParams) MarshalJSON

func (r ValidateDestinationParams) MarshalJSON() (data []byte, err error)

type ValidateDestinationResponse

type ValidateDestinationResponse struct {
	Message string                          `json:"message"`
	Valid   bool                            `json:"valid"`
	JSON    validateDestinationResponseJSON `json:"-"`
}

func (*ValidateDestinationResponse) UnmarshalJSON

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

type ValidateDestinationResponseEnvelope

type ValidateDestinationResponseEnvelope struct {
	Errors   []ValidateDestinationResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ValidateDestinationResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ValidateDestinationResponseEnvelopeSuccess `json:"success,required"`
	Result  ValidateDestinationResponse                `json:"result,nullable"`
	JSON    validateDestinationResponseEnvelopeJSON    `json:"-"`
}

func (*ValidateDestinationResponseEnvelope) UnmarshalJSON

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

type ValidateDestinationResponseEnvelopeErrors added in v4.3.0

type ValidateDestinationResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ValidateDestinationResponseEnvelopeErrorsSource `json:"source"`
	JSON             validateDestinationResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ValidateDestinationResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ValidateDestinationResponseEnvelopeErrorsSource added in v4.3.0

type ValidateDestinationResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    validateDestinationResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ValidateDestinationResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ValidateDestinationResponseEnvelopeMessages added in v4.3.0

type ValidateDestinationResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ValidateDestinationResponseEnvelopeMessagesSource `json:"source"`
	JSON             validateDestinationResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ValidateDestinationResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ValidateDestinationResponseEnvelopeMessagesSource added in v4.3.0

type ValidateDestinationResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    validateDestinationResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ValidateDestinationResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ValidateDestinationResponseEnvelopeSuccess

type ValidateDestinationResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ValidateDestinationResponseEnvelopeSuccessTrue ValidateDestinationResponseEnvelopeSuccess = true
)

func (ValidateDestinationResponseEnvelopeSuccess) IsKnown

type ValidateOriginParams

type ValidateOriginParams struct {
	// This field is deprecated. Use `output_options` instead. Configuration string. It
	// specifies things like requested fields and timestamp formats. If migrating from
	// the logpull api, copy the url (full url or just the query string) of your call
	// here, and logpush will keep on making this call for you, setting start and end
	// times appropriately.
	LogpullOptions param.Field[string] `json:"logpull_options,required" format:"uri-reference"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (ValidateOriginParams) MarshalJSON

func (r ValidateOriginParams) MarshalJSON() (data []byte, err error)

type ValidateOriginResponse

type ValidateOriginResponse struct {
	Message string                     `json:"message"`
	Valid   bool                       `json:"valid"`
	JSON    validateOriginResponseJSON `json:"-"`
}

func (*ValidateOriginResponse) UnmarshalJSON

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

type ValidateOriginResponseEnvelope

type ValidateOriginResponseEnvelope struct {
	Errors   []ValidateOriginResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ValidateOriginResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ValidateOriginResponseEnvelopeSuccess `json:"success,required"`
	Result  ValidateOriginResponse                `json:"result,nullable"`
	JSON    validateOriginResponseEnvelopeJSON    `json:"-"`
}

func (*ValidateOriginResponseEnvelope) UnmarshalJSON

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

type ValidateOriginResponseEnvelopeErrors added in v4.3.0

type ValidateOriginResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ValidateOriginResponseEnvelopeErrorsSource `json:"source"`
	JSON             validateOriginResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ValidateOriginResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ValidateOriginResponseEnvelopeErrorsSource added in v4.3.0

type ValidateOriginResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    validateOriginResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ValidateOriginResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ValidateOriginResponseEnvelopeMessages added in v4.3.0

type ValidateOriginResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ValidateOriginResponseEnvelopeMessagesSource `json:"source"`
	JSON             validateOriginResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ValidateOriginResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ValidateOriginResponseEnvelopeMessagesSource added in v4.3.0

type ValidateOriginResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    validateOriginResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ValidateOriginResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ValidateOriginResponseEnvelopeSuccess

type ValidateOriginResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ValidateOriginResponseEnvelopeSuccessTrue ValidateOriginResponseEnvelopeSuccess = true
)

func (ValidateOriginResponseEnvelopeSuccess) IsKnown

type ValidateService

type ValidateService struct {
	Options []option.RequestOption
}

ValidateService 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 NewValidateService method instead.

func NewValidateService

func NewValidateService(opts ...option.RequestOption) (r *ValidateService)

NewValidateService 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 (*ValidateService) Destination

Validates destination.

func (*ValidateService) DestinationExists added in v4.1.0

Checks if there is an existing job with a destination.

func (*ValidateService) Origin

Validates logpull origin with logpull_options.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL