precursor

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 CloudflareTunnelConfigSrc ¶

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

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 EnforcementRule ¶

type EnforcementRule struct {
	// The filter expression that determines which requests the rule matches.
	Expression string `json:"expression" api:"required"`
	// The override mode Precursor applies to requests matching an enforcement rule.
	// Unlike `default_mode`, this cannot be `off`.
	Mode EnforcementRuleMode `json:"mode" api:"required"`
	// The read-only identifier that Cloudflare assigns to the rule.
	ID string `json:"id"`
	// An informative description of the rule.
	Description string `json:"description"`
	// Whether the rule is active.
	Enabled bool                `json:"enabled"`
	JSON    enforcementRuleJSON `json:"-"`
}

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

type EnforcementRuleMode ¶

type EnforcementRuleMode string

The override mode Precursor applies to requests matching an enforcement rule. Unlike `default_mode`, this cannot be `off`.

const (
	EnforcementRuleModeMinFriction EnforcementRuleMode = "min-friction"
	EnforcementRuleModeMaxSecurity EnforcementRuleMode = "max-security"
)

func (r EnforcementRuleMode) IsKnown() bool

type EnforcementRuleParam ¶

type EnforcementRuleParam struct {
	// The filter expression that determines which requests the rule matches.
	Expression param.Field[string] `json:"expression" api:"required"`
	// The override mode Precursor applies to requests matching an enforcement rule.
	// Unlike `default_mode`, this cannot be `off`.
	Mode param.Field[EnforcementRuleMode] `json:"mode" api:"required"`
	// An informative description of the rule.
	Description param.Field[string] `json:"description"`
	// Whether the rule is active.
	Enabled param.Field[bool] `json:"enabled"`
}

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

type Error ¶

type Error = apierror.Error

type ErrorData ¶

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource ¶

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member ¶

type Member = shared.Member

This is an alias to an internal type.

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 MemberPolicy ¶

type MemberPolicy = shared.MemberPolicy

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 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 PrecursorConfig ¶

type PrecursorConfig struct {
	// The zone-level Precursor enforcement mode applied to requests that do not match
	// a more specific enforcement rule.
	DefaultMode PrecursorConfigDefaultMode `json:"default_mode"`
	// The ordered list of enforcement rules for the zone.
	EnforcementRules []EnforcementRule   `json:"enforcement_rules"`
	JSON             precursorConfigJSON `json:"-"`
}

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

type PrecursorConfigDefaultMode ¶

type PrecursorConfigDefaultMode string

The zone-level Precursor enforcement mode applied to requests that do not match a more specific enforcement rule.

const (
	PrecursorConfigDefaultModeOff         PrecursorConfigDefaultMode = "off"
	PrecursorConfigDefaultModeMinFriction PrecursorConfigDefaultMode = "min-friction"
	PrecursorConfigDefaultModeMaxSecurity PrecursorConfigDefaultMode = "max-security"
)

func (r PrecursorConfigDefaultMode) IsKnown() bool

type PrecursorConfigParam ¶

type PrecursorConfigParam struct {
	// The zone-level Precursor enforcement mode applied to requests that do not match
	// a more specific enforcement rule.
	DefaultMode param.Field[PrecursorConfigDefaultMode] `json:"default_mode"`
	// The ordered list of enforcement rules for the zone.
	EnforcementRules param.Field[[]EnforcementRuleParam] `json:"enforcement_rules"`
}

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

type PrecursorGetParams ¶

type PrecursorGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id" api:"required"`
}

type PrecursorGetResponseEnvelope ¶

type PrecursorGetResponseEnvelope struct {
	Errors   []PrecursorGetResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []PrecursorGetResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success PrecursorGetResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  PrecursorConfig                     `json:"result"`
	JSON    precursorGetResponseEnvelopeJSON    `json:"-"`
}

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

type PrecursorGetResponseEnvelopeErrors ¶

type PrecursorGetResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code" api:"required"`
	Message          string                                   `json:"message" api:"required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           PrecursorGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             precursorGetResponseEnvelopeErrorsJSON   `json:"-"`
}

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

type PrecursorGetResponseEnvelopeErrorsSource ¶

type PrecursorGetResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    precursorGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

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

type PrecursorGetResponseEnvelopeMessages ¶

type PrecursorGetResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code" api:"required"`
	Message          string                                     `json:"message" api:"required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           PrecursorGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             precursorGetResponseEnvelopeMessagesJSON   `json:"-"`
}

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

type PrecursorGetResponseEnvelopeMessagesSource ¶

type PrecursorGetResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    precursorGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

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

type PrecursorGetResponseEnvelopeSuccess ¶

type PrecursorGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	PrecursorGetResponseEnvelopeSuccessTrue PrecursorGetResponseEnvelopeSuccess = true
)

func (r PrecursorGetResponseEnvelopeSuccess) IsKnown() bool

type PrecursorService ¶

type PrecursorService struct {
	Options []option.RequestOption
}

PrecursorService 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 NewPrecursorService method instead.

func NewPrecursorService(opts ...option.RequestOption) (r *PrecursorService)

func (r *PrecursorService) Get(ctx context.Context, query PrecursorGetParams, opts ...option.RequestOption) (res *PrecursorConfig, err error)

func (r *PrecursorService) Update(ctx context.Context, params PrecursorUpdateParams, opts ...option.RequestOption) (res *PrecursorConfig, err error)

type PrecursorUpdateParams ¶

type PrecursorUpdateParams struct {
	// Identifier.
	ZoneID          param.Field[string]  `path:"zone_id" api:"required"`
	PrecursorConfig PrecursorConfigParam `json:"precursor_config" api:"required"`
}

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

type PrecursorUpdateResponseEnvelope ¶

type PrecursorUpdateResponseEnvelope struct {
	Errors   []PrecursorUpdateResponseEnvelopeErrors   `json:"errors" api:"required"`
	Messages []PrecursorUpdateResponseEnvelopeMessages `json:"messages" api:"required"`
	// Whether the API call was successful.
	Success PrecursorUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	Result  PrecursorConfig                        `json:"result"`
	JSON    precursorUpdateResponseEnvelopeJSON    `json:"-"`
}

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

type PrecursorUpdateResponseEnvelopeErrors ¶

type PrecursorUpdateResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code" api:"required"`
	Message          string                                      `json:"message" api:"required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           PrecursorUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             precursorUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

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

type PrecursorUpdateResponseEnvelopeErrorsSource ¶

type PrecursorUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    precursorUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

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

type PrecursorUpdateResponseEnvelopeMessages ¶

type PrecursorUpdateResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code" api:"required"`
	Message          string                                        `json:"message" api:"required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           PrecursorUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             precursorUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

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

type PrecursorUpdateResponseEnvelopeMessagesSource ¶

type PrecursorUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    precursorUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

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

type PrecursorUpdateResponseEnvelopeSuccess ¶

type PrecursorUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	PrecursorUpdateResponseEnvelopeSuccessTrue PrecursorUpdateResponseEnvelopeSuccess = true
)

func (r PrecursorUpdateResponseEnvelopeSuccess) IsKnown() bool

type RatePlan ¶

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID ¶

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 ResponseInfo ¶

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource ¶

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role ¶

type Role = shared.Role

This is an alias to an internal type.

type RoleParam ¶

type RoleParam = shared.RoleParam

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 Subscription ¶

type Subscription = shared.Subscription

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 Token ¶

type Token = shared.Token

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 TokenParam ¶

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy ¶

type TokenPolicy = shared.TokenPolicy

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 TokenPolicyResourcesIAMResourcesTypeObjectNested ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString ¶

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion ¶

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam ¶

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

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.