logs

package
v2.0.0 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type CmbConfig 

type CmbConfig struct {
	// Comma-separated list of regions.
	Regions string        `json:"regions"`
	JSON    cmbConfigJSON `json:"-"`
}

func (*CmbConfig) UnmarshalJSON 

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

type CmbConfigParam 

type CmbConfigParam struct {
	// Comma-separated list of regions.
	Regions param.Field[string] `json:"regions"`
}

func (CmbConfigParam) MarshalJSON 

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

type ControlCmbConfigDeleteResponse 

type ControlCmbConfigDeleteResponse = interface{}

type ControlCmbConfigDeleteResponseEnvelope 

type ControlCmbConfigDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success ControlCmbConfigDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  ControlCmbConfigDeleteResponse                `json:"result,nullable"`
	JSON    controlCmbConfigDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ControlCmbConfigDeleteResponseEnvelope) UnmarshalJSON 

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

type ControlCmbConfigDeleteResponseEnvelopeSuccess 

type ControlCmbConfigDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ControlCmbConfigDeleteResponseEnvelopeSuccessTrue ControlCmbConfigDeleteResponseEnvelopeSuccess = true
)

func (ControlCmbConfigDeleteResponseEnvelopeSuccess) IsKnown 

func (r ControlCmbConfigDeleteResponseEnvelopeSuccess) IsKnown() bool

type ControlCmbConfigGetResponseEnvelope 

type ControlCmbConfigGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success ControlCmbConfigGetResponseEnvelopeSuccess `json:"success,required"`
	Result  CmbConfig                                  `json:"result,nullable"`
	JSON    controlCmbConfigGetResponseEnvelopeJSON    `json:"-"`
}

func (*ControlCmbConfigGetResponseEnvelope) UnmarshalJSON 

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

type ControlCmbConfigGetResponseEnvelopeSuccess 

type ControlCmbConfigGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ControlCmbConfigGetResponseEnvelopeSuccessTrue ControlCmbConfigGetResponseEnvelopeSuccess = true
)

func (ControlCmbConfigGetResponseEnvelopeSuccess) IsKnown 

func (r ControlCmbConfigGetResponseEnvelopeSuccess) IsKnown() bool

type ControlCmbConfigNewParams 

type ControlCmbConfigNewParams struct {
	CmbConfig CmbConfigParam `json:"cmb_config,required"`
}

func (ControlCmbConfigNewParams) MarshalJSON 

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

type ControlCmbConfigNewResponseEnvelope 

type ControlCmbConfigNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful
	Success ControlCmbConfigNewResponseEnvelopeSuccess `json:"success,required"`
	Result  CmbConfig                                  `json:"result,nullable"`
	JSON    controlCmbConfigNewResponseEnvelopeJSON    `json:"-"`
}

func (*ControlCmbConfigNewResponseEnvelope) UnmarshalJSON 

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

type ControlCmbConfigNewResponseEnvelopeSuccess 

type ControlCmbConfigNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ControlCmbConfigNewResponseEnvelopeSuccessTrue ControlCmbConfigNewResponseEnvelopeSuccess = true
)

func (ControlCmbConfigNewResponseEnvelopeSuccess) IsKnown 

func (r ControlCmbConfigNewResponseEnvelopeSuccess) IsKnown() bool

type ControlCmbConfigService 

type ControlCmbConfigService struct {
	Options []option.RequestOption
}

ControlCmbConfigService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewControlCmbConfigService 

func NewControlCmbConfigService(opts ...option.RequestOption) (r *ControlCmbConfigService)

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

func (*ControlCmbConfigService) Delete 

func (r *ControlCmbConfigService) Delete(ctx context.Context, accountID string, opts ...option.RequestOption) (res *ControlCmbConfigDeleteResponse, err error)

Deletes CMB config.

func (*ControlCmbConfigService) Get 

