Documentation
¶
Index ¶
- Constants
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type AvailableRatePlan
- type AvailableRatePlanFrequency
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type PlanGetResponseEnvelope
- type PlanGetResponseEnvelopeSuccess
- type PlanService
- func (r *PlanService) Get(ctx context.Context, zoneIdentifier string, planIdentifier string, ...) (res *AvailableRatePlan, err error)
- func (r *PlanService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[AvailableRatePlan], err error)
- func (r *PlanService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AvailableRatePlan]
- type ResponseInfo
- type Role
- type User
- type UserParam
- type UserRole
- type UserRoleParam
- type UserRolesPermissions
- type UserRolesPermissionsParam
- type UserUser
- type UserUserParam
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 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.
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 AvailableRatePlan ¶
type AvailableRatePlan struct {
// Identifier
ID string `json:"id"`
// Indicates whether you can subscribe to this plan.
CanSubscribe bool `json:"can_subscribe"`
// The monetary unit in which pricing information is displayed.
Currency string `json:"currency"`
// Indicates whether this plan is managed externally.
ExternallyManaged bool `json:"externally_managed"`
// The frequency at which you will be billed for this plan.
Frequency AvailableRatePlanFrequency `json:"frequency"`
// Indicates whether you are currently subscribed to this plan.
IsSubscribed bool `json:"is_subscribed"`
// Indicates whether this plan has a legacy discount applied.
LegacyDiscount bool `json:"legacy_discount"`
// The legacy identifier for this rate plan, if any.
LegacyID string `json:"legacy_id"`
// The plan name.
Name string `json:"name"`
// The amount you will be billed for this plan.
Price float64 `json:"price"`
JSON availableRatePlanJSON `json:"-"`
}
func (*AvailableRatePlan) UnmarshalJSON ¶
func (r *AvailableRatePlan) UnmarshalJSON(data []byte) (err error)
type AvailableRatePlanFrequency ¶
type AvailableRatePlanFrequency string
The frequency at which you will be billed for this plan.
const ( AvailableRatePlanFrequencyWeekly AvailableRatePlanFrequency = "weekly" AvailableRatePlanFrequencyMonthly AvailableRatePlanFrequency = "monthly" AvailableRatePlanFrequencyQuarterly AvailableRatePlanFrequency = "quarterly" AvailableRatePlanFrequencyYearly AvailableRatePlanFrequency = "yearly" )
func (AvailableRatePlanFrequency) IsKnown ¶
func (r AvailableRatePlanFrequency) IsKnown() bool
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 CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
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 PlanGetResponseEnvelope ¶
type PlanGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result AvailableRatePlan `json:"result,required"`
// Whether the API call was successful
Success PlanGetResponseEnvelopeSuccess `json:"success,required"`
JSON planGetResponseEnvelopeJSON `json:"-"`
}
func (*PlanGetResponseEnvelope) UnmarshalJSON ¶
func (r *PlanGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PlanGetResponseEnvelopeSuccess ¶
type PlanGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
PlanGetResponseEnvelopeSuccessTrue PlanGetResponseEnvelopeSuccess = true
)
func (PlanGetResponseEnvelopeSuccess) IsKnown ¶
func (r PlanGetResponseEnvelopeSuccess) IsKnown() bool
type PlanService ¶
type PlanService struct {
Options []option.RequestOption
}
PlanService 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 NewPlanService method instead.
func NewPlanService ¶
func NewPlanService(opts ...option.RequestOption) (r *PlanService)
NewPlanService 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 (*PlanService) Get ¶
func (r *PlanService) Get(ctx context.Context, zoneIdentifier string, planIdentifier string, opts ...option.RequestOption) (res *AvailableRatePlan, err error)
Details of the available plan that the zone can subscribe to.
func (*PlanService) List ¶
func (r *PlanService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[AvailableRatePlan], err error)
Lists available plans the zone can subscribe to.
func (*PlanService) ListAutoPaging ¶
func (r *PlanService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AvailableRatePlan]
Lists available plans the zone can subscribe to.
type UserRoleParam ¶
type UserRoleParam = shared.UserRoleParam
This is an alias to an internal type.
type UserRolesPermissions ¶
type UserRolesPermissions = shared.UserRolesPermissions
This is an alias to an internal type.
type UserRolesPermissionsParam ¶
type UserRolesPermissionsParam = shared.UserRolesPermissionsParam
This is an alias to an internal type.
type UserUserParam ¶
type UserUserParam = shared.UserUserParam
This is an alias to an internal type.