Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type CmbConfig
- type CmbConfigParam
- type ControlCmbConfigDeleteParams
- type ControlCmbConfigDeleteResponse
- type ControlCmbConfigDeleteResponseEnvelope
- type ControlCmbConfigDeleteResponseEnvelopeErrors
- type ControlCmbConfigDeleteResponseEnvelopeErrorsSource
- type ControlCmbConfigDeleteResponseEnvelopeMessages
- type ControlCmbConfigDeleteResponseEnvelopeMessagesSource
- type ControlCmbConfigDeleteResponseEnvelopeSuccess
- type ControlCmbConfigGetParams
- type ControlCmbConfigGetResponseEnvelope
- type ControlCmbConfigGetResponseEnvelopeErrors
- type ControlCmbConfigGetResponseEnvelopeErrorsSource
- type ControlCmbConfigGetResponseEnvelopeMessages
- type ControlCmbConfigGetResponseEnvelopeMessagesSource
- type ControlCmbConfigGetResponseEnvelopeSuccess
- type ControlCmbConfigNewParams
- type ControlCmbConfigNewResponseEnvelope
- type ControlCmbConfigNewResponseEnvelopeErrors
- type ControlCmbConfigNewResponseEnvelopeErrorsSource
- type ControlCmbConfigNewResponseEnvelopeMessages
- type ControlCmbConfigNewResponseEnvelopeMessagesSource
- type ControlCmbConfigNewResponseEnvelopeSuccess
- type ControlCmbConfigService
- func (r *ControlCmbConfigService) Delete(ctx context.Context, body ControlCmbConfigDeleteParams, ...) (res *ControlCmbConfigDeleteResponse, err error)
- func (r *ControlCmbConfigService) Get(ctx context.Context, query ControlCmbConfigGetParams, ...) (res *CmbConfig, err error)
- func (r *ControlCmbConfigService) New(ctx context.Context, params ControlCmbConfigNewParams, ...) (res *CmbConfig, err error)
- type ControlCmbService
- type ControlRetentionGetParams
- type ControlRetentionGetResponse
- type ControlRetentionGetResponseEnvelope
- type ControlRetentionGetResponseEnvelopeErrors
- type ControlRetentionGetResponseEnvelopeErrorsSource
- type ControlRetentionGetResponseEnvelopeMessages
- type ControlRetentionGetResponseEnvelopeMessagesSource
- type ControlRetentionGetResponseEnvelopeSuccess
- type ControlRetentionNewParams
- type ControlRetentionNewResponse
- type ControlRetentionNewResponseEnvelope
- type ControlRetentionNewResponseEnvelopeErrors
- type ControlRetentionNewResponseEnvelopeErrorsSource
- type ControlRetentionNewResponseEnvelopeMessages
- type ControlRetentionNewResponseEnvelopeMessagesSource
- type ControlRetentionNewResponseEnvelopeSuccess
- type ControlRetentionService
- type ControlService
- type Error
- type ErrorData
- type ErrorDataSource
- type LogService
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type RayIDGetParams
- type RayIDGetParamsTimestamps
- type RayIDService
- type ReceivedFieldGetParams
- type ReceivedFieldGetResponse
- type ReceivedFieldService
- type ReceivedGetParams
- type ReceivedGetParamsEndUnion
- type ReceivedGetParamsStartUnion
- type ReceivedGetParamsTimestamps
- type ReceivedService
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesMap
- type TokenPolicyResourcesMapParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type 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 {
// Allow out of region access
AllowOutOfRegionAccess bool `json:"allow_out_of_region_access"`
// Name of the region.
Regions string `json:"regions"`
JSON cmbConfigJSON `json:"-"`
}
func (*CmbConfig) UnmarshalJSON ¶
type CmbConfigParam ¶
type CmbConfigParam struct {
// Allow out of region access
AllowOutOfRegionAccess param.Field[bool] `json:"allow_out_of_region_access"`
// Name of the region.
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 []ControlCmbConfigDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []ControlCmbConfigDeleteResponseEnvelopeMessages `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 ControlCmbConfigDeleteResponseEnvelopeErrors ¶ added in v4.3.0
type ControlCmbConfigDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlCmbConfigDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON controlCmbConfigDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ControlCmbConfigDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigDeleteResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ControlCmbConfigDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON controlCmbConfigDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ControlCmbConfigDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigDeleteResponseEnvelopeMessages ¶ added in v4.3.0
type ControlCmbConfigDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlCmbConfigDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON controlCmbConfigDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ControlCmbConfigDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigDeleteResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ControlCmbConfigDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON controlCmbConfigDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ControlCmbConfigDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigDeleteResponseEnvelopeMessagesSource) 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 []ControlCmbConfigGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ControlCmbConfigGetResponseEnvelopeMessages `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 ControlCmbConfigGetResponseEnvelopeErrors ¶ added in v4.3.0
type ControlCmbConfigGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlCmbConfigGetResponseEnvelopeErrorsSource `json:"source"`
JSON controlCmbConfigGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ControlCmbConfigGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ControlCmbConfigGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON controlCmbConfigGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ControlCmbConfigGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigGetResponseEnvelopeMessages ¶ added in v4.3.0
type ControlCmbConfigGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlCmbConfigGetResponseEnvelopeMessagesSource `json:"source"`
JSON controlCmbConfigGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ControlCmbConfigGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ControlCmbConfigGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON controlCmbConfigGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ControlCmbConfigGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigGetResponseEnvelopeMessagesSource) 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 {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
CmbConfig CmbConfigParam `json:"cmb_config,required"`
}
func (ControlCmbConfigNewParams) MarshalJSON ¶
func (r ControlCmbConfigNewParams) MarshalJSON() (data []byte, err error)
type ControlCmbConfigNewResponseEnvelope ¶
type ControlCmbConfigNewResponseEnvelope struct {
Errors []ControlCmbConfigNewResponseEnvelopeErrors `json:"errors,required"`
Messages []ControlCmbConfigNewResponseEnvelopeMessages `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 ControlCmbConfigNewResponseEnvelopeErrors ¶ added in v4.3.0
type ControlCmbConfigNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlCmbConfigNewResponseEnvelopeErrorsSource `json:"source"`
JSON controlCmbConfigNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ControlCmbConfigNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ControlCmbConfigNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON controlCmbConfigNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ControlCmbConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigNewResponseEnvelopeMessages ¶ added in v4.3.0
type ControlCmbConfigNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlCmbConfigNewResponseEnvelopeMessagesSource `json:"source"`
JSON controlCmbConfigNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ControlCmbConfigNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ControlCmbConfigNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ControlCmbConfigNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON controlCmbConfigNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ControlCmbConfigNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlCmbConfigNewResponseEnvelopeMessagesSource) 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 cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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, body ControlCmbConfigDeleteParams, opts ...option.RequestOption) (res *ControlCmbConfigDeleteResponse, err error)
Deletes CMB config.
func (*ControlCmbConfigService) Get ¶
func (r *ControlCmbConfigService) Get(ctx context.Context, query ControlCmbConfigGetParams, opts ...option.RequestOption) (res *CmbConfig, err error)
Gets CMB config.
func (*ControlCmbConfigService) New ¶
func (r *ControlCmbConfigService) New(ctx context.Context, params 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 cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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 {
// The log retention flag for Logpull API.
Flag bool `json:"flag"`
JSON controlRetentionGetResponseJSON `json:"-"`
}
func (*ControlRetentionGetResponse) UnmarshalJSON ¶
func (r *ControlRetentionGetResponse) UnmarshalJSON(data []byte) (err error)
type ControlRetentionGetResponseEnvelope ¶
type ControlRetentionGetResponseEnvelope struct {
Errors []ControlRetentionGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ControlRetentionGetResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ControlRetentionGetResponseEnvelopeSuccess `json:"success,required"`
Result ControlRetentionGetResponse `json:"result,nullable"`
JSON controlRetentionGetResponseEnvelopeJSON `json:"-"`
}
func (*ControlRetentionGetResponseEnvelope) UnmarshalJSON ¶
func (r *ControlRetentionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ControlRetentionGetResponseEnvelopeErrors ¶ added in v4.3.0
type ControlRetentionGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlRetentionGetResponseEnvelopeErrorsSource `json:"source"`
JSON controlRetentionGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ControlRetentionGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ControlRetentionGetResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ControlRetentionGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON controlRetentionGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ControlRetentionGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ControlRetentionGetResponseEnvelopeMessages ¶ added in v4.3.0
type ControlRetentionGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlRetentionGetResponseEnvelopeMessagesSource `json:"source"`
JSON controlRetentionGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ControlRetentionGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ControlRetentionGetResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ControlRetentionGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON controlRetentionGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ControlRetentionGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionGetResponseEnvelopeMessagesSource) 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 {
// Identifier.
ZoneID param.Field[string] `path:"zone_id,required"`
// The log retention flag for Logpull API.
Flag param.Field[bool] `json:"flag"`
}
func (ControlRetentionNewParams) MarshalJSON ¶
func (r ControlRetentionNewParams) MarshalJSON() (data []byte, err error)
type ControlRetentionNewResponse ¶
type ControlRetentionNewResponse struct {
// The log retention flag for Logpull API.
Flag bool `json:"flag"`
JSON controlRetentionNewResponseJSON `json:"-"`
}
func (*ControlRetentionNewResponse) UnmarshalJSON ¶
func (r *ControlRetentionNewResponse) UnmarshalJSON(data []byte) (err error)
type ControlRetentionNewResponseEnvelope ¶
type ControlRetentionNewResponseEnvelope struct {
Errors []ControlRetentionNewResponseEnvelopeErrors `json:"errors,required"`
Messages []ControlRetentionNewResponseEnvelopeMessages `json:"messages,required"`
// Whether the API call was successful.
Success ControlRetentionNewResponseEnvelopeSuccess `json:"success,required"`
Result ControlRetentionNewResponse `json:"result,nullable"`
JSON controlRetentionNewResponseEnvelopeJSON `json:"-"`
}
func (*ControlRetentionNewResponseEnvelope) UnmarshalJSON ¶
func (r *ControlRetentionNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ControlRetentionNewResponseEnvelopeErrors ¶ added in v4.3.0
type ControlRetentionNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlRetentionNewResponseEnvelopeErrorsSource `json:"source"`
JSON controlRetentionNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ControlRetentionNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ControlRetentionNewResponseEnvelopeErrorsSource ¶ added in v4.3.0
type ControlRetentionNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON controlRetentionNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ControlRetentionNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ControlRetentionNewResponseEnvelopeMessages ¶ added in v4.3.0
type ControlRetentionNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ControlRetentionNewResponseEnvelopeMessagesSource `json:"source"`
JSON controlRetentionNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ControlRetentionNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ControlRetentionNewResponseEnvelopeMessagesSource ¶ added in v4.3.0
type ControlRetentionNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON controlRetentionNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ControlRetentionNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v4.3.0
func (r *ControlRetentionNewResponseEnvelopeMessagesSource) 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 cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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, query ControlRetentionGetParams, opts ...option.RequestOption) (res *ControlRetentionGetResponse, err error)
Gets log retention flag for Logpull API.
func (*ControlRetentionService) New ¶
func (r *ControlRetentionService) New(ctx context.Context, params 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 cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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 ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
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 cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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 MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type 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 RatePlanID ¶ added in v4.1.0
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type RayIDGetParams ¶
type RayIDGetParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// 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 RayIDService ¶
type RayIDService struct {
Options []option.RequestOption
}
RayIDService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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, RayID string, params RayIDGetParams, opts ...option.RequestOption) (res *interface{}, 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 ReceivedFieldGetParams ¶
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 cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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, query ReceivedFieldGetParams, 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 {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// 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 {
ImplementsReceivedGetParamsEndUnion()
}
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 {
ImplementsReceivedGetParamsStartUnion()
}
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 ReceivedService ¶
type ReceivedService struct {
Options []option.RequestOption
Fields *ReceivedFieldService
}
ReceivedService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the 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, params ReceivedGetParams, opts ...option.RequestOption) (res *interface{}, 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 ResponseInfoSource ¶ added in v4.3.0
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesMap ¶ added in v4.6.0
type TokenPolicyResourcesMap = shared.TokenPolicyResourcesMap
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesMapParam ¶ added in v4.6.0
type TokenPolicyResourcesMapParam = shared.TokenPolicyResourcesMapParam
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶ added in v4.6.0
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A simple wildcard permission, e.g., "\*".
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶ added in v4.6.0
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A simple wildcard permission, e.g., "\*".
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.