Movatterモバイル変換

[0]ホーム
URL:

logpush

package
v4.6.0Latest Latest
Warning

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

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

Details

Repository

github.com/cloudflare/cloudflare-go

Links

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

typeASN

type ASN =shared.ASN

This is an alias to an internal type.

typeASNParam

type ASNParam =shared.ASNParam

This is an alias to an internal type.

typeAuditLog

type AuditLog =shared.AuditLog

This is an alias to an internal type.

typeAuditLogAction

type AuditLogAction =shared.AuditLogAction

This is an alias to an internal type.

typeAuditLogActor

type AuditLogActor =shared.AuditLogActor

This is an alias to an internal type.

typeAuditLogActorType

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.

typeAuditLogOwner

type AuditLogOwner =shared.AuditLogOwner

This is an alias to an internal type.

typeAuditLogResource

type AuditLogResource =shared.AuditLogResource

This is an alias to an internal type.

typeCertificateCA

type CertificateCA =shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

typeCertificateRequestType

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.

typeCloudflareTunnel

type CloudflareTunnel =shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

typeCloudflareTunnelConnection

type CloudflareTunnelConnection =shared.CloudflareTunnelConnection

This is an alias to an internal type.

typeCloudflareTunnelStatus

type CloudflareTunnelStatus =shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never beenrun), `degraded` (tunnel is active and able to serve traffic but in an unhealthystate), `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.

typeCloudflareTunnelTunType

type CloudflareTunnelTunType =shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

typeDatasetFieldGetParams

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

typeDatasetFieldGetParamsDatasetIDadded inv4.3.0

type DatasetFieldGetParamsDatasetIDstring

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 (DatasetFieldGetParamsDatasetIDAccessRequestsDatasetFieldGetParamsDatasetID = "access_requests"DatasetFieldGetParamsDatasetIDAuditLogsDatasetFieldGetParamsDatasetID = "audit_logs"DatasetFieldGetParamsDatasetIDBISOUserActionsDatasetFieldGetParamsDatasetID = "biso_user_actions"DatasetFieldGetParamsDatasetIDCasbFindingsDatasetFieldGetParamsDatasetID = "casb_findings"DatasetFieldGetParamsDatasetIDDevicePostureResultsDatasetFieldGetParamsDatasetID = "device_posture_results"DatasetFieldGetParamsDatasetIDDLPForensicCopiesDatasetFieldGetParamsDatasetID = "dlp_forensic_copies"DatasetFieldGetParamsDatasetIDDNSFirewallLogsDatasetFieldGetParamsDatasetID = "dns_firewall_logs"DatasetFieldGetParamsDatasetIDDNSLogsDatasetFieldGetParamsDatasetID = "dns_logs"DatasetFieldGetParamsDatasetIDEmailSecurityAlertsDatasetFieldGetParamsDatasetID = "email_security_alerts"DatasetFieldGetParamsDatasetIDFirewallEventsDatasetFieldGetParamsDatasetID = "firewall_events"DatasetFieldGetParamsDatasetIDGatewayDNSDatasetFieldGetParamsDatasetID = "gateway_dns"DatasetFieldGetParamsDatasetIDGatewayHTTPDatasetFieldGetParamsDatasetID = "gateway_http"DatasetFieldGetParamsDatasetIDGatewayNetworkDatasetFieldGetParamsDatasetID = "gateway_network"DatasetFieldGetParamsDatasetIDHTTPRequestsDatasetFieldGetParamsDatasetID = "http_requests"DatasetFieldGetParamsDatasetIDMagicIDsDetectionsDatasetFieldGetParamsDatasetID = "magic_ids_detections"DatasetFieldGetParamsDatasetIDNELReportsDatasetFieldGetParamsDatasetID = "nel_reports"DatasetFieldGetParamsDatasetIDNetworkAnalyticsLogsDatasetFieldGetParamsDatasetID = "network_analytics_logs"DatasetFieldGetParamsDatasetIDPageShieldEventsDatasetFieldGetParamsDatasetID = "page_shield_events"DatasetFieldGetParamsDatasetIDSinkholeHTTPLogsDatasetFieldGetParamsDatasetID = "sinkhole_http_logs"DatasetFieldGetParamsDatasetIDSpectrumEventsDatasetFieldGetParamsDatasetID = "spectrum_events"DatasetFieldGetParamsDatasetIDSSHLogsDatasetFieldGetParamsDatasetID = "ssh_logs"DatasetFieldGetParamsDatasetIDWorkersTraceEventsDatasetFieldGetParamsDatasetID = "workers_trace_events"DatasetFieldGetParamsDatasetIDZarazEventsDatasetFieldGetParamsDatasetID = "zaraz_events"DatasetFieldGetParamsDatasetIDZeroTrustNetworkSessionsDatasetFieldGetParamsDatasetID = "zero_trust_network_sessions")

func (DatasetFieldGetParamsDatasetID)IsKnownadded inv4.3.0

typeDatasetFieldGetResponse

type DatasetFieldGetResponse = interface{}

typeDatasetFieldGetResponseEnvelope

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

func (*DatasetFieldGetResponseEnvelope)UnmarshalJSON

func (r *DatasetFieldGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeDatasetFieldGetResponseEnvelopeErrorsadded inv4.3.0

type DatasetFieldGetResponseEnvelopeErrors struct {Codeint64                                       `json:"code,required"`Messagestring                                      `json:"message,required"`DocumentationURLstring                                      `json:"documentation_url"`SourceDatasetFieldGetResponseEnvelopeErrorsSource `json:"source"`JSON             datasetFieldGetResponseEnvelopeErrorsJSON   `json:"-"`}

func (*DatasetFieldGetResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *DatasetFieldGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeDatasetFieldGetResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*DatasetFieldGetResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *DatasetFieldGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeDatasetFieldGetResponseEnvelopeMessagesadded inv4.3.0

type DatasetFieldGetResponseEnvelopeMessages struct {Codeint64                                         `json:"code,required"`Messagestring                                        `json:"message,required"`DocumentationURLstring                                        `json:"documentation_url"`SourceDatasetFieldGetResponseEnvelopeMessagesSource `json:"source"`JSON             datasetFieldGetResponseEnvelopeMessagesJSON   `json:"-"`}

func (*DatasetFieldGetResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *DatasetFieldGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeDatasetFieldGetResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*DatasetFieldGetResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *DatasetFieldGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeDatasetFieldGetResponseEnvelopeSuccess

type DatasetFieldGetResponseEnvelopeSuccessbool

Whether the API call was successful.

const (DatasetFieldGetResponseEnvelopeSuccessTrueDatasetFieldGetResponseEnvelopeSuccess =true)

func (DatasetFieldGetResponseEnvelopeSuccess)IsKnown

typeDatasetFieldService

type DatasetFieldService struct {Options []option.RequestOption}

DatasetFieldService contains methods and other services that help withinteracting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewDatasetFieldService method instead.

funcNewDatasetFieldService

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

NewDatasetFieldService generates a new service that applies the given options toeach request. These options are applied after the parent client's options (ifthere is one), and before any request-specific options.

func (*DatasetFieldService)Get

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

typeDatasetJobGetParams

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

typeDatasetJobGetParamsDatasetIDadded inv4.3.0

type DatasetJobGetParamsDatasetIDstring

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 (DatasetJobGetParamsDatasetIDAccessRequestsDatasetJobGetParamsDatasetID = "access_requests"DatasetJobGetParamsDatasetIDAuditLogsDatasetJobGetParamsDatasetID = "audit_logs"DatasetJobGetParamsDatasetIDBISOUserActionsDatasetJobGetParamsDatasetID = "biso_user_actions"DatasetJobGetParamsDatasetIDCasbFindingsDatasetJobGetParamsDatasetID = "casb_findings"DatasetJobGetParamsDatasetIDDevicePostureResultsDatasetJobGetParamsDatasetID = "device_posture_results"DatasetJobGetParamsDatasetIDDLPForensicCopiesDatasetJobGetParamsDatasetID = "dlp_forensic_copies"DatasetJobGetParamsDatasetIDDNSFirewallLogsDatasetJobGetParamsDatasetID = "dns_firewall_logs"DatasetJobGetParamsDatasetIDDNSLogsDatasetJobGetParamsDatasetID = "dns_logs"DatasetJobGetParamsDatasetIDEmailSecurityAlertsDatasetJobGetParamsDatasetID = "email_security_alerts"DatasetJobGetParamsDatasetIDFirewallEventsDatasetJobGetParamsDatasetID = "firewall_events"DatasetJobGetParamsDatasetIDGatewayDNSDatasetJobGetParamsDatasetID = "gateway_dns"DatasetJobGetParamsDatasetIDGatewayHTTPDatasetJobGetParamsDatasetID = "gateway_http"DatasetJobGetParamsDatasetIDGatewayNetworkDatasetJobGetParamsDatasetID = "gateway_network"DatasetJobGetParamsDatasetIDHTTPRequestsDatasetJobGetParamsDatasetID = "http_requests"DatasetJobGetParamsDatasetIDMagicIDsDetectionsDatasetJobGetParamsDatasetID = "magic_ids_detections"DatasetJobGetParamsDatasetIDNELReportsDatasetJobGetParamsDatasetID = "nel_reports"DatasetJobGetParamsDatasetIDNetworkAnalyticsLogsDatasetJobGetParamsDatasetID = "network_analytics_logs"DatasetJobGetParamsDatasetIDPageShieldEventsDatasetJobGetParamsDatasetID = "page_shield_events"DatasetJobGetParamsDatasetIDSinkholeHTTPLogsDatasetJobGetParamsDatasetID = "sinkhole_http_logs"DatasetJobGetParamsDatasetIDSpectrumEventsDatasetJobGetParamsDatasetID = "spectrum_events"DatasetJobGetParamsDatasetIDSSHLogsDatasetJobGetParamsDatasetID = "ssh_logs"DatasetJobGetParamsDatasetIDWorkersTraceEventsDatasetJobGetParamsDatasetID = "workers_trace_events"DatasetJobGetParamsDatasetIDZarazEventsDatasetJobGetParamsDatasetID = "zaraz_events"DatasetJobGetParamsDatasetIDZeroTrustNetworkSessionsDatasetJobGetParamsDatasetID = "zero_trust_network_sessions")

func (DatasetJobGetParamsDatasetID)IsKnownadded inv4.3.0

typeDatasetJobService

type DatasetJobService struct {Options []option.RequestOption}

DatasetJobService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewDatasetJobService method instead.

funcNewDatasetJobService

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

NewDatasetJobService generates a new service that applies the given options toeach request. These options are applied after the parent client's options (ifthere is one), and before any request-specific options.

func (*DatasetJobService)Get

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

func (*DatasetJobService)GetAutoPagingadded inv4.1.0

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

typeDatasetService

type DatasetService struct {Options []option.RequestOptionFields  *DatasetFieldServiceJobs    *DatasetJobService}

DatasetService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewDatasetService method instead.

funcNewDatasetService

func NewDatasetService(opts ...option.RequestOption) (r *DatasetService)

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

typeEdgeGetParams

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

typeEdgeNewParams

type EdgeNewParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// Comma-separated list of fields.Fieldsparam.Field[string] `json:"fields"`// Filters to drill down into specific events.Filterparam.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.Sampleparam.Field[int64] `json:"sample"`}

func (EdgeNewParams)MarshalJSON

func (rEdgeNewParams) MarshalJSON() (data []byte, errerror)

typeEdgeNewResponseEnvelope

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

func (*EdgeNewResponseEnvelope)UnmarshalJSON

func (r *EdgeNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeEdgeNewResponseEnvelopeErrorsadded inv4.3.0

type EdgeNewResponseEnvelopeErrors struct {Codeint64                               `json:"code,required"`Messagestring                              `json:"message,required"`DocumentationURLstring                              `json:"documentation_url"`SourceEdgeNewResponseEnvelopeErrorsSource `json:"source"`JSON             edgeNewResponseEnvelopeErrorsJSON   `json:"-"`}

func (*EdgeNewResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *EdgeNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeEdgeNewResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*EdgeNewResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *EdgeNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeEdgeNewResponseEnvelopeMessagesadded inv4.3.0

type EdgeNewResponseEnvelopeMessages struct {Codeint64                                 `json:"code,required"`Messagestring                                `json:"message,required"`DocumentationURLstring                                `json:"documentation_url"`SourceEdgeNewResponseEnvelopeMessagesSource `json:"source"`JSON             edgeNewResponseEnvelopeMessagesJSON   `json:"-"`}

func (*EdgeNewResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *EdgeNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeEdgeNewResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*EdgeNewResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *EdgeNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeEdgeNewResponseEnvelopeSuccess

type EdgeNewResponseEnvelopeSuccessbool

Whether the API call was successful.

const (EdgeNewResponseEnvelopeSuccessTrueEdgeNewResponseEnvelopeSuccess =true)

func (EdgeNewResponseEnvelopeSuccess)IsKnown

typeEdgeService

type EdgeService struct {Options []option.RequestOption}

EdgeService contains methods and other services that help with interacting withthe cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewEdgeService method instead.

funcNewEdgeService

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

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

func (*EdgeService)Get

Lists Instant Logs jobs for a zone.

func (*EdgeService)GetAutoPagingadded inv4.1.0

Lists Instant Logs jobs for a zone.

func (*EdgeService)New

Creates a new Instant Logs job for a zone.

typeError

type Error =apierror.Error

typeErrorData

type ErrorData =shared.ErrorData

This is an alias to an internal type.

typeErrorDataSourceadded inv4.2.0

type ErrorDataSource =shared.ErrorDataSource

This is an alias to an internal type.

typeInstantLogpushJob

type InstantLogpushJob struct {// Unique WebSocket address that will receive messages from Cloudflare’s edge.DestinationConfstring `json:"destination_conf" format:"uri"`// Comma-separated list of fields.Fieldsstring `json:"fields"`// Filters to drill down into specific events.Filterstring `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.Sampleint64 `json:"sample"`// Unique session id of the job.SessionIDstring                `json:"session_id"`JSON      instantLogpushJobJSON `json:"-"`}