func (r *ControlCmbConfigService) Get(ctx context.Context, accountID string, opts ...option.RequestOption) (res *CmbConfig, err error)

Gets CMB config.

func (*ControlCmbConfigService) New 

func (r *ControlCmbConfigService) New(ctx context.Context, accountID string, body ControlCmbConfigNewParams, opts ...option.RequestOption) (res *CmbConfig, err error)

Updates CMB config.

type ControlCmbService 

type ControlCmbService struct {
	Options []option.RequestOption
	Config  *ControlCmbConfigService
}

ControlCmbService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewControlCmbService 

func NewControlCmbService(opts ...option.RequestOption) (r *ControlCmbService)

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

type ControlRetentionGetResponse 

type ControlRetentionGetResponse struct {
	Flag bool                            `json:"flag"`
	JSON controlRetentionGetResponseJSON `json:"-"`
}

func (*ControlRetentionGetResponse) UnmarshalJSON 

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

type ControlRetentionGetResponseEnvelope 

type ControlRetentionGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo       `json:"errors,required"`
	Messages []shared.ResponseInfo       `json:"messages,required"`
	Result   ControlRetentionGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success ControlRetentionGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    controlRetentionGetResponseEnvelopeJSON    `json:"-"`
}

func (*ControlRetentionGetResponseEnvelope) UnmarshalJSON 

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

type ControlRetentionGetResponseEnvelopeSuccess 

type ControlRetentionGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ControlRetentionGetResponseEnvelopeSuccessTrue ControlRetentionGetResponseEnvelopeSuccess = true
)

func (ControlRetentionGetResponseEnvelopeSuccess) IsKnown 

func (r ControlRetentionGetResponseEnvelopeSuccess) IsKnown() bool

type ControlRetentionNewParams 

type ControlRetentionNewParams struct {
	// The log retention flag for Logpull API.
	Flag param.Field[bool] `json:"flag,required"`
}

func (ControlRetentionNewParams) MarshalJSON 

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

type ControlRetentionNewResponse 

type ControlRetentionNewResponse struct {
	Flag bool                            `json:"flag"`
	JSON controlRetentionNewResponseJSON `json:"-"`
}

func (*ControlRetentionNewResponse) UnmarshalJSON 

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

type ControlRetentionNewResponseEnvelope 

type ControlRetentionNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo       `json:"errors,required"`
	Messages []shared.ResponseInfo       `json:"messages,required"`
	Result   ControlRetentionNewResponse `json:"result,required"`
	// Whether the API call was successful
	Success ControlRetentionNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    controlRetentionNewResponseEnvelopeJSON    `json:"-"`
}

func (*ControlRetentionNewResponseEnvelope) UnmarshalJSON 

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

type ControlRetentionNewResponseEnvelopeSuccess 

type ControlRetentionNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ControlRetentionNewResponseEnvelopeSuccessTrue ControlRetentionNewResponseEnvelopeSuccess = true
)

func (ControlRetentionNewResponseEnvelopeSuccess) IsKnown 

func (r ControlRetentionNewResponseEnvelopeSuccess) IsKnown() bool

type ControlRetentionService 

type ControlRetentionService struct {
	Options []option.RequestOption
}

ControlRetentionService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewControlRetentionService 

func NewControlRetentionService(opts ...option.RequestOption) (r *ControlRetentionService)

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

func (*ControlRetentionService) Get 

func (r *ControlRetentionService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *ControlRetentionGetResponse, err error)

Gets log retention flag for Logpull API.

func (*ControlRetentionService) New 

func (r *ControlRetentionService) New(ctx context.Context, zoneIdentifier string, body ControlRetentionNewParams, opts ...option.RequestOption) (res *ControlRetentionNewResponse, err error)

Updates log retention flag for Logpull API.

type ControlService 

type ControlService struct {
	Options   []option.RequestOption
	Retention *ControlRetentionService
	Cmb       *ControlCmbService
}

