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 Error
- type ErrorData
- type MemberParam
- type MemberRoleParam
- type MemberRolesPermissionsParam
- type MemberStatus
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanComponent
- type RatePlanComponentsName
- type RatePlanFrequency
- type RatePlanGetResponseEnvelope
- type RatePlanGetResponseEnvelopeResultInfo
- type RatePlanGetResponseEnvelopeSuccess
- type RatePlanService
- type ResponseInfo
- type Role
- type SortDirection
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 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
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 SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
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 ¶ added in v2.2.0
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶ added in v2.2.0
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 ¶ added in v2.3.0
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 MemberParam ¶ added in v2.1.0
type MemberParam = shared.MemberParam
This is an alias to an internal type.
type MemberRoleParam ¶ added in v2.1.0
type MemberRoleParam = shared.MemberRoleParam
This is an alias to an internal type.
type MemberRolesPermissionsParam ¶ added in v2.1.0
type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam
This is an alias to an internal type.
type MemberStatus ¶ added in v2.3.0
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUserParam ¶ added in v2.1.0
type MemberUserParam = shared.MemberUserParam
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 RatePlan ¶
type RatePlan struct { // Plan identifier tag. ID string `json:"id"` // Array of available components values for the plan. Components []RatePlanComponent `json:"components"` // The monetary unit in which pricing information is displayed. Currency string `json:"currency"` // The duration of the plan subscription. Duration float64 `json:"duration"` // The frequency at which you will be billed for this plan. Frequency RatePlanFrequency `json:"frequency"` // The plan name. Name string `json:"name"` JSON ratePlanJSON `json:"-"` }
func (*RatePlan) UnmarshalJSON ¶
type RatePlanComponent ¶
type RatePlanComponent struct { // The default amount allocated. Default float64 `json:"default"` // The unique component. Name RatePlanComponentsName `json:"name"` // The unit price of the addon. UnitPrice float64 `json:"unit_price"` JSON ratePlanComponentJSON `json:"-"` }
func (*RatePlanComponent) UnmarshalJSON ¶
func (r *RatePlanComponent) UnmarshalJSON(data []byte) (err error)
type RatePlanComponentsName ¶
type RatePlanComponentsName string
The unique component.
const ( RatePlanComponentsNameZones RatePlanComponentsName = "zones" RatePlanComponentsNamePageRules RatePlanComponentsName = "page_rules" RatePlanComponentsNameDedicatedCertificates RatePlanComponentsName = "dedicated_certificates" RatePlanComponentsNameDedicatedCertificatesCustom RatePlanComponentsName = "dedicated_certificates_custom" )
func (RatePlanComponentsName) IsKnown ¶
func (r RatePlanComponentsName) IsKnown() bool
type RatePlanFrequency ¶
type RatePlanFrequency string
The frequency at which you will be billed for this plan.
const ( RatePlanFrequencyWeekly RatePlanFrequency = "weekly" RatePlanFrequencyMonthly RatePlanFrequency = "monthly" RatePlanFrequencyQuarterly RatePlanFrequency = "quarterly" RatePlanFrequencyYearly RatePlanFrequency = "yearly" )
func (RatePlanFrequency) IsKnown ¶
func (r RatePlanFrequency) IsKnown() bool
type RatePlanGetResponseEnvelope ¶
type RatePlanGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result []RatePlan `json:"result,required,nullable"` // Whether the API call was successful Success RatePlanGetResponseEnvelopeSuccess `json:"success,required"` ResultInfo RatePlanGetResponseEnvelopeResultInfo `json:"result_info"` JSON ratePlanGetResponseEnvelopeJSON `json:"-"` }
func (*RatePlanGetResponseEnvelope) UnmarshalJSON ¶
func (r *RatePlanGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RatePlanGetResponseEnvelopeResultInfo ¶
type RatePlanGetResponseEnvelopeResultInfo struct { // Total number of results for the requested service Count float64 `json:"count"` // Current page within paginated list of results Page float64 `json:"page"` // Number of results per page of results PerPage float64 `json:"per_page"` // Total results available without any search parameters TotalCount float64 `json:"total_count"` JSON ratePlanGetResponseEnvelopeResultInfoJSON `json:"-"` }
func (*RatePlanGetResponseEnvelopeResultInfo) UnmarshalJSON ¶
func (r *RatePlanGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
type RatePlanGetResponseEnvelopeSuccess ¶
type RatePlanGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RatePlanGetResponseEnvelopeSuccessTrue RatePlanGetResponseEnvelopeSuccess = true
)
func (RatePlanGetResponseEnvelopeSuccess) IsKnown ¶
func (r RatePlanGetResponseEnvelopeSuccess) IsKnown() bool
type RatePlanService ¶
type RatePlanService struct {
Options []option.RequestOption
}
RatePlanService 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 NewRatePlanService method instead.
func NewRatePlanService ¶
func NewRatePlanService(opts ...option.RequestOption) (r *RatePlanService)
NewRatePlanService 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 (*RatePlanService) Get ¶
func (r *RatePlanService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *[]RatePlan, err error)
Lists all rate plans the zone can subscribe to.
type SortDirection ¶ added in v2.2.0
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.