func (*InstantLogpushJob)UnmarshalJSON

func (r *InstantLogpushJob) UnmarshalJSON(data []byte) (errerror)

typeJobDeleteParams

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

typeJobDeleteResponse

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

func (*JobDeleteResponse)UnmarshalJSON

func (r *JobDeleteResponse) UnmarshalJSON(data []byte) (errerror)

typeJobDeleteResponseEnvelope

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

func (*JobDeleteResponseEnvelope)UnmarshalJSON

func (r *JobDeleteResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeJobDeleteResponseEnvelopeErrorsadded inv4.3.0

type JobDeleteResponseEnvelopeErrors struct {Codeint64                                 `json:"code,required"`Messagestring                                `json:"message,required"`DocumentationURLstring                                `json:"documentation_url"`SourceJobDeleteResponseEnvelopeErrorsSource `json:"source"`JSON             jobDeleteResponseEnvelopeErrorsJSON   `json:"-"`}

func (*JobDeleteResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *JobDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeJobDeleteResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*JobDeleteResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *JobDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeJobDeleteResponseEnvelopeMessagesadded inv4.3.0

type JobDeleteResponseEnvelopeMessages struct {Codeint64                                   `json:"code,required"`Messagestring                                  `json:"message,required"`DocumentationURLstring                                  `json:"documentation_url"`SourceJobDeleteResponseEnvelopeMessagesSource `json:"source"`JSON             jobDeleteResponseEnvelopeMessagesJSON   `json:"-"`}

func (*JobDeleteResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *JobDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeJobDeleteResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*JobDeleteResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *JobDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeJobDeleteResponseEnvelopeSuccess

type JobDeleteResponseEnvelopeSuccessbool

Whether the API call was successful.

const (JobDeleteResponseEnvelopeSuccessTrueJobDeleteResponseEnvelopeSuccess =true)

func (JobDeleteResponseEnvelopeSuccess)IsKnown

typeJobGetParams

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

typeJobGetResponseEnvelope

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

func (*JobGetResponseEnvelope)UnmarshalJSON

func (r *JobGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeJobGetResponseEnvelopeErrorsadded inv4.3.0

type JobGetResponseEnvelopeErrors struct {Codeint64                              `json:"code,required"`Messagestring                             `json:"message,required"`DocumentationURLstring                             `json:"documentation_url"`SourceJobGetResponseEnvelopeErrorsSource `json:"source"`JSON             jobGetResponseEnvelopeErrorsJSON   `json:"-"`}

func (*JobGetResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *JobGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeJobGetResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*JobGetResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *JobGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeJobGetResponseEnvelopeMessagesadded inv4.3.0

type JobGetResponseEnvelopeMessages struct {Codeint64                                `json:"code,required"`Messagestring                               `json:"message,required"`DocumentationURLstring                               `json:"documentation_url"`SourceJobGetResponseEnvelopeMessagesSource `json:"source"`JSON             jobGetResponseEnvelopeMessagesJSON   `json:"-"`}

func (*JobGetResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *JobGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeJobGetResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*JobGetResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *JobGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeJobGetResponseEnvelopeSuccess

type JobGetResponseEnvelopeSuccessbool

Whether the API call was successful.

const (JobGetResponseEnvelopeSuccessTrueJobGetResponseEnvelopeSuccess =true)

func (JobGetResponseEnvelopeSuccess)IsKnown

typeJobListParams

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

typeJobNewParams

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.DestinationConfparam.Field[string] `json:"destination_conf,required" format:"uri"`// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.AccountIDparam.Field[string] `path:"account_id"`// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.ZoneIDparam.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/).Datasetparam.Field[JobNewParamsDataset] `json:"dataset"`// Flag that indicates if the job is enabled.Enabledparam.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/).Filterparam.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.Frequencyparam.Field[JobNewParamsFrequency] `json:"frequency"`// The kind parameter (optional) is used to differentiate between Logpush and Edge// Log Delivery jobs (when supported by the dataset).Kindparam.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.LogpullOptionsparam.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.MaxUploadBytesparam.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.MaxUploadIntervalSecondsparam.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.MaxUploadRecordsparam.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.Nameparam.Field[string] `json:"name"`// The structured replacement for `logpull_options`. When including this field, the// `logpull_option` field will be ignored.OutputOptionsparam.Field[OutputOptionsParam] `json:"output_options"`// Ownership challenge token to prove destination ownership.OwnershipChallengeparam.Field[string] `json:"ownership_challenge"`}

func (JobNewParams)MarshalJSON

func (rJobNewParams) MarshalJSON() (data []byte, errerror)

typeJobNewParamsDatasetadded inv4.3.0

type JobNewParamsDatasetstring

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 (JobNewParamsDatasetAccessRequestsJobNewParamsDataset = "access_requests"JobNewParamsDatasetAuditLogsJobNewParamsDataset = "audit_logs"JobNewParamsDatasetBISOUserActionsJobNewParamsDataset = "biso_user_actions"JobNewParamsDatasetCasbFindingsJobNewParamsDataset = "casb_findings"JobNewParamsDatasetDevicePostureResultsJobNewParamsDataset = "device_posture_results"JobNewParamsDatasetDLPForensicCopiesJobNewParamsDataset = "dlp_forensic_copies"JobNewParamsDatasetDNSFirewallLogsJobNewParamsDataset = "dns_firewall_logs"JobNewParamsDatasetDNSLogsJobNewParamsDataset = "dns_logs"JobNewParamsDatasetEmailSecurityAlertsJobNewParamsDataset = "email_security_alerts"JobNewParamsDatasetFirewallEventsJobNewParamsDataset = "firewall_events"JobNewParamsDatasetGatewayDNSJobNewParamsDataset = "gateway_dns"JobNewParamsDatasetGatewayHTTPJobNewParamsDataset = "gateway_http"JobNewParamsDatasetGatewayNetworkJobNewParamsDataset = "gateway_network"JobNewParamsDatasetHTTPRequestsJobNewParamsDataset = "http_requests"JobNewParamsDatasetMagicIDsDetectionsJobNewParamsDataset = "magic_ids_detections"JobNewParamsDatasetNELReportsJobNewParamsDataset = "nel_reports"JobNewParamsDatasetNetworkAnalyticsLogsJobNewParamsDataset = "network_analytics_logs"JobNewParamsDatasetPageShieldEventsJobNewParamsDataset = "page_shield_events"JobNewParamsDatasetSinkholeHTTPLogsJobNewParamsDataset = "sinkhole_http_logs"JobNewParamsDatasetSpectrumEventsJobNewParamsDataset = "spectrum_events"JobNewParamsDatasetSSHLogsJobNewParamsDataset = "ssh_logs"JobNewParamsDatasetWorkersTraceEventsJobNewParamsDataset = "workers_trace_events"JobNewParamsDatasetZarazEventsJobNewParamsDataset = "zaraz_events"JobNewParamsDatasetZeroTrustNetworkSessionsJobNewParamsDataset = "zero_trust_network_sessions")

func (JobNewParamsDataset)IsKnownadded inv4.3.0

func (rJobNewParamsDataset) IsKnown()bool

typeJobNewParamsFrequency

type JobNewParamsFrequencystring

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

const (JobNewParamsFrequencyHighJobNewParamsFrequency = "high"JobNewParamsFrequencyLowJobNewParamsFrequency = "low")

func (JobNewParamsFrequency)IsKnown

func (rJobNewParamsFrequency) IsKnown()bool

typeJobNewParamsKind

type JobNewParamsKindstring

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

const (JobNewParamsKindEmptyJobNewParamsKind = ""JobNewParamsKindEdgeJobNewParamsKind = "edge")

func (JobNewParamsKind)IsKnown

func (rJobNewParamsKind) IsKnown()bool

typeJobNewParamsMaxUploadBytesadded inv4.6.0

type JobNewParamsMaxUploadBytesfloat64

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

const (JobNewParamsMaxUploadBytes0JobNewParamsMaxUploadBytes = 0)

func (JobNewParamsMaxUploadBytes)IsKnownadded inv4.6.0

typeJobNewParamsMaxUploadIntervalSecondsadded inv4.6.0

type JobNewParamsMaxUploadIntervalSecondsfloat64

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

const (JobNewParamsMaxUploadIntervalSeconds0JobNewParamsMaxUploadIntervalSeconds = 0)

func (JobNewParamsMaxUploadIntervalSeconds)IsKnownadded inv4.6.0

typeJobNewParamsMaxUploadRecordsadded inv4.6.0

type JobNewParamsMaxUploadRecordsfloat64

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

const (JobNewParamsMaxUploadRecords0JobNewParamsMaxUploadRecords = 0)

func (JobNewParamsMaxUploadRecords)IsKnownadded inv4.6.0

typeJobNewResponseEnvelope

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

func (*JobNewResponseEnvelope)UnmarshalJSON

func (r *JobNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeJobNewResponseEnvelopeErrorsadded inv4.3.0

type JobNewResponseEnvelopeErrors struct {Codeint64                              `json:"code,required"`Messagestring                             `json:"message,required"`DocumentationURLstring                             `json:"documentation_url"`SourceJobNewResponseEnvelopeErrorsSource `json:"source"`JSON             jobNewResponseEnvelopeErrorsJSON   `json:"-"`}

func (*JobNewResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *JobNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeJobNewResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*JobNewResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *JobNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeJobNewResponseEnvelopeMessagesadded inv4.3.0

type JobNewResponseEnvelopeMessages struct {Codeint64                                `json:"code,required"`Messagestring                               `json:"message,required"`DocumentationURLstring                               `json:"documentation_url"`SourceJobNewResponseEnvelopeMessagesSource `json:"source"`JSON             jobNewResponseEnvelopeMessagesJSON   `json:"-"`}

func (*JobNewResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *JobNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeJobNewResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*JobNewResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *JobNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeJobNewResponseEnvelopeSuccess

type JobNewResponseEnvelopeSuccessbool

Whether the API call was successful.

const (JobNewResponseEnvelopeSuccessTrueJobNewResponseEnvelopeSuccess =true)

func (JobNewResponseEnvelopeSuccess)IsKnown

typeJobService

type JobService struct {Options []option.RequestOption}

JobService contains methods and other services that help with interacting withthe cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewJobService method instead.

funcNewJobService

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

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

func (*JobService)Delete

func (r *JobService) Delete(ctxcontext.Context, jobIDint64, bodyJobDeleteParams, opts ...option.RequestOption) (res *JobDeleteResponse, errerror)

Deletes a Logpush job.

func (*JobService)Get

func (r *JobService) Get(ctxcontext.Context, jobIDint64, queryJobGetParams, opts ...option.RequestOption) (res *LogpushJob, errerror)

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(ctxcontext.Context, paramsJobNewParams, opts ...option.RequestOption) (res *LogpushJob, errerror)

Creates a new Logpush job for an account or zone.

func (*JobService)Update

func (r *JobService) Update(ctxcontext.Context, jobIDint64, paramsJobUpdateParams, opts ...option.RequestOption) (res *LogpushJob, errerror)

Updates a Logpush job.

typeJobUpdateParams

type JobUpdateParams struct {// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.AccountIDparam.Field[string] `path:"account_id"`// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.ZoneIDparam.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.DestinationConfparam.Field[string] `json:"destination_conf" format:"uri"`// Flag that indicates if the job is enabled.Enabledparam.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/).Filterparam.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.Frequencyparam.Field[JobUpdateParamsFrequency] `json:"frequency"`// The kind parameter (optional) is used to differentiate between Logpush and Edge// Log Delivery jobs (when supported by the dataset).Kindparam.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.LogpullOptionsparam.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.MaxUploadBytesparam.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.MaxUploadIntervalSecondsparam.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.MaxUploadRecordsparam.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.Nameparam.Field[string] `json:"name"`// The structured replacement for `logpull_options`. When including this field, the// `logpull_option` field will be ignored.OutputOptionsparam.Field[OutputOptionsParam] `json:"output_options"`// Ownership challenge token to prove destination ownership.OwnershipChallengeparam.Field[string] `json:"ownership_challenge"`}

func (JobUpdateParams)MarshalJSON

func (rJobUpdateParams) MarshalJSON() (data []byte, errerror)

typeJobUpdateParamsFrequency

type JobUpdateParamsFrequencystring

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

const (JobUpdateParamsFrequencyHighJobUpdateParamsFrequency = "high"JobUpdateParamsFrequencyLowJobUpdateParamsFrequency = "low")

func (JobUpdateParamsFrequency)IsKnown

typeJobUpdateParamsKind

type JobUpdateParamsKindstring

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

const (JobUpdateParamsKindEmptyJobUpdateParamsKind = ""JobUpdateParamsKindEdgeJobUpdateParamsKind = "edge")

func (JobUpdateParamsKind)IsKnown

func (rJobUpdateParamsKind) IsKnown()bool

typeJobUpdateParamsMaxUploadBytesadded inv4.6.0

type JobUpdateParamsMaxUploadBytesfloat64

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

const (JobUpdateParamsMaxUploadBytes0JobUpdateParamsMaxUploadBytes = 0)

func (JobUpdateParamsMaxUploadBytes)IsKnownadded inv4.6.0

typeJobUpdateParamsMaxUploadIntervalSecondsadded inv4.6.0

type JobUpdateParamsMaxUploadIntervalSecondsfloat64

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

const (JobUpdateParamsMaxUploadIntervalSeconds0JobUpdateParamsMaxUploadIntervalSeconds = 0)

func (JobUpdateParamsMaxUploadIntervalSeconds)IsKnownadded inv4.6.0

typeJobUpdateParamsMaxUploadRecordsadded inv4.6.0

type JobUpdateParamsMaxUploadRecordsfloat64

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

const (JobUpdateParamsMaxUploadRecords0JobUpdateParamsMaxUploadRecords = 0)

func (JobUpdateParamsMaxUploadRecords)IsKnownadded inv4.6.0

typeJobUpdateResponseEnvelope

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

func (*JobUpdateResponseEnvelope)UnmarshalJSON

func (r *JobUpdateResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeJobUpdateResponseEnvelopeErrorsadded inv4.3.0

type JobUpdateResponseEnvelopeErrors struct {Codeint64                                 `json:"code,required"`Messagestring                                `json:"message,required"`DocumentationURLstring                                `json:"documentation_url"`SourceJobUpdateResponseEnvelopeErrorsSource `json:"source"`JSON             jobUpdateResponseEnvelopeErrorsJSON   `json:"-"`}

func (*JobUpdateResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *JobUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeJobUpdateResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*JobUpdateResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *JobUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeJobUpdateResponseEnvelopeMessagesadded inv4.3.0

type JobUpdateResponseEnvelopeMessages struct {Codeint64                                   `json:"code,required"`Messagestring                                  `json:"message,required"`DocumentationURLstring                                  `json:"documentation_url"`SourceJobUpdateResponseEnvelopeMessagesSource `json:"source"`JSON             jobUpdateResponseEnvelopeMessagesJSON   `json:"-"`}

func (*JobUpdateResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *JobUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeJobUpdateResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*JobUpdateResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *JobUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeJobUpdateResponseEnvelopeSuccess

type JobUpdateResponseEnvelopeSuccessbool

Whether the API call was successful.

const (JobUpdateResponseEnvelopeSuccessTrueJobUpdateResponseEnvelopeSuccess =true)

func (JobUpdateResponseEnvelopeSuccess)IsKnown

typeLogpushJob

type LogpushJob struct {// Unique id of the job.IDint64 `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/).DatasetLogpushJobDataset `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.DestinationConfstring `json:"destination_conf" format:"uri"`// Flag that indicates if the job is enabled.Enabledbool `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.ErrorMessagestring `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: deprecatedFrequencyLogpushJobFrequency `json:"frequency,nullable"`// The kind parameter (optional) is used to differentiate between Logpush and Edge// Log Delivery jobs (when supported by the dataset).KindLogpushJobKind `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.LastCompletetime.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.LastErrortime.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: deprecatedLogpullOptionsstring `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.MaxUploadBytesLogpushJobMaxUploadBytes `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.MaxUploadIntervalSecondsLogpushJobMaxUploadIntervalSeconds `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.MaxUploadRecordsLogpushJobMaxUploadRecords `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.Namestring `json:"name,nullable"`// The structured replacement for `logpull_options`. When including this field, the// `logpull_option` field will be ignored.OutputOptionsOutputOptions  `json:"output_options,nullable"`JSON          logpushJobJSON `json:"-"`}

func (*LogpushJob)UnmarshalJSON

func (r *LogpushJob) UnmarshalJSON(data []byte) (errerror)

typeLogpushJobDatasetadded inv4.3.0

type LogpushJobDatasetstring

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 (LogpushJobDatasetAccessRequestsLogpushJobDataset = "access_requests"LogpushJobDatasetAuditLogsLogpushJobDataset = "audit_logs"LogpushJobDatasetBISOUserActionsLogpushJobDataset = "biso_user_actions"LogpushJobDatasetCasbFindingsLogpushJobDataset = "casb_findings"LogpushJobDatasetDevicePostureResultsLogpushJobDataset = "device_posture_results"LogpushJobDatasetDLPForensicCopiesLogpushJobDataset = "dlp_forensic_copies"LogpushJobDatasetDNSFirewallLogsLogpushJobDataset = "dns_firewall_logs"LogpushJobDatasetDNSLogsLogpushJobDataset = "dns_logs"LogpushJobDatasetEmailSecurityAlertsLogpushJobDataset = "email_security_alerts"LogpushJobDatasetFirewallEventsLogpushJobDataset = "firewall_events"LogpushJobDatasetGatewayDNSLogpushJobDataset = "gateway_dns"LogpushJobDatasetGatewayHTTPLogpushJobDataset = "gateway_http"LogpushJobDatasetGatewayNetworkLogpushJobDataset = "gateway_network"LogpushJobDatasetHTTPRequestsLogpushJobDataset = "http_requests"LogpushJobDatasetMagicIDsDetectionsLogpushJobDataset = "magic_ids_detections"LogpushJobDatasetNELReportsLogpushJobDataset = "nel_reports"LogpushJobDatasetNetworkAnalyticsLogsLogpushJobDataset = "network_analytics_logs"LogpushJobDatasetPageShieldEventsLogpushJobDataset = "page_shield_events"LogpushJobDatasetSinkholeHTTPLogsLogpushJobDataset = "sinkhole_http_logs"LogpushJobDatasetSpectrumEventsLogpushJobDataset = "spectrum_events"LogpushJobDatasetSSHLogsLogpushJobDataset = "ssh_logs"LogpushJobDatasetWorkersTraceEventsLogpushJobDataset = "workers_trace_events"LogpushJobDatasetZarazEventsLogpushJobDataset = "zaraz_events"LogpushJobDatasetZeroTrustNetworkSessionsLogpushJobDataset = "zero_trust_network_sessions")

func (LogpushJobDataset)IsKnownadded inv4.3.0

func (rLogpushJobDataset) IsKnown()bool

typeLogpushJobFrequency

type LogpushJobFrequencystring

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

const (LogpushJobFrequencyHighLogpushJobFrequency = "high"LogpushJobFrequencyLowLogpushJobFrequency = "low")

func (LogpushJobFrequency)IsKnown

func (rLogpushJobFrequency) IsKnown()bool

typeLogpushJobKind

type LogpushJobKindstring

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

const (LogpushJobKindEmptyLogpushJobKind = ""LogpushJobKindEdgeLogpushJobKind = "edge")

func (LogpushJobKind)IsKnown

func (rLogpushJobKind) IsKnown()bool

typeLogpushJobMaxUploadBytesadded inv4.6.0

type LogpushJobMaxUploadBytesfloat64

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

const (LogpushJobMaxUploadBytes0LogpushJobMaxUploadBytes = 0)

func (LogpushJobMaxUploadBytes)IsKnownadded inv4.6.0

typeLogpushJobMaxUploadIntervalSecondsadded inv4.6.0

type LogpushJobMaxUploadIntervalSecondsfloat64

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

const (LogpushJobMaxUploadIntervalSeconds0LogpushJobMaxUploadIntervalSeconds = 0)

func (LogpushJobMaxUploadIntervalSeconds)IsKnownadded inv4.6.0

typeLogpushJobMaxUploadRecordsadded inv4.6.0

type LogpushJobMaxUploadRecordsfloat64

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

const (LogpushJobMaxUploadRecords0LogpushJobMaxUploadRecords = 0)

func (LogpushJobMaxUploadRecords)IsKnownadded inv4.6.0

typeLogpushService

type LogpushService struct {Options   []option.RequestOptionDatasets  *DatasetServiceEdge      *EdgeServiceJobs      *JobServiceOwnership *OwnershipServiceValidate  *ValidateService}

LogpushService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewLogpushService method instead.

funcNewLogpushService

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

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

typeMember

type Member =shared.Member

This is an alias to an internal type.

typeMemberPoliciesAccess

type MemberPoliciesAccess =shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup =shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta =shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroup

type MemberPoliciesResourceGroup =shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta =shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope =shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject =shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied againstinvite.

This is an alias to an internal type.

typeMemberPolicy

type MemberPolicy =shared.MemberPolicy

This is an alias to an internal type.

typeMemberStatus

type MemberStatus =shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

typeMemberUser

type MemberUser =shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

typeOutputOptions

type OutputOptions struct {// String to be prepended before each batch.BatchPrefixstring `json:"batch_prefix,nullable"`// String to be appended after each batch.BatchSuffixstring `json:"batch_suffix,nullable"`// If set to true, will cause all occurrences of `${` in the generated files to be// replaced with `x{`.Cve2021_44228bool `json:"CVE-2021-44228,nullable"`// String to join fields. This field be ignored when `record_template` is set.FieldDelimiterstring `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.OutputTypeOutputOptionsOutputType `json:"output_type"`// String to be inserted in-between the records as separator.RecordDelimiterstring `json:"record_delimiter,nullable"`// String to be prepended before each record.RecordPrefixstring `json:"record_prefix,nullable"`// String to be appended after each record.RecordSuffixstring `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.RecordTemplatestring `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.SampleRatefloat64 `json:"sample_rate,nullable"`// String to specify the format for timestamps, such as `unixnano`, `unix`, or// `rfc3339`.TimestampFormatOutputOptionsTimestampFormat `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) (errerror)

typeOutputOptionsOutputType

type OutputOptionsOutputTypestring

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

const (OutputOptionsOutputTypeNdjsonOutputOptionsOutputType = "ndjson"OutputOptionsOutputTypeCsvOutputOptionsOutputType = "csv")

func (OutputOptionsOutputType)IsKnown

func (rOutputOptionsOutputType) IsKnown()bool

typeOutputOptionsParam

type OutputOptionsParam struct {// String to be prepended before each batch.BatchPrefixparam.Field[string] `json:"batch_prefix"`// String to be appended after each batch.BatchSuffixparam.Field[string] `json:"batch_suffix"`// If set to true, will cause all occurrences of `${` in the generated files to be// replaced with `x{`.Cve2021_44228param.Field[bool] `json:"CVE-2021-44228"`// String to join fields. This field be ignored when `record_template` is set.FieldDelimiterparam.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.FieldNamesparam.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.OutputTypeparam.Field[OutputOptionsOutputType] `json:"output_type"`// String to be inserted in-between the records as separator.RecordDelimiterparam.Field[string] `json:"record_delimiter"`// String to be prepended before each record.RecordPrefixparam.Field[string] `json:"record_prefix"`// String to be appended after each record.RecordSuffixparam.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.RecordTemplateparam.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.SampleRateparam.Field[float64] `json:"sample_rate"`// String to specify the format for timestamps, such as `unixnano`, `unix`, or// `rfc3339`.TimestampFormatparam.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 (rOutputOptionsParam) MarshalJSON() (data []byte, errerror)

typeOutputOptionsTimestampFormat

type OutputOptionsTimestampFormatstring

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

const (OutputOptionsTimestampFormatUnixnanoOutputOptionsTimestampFormat = "unixnano"OutputOptionsTimestampFormatUnixOutputOptionsTimestampFormat = "unix"OutputOptionsTimestampFormatRfc3339OutputOptionsTimestampFormat = "rfc3339")

func (OutputOptionsTimestampFormat)IsKnown

typeOwnershipNewParams

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.DestinationConfparam.Field[string] `json:"destination_conf,required" format:"uri"`// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.AccountIDparam.Field[string] `path:"account_id"`// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.ZoneIDparam.Field[string] `path:"zone_id"`}

func (OwnershipNewParams)MarshalJSON

func (rOwnershipNewParams) MarshalJSON() (data []byte, errerror)

typeOwnershipNewResponse

type OwnershipNewResponse struct {Filenamestring                   `json:"filename"`Messagestring                   `json:"message"`Validbool                     `json:"valid"`JSON     ownershipNewResponseJSON `json:"-"`}

func (*OwnershipNewResponse)UnmarshalJSON

func (r *OwnershipNewResponse) UnmarshalJSON(data []byte) (errerror)

typeOwnershipNewResponseEnvelope

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

func (*OwnershipNewResponseEnvelope)UnmarshalJSON

func (r *OwnershipNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeOwnershipNewResponseEnvelopeErrorsadded inv4.3.0

type OwnershipNewResponseEnvelopeErrors struct {Codeint64                                    `json:"code,required"`Messagestring                                   `json:"message,required"`DocumentationURLstring                                   `json:"documentation_url"`SourceOwnershipNewResponseEnvelopeErrorsSource `json:"source"`JSON             ownershipNewResponseEnvelopeErrorsJSON   `json:"-"`}

func (*OwnershipNewResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *OwnershipNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeOwnershipNewResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*OwnershipNewResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *OwnershipNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeOwnershipNewResponseEnvelopeMessagesadded inv4.3.0

type OwnershipNewResponseEnvelopeMessages struct {Codeint64                                      `json:"code,required"`Messagestring                                     `json:"message,required"`DocumentationURLstring                                     `json:"documentation_url"`SourceOwnershipNewResponseEnvelopeMessagesSource `json:"source"`JSON             ownershipNewResponseEnvelopeMessagesJSON   `json:"-"`}

func (*OwnershipNewResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *OwnershipNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeOwnershipNewResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*OwnershipNewResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *OwnershipNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeOwnershipNewResponseEnvelopeSuccess

type OwnershipNewResponseEnvelopeSuccessbool

Whether the API call was successful.

const (OwnershipNewResponseEnvelopeSuccessTrueOwnershipNewResponseEnvelopeSuccess =true)

func (OwnershipNewResponseEnvelopeSuccess)IsKnown

typeOwnershipService

type OwnershipService struct {Options []option.RequestOption}

OwnershipService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewOwnershipService method instead.

funcNewOwnershipService

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

NewOwnershipService generates a new service that applies the given options toeach request. These options are applied after the parent client's options (ifthere 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.

typeOwnershipValidateParams

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.DestinationConfparam.Field[string] `json:"destination_conf,required" format:"uri"`// Ownership challenge token to prove destination ownership.OwnershipChallengeparam.Field[string] `json:"ownership_challenge,required"`// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.AccountIDparam.Field[string] `path:"account_id"`// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.ZoneIDparam.Field[string] `path:"zone_id"`}

func (OwnershipValidateParams)MarshalJSON

func (rOwnershipValidateParams) MarshalJSON() (data []byte, errerror)

typeOwnershipValidateResponseEnvelope

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

func (*OwnershipValidateResponseEnvelope)UnmarshalJSON

func (r *OwnershipValidateResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeOwnershipValidateResponseEnvelopeErrorsadded inv4.3.0

type OwnershipValidateResponseEnvelopeErrors struct {Codeint64                                         `json:"code,required"`Messagestring                                        `json:"message,required"`DocumentationURLstring                                        `json:"documentation_url"`SourceOwnershipValidateResponseEnvelopeErrorsSource `json:"source"`JSON             ownershipValidateResponseEnvelopeErrorsJSON   `json:"-"`}

func (*OwnershipValidateResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *OwnershipValidateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeOwnershipValidateResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*OwnershipValidateResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *OwnershipValidateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeOwnershipValidateResponseEnvelopeMessagesadded inv4.3.0

type OwnershipValidateResponseEnvelopeMessages struct {Codeint64                                           `json:"code,required"`Messagestring                                          `json:"message,required"`DocumentationURLstring                                          `json:"documentation_url"`SourceOwnershipValidateResponseEnvelopeMessagesSource `json:"source"`JSON             ownershipValidateResponseEnvelopeMessagesJSON   `json:"-"`}

func (*OwnershipValidateResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *OwnershipValidateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeOwnershipValidateResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*OwnershipValidateResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *OwnershipValidateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeOwnershipValidateResponseEnvelopeSuccess

type OwnershipValidateResponseEnvelopeSuccessbool

Whether the API call was successful.

const (OwnershipValidateResponseEnvelopeSuccessTrueOwnershipValidateResponseEnvelopeSuccess =true)

func (OwnershipValidateResponseEnvelopeSuccess)IsKnown

typeOwnershipValidation

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

func (*OwnershipValidation)UnmarshalJSON

func (r *OwnershipValidation) UnmarshalJSON(data []byte) (errerror)

typePermission

type Permission =shared.Permission

This is an alias to an internal type.

typePermissionGrant

type PermissionGrant =shared.PermissionGrant

This is an alias to an internal type.

typePermissionGrantParam

type PermissionGrantParam =shared.PermissionGrantParam

This is an alias to an internal type.

typeRatePlan

type RatePlan =shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

typeRatePlanIDadded inv4.1.0

type RatePlanID =shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

typeRatePlanParam

type RatePlanParam =shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

typeResponseInfo

type ResponseInfo =shared.ResponseInfo

This is an alias to an internal type.

typeResponseInfoSourceadded inv4.3.0

type ResponseInfoSource =shared.ResponseInfoSource

This is an alias to an internal type.

typeRole

type Role =shared.Role

This is an alias to an internal type.

typeRoleParam

type RoleParam =shared.RoleParam

This is an alias to an internal type.

typeRolePermissions

type RolePermissions =shared.RolePermissions

This is an alias to an internal type.

typeRolePermissionsParam

type RolePermissionsParam =shared.RolePermissionsParam

This is an alias to an internal type.

typeSortDirection

type SortDirection =shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

typeSubscription

type Subscription =shared.Subscription

This is an alias to an internal type.

typeSubscriptionFrequency

type SubscriptionFrequency =shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

typeSubscriptionParam

type SubscriptionParam =shared.SubscriptionParam

This is an alias to an internal type.

typeSubscriptionState

type SubscriptionState =shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

typeToken

type Token =shared.Token

This is an alias to an internal type.

typeTokenCondition

type TokenCondition =shared.TokenCondition

This is an alias to an internal type.

typeTokenConditionCIDRList

type TokenConditionCIDRList =shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionCIDRListParam

type TokenConditionCIDRListParam =shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionParam

type TokenConditionParam =shared.TokenConditionParam

This is an alias to an internal type.

typeTokenConditionRequestIP

type TokenConditionRequestIP =shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

typeTokenConditionRequestIPParam

type TokenConditionRequestIPParam =shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

typeTokenParam

type TokenParam =shared.TokenParam

This is an alias to an internal type.

typeTokenPolicy

type TokenPolicy =shared.TokenPolicy

This is an alias to an internal type.

typeTokenPolicyEffect

type TokenPolicyEffect =shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

typeTokenPolicyParam

type TokenPolicyParam =shared.TokenPolicyParam

This is an alias to an internal type.

typeTokenPolicyPermissionGroup

type TokenPolicyPermissionGroup =shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam =shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta =shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam =shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyResourcesMapadded inv4.6.0

type TokenPolicyResourcesMap =shared.TokenPolicyResourcesMap

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesMapParamadded inv4.6.0

type TokenPolicyResourcesMapParam =shared.TokenPolicyResourcesMapParam

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesUnionadded inv4.6.0

type TokenPolicyResourcesUnion =shared.TokenPolicyResourcesUnion

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

This is an alias to an internal type.

typeTokenPolicyResourcesUnionParamadded inv4.6.0

type TokenPolicyResourcesUnionParam =shared.TokenPolicyResourcesUnionParam

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

This is an alias to an internal type.

typeTokenStatus

type TokenStatus =shared.TokenStatus

Status of the token.

This is an alias to an internal type.

typeTokenValue

type TokenValue =shared.TokenValue

The token value.

This is an alias to an internal type.

typeValidateDestinationExistsParamsadded inv4.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.DestinationConfparam.Field[string] `json:"destination_conf,required" format:"uri"`// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.AccountIDparam.Field[string] `path:"account_id"`// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.ZoneIDparam.Field[string] `path:"zone_id"`}

func (ValidateDestinationExistsParams)MarshalJSONadded inv4.1.0

func (rValidateDestinationExistsParams) MarshalJSON() (data []byte, errerror)

typeValidateDestinationExistsResponseadded inv4.1.0

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

func (*ValidateDestinationExistsResponse)UnmarshalJSONadded inv4.1.0

func (r *ValidateDestinationExistsResponse) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationExistsResponseEnvelopeadded inv4.1.0

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

func (*ValidateDestinationExistsResponseEnvelope)UnmarshalJSONadded inv4.1.0

func (r *ValidateDestinationExistsResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationExistsResponseEnvelopeErrorsadded inv4.3.0

type ValidateDestinationExistsResponseEnvelopeErrors struct {Codeint64                                                 `json:"code,required"`Messagestring                                                `json:"message,required"`DocumentationURLstring                                                `json:"documentation_url"`SourceValidateDestinationExistsResponseEnvelopeErrorsSource `json:"source"`JSON             validateDestinationExistsResponseEnvelopeErrorsJSON   `json:"-"`}

func (*ValidateDestinationExistsResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *ValidateDestinationExistsResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationExistsResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*ValidateDestinationExistsResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

typeValidateDestinationExistsResponseEnvelopeMessagesadded inv4.3.0

type ValidateDestinationExistsResponseEnvelopeMessages struct {Codeint64                                                   `json:"code,required"`Messagestring                                                  `json:"message,required"`DocumentationURLstring                                                  `json:"documentation_url"`SourceValidateDestinationExistsResponseEnvelopeMessagesSource `json:"source"`JSON             validateDestinationExistsResponseEnvelopeMessagesJSON   `json:"-"`}

func (*ValidateDestinationExistsResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *ValidateDestinationExistsResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationExistsResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*ValidateDestinationExistsResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

typeValidateDestinationExistsResponseEnvelopeSuccessadded inv4.1.0

type ValidateDestinationExistsResponseEnvelopeSuccessbool

Whether the API call was successful.

const (ValidateDestinationExistsResponseEnvelopeSuccessTrueValidateDestinationExistsResponseEnvelopeSuccess =true)

func (ValidateDestinationExistsResponseEnvelopeSuccess)IsKnownadded inv4.1.0

typeValidateDestinationParams

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.DestinationConfparam.Field[string] `json:"destination_conf,required" format:"uri"`// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.AccountIDparam.Field[string] `path:"account_id"`// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.ZoneIDparam.Field[string] `path:"zone_id"`}

func (ValidateDestinationParams)MarshalJSON

func (rValidateDestinationParams) MarshalJSON() (data []byte, errerror)

typeValidateDestinationResponse

type ValidateDestinationResponse struct {Messagestring                          `json:"message"`Validbool                            `json:"valid"`JSON    validateDestinationResponseJSON `json:"-"`}

func (*ValidateDestinationResponse)UnmarshalJSON

func (r *ValidateDestinationResponse) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationResponseEnvelope

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

func (*ValidateDestinationResponseEnvelope)UnmarshalJSON

func (r *ValidateDestinationResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationResponseEnvelopeErrorsadded inv4.3.0

type ValidateDestinationResponseEnvelopeErrors struct {Codeint64                                           `json:"code,required"`Messagestring                                          `json:"message,required"`DocumentationURLstring                                          `json:"documentation_url"`SourceValidateDestinationResponseEnvelopeErrorsSource `json:"source"`JSON             validateDestinationResponseEnvelopeErrorsJSON   `json:"-"`}

func (*ValidateDestinationResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *ValidateDestinationResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*ValidateDestinationResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *ValidateDestinationResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationResponseEnvelopeMessagesadded inv4.3.0

type ValidateDestinationResponseEnvelopeMessages struct {Codeint64                                             `json:"code,required"`Messagestring                                            `json:"message,required"`DocumentationURLstring                                            `json:"documentation_url"`SourceValidateDestinationResponseEnvelopeMessagesSource `json:"source"`JSON             validateDestinationResponseEnvelopeMessagesJSON   `json:"-"`}

func (*ValidateDestinationResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *ValidateDestinationResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*ValidateDestinationResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *ValidateDestinationResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeValidateDestinationResponseEnvelopeSuccess

type ValidateDestinationResponseEnvelopeSuccessbool

Whether the API call was successful.

const (ValidateDestinationResponseEnvelopeSuccessTrueValidateDestinationResponseEnvelopeSuccess =true)

func (ValidateDestinationResponseEnvelopeSuccess)IsKnown

typeValidateOriginParams

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.LogpullOptionsparam.Field[string] `json:"logpull_options,required" format:"uri-reference"`// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.AccountIDparam.Field[string] `path:"account_id"`// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.ZoneIDparam.Field[string] `path:"zone_id"`}

func (ValidateOriginParams)MarshalJSON

func (rValidateOriginParams) MarshalJSON() (data []byte, errerror)

typeValidateOriginResponse

type ValidateOriginResponse struct {Messagestring                     `json:"message"`Validbool                       `json:"valid"`JSON    validateOriginResponseJSON `json:"-"`}

func (*ValidateOriginResponse)UnmarshalJSON

func (r *ValidateOriginResponse) UnmarshalJSON(data []byte) (errerror)

typeValidateOriginResponseEnvelope

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

func (*ValidateOriginResponseEnvelope)UnmarshalJSON

func (r *ValidateOriginResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeValidateOriginResponseEnvelopeErrorsadded inv4.3.0

type ValidateOriginResponseEnvelopeErrors struct {Codeint64                                      `json:"code,required"`Messagestring                                     `json:"message,required"`DocumentationURLstring                                     `json:"documentation_url"`SourceValidateOriginResponseEnvelopeErrorsSource `json:"source"`JSON             validateOriginResponseEnvelopeErrorsJSON   `json:"-"`}

func (*ValidateOriginResponseEnvelopeErrors)UnmarshalJSONadded inv4.3.0

func (r *ValidateOriginResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeValidateOriginResponseEnvelopeErrorsSourceadded inv4.3.0

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

func (*ValidateOriginResponseEnvelopeErrorsSource)UnmarshalJSONadded inv4.3.0

func (r *ValidateOriginResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeValidateOriginResponseEnvelopeMessagesadded inv4.3.0

type ValidateOriginResponseEnvelopeMessages struct {Codeint64                                        `json:"code,required"`Messagestring                                       `json:"message,required"`DocumentationURLstring                                       `json:"documentation_url"`SourceValidateOriginResponseEnvelopeMessagesSource `json:"source"`JSON             validateOriginResponseEnvelopeMessagesJSON   `json:"-"`}

func (*ValidateOriginResponseEnvelopeMessages)UnmarshalJSONadded inv4.3.0

func (r *ValidateOriginResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeValidateOriginResponseEnvelopeMessagesSourceadded inv4.3.0

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

func (*ValidateOriginResponseEnvelopeMessagesSource)UnmarshalJSONadded inv4.3.0

func (r *ValidateOriginResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeValidateOriginResponseEnvelopeSuccess

type ValidateOriginResponseEnvelopeSuccessbool

Whether the API call was successful.

const (ValidateOriginResponseEnvelopeSuccessTrueValidateOriginResponseEnvelopeSuccess =true)

func (ValidateOriginResponseEnvelopeSuccess)IsKnown

typeValidateService

type ValidateService struct {Options []option.RequestOption}

ValidateService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewValidateService method instead.

funcNewValidateService

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

NewValidateService generates a new service that applies the given options toeach request. These options are applied after the parent client's options (ifthere is one), and before any request-specific options.

func (*ValidateService)Destination

Validates destination.

func (*ValidateService)DestinationExistsadded inv4.1.0

Checks if there is an existing job with a destination.

func (*ValidateService)Origin

Validates logpull origin with logpull_options.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2025 Movatter.jp