ControlService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewControlService 

func NewControlService(opts ...option.RequestOption) (r *ControlService)

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

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type LogService 

type LogService struct {
	Options  []option.RequestOption
	Control  *ControlService
	RayID    *RayIDService
	Received *ReceivedService
}

LogService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewLogService 

func NewLogService(opts ...option.RequestOption) (r *LogService)

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

type MemberParam 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RayIDGetParams 

type RayIDGetParams struct {
	// The `/received` route by default returns a limited set of fields, and allows
	// customers to override the default field set by specifying individual fields. The
	// reasons for this are: 1. Most customers require only a small subset of fields,
	// but that subset varies from customer to customer; 2. Flat schema is much easier
	// to work with downstream (importing into BigTable etc); 3. Performance (time to
	// process, file size). If `?fields=` is not specified, default field set is
	// returned. This default field set may change at any time. When `?fields=` is
	// provided, each record is returned with the specified fields. `fields` must be
	// specified as a comma separated list without any whitespaces, and all fields must
	// exist. The order in which fields are specified does not matter, and the order of
	// fields in the response is not specified.
	Fields param.Field[string] `query:"fields"`
	// By default, timestamps in responses are returned as Unix nanosecond integers.
	// The `?timestamps=` argument can be set to change the format in which response
	// timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`.
	// Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns
	// timestamps as strings.
	Timestamps param.Field[RayIDGetParamsTimestamps] `query:"timestamps"`
}

func (RayIDGetParams) URLQuery 

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

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

type RayIDGetParamsTimestamps 

type RayIDGetParamsTimestamps string

By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings. 

const (
	RayIDGetParamsTimestampsUnix     RayIDGetParamsTimestamps = "unix"
	RayIDGetParamsTimestampsUnixnano RayIDGetParamsTimestamps = "unixnano"
	RayIDGetParamsTimestampsRfc3339  RayIDGetParamsTimestamps = "rfc3339"
)

func (RayIDGetParamsTimestamps) IsKnown 

func (r RayIDGetParamsTimestamps) IsKnown() bool

type RayIDGetResponseUnion 

type RayIDGetResponseUnion interface {
	ImplementsLogsRayIDGetResponseUnion()
}

Union satisfied by shared.UnionString or logs.RayIDGetResponseUnknown.

type RayIDService 

type RayIDService struct {
	Options []option.RequestOption
}

RayIDService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewRayIDService 

func NewRayIDService(opts ...option.RequestOption) (r *RayIDService)

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

func (*RayIDService) Get 

func (r *RayIDService) Get(ctx context.Context, zoneIdentifier string, rayIdentifier string, query RayIDGetParams, opts ...option.RequestOption) (res *RayIDGetResponseUnion, err error)

The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).

type ReceivedFieldGetResponse 

type ReceivedFieldGetResponse struct {
	Key  string                       `json:"key"`
	JSON receivedFieldGetResponseJSON `json:"-"`
}

func (*ReceivedFieldGetResponse) UnmarshalJSON 

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

type ReceivedFieldService 

type ReceivedFieldService struct {
	Options []option.RequestOption
}

ReceivedFieldService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewReceivedFieldService 

func NewReceivedFieldService(opts ...option.RequestOption) (r *ReceivedFieldService)

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

func (*ReceivedFieldService) Get 

func (r *ReceivedFieldService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *ReceivedFieldGetResponse, err error)

Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.

type ReceivedGetParams 

type ReceivedGetParams struct {
	// Sets the (exclusive) end of the requested time frame. This can be a unix
	// timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to
	// RFC 3339. `end` must be at least five minutes earlier than now and must be later
	// than `start`. Difference between `start` and `end` must be not greater than one
	// hour.
	End param.Field[ReceivedGetParamsEndUnion] `query:"end,required"`
	// When `?count=` is provided, the response will contain up to `count` results.
	// Since results are not sorted, you are likely to get different data for repeated
	// requests. `count` must be an integer > 0.
	Count param.Field[int64] `query:"count"`
	// The `/received` route by default returns a limited set of fields, and allows
	// customers to override the default field set by specifying individual fields. The
	// reasons for this are: 1. Most customers require only a small subset of fields,
	// but that subset varies from customer to customer; 2. Flat schema is much easier
	// to work with downstream (importing into BigTable etc); 3. Performance (time to
	// process, file size). If `?fields=` is not specified, default field set is
	// returned. This default field set may change at any time. When `?fields=` is
	// provided, each record is returned with the specified fields. `fields` must be
	// specified as a comma separated list without any whitespaces, and all fields must
	// exist. The order in which fields are specified does not matter, and the order of
	// fields in the response is not specified.
	Fields param.Field[string] `query:"fields"`
	// When `?sample=` is provided, a sample of matching records is returned. If
	// `sample=0.1` then 10% of records will be returned. Sampling is random: repeated
	// calls will not only return different records, but likely will also vary slightly
	// in number of returned records. When `?count=` is also specified, `count` is
	// applied to the number of returned records, not the sampled records. So, with
	// `sample=0.05` and `count=7`, when there is a total of 100 records available,
	// approximately five will be returned. When there are 1000 records, seven will be
	// returned. When there are 10,000 records, seven will be returned.
	Sample param.Field[float64] `query:"sample"`
	// Sets the (inclusive) beginning of the requested time frame. This can be a unix
	// timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to
	// RFC 3339. At this point in time, it cannot exceed a time in the past greater
	// than seven days.
	Start param.Field[ReceivedGetParamsStartUnion] `query:"start"`
	// By default, timestamps in responses are returned as Unix nanosecond integers.
	// The `?timestamps=` argument can be set to change the format in which response
	// timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`.
	// Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns
	// timestamps as strings.
	Timestamps param.Field[ReceivedGetParamsTimestamps] `query:"timestamps"`
}

func (ReceivedGetParams) URLQuery 

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

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

type ReceivedGetParamsEndUnion 

type ReceivedGetParamsEndUnion interface {
	ImplementsLogsReceivedGetParamsEndUnion()
}

Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.

Satisfied by shared.UnionString, shared.UnionInt.

type ReceivedGetParamsStartUnion 

type ReceivedGetParamsStartUnion interface {
	ImplementsLogsReceivedGetParamsStartUnion()
}

Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.

Satisfied by shared.UnionString, shared.UnionInt.

type ReceivedGetParamsTimestamps 

type ReceivedGetParamsTimestamps string

By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings. 

const (
	ReceivedGetParamsTimestampsUnix     ReceivedGetParamsTimestamps = "unix"
	ReceivedGetParamsTimestampsUnixnano ReceivedGetParamsTimestamps = "unixnano"
	ReceivedGetParamsTimestampsRfc3339  ReceivedGetParamsTimestamps = "rfc3339"
)

func (ReceivedGetParamsTimestamps) IsKnown 

func (r ReceivedGetParamsTimestamps) IsKnown() bool

type ReceivedGetResponseUnion 

type ReceivedGetResponseUnion interface {
	ImplementsLogsReceivedGetResponseUnion()
}

Union satisfied by shared.UnionString or logs.ReceivedGetResponseUnknown.

type ReceivedService 

type ReceivedService struct {
	Options []option.RequestOption
	Fields  *ReceivedFieldService
}

ReceivedService contains methods and other services that help with interacting with the testcloudflare API.

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

func NewReceivedService 

func NewReceivedService(opts ...option.RequestOption) (r *ReceivedService)

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

func (*ReceivedService) Get 

func (r *ReceivedService) Get(ctx context.Context, zoneIdentifier string, query ReceivedGetParams, opts ...option.RequestOption) (res *ReceivedGetResponseUnion, err error)

The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.